Type annotations for boto3.XRay 1.14.24 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-xray
Type annotations for boto3.XRay 1.14.24 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for XRay
service.
python -m pip install boto3-stubs[xray]
How to use
Client annotations
XRayClient
provides annotations for boto3.client("xray")
.
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.
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.
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.
# 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 expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("xray")
session_client = boto3.Session().client("xray")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy-boto3-xray-1.14.24.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2286b193c2827b6f67277b29aacfa6cf37f243ed9ca06287fbd21ffc299e0c3 |
|
MD5 | 7919745be8acfffcebbc7d8fc1cc8d89 |
|
BLAKE2b-256 | 01f09fa24017bd3428c628cd8a82c57ff68694ff1d40f72c4eb6f5ba704a0215 |
Hashes for mypy_boto3_xray-1.14.24.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 17a0f1d73b72b26182223d2b244bae2347a653584f1a6884c37006311392db3a |
|
MD5 | e05c6f24719be3907af4a9e2779169b0 |
|
BLAKE2b-256 | 29ad81140d21835059c2f6e272b692c45f67687129fa5af2248c205185d5d5b5 |