Type annotations for boto3.Inspector 1.14.5 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-inspector
Type annotations for boto3.Inspector 1.14.5 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 Inspector
service.
python -m pip install boto3-stubs[inspector]
How to use
Client annotations
InspectorClient
provides annotations for boto3.client("inspector")
.
import boto3
from mypy_boto3_inspector import InspectorClient
from mypy_boto3_inspector.paginator import (
ListAssessmentRunAgentsPaginator,
ListAssessmentRunsPaginator,
ListAssessmentTargetsPaginator,
ListAssessmentTemplatesPaginator,
ListEventSubscriptionsPaginator,
ListExclusionsPaginator,
ListFindingsPaginator,
ListRulesPackagesPaginator,
PreviewAgentsPaginator,
)
from mypy_boto3_inspector.type_defs import AgentPreviewTypeDef, ...
client: InspectorClient = boto3.client("inspector")
# 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: InspectorClient = session.client("inspector")
Paginators annotations
mypy_boto3_inspector.paginator
module contains type annotations for all paginators.
client: InspectorClient = boto3.client("inspector")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_assessment_run_agents_paginator: ListAssessmentRunAgentsPaginator = client.get_paginator("list_assessment_run_agents")
list_assessment_runs_paginator: ListAssessmentRunsPaginator = client.get_paginator("list_assessment_runs")
list_assessment_targets_paginator: ListAssessmentTargetsPaginator = client.get_paginator("list_assessment_targets")
list_assessment_templates_paginator: ListAssessmentTemplatesPaginator = client.get_paginator("list_assessment_templates")
list_event_subscriptions_paginator: ListEventSubscriptionsPaginator = client.get_paginator("list_event_subscriptions")
list_exclusions_paginator: ListExclusionsPaginator = client.get_paginator("list_exclusions")
list_findings_paginator: ListFindingsPaginator = client.get_paginator("list_findings")
list_rules_packages_paginator: ListRulesPackagesPaginator = client.get_paginator("list_rules_packages")
preview_agents_paginator: PreviewAgentsPaginator = client.get_paginator("preview_agents")
Typed dictionations
mypy_boto3_inspector.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AgentPreviewTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_inspector
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("inspector")
session_client = boto3.Session().client("inspector")
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-inspector-1.14.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 52fba81609314a32d6e0b4834db0bf973b38529d24fac4dc378d7e54296c7be5 |
|
MD5 | 978bb2ee7fd5acc716ad4a96514073d4 |
|
BLAKE2b-256 | 7bfefb37d9876c9a6bbf92c416c8ae2a25e97b3639c3dfa558cc21241ec94b54 |
Hashes for mypy_boto3_inspector-1.14.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b1fe33e4e69089bb010c53070affcb5262664ee5a745b5671e78066a317a2896 |
|
MD5 | 76df634438c7ad8881c5e4abc86722a7 |
|
BLAKE2b-256 | e2476294f71ac8b30232a71d390d5d3e3ae802cae46aed62a68cb2b984de6685 |