Type annotations for boto3.Batch 1.14.13 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-batch
Type annotations for boto3.Batch 1.14.13 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 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
from mypy_boto3_batch.paginator import (
DescribeComputeEnvironmentsPaginator,
DescribeJobDefinitionsPaginator,
DescribeJobQueuesPaginator,
ListJobsPaginator,
)
from mypy_boto3_batch.type_defs import ArrayPropertiesDetailTypeDef, ...
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.
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.
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
# 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.13.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d6fd1b4b248e27740cb0d53322e4aa537aa1fa9222d3103a012e61125da9ac0 |
|
MD5 | b0c1b92c8bb758cbf51a4dd4476133c3 |
|
BLAKE2b-256 | 4d33020792d7ea9a4fdac0a3b57449ebf6f29b787777ce2f10d2d509e7b85395 |
Hashes for mypy_boto3_batch-1.14.13.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 55ce7080eb1f0caf75d15509b06937b76d4e73ce0024a142031c6df06daa3d16 |
|
MD5 | 5ed93c5cb1a4275e0def877d470575b5 |
|
BLAKE2b-256 | 531396bcd062c31f6e5ad18b2ab19679d10111c382416eef7db44c939f4bd425 |