Hygiene

Data cleaning and validation: docstring generation, code quality.

Hygiene utilities for maintaining siege_utilities package.

This module provides tools for package maintenance including: - Documentation generation and management

For release management, use scripts/release_manager.py directly.

siege_utilities.hygiene.generate_docstrings()

Process all Python files in siege_utilities to add missing docstrings.

Raises:

• ImportError – If astor is not installed.

• FileNotFoundError – If no Python files are found in the working directory.

Submodules

Auto-generate docstrings for functions missing them in siege_utilities. Part of the hygiene maintenance toolkit.

siege_utilities.hygiene.generate_docstrings.analyze_function_signature(func)

Analyze a function to generate parameter and return type info.

siege_utilities.hygiene.generate_docstrings.categorize_function(func_name)

Categorize function based on name patterns.

siege_utilities.hygiene.generate_docstrings.generate_docstring_template(func_name, func_obj=None)

Generate a comprehensive docstring template.

class siege_utilities.hygiene.generate_docstrings.DocstringAdder

Bases: NodeTransformer

AST transformer to add docstrings to functions.

__init__(module_name='unknown')

visit_FunctionDef(node)

Visit Functiondef.

General utility functions. Auto-discovered function available at package level.

Returns:

Description needed

Return type:

Any

Example

>>> import siege_utilities
>>> result = siege_utilities.visit_FunctionDef()
>>> pass  # Process result as needed

Note

This function is auto-discovered and available without imports across all siege_utilities modules.

siege_utilities.hygiene.generate_docstrings.process_python_file(file_path)

Process a single Python file to add missing docstrings.

Raises:

• SyntaxError – If the file has invalid Python syntax.

• ImportError – If astor is not installed.

• OSError – If the file cannot be read or written.

siege_utilities.hygiene.generate_docstrings.find_python_files(base_path)

Find Python files to process (excludes __init__.py and build artifacts).

siege_utilities.hygiene.generate_docstrings.main()

Process all Python files in siege_utilities to add missing docstrings.

Raises:

• ImportError – If astor is not installed.

• FileNotFoundError – If no Python files are found in the working directory.

siege_utilities.hygiene.generate_docstrings.cli()

Command line interface.