# mypy-boto3-codestar<a id="mypy-boto3-codestar"></a>
[![PyPI - mypy-boto3-codestar](https://img.shields.io/pypi/v/mypy-boto3-codestar.svg?color=blue)](https://pypi.org/project/mypy-boto3-codestar)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-codestar.svg?color=blue)](https://pypi.org/project/mypy-boto3-codestar)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
[![PyPI - Downloads](https://img.shields.io/pypi/dw/mypy-boto3-codestar?color=blue)](https://pypistats.org/packages/mypy-boto3-codestar)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.CodeStar 1.17.72](https://boto3.amazonaws.com/v1/documentation/api/1.17.72/reference/services/codestar.html#CodeStar)
service compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.
Generated by
[mypy-boto3-buider 4.13.0](https://github.com/vemel/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-codestar docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_codestar/)
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/vemel/mypy_boto3_builder/raw/master/demo.gif)
- [mypy-boto3-codestar](#mypy-boto3-codestar)
- [How to install](#how-to-install)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
- [Versioning](#versioning)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
## How to install<a id="how-to-install"></a>
Install `boto3-stubs` for `CodeStar` service.
```bash
python -m pip install boto3-stubs[codestar]
```
## Usage<a id="usage"></a>
### VSCode<a id="vscode"></a>
- Install
[Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
[Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto-stubs[codestar]` in your environment:
`python -m pip install 'boto3-stubs[codestar]'`
Both type checking and auto-complete should work for `CodeStar` service. No
explicit type annotations required, write your `boto3` code as usual.
### PyCharm<a id="pycharm"></a>
- Install `boto-stubs[codestar]` in your environment:
`python -m pip install 'boto3-stubs[codestar]'`
Both type checking and auto-complete should work for `CodeStar` service. No
explicit type annotations required, write your `boto3` code as usual.
Auto-complete can be slow on big projects or if you have a lot of installed
`boto3-stubs` submodules.
### Other IDEs<a id="other-ides"></a>
Not tested, but as long as your IDE support `mypy` or `pyright`, everything
should work.
### mypy<a id="mypy"></a>
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[codestar]` in your environment:
`python -m pip install 'boto3-stubs[codestar]'`
- Run `mypy` as usual
Type checking should work for `CodeStar` service. No explicit type annotations
required, write your `boto3` code as usual.
### pyright<a id="pyright"></a>
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[codestar]` in your environment:
`python -m pip install 'boto3-stubs[codestar]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `CodeStar` service. No explicit type annotations
required, write your `boto3` code as usual.
## Explicit type annotations<a id="explicit-type-annotations"></a>
### Client annotations<a id="client-annotations"></a>
`CodeStarClient` provides annotations for `boto3.client("codestar")`.
```python
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<a id="paginators-annotations"></a>
`mypy_boto3_codestar.paginator` module contains type annotations for all
paginators.
```python
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")
```
### Literals<a id="literals"></a>
`mypy_boto3_codestar.literals` module contains literals extracted from shapes
that can be used in user code for type checking.
```python
from mypy_boto3_codestar.literals import (
ListProjectsPaginatorName,
ListResourcesPaginatorName,
ListTeamMembersPaginatorName,
ListUserProfilesPaginatorName,
)
def check_value(value: ListProjectsPaginatorName) -> bool:
...
```
### Typed dictionaries<a id="typed-dictionaries"></a>
`mypy_boto3_codestar.type_defs` module contains structures and shapes assembled
to typed dictionaries for additional type checking.
```python
from mypy_boto3_codestar.type_defs import (
AssociateTeamMemberResultTypeDef,
CodeCommitCodeDestinationTypeDef,
CodeDestinationTypeDef,
CodeSourceTypeDef,
CodeTypeDef,
CreateProjectResultTypeDef,
CreateUserProfileResultTypeDef,
DeleteProjectResultTypeDef,
DeleteUserProfileResultTypeDef,
DescribeProjectResultTypeDef,
DescribeUserProfileResultTypeDef,
GitHubCodeDestinationTypeDef,
ListProjectsResultTypeDef,
ListResourcesResultTypeDef,
ListTagsForProjectResultTypeDef,
ListTeamMembersResultTypeDef,
ListUserProfilesResultTypeDef,
PaginatorConfigTypeDef,
ProjectStatusTypeDef,
ProjectSummaryTypeDef,
ResourceTypeDef,
S3LocationTypeDef,
TagProjectResultTypeDef,
TeamMemberTypeDef,
ToolchainSourceTypeDef,
ToolchainTypeDef,
UpdateTeamMemberResultTypeDef,
UpdateUserProfileResultTypeDef,
UserProfileSummaryTypeDef,
)
def get_structure() -> AssociateTeamMemberResultTypeDef:
return {
...
}
```
## Versioning<a id="versioning"></a>
`mypy-boto3-codestar` version is the same as related `boto3` version and
follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
## Documentation<a id="documentation"></a>
All type annotations can be found in
[mypy-boto3-codestar docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_codestar/)
## Support and contributing<a id="support-and-contributing"></a>
This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/vemel/mypy_boto3_builder/issues/)
repository.
没有合适的资源?快使用搜索试试~ 我知道了~
温馨提示
共23个文件
py:8个
pyi:5个
txt:4个
资源分类:Python库 所属语言:Python 资源全名:mypy-boto3-codestar-1.17.72.tar.gz 资源来源:官方 安装方法:https://lanzao.blog.csdn.net/article/details/101784059
资源推荐
资源详情
资源评论
收起资源包目录
mypy-boto3-codestar-1.17.72.tar.gz (23个子文件)
mypy-boto3-codestar-1.17.72
PKG-INFO 11KB
mypy_boto3_codestar.egg-info
PKG-INFO 11KB
requires.txt 45B
not-zip-safe 1B
SOURCES.txt 691B
top_level.txt 20B
dependency_links.txt 1B
setup.cfg 38B
setup.py 2KB
mypy_boto3_codestar
type_defs.py 9KB
py.typed 0B
type_defs.pyi 9KB
literals.py 772B
client.py 12KB
__main__.py 729B
__init__.py 1KB
client.pyi 12KB
paginator.pyi 4KB
paginator.py 4KB
version.py 55B
literals.pyi 770B
__init__.pyi 1KB
README.md 8KB
共 23 条
- 1
资源评论
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功