ServiceName
Auto-generated documentation for mypy_boto3_builder.service_name module.
Description for boto3 service.
- mypy-boto3-builder / Modules / Mypy Boto3 Builder / ServiceName
ServiceName
class ServiceName():
def __init__(name: str, class_name: str) -> None:
Description for boto3 service.
ServiceName().boto3_doc_link
@property
def boto3_doc_link() -> str:
Link to boto3 docs.
ServiceName().boto3_name
@property
def boto3_name() -> str:
Boto3 package name.
ServiceName().extras_name
@property
def extras_name() -> str:
Extras name for subpackage installation.
ServiceName().get_boto3_doc_link
def get_boto3_doc_link(*parts: str) -> str:
Get link to boto3 docs with anchor.
Arguments
parts- Anchor parts
ServiceName.get_md_doc_link
@staticmethod
def get_md_doc_link(
file: Literal[
'client',
'service_resource',
'waiters',
'paginators',
'type_defs',
'literals',
],
*parts: str,
) -> str:
Get link to MD docs with anchor.
Arguments
file- HTML file nameparts- Anchor parts
ServiceName().import_name
@property
def import_name() -> str:
Safe mudule import name.
ServiceName().is_conda_forge_available
def is_conda_forge_available() -> bool:
Whether service is available for conda-forge.
ServiceName().is_custom_resource
def is_custom_resource(resource_name: str) -> bool:
Whether resource should use separte TypeDict namespace.
ServiceName().is_essential
def is_essential() -> bool:
Whether service is included to boto3-stubs[essential].
ServiceName().underscore_name
@property
def underscore_name() -> str:
Python-friendly service name.
ServiceNameCatalog
class ServiceNameCatalog():
Finder for boto3 services by name.
ServiceNameCatalog.add
@classmethod
def add(name: str, class_name: str) -> ServiceName:
Add new ServiceName to catalog or modify existing one.
Returns
New ServiceName or modified if it exists.