PyPI 官网下载 | mypy-boto3-xray-1.14.24.0.tar.gz

# mypy-boto3-xray [](https://pypi.org/project/mypy-boto3-xray) [](https://pypi.org/project/mypy-boto3-xray) [](https://mypy-boto3-builder.readthedocs.io/) Type annotations for [boto3.XRay 1.14.24](https://boto3.amazonaws.com/v1/documentation/api/1.14.24/reference/services/xray.html#XRay) 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 `XRay` service. ```bash python -m pip install boto3-stubs[xray] ``` ## How to use ### Client annotations `XRayClient` provides annotations for `boto3.client("xray")`. ```python import boto3 from mypy_boto3_xray import XRayClient from mypy_boto3_xray.paginator import ( BatchGetTracesPaginator, GetGroupsPaginator, GetSamplingRulesPaginator, GetSamplingStatisticSummariesPaginator, GetServiceGraphPaginator, GetTimeSeriesServiceStatisticsPaginator, GetTraceGraphPaginator, GetTraceSummariesPaginator, ) from mypy_boto3_xray.type_defs import AliasTypeDef, ... client: XRayClient = boto3.client("xray") # 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: XRayClient = session.client("xray") ``` ### Paginators annotations `mypy_boto3_xray.paginator` module contains type annotations for all paginators. ```python client: XRayClient = boto3.client("xray") # Explicit type annotations are optional here # Type should be correctly discovered by mypy and IDEs # VSCode requires explicit type annotations batch_get_traces_paginator: BatchGetTracesPaginator = client.get_paginator("batch_get_traces") get_groups_paginator: GetGroupsPaginator = client.get_paginator("get_groups") get_sampling_rules_paginator: GetSamplingRulesPaginator = client.get_paginator("get_sampling_rules") get_sampling_statistic_summaries_paginator: GetSamplingStatisticSummariesPaginator = client.get_paginator("get_sampling_statistic_summaries") get_service_graph_paginator: GetServiceGraphPaginator = client.get_paginator("get_service_graph") get_time_series_service_statistics_paginator: GetTimeSeriesServiceStatisticsPaginator = client.get_paginator("get_time_series_service_statistics") get_trace_graph_paginator: GetTraceGraphPaginator = client.get_paginator("get_trace_graph") get_trace_summaries_paginator: GetTraceSummariesPaginator = client.get_paginator("get_trace_summaries") ``` ### Typed dictionations `mypy_boto3_xray.type_defs` module contains structures and shapes assembled to typed dictionaries for additional type checking. ```python def get_structure() -> AliasTypeDef: return { ... } ``` ## Dynamic type annotations `mypy_boto3` command generates `boto3.client/resource` type annotations for `mypy_boto3_xray` 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("xray") session_client = boto3.Session().client("xray") ```