Type annotations for boto3.CodeArtifact 1.14.1 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-codeartifact
Type annotations for boto3.CodeArtifact 1.14.1 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.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fae46b6d4a4594624c405d70b31ef98b0c98ac0808dee92ef72922f45584e914 |
|
MD5 | bf78a4e8309e68813b2daaa5f6d3c562 |
|
BLAKE2b-256 | c7ff3513fcd2b8498b2625ccdbade8d3ffe15540cc21ed55ab014bc285857c60 |
Hashes for mypy_boto3_codeartifact-1.14.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 73799d53e99ad6c335333d62566b2616f114d23ccff3ba98a744c135762e1bb0 |
|
MD5 | c05515b57ab6036cc900262d3da04807 |
|
BLAKE2b-256 | f7ad4610724f7b1eb1e457c0bba54da0fd1704f82bd23dd75caf5c621ed2cbb2 |