Type annotations for boto3.CodeArtifact 1.14.26 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-codeartifact
Type annotations for boto3.CodeArtifact 1.14.26 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 CodeArtifact
service.
python -m pip install boto3-stubs[codeartifact]
How to use
Client annotations
CodeArtifactClient
provides annotations for boto3.client("codeartifact")
.
import boto3
from mypy_boto3_codeartifact import CodeArtifactClient
from mypy_boto3_codeartifact.paginator import (
ListDomainsPaginator,
ListPackagesPaginator,
ListPackageVersionAssetsPaginator,
ListPackageVersionsPaginator,
ListRepositoriesInDomainPaginator,
ListRepositoriesPaginator,
)
from mypy_boto3_codeartifact.type_defs import AssetSummaryTypeDef, ...
client: CodeArtifactClient = boto3.client("codeartifact")
# 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: CodeArtifactClient = session.client("codeartifact")
Paginators annotations
mypy_boto3_codeartifact.paginator
module contains type annotations for all paginators.
client: CodeArtifactClient = boto3.client("codeartifact")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_domains_paginator: ListDomainsPaginator = client.get_paginator("list_domains")
list_package_version_assets_paginator: ListPackageVersionAssetsPaginator = client.get_paginator("list_package_version_assets")
list_package_versions_paginator: ListPackageVersionsPaginator = client.get_paginator("list_package_versions")
list_packages_paginator: ListPackagesPaginator = client.get_paginator("list_packages")
list_repositories_paginator: ListRepositoriesPaginator = client.get_paginator("list_repositories")
list_repositories_in_domain_paginator: ListRepositoriesInDomainPaginator = client.get_paginator("list_repositories_in_domain")
Typed dictionations
mypy_boto3_codeartifact.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AssetSummaryTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_codeartifact
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("codeartifact")
session_client = boto3.Session().client("codeartifact")
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-codeartifact-1.14.26.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 339de26db96812b2888a3b5ae3f5448a4a359d07075cc57c500939e5d65954f7 |
|
MD5 | 2ea5281ba47014094a17b65e48fa69b0 |
|
BLAKE2b-256 | 6ca486afadaacf2bea68e0303a063b6800bf1d01fcf27f9193e0fa958acba20e |
Hashes for mypy_boto3_codeartifact-1.14.26.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 803e205ceca863950b6aed9d66b07732a7969a418961f95d6ea1845922305f9b |
|
MD5 | e9979327b790f9feeec5c99b133c13d5 |
|
BLAKE2b-256 | 5d0434279aec29788a09f855bbeafa56fe194bab780142b13be1289d82167515 |