edison-parser 0.3__tar.gz → 0.5__tar.gz

{edison_parser-0.3/src/edison_parser.egg-info → edison_parser-0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: edison-parser
-Version: 0.3
+Version: 0.5
 Summary: An EDIFACT parser with a real syntax tree.
 Author-email: Alex Prengère <alex.prengere@gmail.com>
 License-Expression: MIT
@@ -31,21 +31,23 @@ Dynamic: license-file
         <a href="https://github.com/AmadeusITGroup/Edison/actions/workflows/ci.yml"><img src="https://github.com/AmadeusITGroup/Edison/actions/workflows/ci.yml/badge.svg" alt="Build"></a>
         <a href="https://pypi.org/project/edison-parser/"><img src="https://img.shields.io/pypi/v/edison-parser.svg" alt="Version"></a>
         <a href="https://pypi.org/project/edison-parser/"><img src="https://img.shields.io/pypi/pyversions/edison-parser.svg" alt="Python versions"></a>
+        <a href="https://github.com/AmadeusITGroup/Edison/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
       <!--  <a href="https://pepy.tech/project/edison-parser"><img src="https://static.pepy.tech/badge/edison-parser" alt="Downloads"></a>  -->
     </p>
 </div>
 
-Edison is a Python library for parsing EDIFACT messages. Instead of treating a
-message as a flat stream of segments, it models valid messages as a tree of
-transitions. You define the schema once, then parse, validate, or pretty-print
-messages against that structure.
+Edison is a Python library for parsing EDIFACT messages. Instead of treating a message as a flat list of segments,
+it models messages as a syntax tree: segments can define groups of child segments, recursively.
+
+You define the syntax tree once, then parse, validate, or pretty-print messages against that structure.  
+It works by converting the syntax tree to a state machine of possible transitions between segments.
 
 ## Highlights
 
 - Define EDIFACT syntax trees directly in Python.
+- Segments can define groups of child segments, which can be conditional, mandatory, or repeatable.
 - Attach parsing callbacks to the segments you care about.
-- Select schemas by message version.
-- Model conditional, mandatory, and repeatable segments.
+- Select syntax tree by message version.
 - Handle escaped EDIFACT separators and EBCDIC control characters.
 - Properly tokenize segments with specified lengths like `BLB`
 - Export transition graphs with `pydot`.
@@ -72,12 +74,12 @@ class PIZZAQParser(BaseParser):
         (0, 0): [
             ["UNH"],
             ["CVR"],
-            ["REF"],
+            ["REF"],  # one type of REF segment
             [
                 "PIZ",
                 [
                     ["TYP", [], "parse_typ"],
-                    ["REF", [], "parse_ref"],
+                    ["REF", [], "parse_ref"],  # another type of REF segment
                 ],
             ],
             ["UNT"],
@@ -89,9 +91,12 @@ class PIZZAQParser(BaseParser):
         self.pizza = None
 
     def parse_typ(self, segment: str):
+        # Executed when the parser sees a "TYP" segment. The segment is passed as a string.
         self.pizza = segment[4:]
 
     def parse_ref(self, segment: str):
+        # Executed when the parser sees a "REF" segment. The segment is passed as a string.
+        # Only executed on the "second" type of "REF" segment!
         refs = segment[4:].split("*")
         self.summary[self.pizza] = len(refs)
 
@@ -323,9 +328,12 @@ finishes.
 <details>
 <summary>Transition graphs</summary>
 
-`pydot` is installed with Edison. To write PNG files, make sure Graphviz is
-available on your system, then call `build_dot_object()` on a `BaseParser`
-subclass.
+Internally, Edison builds a directed graph of transitions between segments, when the parser class is created.  
+Each node is a specific segment, and each edge is a valid transition to the next segment.  
+With this, parsing is just a walk through the graph, and validation is checking if the path exists.
+
+You can visualize the transition graph with `build_dot_object()`, which returns a `pydot.Dot` object.  
+`pydot` is installed with Edison. To write PNG files, make sure Graphviz is available on your system.
 
 ```python
 from edison import BaseParser
@@ -350,6 +358,12 @@ dot = Parser.build_dot_object()
 dot.write_png("transitions.png")
 ```
 
+Here is the resulting graph for the above schema.
+
+<p align="center">
+    <img src="https://raw.githubusercontent.com/AmadeusITGroup/Edison/main/docs/transitions.png" alt="pydot">
+</p>
+
 You can pass the same version selector used by parsing, and hide upward links
 for a simpler tree-like graph:
 

{edison_parser-0.3 → edison_parser-0.5}/README.md

@@ -6,21 +6,23 @@
         <a href="https://github.com/AmadeusITGroup/Edison/actions/workflows/ci.yml"><img src="https://github.com/AmadeusITGroup/Edison/actions/workflows/ci.yml/badge.svg" alt="Build"></a>
         <a href="https://pypi.org/project/edison-parser/"><img src="https://img.shields.io/pypi/v/edison-parser.svg" alt="Version"></a>
         <a href="https://pypi.org/project/edison-parser/"><img src="https://img.shields.io/pypi/pyversions/edison-parser.svg" alt="Python versions"></a>
+        <a href="https://github.com/AmadeusITGroup/Edison/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
       <!--  <a href="https://pepy.tech/project/edison-parser"><img src="https://static.pepy.tech/badge/edison-parser" alt="Downloads"></a>  -->
     </p>
 </div>
 
-Edison is a Python library for parsing EDIFACT messages. Instead of treating a
-message as a flat stream of segments, it models valid messages as a tree of
-transitions. You define the schema once, then parse, validate, or pretty-print
-messages against that structure.
+Edison is a Python library for parsing EDIFACT messages. Instead of treating a message as a flat list of segments,
+it models messages as a syntax tree: segments can define groups of child segments, recursively.
+
+You define the syntax tree once, then parse, validate, or pretty-print messages against that structure.  
+It works by converting the syntax tree to a state machine of possible transitions between segments.
 
 ## Highlights
 
 - Define EDIFACT syntax trees directly in Python.
+- Segments can define groups of child segments, which can be conditional, mandatory, or repeatable.
 - Attach parsing callbacks to the segments you care about.
-- Select schemas by message version.
-- Model conditional, mandatory, and repeatable segments.
+- Select syntax tree by message version.
 - Handle escaped EDIFACT separators and EBCDIC control characters.
 - Properly tokenize segments with specified lengths like `BLB`
 - Export transition graphs with `pydot`.
@@ -47,12 +49,12 @@ class PIZZAQParser(BaseParser):
         (0, 0): [
             ["UNH"],
             ["CVR"],
-            ["REF"],
+            ["REF"],  # one type of REF segment
             [
                 "PIZ",
                 [
                     ["TYP", [], "parse_typ"],
-                    ["REF", [], "parse_ref"],
+                    ["REF", [], "parse_ref"],  # another type of REF segment
                 ],
             ],
             ["UNT"],
@@ -64,9 +66,12 @@ class PIZZAQParser(BaseParser):
         self.pizza = None
 
     def parse_typ(self, segment: str):
+        # Executed when the parser sees a "TYP" segment. The segment is passed as a string.
         self.pizza = segment[4:]
 
     def parse_ref(self, segment: str):
+        # Executed when the parser sees a "REF" segment. The segment is passed as a string.
+        # Only executed on the "second" type of "REF" segment!
         refs = segment[4:].split("*")
         self.summary[self.pizza] = len(refs)
 
@@ -298,9 +303,12 @@ finishes.
 <details>
 <summary>Transition graphs</summary>
 
-`pydot` is installed with Edison. To write PNG files, make sure Graphviz is
-available on your system, then call `build_dot_object()` on a `BaseParser`
-subclass.
+Internally, Edison builds a directed graph of transitions between segments, when the parser class is created.  
+Each node is a specific segment, and each edge is a valid transition to the next segment.  
+With this, parsing is just a walk through the graph, and validation is checking if the path exists.
+
+You can visualize the transition graph with `build_dot_object()`, which returns a `pydot.Dot` object.  
+`pydot` is installed with Edison. To write PNG files, make sure Graphviz is available on your system.
 
 ```python
 from edison import BaseParser
@@ -325,6 +333,12 @@ dot = Parser.build_dot_object()
 dot.write_png("transitions.png")
 ```
 
+Here is the resulting graph for the above schema.
+
+<p align="center">
+    <img src="https://raw.githubusercontent.com/AmadeusITGroup/Edison/main/docs/transitions.png" alt="pydot">
+</p>
+
 You can pass the same version selector used by parsing, and hide upward links
 for a simpler tree-like graph:
 

{edison_parser-0.3 → edison_parser-0.5/src/edison_parser.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: edison-parser
-Version: 0.3
+Version: 0.5
 Summary: An EDIFACT parser with a real syntax tree.
 Author-email: Alex Prengère <alex.prengere@gmail.com>
 License-Expression: MIT
@@ -31,21 +31,23 @@ Dynamic: license-file
         <a href="https://github.com/AmadeusITGroup/Edison/actions/workflows/ci.yml"><img src="https://github.com/AmadeusITGroup/Edison/actions/workflows/ci.yml/badge.svg" alt="Build"></a>
         <a href="https://pypi.org/project/edison-parser/"><img src="https://img.shields.io/pypi/v/edison-parser.svg" alt="Version"></a>
         <a href="https://pypi.org/project/edison-parser/"><img src="https://img.shields.io/pypi/pyversions/edison-parser.svg" alt="Python versions"></a>
+        <a href="https://github.com/AmadeusITGroup/Edison/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
       <!--  <a href="https://pepy.tech/project/edison-parser"><img src="https://static.pepy.tech/badge/edison-parser" alt="Downloads"></a>  -->
     </p>
 </div>
 
-Edison is a Python library for parsing EDIFACT messages. Instead of treating a
-message as a flat stream of segments, it models valid messages as a tree of
-transitions. You define the schema once, then parse, validate, or pretty-print
-messages against that structure.
+Edison is a Python library for parsing EDIFACT messages. Instead of treating a message as a flat list of segments,
+it models messages as a syntax tree: segments can define groups of child segments, recursively.
+
+You define the syntax tree once, then parse, validate, or pretty-print messages against that structure.  
+It works by converting the syntax tree to a state machine of possible transitions between segments.
 
 ## Highlights
 
 - Define EDIFACT syntax trees directly in Python.
+- Segments can define groups of child segments, which can be conditional, mandatory, or repeatable.
 - Attach parsing callbacks to the segments you care about.
-- Select schemas by message version.
-- Model conditional, mandatory, and repeatable segments.
+- Select syntax tree by message version.
 - Handle escaped EDIFACT separators and EBCDIC control characters.
 - Properly tokenize segments with specified lengths like `BLB`
 - Export transition graphs with `pydot`.
@@ -72,12 +74,12 @@ class PIZZAQParser(BaseParser):
         (0, 0): [
             ["UNH"],
             ["CVR"],
-            ["REF"],
+            ["REF"],  # one type of REF segment
             [
                 "PIZ",
                 [
                     ["TYP", [], "parse_typ"],
-                    ["REF", [], "parse_ref"],
+                    ["REF", [], "parse_ref"],  # another type of REF segment
                 ],
             ],
             ["UNT"],
@@ -89,9 +91,12 @@ class PIZZAQParser(BaseParser):
         self.pizza = None
 
     def parse_typ(self, segment: str):
+        # Executed when the parser sees a "TYP" segment. The segment is passed as a string.
         self.pizza = segment[4:]
 
     def parse_ref(self, segment: str):
+        # Executed when the parser sees a "REF" segment. The segment is passed as a string.
+        # Only executed on the "second" type of "REF" segment!
         refs = segment[4:].split("*")
         self.summary[self.pizza] = len(refs)
 
@@ -323,9 +328,12 @@ finishes.
 <details>
 <summary>Transition graphs</summary>
 
-`pydot` is installed with Edison. To write PNG files, make sure Graphviz is
-available on your system, then call `build_dot_object()` on a `BaseParser`
-subclass.
+Internally, Edison builds a directed graph of transitions between segments, when the parser class is created.  
+Each node is a specific segment, and each edge is a valid transition to the next segment.  
+With this, parsing is just a walk through the graph, and validation is checking if the path exists.
+
+You can visualize the transition graph with `build_dot_object()`, which returns a `pydot.Dot` object.  
+`pydot` is installed with Edison. To write PNG files, make sure Graphviz is available on your system.
 
 ```python
 from edison import BaseParser
@@ -350,6 +358,12 @@ dot = Parser.build_dot_object()
 dot.write_png("transitions.png")
 ```
 
+Here is the resulting graph for the above schema.
+
+<p align="center">
+    <img src="https://raw.githubusercontent.com/AmadeusITGroup/Edison/main/docs/transitions.png" alt="pydot">
+</p>
+
 You can pass the same version selector used by parsing, and hide upward links
 for a simpler tree-like graph:
 

{edison_parser-0.3 → edison_parser-0.5}/src/edison_parser.egg-info/scm_file_list.json

@@ -16,6 +16,7 @@
     "README.md",
     "docs/Image.png",
     "docs/edison.png",
+    "docs/transitions.png",
     "pyproject.toml",
     "src/edison/__init__.py",
     "src/edison/envelope.py",

edison_parser-0.5/src/edison_parser.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "0.5",
+  "distance": 0,
+  "node": "g6322c36918168e89c37bd4a1872c622539a6ac58",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-10-22"
+}

edison_parser-0.3/src/edison_parser.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "0.3",
-  "distance": 0,
-  "node": "g903d48fb0f27f07def1b2ff3044dee024c863b68",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-10-21"
-}