Type annotations for boto3.CodeStar 1.14.0 service, generated by mypy-boto3-buider 2.1.0
Project description
mypy-boto3-codestar
Type annotations for boto3.CodeStar 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.1.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
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.
from mypy_boto3_codestar import CodeStarClient
from mypy_boto3_codestar.paginator import (
ListProjectsPaginator,
ListResourcesPaginator,
ListTeamMembersPaginator,
ListUserProfilesPaginator,
)
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.
from mypy_boto3_codestar.type_defs import CodeCommitCodeDestinationTypeDef, ...
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
import boto3
# 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.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d1590dbc6b3e1739f558cbc7c30ff3fc8cf220b6075a41829d916c6adbb2251 |
|
MD5 | 6ee216ae704c120b80c4451fc7487fef |
|
BLAKE2b-256 | f02eec68a054a8e5593ddfc7c03b50842174114822d2426285246cd386945296 |
Hashes for mypy_boto3_codestar-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1311d26a2fc735533cc565590fe38d8618c0a3f1b5ae211ab0bc33097ca593ae |
|
MD5 | e2ad2e450c1e35baafd951033bbd014c |
|
BLAKE2b-256 | 44709ad9bcc5f59d0bb5a86812081675b2121710fedc0df8cd75cb1c184d3857 |