BaseGenerator

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

Base stubs/docs generator.

BaseGenerator

[find in source code]

class BaseGenerator(ABC):
    def __init__(
        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,
    ):

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

See also

BaseGenerator().generate_docs

[find in source code]

@abstractmethod
def generate_docs() -> None:

Generate service and master docs.

BaseGenerator().generate_product

[find in source code]

def generate_product(product_type: ProductType) -> None:

Run generator for a product type.

See also

BaseGenerator().generate_service_stubs

[find in source code]

def generate_service_stubs() -> None:

Generate service stubs.

BaseGenerator().generate_stubs

[find in source code]

@abstractmethod
def generate_stubs() -> None:

Generate main stubs.

BaseGenerator().get_library_version

[find in source code]

@abstractmethod
def get_library_version() -> str:

Get underlying library version.

BaseGenerator().get_postprocessor

[find in source code]

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

Get postprocessor for service package.

See also