raesl.excel.text

Raw text export of ESL requirement nodes.

Module Contents

Functions

requirement_text(→ str)	Re-format the requirement as text.
goal_text(→ str)	Re-format goal requirement as text.
transformation_text(→ str)	Re-format transformation requirement as text.
designrule_text(→ str)	Re-format design rule as text.
designclause_text(→ str)	Re-format design clause as text.
design_text(→ str)	Re-format design requirement as text.
subclauses_text(→ str)	Re-format subclauses as text.
case_text(→ str)	Re-format behavior requirement case as text.
behavior_text(→ str)	Re-format behavior requirement as text.
need_text(→ str)	Re-format need as text.
get_common_parts(→ List[str])	Find out the largest shared substrings separated on dots '.'.
strip_prefix(→ str)	Strip a prefix from a string if it starts with it.
abbreviate_comparison(→ str)	Use symbols instead of full text for comparison text.

raesl.excel.text.requirement_text(requirement: ragraph.node.Node, graph: ragraph.graph.Graph, skip: str | None = 'world') → str

Re-format the requirement as text.

raesl.excel.text.goal_text(requirement: ragraph.node.Node, graph: ragraph.graph.Graph, skip: str | None = 'world') → str

Re-format goal requirement as text.

raesl.excel.text.transformation_text(requirement: ragraph.node.Node, graph: ragraph.graph.Graph, skip: str | None = 'world') → str

Re-format transformation requirement as text.

raesl.excel.text.designrule_text(body: Dict[str, Any], graph: ragraph.graph.Graph, skip: str | None = 'world') → str

Re-format design rule as text.

raesl.excel.text.designclause_text(bodies: List[Dict[str, Any]], graph: ragraph.graph.Graph, label: str | None = None, skip: str | None = 'world') → str

Re-format design clause as text.

raesl.excel.text.design_text(requirement: ragraph.node.Node, graph: ragraph.graph.Graph, skip: str | None = 'world') → str

Re-format design requirement as text.

raesl.excel.text.subclauses_text(requirement: ragraph.node.Node, graph: ragraph.graph.Graph, skip: str | None = 'world', spaces: int = 2) → str

Re-format subclauses as text.

raesl.excel.text.case_text(case: Dict[str, Any], graph: ragraph.graph.Graph, skip: str = 'world') → str

Re-format behavior requirement case as text.

raesl.excel.text.behavior_text(requirement: ragraph.node.Node, graph: ragraph.graph.Graph, skip: str | None = 'world') → str

Re-format behavior requirement as text.

raesl.excel.text.need_text(requirement: ragraph.node.Node, graph: ragraph.graph.Graph, skip: str | None = 'world') → str

Re-format need as text.

raesl.excel.text.get_common_parts(strings: Iterable[str]) → List[str]

Find out the largest shared substrings separated on dots ‘.’.

raesl.excel.text.strip_prefix(input: str, prefix: str) → str

Strip a prefix from a string if it starts with it.

raesl.excel.text.abbreviate_comparison(comp_str: str) → str

Use symbols instead of full text for comparison text.