Type annotations for boto3.CodeStar 1.14.2 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-codestar
Type annotations for boto3.CodeStar 1.14.2 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 CodeStar
service.
python -m pip install boto3-stubs[codestar]
How to use
Client annotations
CodeStarClient
provides annotations for boto3.client("codestar")
.
import boto3
from mypy_boto3_codestar import CodeStarClient
from mypy_boto3_codestar.paginator import (
ListProjectsPaginator,
ListResourcesPaginator,
ListTeamMembersPaginator,
ListUserProfilesPaginator,
)
from mypy_boto3_codestar.type_defs import CodeCommitCodeDestinationTypeDef, ...
client: CodeStarClient = boto3.client("codestar")
# 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: CodeStarClient = session.client("codestar")
Paginators annotations
mypy_boto3_codestar.paginator
module contains type annotations for all paginators.
client: CodeStarClient = boto3.client("codestar")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_projects_paginator: ListProjectsPaginator = client.get_paginator("list_projects")
list_resources_paginator: ListResourcesPaginator = client.get_paginator("list_resources")
list_team_members_paginator: ListTeamMembersPaginator = client.get_paginator("list_team_members")
list_user_profiles_paginator: ListUserProfilesPaginator = client.get_paginator("list_user_profiles")
Typed dictionations
mypy_boto3_codestar.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> CodeCommitCodeDestinationTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_codestar
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("codestar")
session_client = boto3.Session().client("codestar")
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-codestar-1.14.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f115da02a739bee91e538cfe8a7037a258c2006e11e1d4dad4939cb0e866bc00 |
|
MD5 | 46f94b8d615544c920a6094cda2596e3 |
|
BLAKE2b-256 | d68e060097503d736b403df627577fecf24266d001948dc9ec1b0830285ec444 |
Hashes for mypy_boto3_codestar-1.14.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6bc904ae940e1eb9c0c7e590e75090cf0d44a6c68f424c3af4ff3abbd19b28c8 |
|
MD5 | 7310c667dd0a0152da025b0938682e2d |
|
BLAKE2b-256 | fa5885bc89a040dcc29c8a9773bb9d539b108fabcce9d39d31435cdf2aaac587 |