mypy-boto3-codestar

boto3.typed

Type annotations for boto3.CodeStar 1.35.0 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated by mypy-boto3-builder 7.26.0.

More information can be found on boto3-stubs page and in mypy-boto3-codestar docs.

See how it helps to find and fix potential bugs:

boto3-stubs demo

mypy-boto3-codestar

How to install

VSCode extension

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and CodeStar.

From PyPI with pip

Install boto3-stubs for CodeStar service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[codestar]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[codestar]'


# standalone installation
python -m pip install mypy-boto3-codestar

How to uninstall

python -m pip uninstall -y mypy-boto3-codestar

Usage

VSCode

Install Python extension
Install Pylance extension
Set Pylance as your Python Language Server
Install boto3-stubs[codestar] in your environment:

python -m pip install 'boto3-stubs[codestar]'

Both type checking and code completion should now work. No explicit type annotations required, write your boto3 code as usual.

PyCharm

Install boto3-stubs-lite[codestar] in your environment:

python -m pip install 'boto3-stubs-lite[codestar]'`

Both type checking and code completion should now work. Explicit type annotations are required.

Use boto3-stubs package instead for implicit type discovery.

Emacs

Install boto3-stubs with services you use in your environment:

python -m pip install 'boto3-stubs[codestar]'

Install use-package, lsp, company and flycheck packages
Install lsp-pyright package

(use-package lsp-pyright
  :ensure t
  :hook (python-mode . (lambda ()
                          (require 'lsp-pyright)
                          (lsp)))  ; or lsp-deferred
  :init (when (executable-find "python3")
          (setq lsp-pyright-python-executable-cmd "python3"))
  )

Make sure emacs uses the environment where you have installed boto3-stubs

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

Sublime Text

Install boto3-stubs[codestar] with services you use in your environment:

python -m pip install 'boto3-stubs[codestar]'

Install LSP-pyright package

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

Other IDEs

Not tested, but as long as your IDE supports mypy or pyright, everything should work.

mypy

Install mypy: python -m pip install mypy
Install boto3-stubs[codestar] in your environment:

python -m pip install 'boto3-stubs[codestar]'`

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

pyright

Install pyright: npm i -g pyright
Install boto3-stubs[codestar] in your environment:

python -m pip install 'boto3-stubs[codestar]'

Optionally, you can install boto3-stubs to typings folder.

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

Explicit type annotations

Client annotations

CodeStarClient provides annotations for boto3.client("codestar").

from boto3.session import Session

from mypy_boto3_codestar import CodeStarClient

client: CodeStarClient = Session().client("codestar")

# now client usage is checked by mypy and IDE should provide code completion

Paginators annotations

mypy_boto3_codestar.paginator module contains type annotations for all paginators.

from boto3.session import Session

from mypy_boto3_codestar import CodeStarClient
from mypy_boto3_codestar.paginator import (
    ListProjectsPaginator,
    ListResourcesPaginator,
    ListTeamMembersPaginator,
    ListUserProfilesPaginator,
)

client: CodeStarClient = Session().client("codestar")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
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")

Literals

mypy_boto3_codestar.literals module contains literals extracted from shapes that can be used in user code for type checking.

Full list of CodeStar Literals can be found in docs.

from mypy_boto3_codestar.literals import ListProjectsPaginatorName


def check_value(value: ListProjectsPaginatorName) -> bool: ...

Type definitions

mypy_boto3_codestar.type_defs module contains structures and shapes assembled to typed dictionaries and unions for additional type checking.

Full list of CodeStar TypeDefs can be found in docs.

from mypy_boto3_codestar.type_defs import AssociateTeamMemberRequestRequestTypeDef


def get_value() -> AssociateTeamMemberRequestRequestTypeDef:
    return {...}

How it works

Fully automated mypy-boto3-builder carefully generates type annotations for each service, patiently waiting for boto3 updates. It delivers drop-in type annotations for you and makes sure that:

All available boto3 services are covered.
Each public class and method of every boto3 service gets valid type annotations extracted from botocore schemas.
Type annotations include up-to-date documentation.
Link to documentation is provided for every method.
Code is processed by black and isort for readability.

What's new

Implemented features

Fully type annotated boto3, botocore, aiobotocore and aioboto3 libraries
mypy, pyright, VSCode, PyCharm, Sublime Text and Emacs compatibility
Client, ServiceResource, Resource, Waiter Paginator type annotations for each service
Generated TypeDefs for each service
Generated Literals for each service
Auto discovery of types for boto3.client and boto3.resource calls
Auto discovery of types for session.client and session.resource calls
Auto discovery of types for client.get_waiter and client.get_paginator calls
Auto discovery of types for ServiceResource and Resource collections
Auto discovery of types for aiobotocore.Session.create_client calls

Latest changes

Builder changelog can be found in Releases.

Versioning

mypy-boto3-codestar version is the same as related boto3 version and follows PEP 440 format.

Thank you

Allie Fitter for boto3-type-annotations, this package is based on top of his work
black developers for an awesome formatting tool
Timothy Edmund Crosley for isort and how flexible it is
mypy developers for doing all dirty work for us
pyright team for the new era of typed Python

Documentation

All services type annotations can be found in boto3 docs

Support and contributing

This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.

Release files for mypy-boto3-codestar 1.35.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mypy-boto3-codestar 1.35.0
File	Size	Uploaded
mypy_boto3_codestar-1.35.0.tar.gz	17.5 kB	Aug 16, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for mypy-boto3-codestar 1.35.0
File	Interpreter	ABI	Platform	Reset
mypy_boto3_codestar-1.35.0-py3-none-any.whl 24.0 kB Aug 16, 2024	Python 3	none	any	Details

Total release size: 41.5 kB

Release files / mypy_boto3_codestar-1.35.0.tar.gz

Download URL	mypy_boto3_codestar-1.35.0.tar.gz
Size	17.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`07d02afa187d04ecc22183244b6d486586f7b4d0a72a75763a9488a38f1a7893`
BLAKE2b-256 checksum How to use checksums	`7da4a09915570a4238ed5f63582d9381243335452e67c2783ad5fa5b3104f034`
Upload date	Aug 16, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.12.4`

Release files / mypy_boto3_codestar-1.35.0-py3-none-any.whl

Download URL	mypy_boto3_codestar-1.35.0-py3-none-any.whl
Size	24.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`4300b0289765bff89ec9f90ed7c994ab676940d8e534ff74373ed7edaa2440fb`
BLAKE2b-256 checksum How to use checksums	`e9a6f3707a1a971be3b24163d9b3cd5d3546a1744a86c0ffae646e61a18002bc`
Upload date	Aug 16, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.12.4`