Skip to main content

Type annotations for boto3 CodeStarconnections 1.35.93 service generated with mypy-boto3-builder 8.8.0

Project description

types-boto3-codestar-connections

PyPI - types-boto3-codestar-connections PyPI - Python Version Docs PyPI - Downloads

boto3.typed

Type annotations for boto3 CodeStarconnections 1.35.93 compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated with mypy-boto3-builder 8.8.0.

More information can be found on types-boto3 page and in types-boto3-codestar-connections docs.

See how it helps you find and fix potential bugs:

types-boto3 demo

How to install

Generate locally (recommended)

You can generate type annotations for boto3 package locally with mypy_boto3_builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.35.93' mypy_boto3_builder
  2. Select boto3 AWS SDK.
  3. Add CodeStarconnections service.
  4. Use provided commands to install generated packages.

VSCode extension

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

Click Modify and select boto3 common and CodeStarconnections.

From PyPI with pip

Install types-boto3 for CodeStarconnections service.

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

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

# standalone installation
python -m pip install types-boto3-codestar-connections

How to uninstall

python -m pip uninstall -y types-boto3-codestar-connections

Usage

VSCode

python -m pip install 'types-boto3[codestar-connections]'

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

PyCharm

⚠️ Due to slow PyCharm performance on Literal overloads (issue PY-40997), it is recommended to use types-boto3-lite until the issue is resolved.

⚠️ If you experience slow performance and high CPU usage, try to disable PyCharm type checker and use mypy or pyright instead.

⚠️ To continue using PyCharm type checker, you can try to replace types-boto3 with types-boto3-lite:

pip uninstall types-boto3
pip install types-boto3-lite

Install types-boto3[codestar-connections] in your environment:

python -m pip install 'types-boto3[codestar-connections]'

Both type checking and code completion should now work.

Emacs

  • Install types-boto3 with services you use in your environment:
python -m pip install 'types-boto3[codestar-connections]'
(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 types-boto3

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

Sublime Text

  • Install types-boto3[codestar-connections] with services you use in your environment:
python -m pip install 'types-boto3[codestar-connections]'

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 types-boto3[codestar-connections] in your environment:
python -m pip install 'types-boto3[codestar-connections]'

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

pyright

  • Install pyright: npm i -g pyright
  • Install types-boto3[codestar-connections] in your environment:
python -m pip install 'types-boto3[codestar-connections]'

Optionally, you can install types-boto3 to typings directory.

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

Pylint compatibility

It is totally safe to use TYPE_CHECKING flag in order to avoid types-boto3-codestar-connections dependency in production. However, there is an issue in pylint that it complains about undefined variables. To fix it, set all types to object in non-TYPE_CHECKING mode.

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from types_boto3_ec2 import EC2Client, EC2ServiceResource
    from types_boto3_ec2.waiters import BundleTaskCompleteWaiter
    from types_boto3_ec2.paginators import DescribeVolumesPaginator
else:
    EC2Client = object
    EC2ServiceResource = object
    BundleTaskCompleteWaiter = object
    DescribeVolumesPaginator = object

...

Explicit type annotations

Client annotations

CodeStarconnectionsClient provides annotations for boto3.client("codestar-connections").

from boto3.session import Session

from types_boto3_codestar_connections import CodeStarconnectionsClient

client: CodeStarconnectionsClient = Session().client("codestar-connections")

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

Literals

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

Full list of CodeStarconnections Literals can be found in docs.

from types_boto3_codestar_connections.literals import BlockerStatusType


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

Type definitions

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

Full list of CodeStarconnections TypeDefs can be found in docs.

from types_boto3_codestar_connections.type_defs import ConnectionTypeDef


def get_value() -> ConnectionTypeDef:
    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 ruff 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

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

Thank you

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

types_boto3_codestar_connections-1.35.93.tar.gz (19.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file types_boto3_codestar_connections-1.35.93.tar.gz.

File metadata

File hashes

Hashes for types_boto3_codestar_connections-1.35.93.tar.gz
Algorithm Hash digest
SHA256 19b368e12adc743b5e4733b3d234937f34e4b5b22990e4b491d358582e5ea2ec
MD5 5a0757300bb7769aba53bb56315d832c
BLAKE2b-256 5f58ca462ce278b6799d31eb65a8d9e3ec931971c4588e8cb3284d5bcd147804

See more details on using hashes here.

File details

Details for the file types_boto3_codestar_connections-1.35.93-py3-none-any.whl.

File metadata

File hashes

Hashes for types_boto3_codestar_connections-1.35.93-py3-none-any.whl
Algorithm Hash digest
SHA256 3229cde23b4a8c3e813fd1f5d78cc12cd070d5356efbb542be312f763711747a
MD5 4331a4a45dba8069dfc96afb462ca8e6
BLAKE2b-256 519d66bb1308d51c57030bbc257751115263fd2d1c0ba19a429aa1ff451aa384

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page