Type annotations for boto3.Batch 1.14.0 service, generated by mypy-boto3-buider 2.1.0
Project description
mypy-boto3-batch
Type annotations for boto3.Batch 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.1.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 Batch
service.
python -m pip install boto3-stubs[batch]
How to use
Client annotations
BatchClient
provides annotations for boto3.client("batch")
.
import boto3
from mypy_boto3_batch import BatchClient
client: BatchClient = boto3.client("batch")
# 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: BatchClient = session.client("batch")
Paginators annotations
mypy_boto3_batch.paginator
module contains type annotations for all paginators.
from mypy_boto3_batch import BatchClient
from mypy_boto3_batch.paginator import (
DescribeComputeEnvironmentsPaginator,
DescribeJobDefinitionsPaginator,
DescribeJobQueuesPaginator,
ListJobsPaginator,
)
client: BatchClient = boto3.client("batch")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_compute_environments_paginator: DescribeComputeEnvironmentsPaginator = client.get_paginator("describe_compute_environments")
describe_job_definitions_paginator: DescribeJobDefinitionsPaginator = client.get_paginator("describe_job_definitions")
describe_job_queues_paginator: DescribeJobQueuesPaginator = client.get_paginator("describe_job_queues")
list_jobs_paginator: ListJobsPaginator = client.get_paginator("list_jobs")
Typed dictionations
mypy_boto3_batch.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
from mypy_boto3_batch.type_defs import ArrayPropertiesDetailTypeDef, ...
def get_structure() -> ArrayPropertiesDetailTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_batch
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
import boto3
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("batch")
session_client = boto3.Session().client("batch")
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-batch-1.14.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d73be880f1d892e07f200714d1cf47e07741849f0105bd313d92d23a55783136 |
|
MD5 | f2e4066dd3730c7026306d194a7e15ce |
|
BLAKE2b-256 | da296ddd2f5ed17d9cfd2955a284f42f16d4c1683b68e7c847ca10b308228cfe |
Hashes for mypy_boto3_batch-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 80e2cb15282968862c877bb82172996fa38a7531f78fe652c863214b9a10e35e |
|
MD5 | 612d3112647b3c7c429afbf4ebb2901b |
|
BLAKE2b-256 | 936cb8282a09475fa8b73ea847b2be750c5878eacd3c4976e20bda65766e4a07 |