Utils

mypy-boto3-builder Index / Mypy Boto3 Builder / Writers / Utils

Auto-generated documentation for mypy_boto3_builder.writers.utils module.

blackify

Show source in utils.py:22

Format content with black if file_path is *.py or *.pyi.

On error writes invalid content to file_path to check for errors.

Arguments

  • content - Python code to format.
  • file_path - Target file path.

Returns

Formatted python code.

Raises

  • ValueError - If content is not a valid Python code.

Signature

def blackify(content: str, file_path: Path) -> str:
    ...

format_md

Show source in utils.py:147

Format MarkDown with mdformat.

Signature

def format_md(text: str) -> str:
    ...

insert_md_toc

Show source in utils.py:123

Insert Table of Contents before the first second-level header.

Signature

def insert_md_toc(text: str) -> str:
    ...

render_jinja2_template

Show source in utils.py:93

Render Jinja2 template to a string.

Arguments

  • template_path - Relative path to template in TEMPLATES_PATH
  • module - Module record.
  • service_name - ServiceName instance.

Returns

A rendered template.

Signature

def render_jinja2_template(
    template_path: Path,
    package: Package | None = None,
    service_name: ServiceName | None = None,
) -> str:
    ...

sort_imports

Show source in utils.py:55

Sort imports with isort.

Arguments

  • content - File content.
  • module_name - Current module name.
  • extension - py or pyi
  • third_party - List of module names to be marked as third-party.

Returns

New file content.

Signature

def sort_imports(
    content: str,
    module_name: str,
    extension: str = "py",
    third_party: Iterable[str] = (),
) -> str:
    ...