BaseGenerator

mypy-boto3-builder Index / Mypy Boto3 Builder / Generators / BaseGenerator

Auto-generated documentation for mypy_boto3_builder.generators.base_generator module.

BaseGenerator

Show source in base_generator.py:22

Base stubs/docs generator.

Arguments

  • service_names - Selected service names
  • master_service_names - Service names included in master
  • session - Botocore session
  • output_path - Path to write generated files
  • generate_setup - Whether to create package or installed module
  • skip_published - Whether to skip packages that are already published
  • disable_smart_version - Whether to create a new postrelease if version is already published
  • version - Package build version

Signature

class BaseGenerator(ABC):
    def __init__(
        self,
        service_names: Sequence[ServiceName],
        master_service_names: Sequence[ServiceName],
        session: Session,
        output_path: Path,
        generate_setup: bool,
        skip_published: bool,
        disable_smart_version: bool,
        version: str,
    ):
        ...

See also

BaseGenerator().generate_docs

Show source in base_generator.py:101

Generate service and master docs.

Signature

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

BaseGenerator().generate_product

Show source in base_generator.py:107

Run generator for a product type.

Signature

def generate_product(self, product_type: ProductType) -> None:
    ...

See also

BaseGenerator().generate_service_stubs

Show source in base_generator.py:201

Generate service stubs.

Signature

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

BaseGenerator().generate_stubs

Show source in base_generator.py:94

Generate main stubs.

Signature

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

BaseGenerator().get_library_version

Show source in base_generator.py:68

Get underlying library version.

Signature

@abstractmethod
def get_library_version(self) -> str:
    ...

BaseGenerator().get_postprocessor

Show source in base_generator.py:62

Get postprocessor for service package.

Signature

@abstractmethod
def get_postprocessor(self, service_package: ServicePackage) -> BasePostprocessor:
    ...

See also