# mypy-boto3-servicecatalog
[![PyPI - mypy-boto3-servicecatalog](https://img.shields.io/pypi/v/mypy-boto3-servicecatalog.svg?color=blue)](https://pypi.org/project/mypy-boto3-servicecatalog)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-servicecatalog.svg?color=blue)](https://pypi.org/project/mypy-boto3-servicecatalog)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
Type annotations for
[boto3.ServiceCatalog 1.14.48](https://boto3.amazonaws.com/v1/documentation/api/1.14.48/reference/services/servicecatalog.html#ServiceCatalog) service
compatible with [mypy](https://github.com/python/mypy), [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/) and other tools.
Generated by [mypy-boto3-buider 2.2.0](https://github.com/vemel/mypy_boto3_builder).
More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page.
## How to install
Make sure you have [mypy](https://github.com/python/mypy) installed and activated in your IDE.
Install `boto3-stubs` for `ServiceCatalog` service.
```bash
python -m pip install boto3-stubs[servicecatalog]
```
## How to use
### Client annotations
`ServiceCatalogClient` provides annotations for `boto3.client("servicecatalog")`.
```python
import boto3
from mypy_boto3_servicecatalog import ServiceCatalogClient
from mypy_boto3_servicecatalog.paginator import (
ListAcceptedPortfolioSharesPaginator,
ListConstraintsForPortfolioPaginator,
ListLaunchPathsPaginator,
ListOrganizationPortfolioAccessPaginator,
ListPortfoliosForProductPaginator,
ListPortfoliosPaginator,
ListPrincipalsForPortfolioPaginator,
ListProvisionedProductPlansPaginator,
ListProvisioningArtifactsForServiceActionPaginator,
ListRecordHistoryPaginator,
ListResourcesForTagOptionPaginator,
ListServiceActionsForProvisioningArtifactPaginator,
ListServiceActionsPaginator,
ListTagOptionsPaginator,
ScanProvisionedProductsPaginator,
SearchProductsAsAdminPaginator,
)
from mypy_boto3_servicecatalog.type_defs import BudgetDetailTypeDef, ...
client: ServiceCatalogClient = boto3.client("servicecatalog")
# 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: ServiceCatalogClient = session.client("servicecatalog")
```
### Paginators annotations
`mypy_boto3_servicecatalog.paginator` module contains type annotations for all paginators.
```python
client: ServiceCatalogClient = boto3.client("servicecatalog")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_accepted_portfolio_shares_paginator: ListAcceptedPortfolioSharesPaginator = client.get_paginator("list_accepted_portfolio_shares")
list_constraints_for_portfolio_paginator: ListConstraintsForPortfolioPaginator = client.get_paginator("list_constraints_for_portfolio")
list_launch_paths_paginator: ListLaunchPathsPaginator = client.get_paginator("list_launch_paths")
list_organization_portfolio_access_paginator: ListOrganizationPortfolioAccessPaginator = client.get_paginator("list_organization_portfolio_access")
list_portfolios_paginator: ListPortfoliosPaginator = client.get_paginator("list_portfolios")
list_portfolios_for_product_paginator: ListPortfoliosForProductPaginator = client.get_paginator("list_portfolios_for_product")
list_principals_for_portfolio_paginator: ListPrincipalsForPortfolioPaginator = client.get_paginator("list_principals_for_portfolio")
list_provisioned_product_plans_paginator: ListProvisionedProductPlansPaginator = client.get_paginator("list_provisioned_product_plans")
list_provisioning_artifacts_for_service_action_paginator: ListProvisioningArtifactsForServiceActionPaginator = client.get_paginator("list_provisioning_artifacts_for_service_action")
list_record_history_paginator: ListRecordHistoryPaginator = client.get_paginator("list_record_history")
list_resources_for_tag_option_paginator: ListResourcesForTagOptionPaginator = client.get_paginator("list_resources_for_tag_option")
list_service_actions_paginator: ListServiceActionsPaginator = client.get_paginator("list_service_actions")
list_service_actions_for_provisioning_artifact_paginator: ListServiceActionsForProvisioningArtifactPaginator = client.get_paginator("list_service_actions_for_provisioning_artifact")
list_tag_options_paginator: ListTagOptionsPaginator = client.get_paginator("list_tag_options")
scan_provisioned_products_paginator: ScanProvisionedProductsPaginator = client.get_paginator("scan_provisioned_products")
search_products_as_admin_paginator: SearchProductsAsAdminPaginator = client.get_paginator("search_products_as_admin")
```
### Typed dictionations
`mypy_boto3_servicecatalog.type_defs` module contains structures and shapes assembled
to typed dictionaries for additional type checking.
```python
def get_structure() -> BudgetDetailTypeDef:
return {
...
}
```
## Dynamic type annotations
`mypy_boto3` command generates `boto3.client/resource` type annotations for
`mypy_boto3_servicecatalog` and other installed services.
```bash
# 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 expected
- `PyCharm` also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installed
- `VSCode` does not currently support function overloads, use explicit type annotations
```python
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("servicecatalog")
session_client = boto3.Session().client("servicecatalog")
```
没有合适的资源?快使用搜索试试~ 我知道了~
资源推荐
资源详情
资源评论
收起资源包目录
mypy-boto3-servicecatalog-1.14.48.0.tar.gz (17个子文件)
mypy-boto3-servicecatalog-1.14.48.0
setup.py 2KB
mypy_boto3_servicecatalog.egg-info
top_level.txt 26B
SOURCES.txt 572B
PKG-INFO 8KB
not-zip-safe 1B
dependency_links.txt 1B
requires.txt 45B
mypy_boto3_servicecatalog
__init__.py 5KB
type_defs.py 32KB
paginator.py 17KB
client.py 49KB
py.typed 0B
__main__.py 0B
version.py 57B
setup.cfg 38B
README.md 6KB
PKG-INFO 8KB
共 17 条
- 1
资源评论
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功