ServiceName

mypy-boto3-builder Index / Mypy Boto3 Builder / ServiceName

Auto-generated documentation for mypy_boto3_builder.service_name module.

ServiceName

Show source in service_name.py:14

Description for boto3 service.

Signature

class ServiceName:
    def __init__(self, name: str, class_name: str) -> None:
        ...

Show source in service_name.py:97

Link to boto3 docs.

Signature

@property
def boto3_doc_link(self) -> str:
    ...

ServiceName().boto3_name

Show source in service_name.py:60

Boto3 package name.

Signature

@property
def boto3_name(self) -> str:
    ...

ServiceName().extras_name

Show source in service_name.py:78

Extras name for subpackage installation.

Signature

@property
def extras_name(self) -> str:
    ...

Show source in service_name.py:107

Get link to boto3 docs with anchor.

Arguments

  • parts - Anchor parts

Signature

def get_boto3_doc_link(self, *parts: str) -> str:
    ...

Show source in service_name.py:116

Get link to MD docs with anchor.

Arguments

  • file - HTML file name
  • parts - Anchor parts

Signature

@staticmethod
def get_md_doc_link(
    file: Literal[
        "client", "service_resource", "waiters", "paginators", "type_defs", "literals"
    ],
    *parts: str
) -> str:
    ...

ServiceName().import_name

Show source in service_name.py:67

Safe mudule import name.

Signature

@property
def import_name(self) -> str:
    ...

ServiceName().is_conda_forge_available

Show source in service_name.py:91

Whether service is available for conda-forge.

Signature

def is_conda_forge_available(self) -> bool:
    ...

ServiceName().is_custom_resource

Show source in service_name.py:141

Whether resource should use separte TypeDict namespace.

Signature

def is_custom_resource(self, resource_name: str) -> bool:
    ...

ServiceName().is_essential

Show source in service_name.py:85

Whether service is included to boto3-stubs[essential].

Signature

def is_essential(self) -> bool:
    ...

ServiceName().underscore_name

Show source in service_name.py:53

Python-friendly service name.

Signature

@property
def underscore_name(self) -> str:
    ...

ServiceNameCatalog

Show source in service_name.py:150

Finder for boto3 services by name.

Signature

class ServiceNameCatalog:
    ...

ServiceNameCatalog.add

Show source in service_name.py:186

Add new ServiceName to catalog or modify existing one.

Returns

New ServiceName or modified if it exists.

Signature

@classmethod
def add(cls, name: str, class_name: str) -> ServiceName:
    ...

See also