Compilers Module

Compilers package for ModuFlow.

This package provides functionality for compiling sections and projects.

Project Compiler

Project compilation for ModuFlow.

This module provides functionality for compiling entire projects.

class moduflow.compilers.project.ProjectCompiler(project_root: str | None = None)[source]

Bases: object

Compiler for entire projects.

compile_project() Path[source]

Compile the entire project.

Returns:

Path to the compiled project.

save_yaml(data: Dict[str, Any], file_path: Path) None[source]

Save data to a YAML file.

Parameters:
  • data – Dictionary to save.

  • file_path – Path to the YAML file.

Section Compiler

Section compilation for ModuFlow.

This module provides functionality for compiling sections.

class moduflow.compilers.section.SectionCompiler(project_root: str | None = None)[source]

Bases: object

Compiler for sections.

compile_all_sections() Dict[str, Path][source]

Compile all sections.

Returns:

Dictionary mapping section names to their compiled directories.

compile_section(name: str) Path[source]

Compile a section.

Parameters:

name – Name of the section.

Returns:

Path to the compiled section.

Raises:

FileNotFoundError – If the section doesn’t exist.

save_yaml(data: Dict[str, Any], file_path: Path) None[source]

Save data to a YAML file.

Parameters:
  • data – Dictionary to save.

  • file_path – Path to the YAML file.