Type annotations for boto3.GameLift 1.14.19 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-gamelift
Type annotations for boto3.GameLift 1.14.19 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for GameLift
service.
python -m pip install boto3-stubs[gamelift]
How to use
Client annotations
GameLiftClient
provides annotations for boto3.client("gamelift")
.
import boto3
from mypy_boto3_gamelift import GameLiftClient
from mypy_boto3_gamelift.paginator import (
DescribeFleetAttributesPaginator,
DescribeFleetCapacityPaginator,
DescribeFleetEventsPaginator,
DescribeFleetUtilizationPaginator,
DescribeGameSessionDetailsPaginator,
DescribeGameSessionQueuesPaginator,
DescribeGameSessionsPaginator,
DescribeInstancesPaginator,
DescribeMatchmakingConfigurationsPaginator,
DescribeMatchmakingRuleSetsPaginator,
DescribePlayerSessionsPaginator,
DescribeScalingPoliciesPaginator,
ListAliasesPaginator,
ListBuildsPaginator,
ListFleetsPaginator,
SearchGameSessionsPaginator,
)
from mypy_boto3_gamelift.type_defs import AliasTypeDef, ...
client: GameLiftClient = boto3.client("gamelift")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: GameLiftClient = session.client("gamelift")
Paginators annotations
mypy_boto3_gamelift.paginator
module contains type annotations for all paginators.
client: GameLiftClient = boto3.client("gamelift")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_fleet_attributes_paginator: DescribeFleetAttributesPaginator = client.get_paginator("describe_fleet_attributes")
describe_fleet_capacity_paginator: DescribeFleetCapacityPaginator = client.get_paginator("describe_fleet_capacity")
describe_fleet_events_paginator: DescribeFleetEventsPaginator = client.get_paginator("describe_fleet_events")
describe_fleet_utilization_paginator: DescribeFleetUtilizationPaginator = client.get_paginator("describe_fleet_utilization")
describe_game_session_details_paginator: DescribeGameSessionDetailsPaginator = client.get_paginator("describe_game_session_details")
describe_game_session_queues_paginator: DescribeGameSessionQueuesPaginator = client.get_paginator("describe_game_session_queues")
describe_game_sessions_paginator: DescribeGameSessionsPaginator = client.get_paginator("describe_game_sessions")
describe_instances_paginator: DescribeInstancesPaginator = client.get_paginator("describe_instances")
describe_matchmaking_configurations_paginator: DescribeMatchmakingConfigurationsPaginator = client.get_paginator("describe_matchmaking_configurations")
describe_matchmaking_rule_sets_paginator: DescribeMatchmakingRuleSetsPaginator = client.get_paginator("describe_matchmaking_rule_sets")
describe_player_sessions_paginator: DescribePlayerSessionsPaginator = client.get_paginator("describe_player_sessions")
describe_scaling_policies_paginator: DescribeScalingPoliciesPaginator = client.get_paginator("describe_scaling_policies")
list_aliases_paginator: ListAliasesPaginator = client.get_paginator("list_aliases")
list_builds_paginator: ListBuildsPaginator = client.get_paginator("list_builds")
list_fleets_paginator: ListFleetsPaginator = client.get_paginator("list_fleets")
search_game_sessions_paginator: SearchGameSessionsPaginator = client.get_paginator("search_game_sessions")
Typed dictionations
mypy_boto3_gamelift.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AliasTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_gamelift
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("gamelift")
session_client = boto3.Session().client("gamelift")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy-boto3-gamelift-1.14.19.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10b5eebc76834307cd61a50f93918f0052db90ee578f226ba7e01bfcd55a17e7 |
|
MD5 | de08729bd8b96857d3af35fcef3f5bab |
|
BLAKE2b-256 | bb5635a69dd02b6830be99395280591c7940daa71f7fd7815d4dc16e0f285925 |
Hashes for mypy_boto3_gamelift-1.14.19.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99f7fa3cd26c9d7ab691876a023b2f8f049a705bb3ee907735636c02b7eb29b3 |
|
MD5 | cb758c969c514f77cf4fdcca0c78a137 |
|
BLAKE2b-256 | 0196adb8e189ed34100f97f254028119db351c13fb4a9314622d679870269bdf |