BaseGenerator
Auto-generated documentation for mypy_boto3_builder.generators.base_generator module.
Base stubs/docs generator.
- mypy-boto3-builder / Modules / Mypy Boto3 Builder / Generators / BaseGenerator
BaseGenerator
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 namesmaster_service_names
- Service names included in mastersession
- Botocore sessionoutput_path
- Path to write generated filesgenerate_setup
- Whether to create package or installed moduleskip_published
- Whether to skip packages that are already publisheddisable_smart_version
- Whether to create a new postrelease if version is already publishedversion
- Package build version
See also
BaseGenerator().generate_docs
@abstractmethod
def generate_docs() -> None:
Generate service and master docs.
BaseGenerator().generate_product
def generate_product(product_type: ProductType) -> None:
Run generator for a product type.
See also
BaseGenerator().generate_service_stubs
def generate_service_stubs() -> None:
Generate service stubs.
BaseGenerator().generate_stubs
@abstractmethod
def generate_stubs() -> None:
Generate main stubs.
BaseGenerator().get_library_version
@abstractmethod
def get_library_version() -> str:
Get underlying library version.
BaseGenerator().get_postprocessor
@abstractmethod
def get_postprocessor(service_package: ServicePackage) -> BasePostprocessor:
Get postprocessor for service package.