Type annotations for boto3.DataPipeline 1.14.12 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-datapipeline
Type annotations for boto3.DataPipeline 1.14.12 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 DataPipeline
service.
python -m pip install boto3-stubs[datapipeline]
How to use
Client annotations
DataPipelineClient
provides annotations for boto3.client("datapipeline")
.
import boto3
from mypy_boto3_datapipeline import DataPipelineClient
from mypy_boto3_datapipeline.paginator import (
DescribeObjectsPaginator,
ListPipelinesPaginator,
QueryObjectsPaginator,
)
from mypy_boto3_datapipeline.type_defs import FieldTypeDef, ...
client: DataPipelineClient = boto3.client("datapipeline")
# 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: DataPipelineClient = session.client("datapipeline")
Paginators annotations
mypy_boto3_datapipeline.paginator
module contains type annotations for all paginators.
client: DataPipelineClient = boto3.client("datapipeline")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_objects_paginator: DescribeObjectsPaginator = client.get_paginator("describe_objects")
list_pipelines_paginator: ListPipelinesPaginator = client.get_paginator("list_pipelines")
query_objects_paginator: QueryObjectsPaginator = client.get_paginator("query_objects")
Typed dictionations
mypy_boto3_datapipeline.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> FieldTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_datapipeline
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("datapipeline")
session_client = boto3.Session().client("datapipeline")
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-datapipeline-1.14.12.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b70c45e4ecbc3c65845d7073fa6ffb980f870fe5358fdedb433b8c0785ef34d |
|
MD5 | 3b63f2845e3acd73b4e913135547865c |
|
BLAKE2b-256 | f40768af2f47c6e7bc0f58f89660396807c71e68ce8288eeba605b4311e37325 |
Hashes for mypy_boto3_datapipeline-1.14.12.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4a20e97adc325c51e8ccd1c82f6960b611fd494ac2d6f80182215cc0f1f4117a |
|
MD5 | f138b02b5906db218fdc109574167022 |
|
BLAKE2b-256 | d6c3b15401e579d3aa53f46a6bb70a9de79e24a39db6afe536c2ea9b1670756e |