PackageWriter#
Mypy_boto3_builder Index / Mypy Boto3 Builder / Writers / PackageWriter
Auto-generated documentation for mypy_boto3_builder.writers.package_writer module.
PackageWriter#
Show source in package_writer.py:47
Writer for package static and template files.
Arguments#
output_path
- Output pathgenerate_setup
- Whether to generate setup files
Signature#
class PackageWriter:
def __init__(self, output_path: Path, generate_setup: bool = True) -> None: ...
PackageWriter().write_docs#
Show source in package_writer.py:224
Generate docs for a package.
Signature#
See also#
PackageWriter().write_package#
Show source in package_writer.py:191
Generate files for a package.
Arguments#
package
- Package to rendertemplates_path
- Path to Jinja templates for packagestatic_files_path
- Path to static files for packageexclude_template_names
- Do not render templates with these names
Signature#
def write_package(
self,
package: Package,
templates_path: Path | None = None,
static_files_path: Path | None = None,
exclude_template_names: Sequence[str] = (),
) -> None: ...
See also#
PackageWriter().write_service_docs#
Show source in package_writer.py:338
Create service docs files.
Arguments#
package
- Service package.output_path
- Path to output folder.
Signature#
See also#
PackageWriter().write_service_package#
Show source in package_writer.py:317
Create stubs files for service.
Arguments#
package
- Service package.
Signature#
See also#
TemplateRender#
Show source in package_writer.py:27
Template render target.
Signature#
TemplateRender().output_paths#
Show source in package_writer.py:36
Get output paths as a tuple.