def process_master(
session: Session,
output_path: Path,
service_names: Iterable[ServiceName],
generate_setup: bool,
version: str,
) -> MasterPackage:
"""
Parse and write master package `mypy_boto3`.
Arguments:
session -- boto3 session
output_path -- Package output path
service_names -- List of known service names
generate_setup -- Generate ready-to-install or to-use package
version -- Package version
Return:
Parsed MasterPackage.
"""
logger = get_logger()
logger.debug("Parsing master")
master_package = parse_master_package(session, service_names)
master_package.version = version
logger.debug(f"Writing master to {NicePath(output_path)}")
package_writer = PackageWriter(output_path=output_path,
generate_setup=generate_setup)
package_writer.write_package(
master_package,
templates_path=TEMPLATES_PATH / "master",
)
return master_package
def process_boto3_stubs_docs(
session: Session,
output_path: Path,
service_names: Iterable[ServiceName],
) -> Boto3StubsPackage:
"""
Parse and write master package docs.
Arguments:
session -- boto3 session
output_path -- Package output path
service_names -- List of known service names
Return:
Parsed Boto3StubsPackage.
"""
logger = get_logger()
package_data = Boto3StubsPackageData
logger.debug(f"Parsing {package_data.PYPI_NAME}")
boto3_stubs_package = parse_boto3_stubs_package(session, service_names,
package_data)
logger.debug(
f"Writing {package_data.PYPI_NAME} to {NicePath(output_path)}")
package_writer = PackageWriter(output_path=output_path)
package_writer.write_docs(
boto3_stubs_package,
templates_path=TEMPLATES_PATH / "boto3_stubs_docs",
)
return boto3_stubs_package
def process_botocore_stubs(
output_path: Path,
generate_setup: bool,
version: str,
) -> None:
"""
Parse and write stubs package `botocore_stubs`.
Arguments:
output_path -- Package output path
generate_setup -- Generate ready-to-install or to-use package
version -- Package version
"""
logger = get_logger()
logger.debug(f"Writing botocore stubs to {NicePath(output_path)}")
botocore_stubs_package = BotocoreStubsPackage()
botocore_stubs_package.version = version
package_writer = PackageWriter(output_path=output_path,
generate_setup=generate_setup)
package_writer.write_package(
botocore_stubs_package,
templates_path=TEMPLATES_PATH / "botocore-stubs",
static_files_path=BOTOCORE_STUBS_STATIC_PATH,
)
def process_aiobotocore_stubs_docs(
session: Session,
output_path: Path,
service_names: Iterable[ServiceName],
) -> AioBotocoreStubsPackage:
"""
Parse and write master package docs.
Arguments:
session -- boto3 session
output_path -- Package output path
service_names -- List of known service names
Return:
Parsed AioBotocoreStubsPackage.
"""
logger = get_logger()
aiobotocore_stubs_package = parse_aiobotocore_stubs_package(
session, service_names, TypesAioBotocorePackageData)
logger.debug(
f"Writing {aiobotocore_stubs_package.pypi_name} to {NicePath(output_path)}"
)
package_writer = PackageWriter(output_path=output_path)
package_writer.write_docs(
aiobotocore_stubs_package,
templates_path=TEMPLATES_PATH / "aiobotocore_stubs_docs",
)
return aiobotocore_stubs_package
def process_aiobotocore_service(
session: Session,
service_name: ServiceName,
output_path: Path,
generate_setup: bool,
service_names: Iterable[ServiceName],
version: str,
) -> ServicePackage:
"""
Parse and write service package `types_aiobotocore_*`.
Arguments:
session -- boto3 session
service_name -- Target service name
output_path -- Package output path
generate_setup -- Generate ready-to-install or to-use package
service_names -- List of known service names
version -- Package version
Return:
Parsed ServicePackage.
"""
logger = get_logger()
logger.debug(f"Parsing {service_name.boto3_name}")
service_package = parse_service_package(session, service_name,
TypesAioBotocorePackageData)
service_package.version = version
service_package.extend_literals(service_names)
postprocessor = ServicePackagePostprocessor(service_package)
postprocessor.generate_docstrings()
postprocessor.make_async()
postprocessor.add_contextmanager_methods()
for typed_dict in service_package.typed_dicts:
typed_dict.replace_self_references()
logger.debug(
f"Writing {service_name.boto3_name} to {NicePath(output_path)}")
package_writer = PackageWriter(output_path=output_path,
generate_setup=generate_setup)
package_writer.write_service_package(
service_package,
templates_path=TEMPLATES_PATH / "aiobotocore_service",
)
return service_package
def process_boto3_stubs_lite(
session: Session,
output_path: Path,
service_names: Iterable[ServiceName],
generate_setup: bool,
version: str,
) -> Boto3StubsPackage:
"""
Parse and write stubs package `boto3-stubs-lite`.
Arguments:
session -- boto3 session
output_path -- Package output path
service_names -- List of known service names
generate_setup -- Generate ready-to-install or to-use package
version -- Package version
Return:
Parsed Boto3StubsPackage.
"""
logger = get_logger()
package_data = Boto3StubsLitePackageData
logger.debug(f"Parsing {package_data.PYPI_NAME}")
boto3_stubs_package = parse_boto3_stubs_package(
session=session,
service_names=service_names,
package_data=package_data,
)
boto3_stubs_package.version = version
logger.debug(
f"Writing {package_data.PYPI_NAME} to {NicePath(output_path)}")
package_writer = PackageWriter(output_path=output_path,
generate_setup=generate_setup)
package_writer.write_package(
boto3_stubs_package,
templates_path=TEMPLATES_PATH / "boto3-stubs",
static_files_path=BOTO3_STUBS_STATIC_PATH,
exclude_template_names=[
"session.pyi.jinja2",
"__init__.pyi.jinja2",
],
)
return boto3_stubs_package
def process_service_docs(
session: Session,
service_name: ServiceName,
output_path: Path,
service_names: Iterable[ServiceName],
) -> ServicePackage:
"""
Parse and write service package docs.
Arguments:
session -- boto3 session
service_name -- Target service name
output_path -- Package output path
service_names -- List of known service names
Return:
Parsed ServicePackage.
"""
logger = get_logger()
logger.debug(f"Parsing {service_name.boto3_name}")
service_package = parse_service_package(session, service_name,
Boto3StubsPackageData)
service_package.extend_literals(service_names)
postprocessor = ServicePackagePostprocessor(service_package)
postprocessor.generate_docstrings()
for typed_dict in service_package.typed_dicts:
typed_dict.replace_self_references()
logger.debug(
f"Writing {service_name.boto3_name} to {NicePath(output_path)}")
package_writer = PackageWriter(output_path=output_path)
package_writer.write_service_docs(
service_package,
templates_path=TEMPLATES_PATH / "boto3_service_docs",
)
return service_package
def process_aiobotocore_stubs_lite(
session: Session,
output_path: Path,
service_names: Iterable[ServiceName],
generate_setup: bool,
version: str,
) -> AioBotocoreStubsPackage:
"""
Parse and write stubs package `aiobotocore-stubs-lite`.
Arguments:
session -- boto3 session
output_path -- Package output path
service_names -- List of known service names
generate_setup -- Generate ready-to-install or to-use package
version -- Package version
Return:
Parsed AioBotocoreStubsPackage.
"""
logger = get_logger()
aiobotocore_stubs_package = parse_aiobotocore_stubs_package(
session, service_names, TypesAioBotocoreLitePackageData)
aiobotocore_stubs_package.version = version
logger.debug(
f"Writing {aiobotocore_stubs_package.pypi_name} to {NicePath(output_path)}"
)
package_writer = PackageWriter(output_path=output_path,
generate_setup=generate_setup)
package_writer.write_package(
aiobotocore_stubs_package,
templates_path=TEMPLATES_PATH / "aiobotocore-stubs",
static_files_path=AIOBOTOCORE_STUBS_STATIC_PATH,
exclude_template_names=["session.pyi.jinja2"],
)
return aiobotocore_stubs_package