Merge pull request #407 from pbs-data-solutions/comments

Add missing comments to native files parsers

Author: sanders41

Cargo.lock

@@ -16,7 +16,7 @@ crate-type = ["cdylib"]
 [dependencies]
 anyhow = "1.0.89"
 chrono = "0.4.38"
-prelude-xml-parser = { version = "0.7.1", features = ["python"] }
+prelude-xml-parser = { version = "0.7.2", features = ["python"] }
 pyo3 = { version = "0.22.4", features = ["extension-module"] }
 roxmltree = "0.20.0"
 serde = { version = "1.0.210", features = ["derive"] }

Cargo.toml

@@ -29,13 +29,20 @@ class Entry:
 
     def to_dict(self) -> dict: ...
 
+class Comment:
+    entry_id: str
+    value: Value | None
+
+    def to_dict(self) -> dict: ...
+
 class Field:
     name: str
     data_type: str | None
     error_code: str
     when_created: datetime
     keep_history: bool
     entries: list[Entry] | None
+    comments: list[Comment] | None
 
     def to_dict(self) -> dict: ...
 

prelude_parser/_prelude_parser.pyi

@@ -10,6 +10,9 @@
           <entry id="1">
             <value by="Paul Sanders" byUniqueId="1681162687395" role="Project Manager" when="2023-04-15 12:08:19 -0400" xml:space="preserve">Some Company</value>
           </entry>
+          <comment id="1">
+            <value by="Paul Sanders" byUniqueId="1681162687395" role="Project Manager" when="2023-04-15 12:09:02 -0400" xml:space="preserve">Some comment</value>
+          </comment>
         </field>
         <field name="site_code_name" type="hidden" dataType="string" errorCode="valid" whenCreated="2023-04-15 11:07:14 -0500" keepHistory="true">
           <entry id="1">

tests/assets/site_native.xml

@@ -9,6 +9,9 @@
           <entry id="1">
             <value by="Paul Sanders" byUniqueId="1681162687395" role="Project Manager" when="2023-04-15 12:09:02 -0400" xml:space="preserve">Labrador</value>
           </entry>
+          <comment id="1">
+            <value by="Paul Sanders" byUniqueId="1681162687395" role="Project Manager" when="2023-04-15 12:09:02 -0400" xml:space="preserve">Some comment</value>
+          </comment>
         </field>
         <field name="dob" type="popUpCalendar" dataType="date" errorCode="valid" whenCreated="2023-04-15 12:08:26 -0400" keepHistory="true">
           <entry id="1">

tests/assets/subject_native.xml

@@ -10,6 +10,9 @@
           <entry id="1">
             <value by="Paul Sanders" byUniqueId="1681162687395" role="Project Manager" when="2023-08-07 10:15:41 -0500" xml:space="preserve">[email protected]</value>
           </entry>
+          <comment id="1">
+            <value by="Paul Sanders" byUniqueId="1681162687395" role="Project Manager" when="2023-04-15 12:09:02 -0400" xml:space="preserve">Some comment</value>
+          </comment>
         </field>
       </category>
       <category name="Administrative" type="normal" highestIndex="0">