Type annotations for boto3.XRay 1.13.25 service, generated by mypy-boto3-buider 2.0.2
Project description
mypy-boto3-xray
Type annotations for boto3.XRay 1.13.25 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.0.2.
More information can be found on boto3-stubs page.
How to use
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for XRay
service.
python -m pip install boto3-stubs[xray]
# update installed packages index for automated type discovery
python -m mypy_boto3
Use boto3
with mypy_boto3_xray
in your project and enjoy type checking and auto-complete.
import boto3
from mypy_boto3_xray import XRayClient
# Now mypy can check if your code is valid.
client: XRayClient = boto3.client("xray")
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: XRayClient = session.client("xray")
# Annotated paginators are included as well
import mypy_boto3_xray.paginator as xray_paginators
batch_get_traces_paginator: xray_paginators.BatchGetTracesPaginator = client.get_paginator("batch_get_traces")
get_groups_paginator: xray_paginators.GetGroupsPaginator = client.get_paginator("get_groups")
get_sampling_rules_paginator: xray_paginators.GetSamplingRulesPaginator = client.get_paginator("get_sampling_rules")
get_sampling_statistic_summaries_paginator: xray_paginators.GetSamplingStatisticSummariesPaginator = client.get_paginator("get_sampling_statistic_summaries")
get_service_graph_paginator: xray_paginators.GetServiceGraphPaginator = client.get_paginator("get_service_graph")
get_time_series_service_statistics_paginator: xray_paginators.GetTimeSeriesServiceStatisticsPaginator = client.get_paginator("get_time_series_service_statistics")
get_trace_graph_paginator: xray_paginators.GetTraceGraphPaginator = client.get_paginator("get_trace_graph")
get_trace_summaries_paginator: xray_paginators.GetTraceSummariesPaginator = client.get_paginator("get_trace_summaries")
Automated type discovery
mypy_boto3
package can generate index for mypy_boto3_xray
and other installed services.
# Run this command when you add or remove service packages
python -m mypy_boto3
Generated index provides overloads for boto3.client
and boto3.service
,
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 carefullyVSCode
does not currently support function overloads
Also, generated index allows you to import types from mypy_boto3
:
# you can replace imports
import mypy_boto3_xray as xray
from mypy_boto3_xray import XRayClient
# with these
from mypy_boto3 import xray
from mypy_boto3.xray import XRayClient
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.13.25.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff6ca01ae3842de448528adc925294e6f510e0ad21394cd28d388059325a805e |
|
MD5 | 5f4d1ef4df593b51b966174e63da2b07 |
|
BLAKE2b-256 | a7fd2fb68d29b63d11bd3a2b00745c27733c72102a03300fd1b11ee9d7d6f4e6 |
Hashes for mypy_boto3_xray-1.13.25.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c76279a86c71bef106702389b99b9d8c327d74f3469e6434ea3965c25a931d37 |
|
MD5 | 909e9e8f7fb3a33e7ab0644d31e97d8c |
|
BLAKE2b-256 | 306b6de0c725fddd831954c43e3b6a6403125feb44c5e64c9ce440264f670481 |