:py:mod:`raesl.excel.text`
==========================

.. py:module:: raesl.excel.text

.. autoapi-nested-parse::

   Raw text export of ESL requirement nodes.



Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   raesl.excel.text.requirement_text
   raesl.excel.text.goal_text
   raesl.excel.text.transformation_text
   raesl.excel.text.designrule_text
   raesl.excel.text.designclause_text
   raesl.excel.text.design_text
   raesl.excel.text.subclauses_text
   raesl.excel.text.case_text
   raesl.excel.text.behavior_text
   raesl.excel.text.need_text
   raesl.excel.text.get_common_parts
   raesl.excel.text.strip_prefix
   raesl.excel.text.abbreviate_comparison



.. py:function:: requirement_text(requirement: ragraph.node.Node, graph: ragraph.graph.Graph, skip: Optional[str] = 'world') -> str

   Re-format the requirement as text.


.. py:function:: goal_text(requirement: ragraph.node.Node, graph: ragraph.graph.Graph, skip: Optional[str] = 'world') -> str

   Re-format goal requirement as text.


.. py:function:: transformation_text(requirement: ragraph.node.Node, graph: ragraph.graph.Graph, skip: Optional[str] = 'world') -> str

   Re-format transformation requirement as text.


.. py:function:: designrule_text(body: Dict[str, Any], graph: ragraph.graph.Graph, skip: Optional[str] = 'world') -> str

   Re-format design rule as text.


.. py:function:: designclause_text(bodies: List[Dict[str, Any]], graph: ragraph.graph.Graph, label: Optional[str] = None, skip: Optional[str] = 'world') -> str

   Re-format design clause as text.


.. py:function:: design_text(requirement: ragraph.node.Node, graph: ragraph.graph.Graph, skip: Optional[str] = 'world') -> str

   Re-format design requirement as text.


.. py:function:: subclauses_text(requirement: ragraph.node.Node, graph: ragraph.graph.Graph, skip: Optional[str] = 'world', spaces: int = 2) -> str

   Re-format subclauses as text.


.. py:function:: case_text(case: Dict[str, Any], graph: ragraph.graph.Graph, skip: str = 'world') -> str

   Re-format behavior requirement case as text.


.. py:function:: behavior_text(requirement: ragraph.node.Node, graph: ragraph.graph.Graph, skip: Optional[str] = 'world') -> str

   Re-format behavior requirement as text.


.. py:function:: need_text(requirement: ragraph.node.Node, graph: ragraph.graph.Graph, skip: Optional[str] = 'world') -> str

   Re-format need as text.


.. py:function:: get_common_parts(strings: Iterable[str]) -> List[str]

   Find out the largest shared substrings separated on dots '.'.


.. py:function:: strip_prefix(input: str, prefix: str) -> str

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


.. py:function:: abbreviate_comparison(comp_str: str) -> str

   Use symbols instead of full text for comparison text.