mypy-boto3-网络防火墙

boto3.NetworkFirewall 1.24.36服务的类型注释 兼容VSCode、 PyCharm、 Emacs、 Sublime Text、 mypy、 pyright和其他工具。

由 mypy-boto3-builder 7.10.0 生成。

更多信息可以在 boto3-stubs页面和 mypy-boto3-network-firewall 文档中找到。

了解它如何帮助查找和修复潜在错误：

• mypy-boto3-网络防火墙
  • 如何安装
    • VSCode 扩展
    • 来自带有 pip 的 PyPI
  • 如何卸载
  • 用法
    • VSCode
    • PyCharm
    • Emacs
    • 崇高的文本
    • 其他 IDE
    • 我的
    • 版权
  • 显式类型注释
    • 客户端注释
    • 分页器注释
    • 字面量
    • 打字字典
  • 这个怎么运作
  • 什么是新的
    • 实现的功能
    • 最新变化
  • 版本控制
  • 谢谢
  • 文档
  • 支持和贡献

如何安装

VSCode 扩展

将 AWS Boto3 扩展添加到您的 VSCode 并运行AWS boto3: Quick Start命令。

单击Modify并选择boto3 common和NetworkFirewall。

来自带有 pip 的 PyPI

安装boto3-stubs服务NetworkFirewall。

# install with boto3 type annotations
python -m pip install 'boto3-stubs[network-firewall]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[network-firewall]'


# standalone installation
python -m pip install mypy-boto3-network-firewall

如何卸载

python -m pip uninstall -y mypy-boto3-network-firewall

用法

VSCode

• 安装 Python 扩展
• 安装 Pylance 扩展
• 设置Pylance为您的 Python 语言服务器
• boto3-stubs[network-firewall]在您的环境中安装：

python -m pip install 'boto3-stubs[network-firewall]'

类型检查和代码完成现在都应该可以工作了。不需要显式类型注释，boto3像往常一样编写代码。

PyCharm

boto3-stubs-lite[network-firewall]在您的环境中安装：

python -m pip install 'boto3-stubs-lite[network-firewall]'`

类型检查和代码完成现在都应该可以工作了。需要显式类型注释。

使用boto3-stubs包代替隐式类型发现。

Emacs

• 安装boto3-stubs您在环境中使用的服务：

python -m pip install 'boto3-stubs[network-firewall]'

• 安装use-package、 lsp、 company和 flycheck包
• 安装lsp-pyright包

(use-package lsp-pyright
  :ensure t
  :hook (python-mode . (lambda ()
                          (require 'lsp-pyright)
                          (lsp)))  ; or lsp-deferred
  :init (when (executable-find "python3")
          (setq lsp-pyright-python-executable-cmd "python3"))
  )

• 确保 emacs 使用您安装的环境boto3-stubs

类型检查现在应该可以工作了。不需要显式类型注释，boto3像往常一样编写代码。

崇高的文本

• 安装boto3-stubs[network-firewall]您在环境中使用的服务：

python -m pip install 'boto3-stubs[network-firewall]'

• 安装LSP-pyright包

类型检查现在应该可以工作了。不需要显式类型注释，boto3像往常一样编写代码。

其他 IDE

未经测试，但只要您的 IDE 支持mypyor pyright，一切都应该工作。

我的

• 安装mypy：python -m pip install mypy
• boto3-stubs[network-firewall]在您的环境中安装：

python -m pip install 'boto3-stubs[network-firewall]'`

类型检查现在应该可以工作了。不需要显式类型注释，boto3像往常一样编写代码。

版权

• 安装pyright：npm i -g pyright
• boto3-stubs[network-firewall]在您的环境中安装：

python -m pip install 'boto3-stubs[network-firewall]'

或者，您可以安装boto3-stubs到typings文件夹。

类型检查现在应该可以工作了。不需要显式类型注释，boto3像往常一样编写代码。

显式类型注释

客户端注释

NetworkFirewallClient为 boto3.client("network-firewall").

from boto3.session import Session

from mypy_boto3_network_firewall import NetworkFirewallClient

client: NetworkFirewallClient = Session().client("network-firewall")

# now client usage is checked by mypy and IDE should provide code completion

分页器注释

mypy_boto3_network_firewall.paginator模块包含所有分页器的类型注释。

from boto3.session import Session

from mypy_boto3_network_firewall import NetworkFirewallClient
from mypy_boto3_network_firewall.paginator import (
    ListFirewallPoliciesPaginator,
    ListFirewallsPaginator,
    ListRuleGroupsPaginator,
    ListTagsForResourcePaginator,
)

client: NetworkFirewallClient = Session().client("network-firewall")

# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_firewall_policies_paginator: ListFirewallPoliciesPaginator = client.get_paginator("list_firewall_policies")
list_firewalls_paginator: ListFirewallsPaginator = client.get_paginator("list_firewalls")
list_rule_groups_paginator: ListRuleGroupsPaginator = client.get_paginator("list_rule_groups")
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")

字面量

mypy_boto3_network_firewall.literals模块包含从形状中提取的文字，可在用户代码中用于类型检查。

from mypy_boto3_network_firewall.literals import (
    AttachmentStatusType,
    ConfigurationSyncStateType,
    EncryptionTypeType,
    FirewallStatusValueType,
    GeneratedRulesTypeType,
    ListFirewallPoliciesPaginatorName,
    ListFirewallsPaginatorName,
    ListRuleGroupsPaginatorName,
    ListTagsForResourcePaginatorName,
    LogDestinationTypeType,
    LogTypeType,
    OverrideActionType,
    PerObjectSyncStatusType,
    ResourceManagedStatusType,
    ResourceManagedTypeType,
    ResourceStatusType,
    RuleGroupTypeType,
    RuleOrderType,
    StatefulActionType,
    StatefulRuleDirectionType,
    StatefulRuleProtocolType,
    TCPFlagType,
    TargetTypeType,
    NetworkFirewallServiceName,
    ServiceName,
    ResourceServiceName,
    PaginatorName,
    RegionName,
)

def check_value(value: AttachmentStatusType) -> bool:
    ...

打字字典

mypy_boto3_network_firewall.type_defs模块包含组装到类型化字典的结构和形状，以进行额外的类型检查。

from mypy_boto3_network_firewall.type_defs import (
    AddressTypeDef,
    AssociateFirewallPolicyRequestRequestTypeDef,
    ResponseMetadataTypeDef,
    SubnetMappingTypeDef,
    AttachmentTypeDef,
    IPSetMetadataTypeDef,
    EncryptionConfigurationTypeDef,
    TagTypeDef,
    SourceMetadataTypeDef,
    DeleteFirewallPolicyRequestRequestTypeDef,
    DeleteFirewallRequestRequestTypeDef,
    DeleteResourcePolicyRequestRequestTypeDef,
    DeleteRuleGroupRequestRequestTypeDef,
    DescribeFirewallPolicyRequestRequestTypeDef,
    DescribeFirewallRequestRequestTypeDef,
    DescribeLoggingConfigurationRequestRequestTypeDef,
    DescribeResourcePolicyRequestRequestTypeDef,
    DescribeRuleGroupMetadataRequestRequestTypeDef,
    StatefulRuleOptionsTypeDef,
    DescribeRuleGroupRequestRequestTypeDef,
    DimensionTypeDef,
    DisassociateSubnetsRequestRequestTypeDef,
    FirewallMetadataTypeDef,
    FirewallPolicyMetadataTypeDef,
    StatefulEngineOptionsTypeDef,
    StatelessRuleGroupReferenceTypeDef,
    HeaderTypeDef,
    IPSetReferenceTypeDef,
    IPSetTypeDef,
    PaginatorConfigTypeDef,
    ListFirewallPoliciesRequestRequestTypeDef,
    ListFirewallsRequestRequestTypeDef,
    ListRuleGroupsRequestRequestTypeDef,
    RuleGroupMetadataTypeDef,
    ListTagsForResourceRequestRequestTypeDef,
    LogDestinationConfigTypeDef,
    PortRangeTypeDef,
    TCPFlagFieldTypeDef,
    PerObjectStatusTypeDef,
    PortSetTypeDef,
    PutResourcePolicyRequestRequestTypeDef,
    RuleOptionTypeDef,
    RulesSourceListTypeDef,
    StatefulRuleGroupOverrideTypeDef,
    UntagResourceRequestRequestTypeDef,
    UpdateFirewallDeleteProtectionRequestRequestTypeDef,
    UpdateFirewallDescriptionRequestRequestTypeDef,
    UpdateFirewallPolicyChangeProtectionRequestRequestTypeDef,
    UpdateSubnetChangeProtectionRequestRequestTypeDef,
    AssociateFirewallPolicyResponseTypeDef,
    DescribeResourcePolicyResponseTypeDef,
    UpdateFirewallDeleteProtectionResponseTypeDef,
    UpdateFirewallDescriptionResponseTypeDef,
    UpdateFirewallPolicyChangeProtectionResponseTypeDef,
    UpdateSubnetChangeProtectionResponseTypeDef,
    AssociateSubnetsRequestRequestTypeDef,
    AssociateSubnetsResponseTypeDef,
    DisassociateSubnetsResponseTypeDef,
    CIDRSummaryTypeDef,
    UpdateFirewallEncryptionConfigurationRequestRequestTypeDef,
    UpdateFirewallEncryptionConfigurationResponseTypeDef,
    CreateFirewallRequestRequestTypeDef,
    FirewallPolicyResponseTypeDef,
    FirewallTypeDef,
    ListTagsForResourceResponseTypeDef,
    TagResourceRequestRequestTypeDef,
    RuleGroupResponseTypeDef,
    DescribeRuleGroupMetadataResponseTypeDef,
    PublishMetricActionTypeDef,
    ListFirewallsResponseTypeDef,
    ListFirewallPoliciesResponseTypeDef,
    ReferenceSetsTypeDef,
    ListFirewallPoliciesRequestListFirewallPoliciesPaginateTypeDef,
    ListFirewallsRequestListFirewallsPaginateTypeDef,
    ListRuleGroupsRequestListRuleGroupsPaginateTypeDef,
    ListTagsForResourceRequestListTagsForResourcePaginateTypeDef,
    ListRuleGroupsResponseTypeDef,
    LoggingConfigurationTypeDef,
    MatchAttributesTypeDef,
    SyncStateTypeDef,
    RuleVariablesTypeDef,
    StatefulRuleTypeDef,
    StatefulRuleGroupReferenceTypeDef,
    CapacityUsageSummaryTypeDef,
    CreateFirewallPolicyResponseTypeDef,
    DeleteFirewallPolicyResponseTypeDef,
    UpdateFirewallPolicyResponseTypeDef,
    CreateRuleGroupResponseTypeDef,
    DeleteRuleGroupResponseTypeDef,
    UpdateRuleGroupResponseTypeDef,
    ActionDefinitionTypeDef,
    DescribeLoggingConfigurationResponseTypeDef,
    UpdateLoggingConfigurationRequestRequestTypeDef,
    UpdateLoggingConfigurationResponseTypeDef,
    RuleDefinitionTypeDef,
    FirewallStatusTypeDef,
    CustomActionTypeDef,
    StatelessRuleTypeDef,
    CreateFirewallResponseTypeDef,
    DeleteFirewallResponseTypeDef,
    DescribeFirewallResponseTypeDef,
    FirewallPolicyTypeDef,
    StatelessRulesAndCustomActionsTypeDef,
    CreateFirewallPolicyRequestRequestTypeDef,
    DescribeFirewallPolicyResponseTypeDef,
    UpdateFirewallPolicyRequestRequestTypeDef,
    RulesSourceTypeDef,
    RuleGroupTypeDef,
    CreateRuleGroupRequestRequestTypeDef,
    DescribeRuleGroupResponseTypeDef,
    UpdateRuleGroupRequestRequestTypeDef,
)

def get_structure() -> AddressTypeDef:
    return {
      ...
    }

这个怎么运作

全自动 的mypy-boto3-builder为每个服务仔细生成类型注解，耐心等待boto3 更新。它为您提供插入式注释，并确保：

• 涵盖所有可用boto3服务。
• 每个boto3服务的每个公共类和方法都会从文档中提取有效的类型注释（botocore如果类型不正确，请归咎于文档）。
• 类型注释包括最新的文档。
• 每种方法都提供了文档链接。
• 为了可读性，代码由black和 isort处理。

什么是新的

实现的功能

• 全类型注释boto3和botocore库aiobotocore
• mypy, pyright, VSCode, PyCharm,Sublime Text和Emacs 兼容性
• Client, ServiceResource, Resource,Waiter Paginator为每个服务键入注释
• TypeDefs为每个服务生成
• Literals为每个服务生成
• 自动发现类型boto3.client和boto3.session调用
• 自动发现类型session.client和session.session调用
• 自动发现类型client.get_waiter和client.get_paginator 调用
• 自动发现类型ServiceResource和Resource集合
• 自动发现aiobotocore.Session.create_client呼叫类型

最新变化

生成器更改日志可以在 Releases中找到。

版本控制

mypy-boto3-network-firewall版本与相关boto3版本相同，遵循PEP 440格式。

谢谢

• Allie Fitter for boto3-type-annotations，这个包是基于他的工作
• 一个很棒的格式化工具的黑人开发者
• 蒂莫西·埃德蒙·克罗斯利 (Timothy Edmund Crosley ) 的 isort及其灵活度
• mypy开发人员为我们做了所有肮脏的工作
• pyright团队为类型化 Python 的新时代

文档

所有服务类型注释都可以在 boto3 文档中找到

支持和贡献

这个包是自动生成的。请在mypy-boto3-builder存储库中报告任何错误或请求新功能 。