Skip to content

Base#

Mypy_boto3_builder Index / Mypy Boto3 Builder / Postprocessors / Base

Auto-generated documentation for mypy_boto3_builder.postprocessors.base module.

BasePostprocessor#

Show source in base.py:20

Base postprocessor for classes and methods.

Arguments#

  • session - Boto3 session
  • package - Service package
  • service_names - Available service names

Signature#

class BasePostprocessor(ABC):
    def __init__(
        self,
        session: Session,
        package: ServicePackage,
        service_names: Sequence[ServiceName],
    ) -> None: ...

See also#

BasePostprocessor()._replace_typed_dict_references#

Show source in base.py:245

Replace self references with Dict[str, Any] to avoid circular dependencies.

Signature#

def _replace_typed_dict_references(
    self, typed_dict: TypeTypedDict, reference: TypeTypedDict, depth: int
) -> None: ...

See also#

BasePostprocessor().extend_literals#

Show source in base.py:182

Add extra literals.

  • <Class>ServiceName
  • ServiceName
  • ResourceServiceName
  • PaginatorName
  • WaiterName
  • RegionName

Signature#

def extend_literals(self) -> None: ...

BasePostprocessor().generate_docstrings#

Show source in base.py:42

Generate all docstrings.

Signature#

def generate_docstrings(self) -> None: ...

BasePostprocessor().process_package#

Show source in base.py:53

Postprocess built package.

Signature#

@abstractmethod
def process_package(self) -> None: ...

BasePostprocessor().replace_self_ref_typed_dicts#

Show source in base.py:265

Remove self-references from TypedDicts.

Signature#

def replace_self_ref_typed_dicts(self) -> None: ...