Type annotations for boto3.CodeArtifact 1.14.3 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-codeartifact
Type annotations for boto3.CodeArtifact 1.14.3 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.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c51cc70f915f3a3c91bc0f1d38d07d92bf49a11e0e8837c60018829073db064 |
|
MD5 | d301e156094decefa439c1a2051d6872 |
|
BLAKE2b-256 | e766fc4eb9ef71d217e96becd67bc255570891c07ca158c418a644b47d02bbaf |
Hashes for mypy_boto3_codeartifact-1.14.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b36bc1578cc1873b435a5388d41d4cf796bf6db4af9e534ba3a37ef8844fb5d6 |
|
MD5 | ffa352a9eab9efb8ddad3d06cec6e1bb |
|
BLAKE2b-256 | c3ac68a97320f6bb4540f86a612b86711ad5963e6f0bea103524389636f0c84d |