mypy-boto3-xray 1.13.26.2

Type annotations for boto3.XRay 1.13.26 service, generated by mypy-boto3-buider 2.0.4

mypy-boto3-xray

• mypy-boto3-xray
  • How to use
  • Automated type discovery

Type annotations for boto3.XRay 1.13.26 service compatible with mypy, VSCode, PyCharm and other tools.

Generated by mypy-boto3-buider 2.0.4.

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]

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")

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 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

import boto3

# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("xray")

session_client = boto3.Session().client("xray")