raesl.compile

ESL compiler.

Compiles ESL documents and workspaces, meaning:

• Parsing lines

• Typechecking

• Building an AST

• Instantiating components, variables and requirements.

• Deriving dependencies from these to build an output graph (network).

Subpackages

• raesl.compile.ast
  • raesl.compile.ast.comment_storage
  • raesl.compile.ast.components
  • raesl.compile.ast.exprs
  • raesl.compile.ast.nodes
  • raesl.compile.ast.relations
  • raesl.compile.ast.specification
  • raesl.compile.ast.types
  • raesl.compile.ast.verbs
• raesl.compile.instantiating
  • raesl.compile.instantiating.edge_building
  • raesl.compile.instantiating.graph_building
  • raesl.compile.instantiating.graph_data
  • raesl.compile.instantiating.node_building
• raesl.compile.machine_files
  • raesl.compile.machine_files.argument_list
  • raesl.compile.machine_files.behavior
  • raesl.compile.machine_files.builder
  • raesl.compile.machine_files.comments
  • raesl.compile.machine_files.component_definitions
  • raesl.compile.machine_files.component_instances
  • raesl.compile.machine_files.designs
  • raesl.compile.machine_files.goals
  • raesl.compile.machine_files.groups
  • raesl.compile.machine_files.machine_parts
  • raesl.compile.machine_files.needs
  • raesl.compile.machine_files.parameters
  • raesl.compile.machine_files.relation_definitions
  • raesl.compile.machine_files.relation_instances
  • raesl.compile.machine_files.sub_clause
  • raesl.compile.machine_files.transforms
  • raesl.compile.machine_files.type_defs
  • raesl.compile.machine_files.typing
  • raesl.compile.machine_files.utils
  • raesl.compile.machine_files.variables
  • raesl.compile.machine_files.verb_defs
• raesl.compile.typechecking
  • raesl.compile.typechecking.ast_builder
  • raesl.compile.typechecking.compdef_behavior_builder
  • raesl.compile.typechecking.compdef_builder
  • raesl.compile.typechecking.compdef_comment_builder
  • raesl.compile.typechecking.compdef_compinst_builder
  • raesl.compile.typechecking.compdef_design_builder
  • raesl.compile.typechecking.compdef_goal_builder
  • raesl.compile.typechecking.compdef_need_builder
  • raesl.compile.typechecking.compdef_relinst_builder
  • raesl.compile.typechecking.compdef_transform_builder
  • raesl.compile.typechecking.compdef_vargroup_builder
  • raesl.compile.typechecking.compdef_varparam_builder
  • raesl.compile.typechecking.expr_checker
  • raesl.compile.typechecking.goal_transform_base
  • raesl.compile.typechecking.orderer
  • raesl.compile.typechecking.reldef_builder
  • raesl.compile.typechecking.type_builder
  • raesl.compile.typechecking.type_checker
  • raesl.compile.typechecking.utils
  • raesl.compile.typechecking.verb_builder

Submodules

• raesl.compile.cli
• raesl.compile.diagnostics
• raesl.compile.esl_lines
• raesl.compile.parser
• raesl.compile.scanner
• raesl.compile.state_machine

Package Contents

Functions

to_graph(→ ragraph.graph.Graph)

Convert ESL file(s) into a ragraph.graph.Graph.

exception raesl.compile.EslCompilationError

Bases: Exception

Error during ESL compilation.

raesl.compile.to_graph(*paths: str | pathlib.Path, output: str | pathlib.Path | None = None, force: bool = False) → ragraph.graph.Graph

Convert ESL file(s) into a ragraph.graph.Graph.

Parameters:

• paths – Paths to resolve into ESL files. May be any number of files and directories to scan.

• output – Optional output file (JSON) to write the graph to.

• force – Whether to overwrite the output file or raise an error if it the file already exists.

Returns:

Instantiated graph.