labfreed 0.0.13__tar.gz → 0.0.15__tar.gz

labfreed-0.0.15/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: labfreed
+Version: 0.0.15
+Summary: Python implementation of LabFREED building blocks
+Author-email: Reto Thürer <thuerer.r@buchi.com>
+Description-Content-Type: text/markdown
+License-Expression: MIT
+License-File: LICENSE
+
+# LabFREED for Python
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![PyPI](https://img.shields.io/pypi/v/labfreed.svg)](https://pypi.org/project/labfreed/) ![Python Version](https://img.shields.io/pypi/pyversions/labfreed)
+
+<!--
+[![Tests](https://github.com/retothuerer/LabFREED/actions/workflows/ci.yml/badge.svg)](https://github.com/retothuerer/LabFREED/actions/workflows/ci.yml)
+-->
+
+This is a Python implementation of [LabFREED](www.labfreed.wega-it.com) building blocks.
+
+## Supported Building Blocks
+- PAC-ID
+- PAC-CAT
+- TREX
+- Display Extension
+
+## Installation
+You can install LabFREED from [PyPI](https://pypi.org/project/labfreed/) using pip:
+
+```bash
+pip install labfreed
+```
+
+
+## Usage Examples
+<!-- BEGIN EXAMPLES -->
+```python
+
+```
+
+### Parse a simple PAC-ID 
+The
+
+```python
+from labfreed.parse_pac import PAC_Parser
+
+# Parse the PAC-ID
+pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234'
+pac_id = PAC_Parser().parse(pac_str).pac_id
+
+# Check validity of this PAC-ID
+pac_id = PAC_Parser().parse(pac_str).pac_id
+is_valid = pac_id.is_valid()
+print('PAC-ID is valid: {is_valid}')
+# >> PAC-ID is valid: {is_valid}
+```
+
+Show recommendations:
+Note that the PAC-ID, while valid uses characters, which are not recommended (results in larger QR code).
+There is a nice function to highlight problems
+
+```python
+pac_id.print_validation_messages()
+# >>
+#   =======================================
+#   Validation Results
+#   ---------------------------------------
+
+#   Recommendation  in      id segment value bal500
+#   HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234
+#   Characters a b l should not be used.
+
+#   Recommendation  in      id segment value @1234
+#   HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234
+#   Characters @ should not be used.
+
+#   Warning  in     Category -MD
+#   HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234
+#   Category key -MD is not a well known key. It is recommended to use well known keys only
+```
+
+### Parse a PAC-ID with extensions
+PAC-ID can have extensions. Here we parse a PAC-ID with attached display names and summary.
+
+```python
+pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/BAL500/1234*N$N/WM633OV3E5DGJW2BEG0PDM1EA7*SUM$TREX/WEIGHT$GRM:67.89'
+pac_id = PAC_Parser().parse(pac_str)
+
+# Display Name
+display_names = pac_id.get_extension('N') # display name has name 'N'
+print(f'\n {display_names}')
+# >> Display names: My Balance ❤️
+
+# TREX
+trexes = pac_id.get_extension_of_type('TREX')
+trex = trexes[0] # there could be multiple trexes. In this example there is only one, though
+v = trex.get_segment('WEIGHT').to_python_type() 
+print(f'WEIGHT = {v}')
+# >> WEIGHT = 67.89 g
+```
+
+### Create a PAC-ID with Extensions
+
+#### Create PAC-ID
+
+```python
+from labfreed.PAC_ID.data_model import PACID, IDSegment
+from labfreed.utilities.well_known_keys import WellKnownKeys
+
+pac_id = PACID(issuer='METTORIUS:COM', identifier=[IDSegment(key=WellKnownKeys.SERIAL, value='1234')])
+pac_str = pac_id.serialize()
+pac_str = pac_id.serialize()
+print(pac_str)
+```
+
+#### Create a TREX 
+TREX can conveniently be created from a python dictionary.
+Note that utility types for Quantity (number with unit) and table are needed
+
+```python
+from datetime import datetime
+from labfreed.TREX.data_model import TREX
+from labfreed.utilities.utility_types import Quantity, DataTable, Unit
+
+# Create TREX
+trex = TREX(name_='DEMO') 
+# Add value segments of different type
+trex.update(   
+                    {
+                        'STOP': datetime(year=2024,month=5,day=5,hour=13,minute=6),
+                        'TEMP': Quantity(value=10.15, unit=Unit(name='kelvin', symbol='K')),
+                        'OK':False,
+                        'COMMENT': 'FOO',
+                        'COMMENT2':'£'
+                    }
+)
+
+# Create a table
+table = DataTable(['DURATION', 'DATE', 'OK', 'COMMENT'])
+table.append([Quantity(value=1, unit=Unit(symbol='h', name='hour')), datetime.now(), True, 'FOO'])
+table.append([                                                 1.1,  datetime.now(), True, 'BAR'])
+table.append([                                                 1.3,  datetime.now(), False, 'BLUBB'])
+#add the table to the trex
+trex.update({'TABLE': table})
+
+# Validation also works the same way for TREX
+if trex.get_nested_validation_messages():
+    trex.print_validation_messages()
+
+# Side Note: The TREX can be turned back into a dict
+d = trex.dict()
+```
+
+#### Combine PAC-ID and TREX and serialize
+
+```python
+from labfreed.parse_pac import PACID_With_Extensions
+
+pac_with_trex = PACID_With_Extensions(pac_id=pac_id, extensions=[trex])
+pac_str = pac_with_trex.serialize()
+print(pac_str)
+```
+
+<!-- END EXAMPLES -->
+
+
+
+## Change Log
+
+### v0.0.9
+- supports PAC-ID, PAC-CAT, TREX and DisplayName
+- ok-ish test coverage

labfreed-0.0.15/README.md

@@ -0,0 +1,162 @@
+# LabFREED for Python
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![PyPI](https://img.shields.io/pypi/v/labfreed.svg)](https://pypi.org/project/labfreed/) ![Python Version](https://img.shields.io/pypi/pyversions/labfreed)
+
+<!--
+[![Tests](https://github.com/retothuerer/LabFREED/actions/workflows/ci.yml/badge.svg)](https://github.com/retothuerer/LabFREED/actions/workflows/ci.yml)
+-->
+
+This is a Python implementation of [LabFREED](www.labfreed.wega-it.com) building blocks.
+
+## Supported Building Blocks
+- PAC-ID
+- PAC-CAT
+- TREX
+- Display Extension
+
+## Installation
+You can install LabFREED from [PyPI](https://pypi.org/project/labfreed/) using pip:
+
+```bash
+pip install labfreed
+```
+
+
+## Usage Examples
+<!-- BEGIN EXAMPLES -->
+```python
+
+```
+
+### Parse a simple PAC-ID 
+The
+
+```python
+from labfreed.parse_pac import PAC_Parser
+
+# Parse the PAC-ID
+pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234'
+pac_id = PAC_Parser().parse(pac_str).pac_id
+
+# Check validity of this PAC-ID
+pac_id = PAC_Parser().parse(pac_str).pac_id
+is_valid = pac_id.is_valid()
+print('PAC-ID is valid: {is_valid}')
+# >> PAC-ID is valid: {is_valid}
+```
+
+Show recommendations:
+Note that the PAC-ID, while valid uses characters, which are not recommended (results in larger QR code).
+There is a nice function to highlight problems
+
+```python
+pac_id.print_validation_messages()
+# >>
+#   =======================================
+#   Validation Results
+#   ---------------------------------------
+
+#   Recommendation  in      id segment value bal500
+#   HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234
+#   Characters a b l should not be used.
+
+#   Recommendation  in      id segment value @1234
+#   HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234
+#   Characters @ should not be used.
+
+#   Warning  in     Category -MD
+#   HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234
+#   Category key -MD is not a well known key. It is recommended to use well known keys only
+```
+
+### Parse a PAC-ID with extensions
+PAC-ID can have extensions. Here we parse a PAC-ID with attached display names and summary.
+
+```python
+pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/BAL500/1234*N$N/WM633OV3E5DGJW2BEG0PDM1EA7*SUM$TREX/WEIGHT$GRM:67.89'
+pac_id = PAC_Parser().parse(pac_str)
+
+# Display Name
+display_names = pac_id.get_extension('N') # display name has name 'N'
+print(f'\n {display_names}')
+# >> Display names: My Balance ❤️
+
+# TREX
+trexes = pac_id.get_extension_of_type('TREX')
+trex = trexes[0] # there could be multiple trexes. In this example there is only one, though
+v = trex.get_segment('WEIGHT').to_python_type() 
+print(f'WEIGHT = {v}')
+# >> WEIGHT = 67.89 g
+```
+
+### Create a PAC-ID with Extensions
+
+#### Create PAC-ID
+
+```python
+from labfreed.PAC_ID.data_model import PACID, IDSegment
+from labfreed.utilities.well_known_keys import WellKnownKeys
+
+pac_id = PACID(issuer='METTORIUS:COM', identifier=[IDSegment(key=WellKnownKeys.SERIAL, value='1234')])
+pac_str = pac_id.serialize()
+pac_str = pac_id.serialize()
+print(pac_str)
+```
+
+#### Create a TREX 
+TREX can conveniently be created from a python dictionary.
+Note that utility types for Quantity (number with unit) and table are needed
+
+```python
+from datetime import datetime
+from labfreed.TREX.data_model import TREX
+from labfreed.utilities.utility_types import Quantity, DataTable, Unit
+
+# Create TREX
+trex = TREX(name_='DEMO') 
+# Add value segments of different type
+trex.update(   
+                    {
+                        'STOP': datetime(year=2024,month=5,day=5,hour=13,minute=6),
+                        'TEMP': Quantity(value=10.15, unit=Unit(name='kelvin', symbol='K')),
+                        'OK':False,
+                        'COMMENT': 'FOO',
+                        'COMMENT2':'£'
+                    }
+)
+
+# Create a table
+table = DataTable(['DURATION', 'DATE', 'OK', 'COMMENT'])
+table.append([Quantity(value=1, unit=Unit(symbol='h', name='hour')), datetime.now(), True, 'FOO'])
+table.append([                                                 1.1,  datetime.now(), True, 'BAR'])
+table.append([                                                 1.3,  datetime.now(), False, 'BLUBB'])
+#add the table to the trex
+trex.update({'TABLE': table})
+
+# Validation also works the same way for TREX
+if trex.get_nested_validation_messages():
+    trex.print_validation_messages()
+
+# Side Note: The TREX can be turned back into a dict
+d = trex.dict()
+```
+
+#### Combine PAC-ID and TREX and serialize
+
+```python
+from labfreed.parse_pac import PACID_With_Extensions
+
+pac_with_trex = PACID_With_Extensions(pac_id=pac_id, extensions=[trex])
+pac_str = pac_with_trex.serialize()
+print(pac_str)
+```
+
+<!-- END EXAMPLES -->
+
+
+
+## Change Log
+
+### v0.0.9
+- supports PAC-ID, PAC-CAT, TREX and DisplayName
+- ok-ish test coverage

labfreed-0.0.15/examples.py

@@ -0,0 +1,126 @@
+''' 
+### Parse a simple PAC-ID 
+The 
+'''
+from labfreed.parse_pac import PAC_Parser
+
+# Parse the PAC-ID
+pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234'
+pac_id = PAC_Parser().parse(pac_str).pac_id
+
+# Check validity of this PAC-ID
+pac_id = PAC_Parser().parse(pac_str).pac_id
+is_valid = pac_id.is_valid()
+print('PAC-ID is valid: {is_valid}')
+# >> PAC-ID is valid: {is_valid}
+
+''' 
+Show recommendations:
+Note that the PAC-ID, while valid uses characters, which are not recommended (results in larger QR code).
+There is a nice function to highlight problems
+'''
+pac_id.print_validation_messages()
+# >>
+#   =======================================
+#   Validation Results
+#   ---------------------------------------
+
+#   Recommendation  in      id segment value bal500
+#   HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234
+#   Characters a b l should not be used.
+
+#   Recommendation  in      id segment value @1234
+#   HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234
+#   Characters @ should not be used.
+
+#   Warning  in     Category -MD
+#   HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234
+#   Category key -MD is not a well known key. It is recommended to use well known keys only
+
+
+
+''' 
+### Parse a PAC-ID with extensions
+PAC-ID can have extensions. Here we parse a PAC-ID with attached display names and summary.
+'''
+pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/BAL500/1234*N$N/WM633OV3E5DGJW2BEG0PDM1EA7*SUM$TREX/WEIGHT$GRM:67.89'
+pac_id = PAC_Parser().parse(pac_str)
+
+# Display Name
+display_names = pac_id.get_extension('N') # display name has name 'N'
+print(f'\n {display_names}')
+# >> Display names: My Balance ❤️
+
+# TREX
+trexes = pac_id.get_extension_of_type('TREX')
+trex = trexes[0] # there could be multiple trexes. In this example there is only one, though
+v = trex.get_segment('WEIGHT').to_python_type() 
+print(f'WEIGHT = {v}')
+# >> WEIGHT = 67.89 g
+
+
+
+''' 
+### Create a PAC-ID with Extensions
+
+#### Create PAC-ID
+'''
+from labfreed.PAC_ID.data_model import PACID, IDSegment
+from labfreed.utilities.well_known_keys import WellKnownKeys
+
+pac_id = PACID(issuer='METTORIUS:COM', identifier=[IDSegment(key=WellKnownKeys.SERIAL, value='1234')])
+pac_str = pac_id.serialize()
+pac_str = pac_id.serialize()
+print(pac_str)
+
+
+''' 
+#### Create a TREX 
+TREX can conveniently be created from a python dictionary.
+Note that utility types for Quantity (number with unit) and table are needed
+'''
+from datetime import datetime
+from labfreed.TREX.data_model import TREX
+from labfreed.utilities.utility_types import Quantity, DataTable, Unit
+
+# Create TREX
+trex = TREX(name_='DEMO') 
+# Add value segments of different type
+trex.update(   
+                    {
+                        'STOP': datetime(year=2024,month=5,day=5,hour=13,minute=6),
+                        'TEMP': Quantity(value=10.15, unit=Unit(name='kelvin', symbol='K')),
+                        'OK':False,
+                        'COMMENT': 'FOO',
+                        'COMMENT2':'£'
+                    }
+)
+
+# Create a table
+table = DataTable(['DURATION', 'DATE', 'OK', 'COMMENT'])
+table.append([Quantity(value=1, unit=Unit(symbol='h', name='hour')), datetime.now(), True, 'FOO'])
+table.append([                                                 1.1,  datetime.now(), True, 'BAR'])
+table.append([                                                 1.3,  datetime.now(), False, 'BLUBB'])
+#add the table to the trex
+trex.update({'TABLE': table})
+
+# Validation also works the same way for TREX
+if trex.get_nested_validation_messages():
+    trex.print_validation_messages()
+
+# Side Note: The TREX can be turned back into a dict
+d = trex.dict()
+
+''' 
+#### Combine PAC-ID and TREX and serialize
+'''
+from labfreed.parse_pac import PACID_With_Extensions
+
+pac_with_trex = PACID_With_Extensions(pac_id=pac_id, extensions=[trex])
+pac_str = pac_with_trex.serialize()
+print(pac_str)
+
+
+
+
+

{labfreed-0.0.13 → labfreed-0.0.15}/labfreed/__init__.py

@@ -2,4 +2,4 @@
 Python implementation of LabFREED building blocks
 '''
 
-__version__ = "0.0.13"
+__version__ = "0.0.15"

{labfreed-0.0.13 → labfreed-0.0.15}/labfreed/parse_pac.py

@@ -49,7 +49,7 @@ class PACID_With_Extensions(BaseModelWithValidationMessages):
     @classmethod
     def deserialize(cls, url, extension_interpreters ):
         parser = PAC_Parser(extension_interpreters)
-        return parser.parse_pac_with_extensions(url)
+        return parser.parse(url)
         
         
     
@@ -87,15 +87,15 @@ class PAC_Parser():
     def __init__(self, extension_interpreters:dict[str, Extension]=None):
         self.extension_interpreters = extension_interpreters or {'TREX': TREX, 'N': DisplayNames}
         
-    def parse_pac_with_extensions(self, pac_url:str) -> PACID_With_Extensions:
+    def parse(self, pac_url:str) -> PACID_With_Extensions:
         if '*' in pac_url:
             id_str, ext_str = pac_url.split('*', 1)
         else:
             id_str = pac_url
             ext_str = ""
             
-        pac_id = self.parse_pac_id(id_str)
-        extensions = self.parse_extensions(ext_str)
+        pac_id = self._parse_pac_id(id_str)
+        extensions = self._parse_extensions(ext_str)
         
         pac_with_extension = PACID_With_Extensions(pac_id=pac_id, extensions=extensions)
         if not pac_with_extension.is_valid():
@@ -104,7 +104,7 @@ class PAC_Parser():
         return pac_with_extension
             
             
-    def parse_pac_id(self,id_str:str) -> PACID:
+    def _parse_pac_id(self,id_str:str) -> PACID:
         m = re.match(f'(HTTPS://)?(PAC.)?(?P<issuer>.+?\..+?)/(?P<identifier>.*)', id_str)
         d = m.groupdict()
         
@@ -148,7 +148,7 @@ class PAC_Parser():
     
 
 
-    def parse_extensions(self, extensions_str:str|None) -> list[Extension]:    
+    def _parse_extensions(self, extensions_str:str|None) -> list[Extension]:    
         
         extensions = list()
         

{labfreed-0.0.13 → labfreed-0.0.15}/pyproject.toml

@@ -8,11 +8,12 @@ authors = [{name = "Reto Thürer", email = "thuerer.r@buchi.com"}]
 license = "MIT"
 license-files = ["LICENSE"]
 dynamic = ["version", "description"]
+readme = {file = "README.md", content-type = "text/markdown"}
 
 [tool.flit.module]
 name = "labfreed"
 
-readme = {file = "README.md", content-type = "text/markdown"}
+
 requires-python = ">=3.10"
 classifiers = [
     "Programming Language :: Python :: 3",

{labfreed-0.0.13 → labfreed-0.0.15}/tests/test_(de)_serialization_incl_extension/test__parse.py

@@ -11,7 +11,7 @@ parser = PAC_Parser()
 
 # Extensions
 def test_valid_extensions():
-    pac = parser.parse_pac_with_extensions(valid_base + valid_standard_segments + "*name1$t1/data1*name2$t2/data2")
+    pac = parser.parse(valid_base + valid_standard_segments + "*name1$t1/data1*name2$t2/data2")
     extensions = pac.extensions
     ext: Extension = extensions[0]
     assert ext.name == 'name1'
@@ -45,7 +45,7 @@ def test_known_extension_types_are_parsed():
             'KNOWN_EXTENSION': ExtensionMockType,
     }  
     parser_with_known_extension = PAC_Parser(extension_interpreters)
-    pac = parser_with_known_extension.parse_pac_with_extensions(valid_base + valid_standard_segments + "*name1$KNOWN_EXTENSION/data1")
+    pac = parser_with_known_extension.parse(valid_base + valid_standard_segments + "*name1$KNOWN_EXTENSION/data1")
     extensions= pac.extensions
     ext: Extension = extensions[0]
     assert isinstance(ext, ExtensionMockType)
@@ -55,7 +55,7 @@ def test_known_extension_types_are_parsed():
     
     
 def test_imply_display_name_and_summary_extension():
-    pac = parser.parse_pac_with_extensions(valid_base + valid_standard_segments + "*data1*data2")
+    pac = parser.parse(valid_base + valid_standard_segments + "*data1*data2")
     extensions = pac.extensions
     ext: Extension = extensions[0]
     assert ext.name == 'N'
@@ -67,13 +67,13 @@ def test_imply_display_name_and_summary_extension():
     
 def test_stop_imply_extensions_after_explicit():
     with pytest.raises(Exception):
-        pac = parser.parse_pac_with_extensions(valid_base + valid_standard_segments + "*N$T/data1*data2")
+        pac = parser.parse(valid_base + valid_standard_segments + "*N$T/data1*data2")
         pac.extensions
         
 
 def test_extension_parsing():
     s = '*NAME$MYFORMAT/AUGDSJGTZFRDGJHDSFRTZGHJAAUTZSGADT*NAME$ANOTHERFORMAT/BLUBBER'
-    extensions = parser.parse_extensions(s)
+    extensions = parser._parse_extensions(s)
     ext: Extension = extensions[0]
     assert ext.name == 'NAME'
     assert ext.type == 'MYFORMAT'

{labfreed-0.0.13 → labfreed-0.0.15}/tests/test_PAC_CAT/test_PAC_CAT_parse.py

@@ -16,27 +16,27 @@ parser = PAC_Parser()
 
 # Identifier Segments Categories (Recommendation)
 def test_basic_valid_category():
-    pac = parser.parse_pac_with_extensions(valid_base + "-DM/21:VAL")
+    pac = parser.parse(valid_base + "-DM/21:VAL")
     cat: Category = pac.pac_id.categories[0]
     assert cat.key == '-DM'
     assert cat.segments[0].key == '21'
     assert cat.segments[0].value == 'VAL'
     
 def test_if_no_category_is_specified_default_to_unnamed_category():
-    pac = parser.parse_pac_with_extensions(valid_base + "KEY:VAL")
+    pac = parser.parse(valid_base + "KEY:VAL")
     cat: Category = pac.pac_id.categories[0]
     assert cat.key == None
     assert cat.segments[0].key == 'KEY'
     assert cat.segments[0].value == 'VAL'
     
 def test_missing_dash_in_category_name_is_interpreted_as_unnamed_segment():
-    pac = parser.parse_pac_with_extensions(valid_base + "DM/21:VAL")
+    pac = parser.parse(valid_base + "DM/21:VAL")
     cat: Category = pac.pac_id.categories[0]
     assert cat.key == None
     assert cat.segments[0].value == 'DM'
     
 def test_category_with_multiple_segments():
-    pac = parser.parse_pac_with_extensions(valid_base + "-MX/KEY0:VAL0/VAL1/KEY2:VAL2")
+    pac = parser.parse(valid_base + "-MX/KEY0:VAL0/VAL1/KEY2:VAL2")
     cat: Category = pac.pac_id.categories[0]
     assert cat.key == '-MX'
     
@@ -53,7 +53,7 @@ def test_category_with_multiple_segments():
     assert seg.value == "VAL2"
       
 def test_two_categories():
-    pac = parser.parse_pac_with_extensions(valid_base + "-DX/KEY:VAL/-MX/KEY:VAL")
+    pac = parser.parse(valid_base + "-DX/KEY:VAL/-MX/KEY:VAL")
     cat: Category = pac.pac_id.categories[0]
     assert cat.key == '-DX'
     assert cat.segments[0].key == 'KEY'
@@ -65,7 +65,7 @@ def test_two_categories():
     assert cat.segments[0].value == 'VAL'
      
 def test_three_categories():
-    pac = parser.parse_pac_with_extensions(valid_base + "-DX/KEY0:VAL0/-MX/KEY1:VAL1/-CAT/KEY2:VAL2")
+    pac = parser.parse(valid_base + "-DX/KEY0:VAL0/-MX/KEY1:VAL1/-CAT/KEY2:VAL2")
     pac = pac.pac_id
     cat: Category = pac.categories[0]
     assert cat.key == '-DX'
@@ -83,13 +83,13 @@ def test_three_categories():
     assert cat.segments[0].value == 'VAL2'
     
 def test_implied_segments_of_MD_category():
-    pac = parser.parse_pac_with_extensions(valid_base + "-MD/0/1")
+    pac = parser.parse(valid_base + "-MD/0/1")
     cat: Category = pac.pac_id.categories[0]
     assert cat.segments[0].key == '240'
     assert cat.segments[1].key == '21'
     
 def test_implied_segments_of_MS_category():
-    pac = parser.parse_pac_with_extensions(valid_base + "-MS/0/1/2/3/4")
+    pac = parser.parse(valid_base + "-MS/0/1/2/3/4")
     cat: Category = pac.pac_id.categories[0]
     assert cat.segments[0].key == '240'
     assert cat.segments[1].key == '10'
@@ -98,7 +98,7 @@ def test_implied_segments_of_MS_category():
     assert cat.segments[4].key == '250'
     
 def test_implied_segments_of_MC_category():
-    pac = parser.parse_pac_with_extensions(valid_base + "-MC/0/1/2/3/4")
+    pac = parser.parse(valid_base + "-MC/0/1/2/3/4")
     cat: Category = pac.pac_id.categories[0]
     assert cat.segments[0].key == '240'
     assert cat.segments[1].key == '10'
@@ -107,7 +107,7 @@ def test_implied_segments_of_MC_category():
     assert cat.segments[4].key == '250'
     
 def test_implied_segments_of_MM_category():
-    pac = parser.parse_pac_with_extensions(valid_base + "-MM/0/1/2/3/4")
+    pac = parser.parse(valid_base + "-MM/0/1/2/3/4")
     cat: Category = pac.pac_id.categories[0]
     assert cat.segments[0].key == '240'
     assert cat.segments[1].key == '10'
@@ -116,7 +116,7 @@ def test_implied_segments_of_MM_category():
     assert cat.segments[4].key == '250'
     
 def test_stop_implying_segments_after_an_explicit_one_is_found():
-    pac = parser.parse_pac_with_extensions(valid_base + "-MS/0/1/KEY:2/3/4")
+    pac = parser.parse(valid_base + "-MS/0/1/KEY:2/3/4")
     cat: Category = pac.pac_id.categories[0]
     assert cat.segments[0].key == '240'
     assert cat.segments[1].key == '10'
@@ -125,7 +125,7 @@ def test_stop_implying_segments_after_an_explicit_one_is_found():
     assert cat.segments[4].key == None
     
 def test_more_segments_than_implicit_keys():
-    pac = parser.parse_pac_with_extensions(valid_base + "-MD/IMPLIED1/IMPLIED2/ADDITIONAL")
+    pac = parser.parse(valid_base + "-MD/IMPLIED1/IMPLIED2/ADDITIONAL")
     cat: Category = pac.pac_id.categories[0]
     assert cat.segments[2].key == None
     
@@ -135,9 +135,9 @@ def test_more_segments_than_implicit_keys():
     
 def test_mandatory_fields_of_MD_category():
     with pytest.raises(LabFREEDValidationError):
-        pac = parser.parse_pac_with_extensions(valid_base + "-MD/KEY:VAL")
+        pac = parser.parse(valid_base + "-MD/KEY:VAL")
     
-    pac:PAC_CAT = parser.parse_pac_with_extensions(valid_base + "-MD/21:1234/KEY:VAL/240:BAL500").pac_id
+    pac:PAC_CAT = parser.parse(valid_base + "-MD/21:1234/KEY:VAL/240:BAL500").pac_id
     assert pac.get_category('-MD').serial_number == '1234'
     assert pac.get_category('-MD').model_number == 'BAL500'
     

{labfreed-0.0.13 → labfreed-0.0.15}/tests/test_PAC_ID/test_pac_id_parse.py

@@ -14,20 +14,20 @@ parser = PAC_Parser()
 
 # Issuer
 def test_standard_base_gives_correct_issuer():
-    pac = parser.parse_pac_with_extensions("HTTPS://PAC.METTORIUS.COM/" + valid_standard_segments)
+    pac = parser.parse("HTTPS://PAC.METTORIUS.COM/" + valid_standard_segments)
     assert pac.pac_id.issuer == "METTORIUS.COM"
        
 def test_pac_can_be_missing_from_domain():
-    pac = parser.parse_pac_with_extensions("HTTPS://METTORIUS.COM/" + valid_standard_segments)
+    pac = parser.parse("HTTPS://METTORIUS.COM/" + valid_standard_segments)
     assert pac.pac_id.issuer == "METTORIUS.COM"
      
 def test_pac_can_be_missing_from_domain():
-    pac = parser.parse_pac_with_extensions("METTORIUS.COM/" + valid_standard_segments)
+    pac = parser.parse("METTORIUS.COM/" + valid_standard_segments)
     assert pac.pac_id.issuer == "METTORIUS.COM"
     
 def test_issuer_must_be_valid_domain():
     with pytest.raises(Exception):
-        pac = parser.parse_pac_with_extensions("HTTPS://METTORIUS/" + valid_standard_segments)
+        pac = parser.parse("HTTPS://METTORIUS/" + valid_standard_segments)
         
         
         
@@ -36,22 +36,22 @@ def test_issuer_must_be_valid_domain():
 # Identifier Segments
 def test_pac_must_have_at_least_one_segment():
     with pytest.raises(Exception):
-        pac = parser.parse_pac_with_extensions(valid_base = "").pac_id
+        pac = parser.parse(valid_base = "").pac_id
           
 def test_identifier_named_segment():
-    pac = parser.parse_pac_with_extensions(valid_base + "KEY:VAL")
+    pac = parser.parse(valid_base + "KEY:VAL")
     seg: IDSegment = pac.pac_id.identifier[0]
     assert seg.key == "KEY"
     assert seg.value == "VAL"
     
 def test_identifier_unnamed_segment():
-    pac = parser.parse_pac_with_extensions(valid_base + "VAL")
+    pac = parser.parse(valid_base + "VAL")
     seg: IDSegment = pac.pac_id.identifier[0]
     assert not seg.key
     assert seg.value == "VAL"
      
 def test_identifier_combination_of_named_and_unnamed_segments():
-    pac = parser.parse_pac_with_extensions(valid_base + "KEY0:VAL0/VAL1/KEY2:VAL2")
+    pac = parser.parse(valid_base + "KEY0:VAL0/VAL1/KEY2:VAL2")
     pac = pac.pac_id
     seg: IDSegment = pac.identifier[0]
     assert seg.key == 'KEY0'
@@ -66,11 +66,11 @@ def test_identifier_combination_of_named_and_unnamed_segments():
     assert seg.value == "VAL2"
       
 def test_keys_must_be_unique():
-    pac = parser.parse_pac_with_extensions(valid_base + "KEY:VAL/KEY:ANOTHERVAL/KEY:VAL/KEY2:ANOTHERVAL")
+    pac = parser.parse(valid_base + "KEY:VAL/KEY:ANOTHERVAL/KEY:VAL/KEY2:ANOTHERVAL")
     assert len(pac.pac_id.get_warnings()) > 0
         
 def test_keys_can_repeat_accross_categories():
-    pac = parser.parse_pac_with_extensions(valid_base + "-MD/KEY:VAL/-MS/KEY:VAL")
+    pac = parser.parse(valid_base + "-MD/KEY:VAL/-MS/KEY:VAL")
     assert True # made it here without exception > it's fine
         
         

labfreed-0.0.15/update_readme.py

@@ -0,0 +1,63 @@
+import re
+
+start_marker = "<!-- BEGIN EXAMPLES -->"
+end_marker = "<!-- END EXAMPLES -->"
+
+with open("examples.py", encoding="utf-8") as ex_file:
+    example_content = ex_file.read()
+
+# Split on docstring blocks, keeping the docstring delimiters
+pattern = r"(?:'''(.*?)'''|\"\"\"(.*?)\"\"\")"
+splits = re.split(pattern, example_content, flags=re.DOTALL)
+
+# Rebuild output
+output_parts = []
+in_code_block = False
+
+def flush_code_block(buffer):
+    if buffer:
+        return "```python\n" + "".join(buffer).strip() + "\n```\n"
+    return ""
+
+code_buffer = []
+
+for i in range(len(splits)):
+    chunk = splits[i]
+    if chunk is None:
+        continue
+
+    # Every odd-numbered chunk is a docstring match (because of how re.split works with groups)
+    if i % 3 == 1 or i % 3 == 2:
+        # Flush any previous code block
+        output_parts.append(flush_code_block(code_buffer))
+        code_buffer = []
+        docstring = chunk.strip()
+        output_parts.append(docstring + "\n")
+    else:
+        code_buffer.append(chunk)
+
+# Final flush
+output_parts.append(flush_code_block(code_buffer))
+
+example_content_md = "\n".join(part for part in output_parts if part.strip())
+
+# Inject into README.md
+with open("README.md", encoding="utf-8") as readme_file:
+    readme = readme_file.read()
+
+if not readme:
+    raise ValueError("README.md is empty")
+
+if start_marker not in readme or end_marker not in readme:
+    raise ValueError("Markers not found in README.md")
+
+new_readme = (
+    readme.split(start_marker)[0]
+    + start_marker + "\n"
+    + example_content_md + "\n"
+    + end_marker
+    + readme.split(end_marker)[1]
+)
+
+with open("README.md", "w", encoding="utf-8") as readme_file:
+    readme_file.write(new_readme)

labfreed-0.0.13/PKG-INFO

@@ -1,7 +0,0 @@
-Metadata-Version: 2.4
-Name: labfreed
-Version: 0.0.13
-Summary: Python implementation of LabFREED building blocks
-Author-email: Reto Thürer <thuerer.r@buchi.com>
-License-Expression: MIT
-License-File: LICENSE

labfreed-0.0.13/README.md

@@ -1,152 +0,0 @@
-# LabFREED for Python
-
-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![PyPI](https://img.shields.io/pypi/v/labfreed.svg)](https://pypi.org/project/labfreed/) ![Python Version](https://img.shields.io/pypi/pyversions/labfreed)
-
-<!--
-[![Tests](https://github.com/retothuerer/LabFREED/actions/workflows/ci.yml/badge.svg)](https://github.com/retothuerer/LabFREED/actions/workflows/ci.yml)
--->
-
-This is a Python implementation of [LabFREED](www.labfreed.wega-it.com) building blocks.
-
-## Supported Building Blocks
-- PAC-ID
-- PAC-CAT
-- TREX
-- Display Extension
-
-## Installation
-You can install LabFREED from [PyPI](https://pypi.org/project/labfreed/) using pip:
-
-```bash
-pip install labfreed
-```
-
-
-## Usage Examples
-<!-- BEGIN EXAMPLES -->
-```python
-from datetime import datetime
-from typing import Annotated
-
-# Parse a PAC ID
-from labfreed.PAC_ID.data_model import PACID, IDSegment
-from labfreed.parse_pac import PAC_Parser, PACID_With_Extensions
-from utility_types import Quantity
-pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/BAL500/1234'
-pac = PAC_Parser().parse_pac_id(pac_str)
-
-## Check validity
-pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234'
-pac = PAC_Parser().parse_pac_id(pac_str)
-is_valid = pac.is_valid()
-print('PAC-ID is valid: {is_valid}')
-
-# Show recommendations
-pac.print_validation_messages()
-
-
-
-
-## Parse a PAC-ID with extensions
-pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/BAL500/1234*N$N/WM633OV3E5DGJW2BEG0PDM1EA7*SUM$TREX/WEIGHT$GRM:67.89'
-pac = PAC_Parser().parse_pac_with_extensions(pac_str)
-
-# Display Name
-display_names = pac.get_extension('N')
-print(f'\nDisplay names: {display_names}')
-
-# TREX
-from labfreed.TREX.data_model import TREX, ColumnHeader, TREX_Table, TableRow
-trexes = pac.get_extension_of_type('TREX')
-trex:TREX = trexes[0]
-v = trex.get_segment('WEIGHT').to_python_type()
-
-
-
-
-## Create a PAC-ID
-from labfreed.utilities.well_known_keys import WellKnownKeys
-pac = PACID(issuer='METTORIUS:COM', identifier=[IDSegment(key=WellKnownKeys.SERIAL, value='1234')])
-pac_str = pac.serialize()
-pac_str = pac.serialize()
-print(pac_str)
-
-
-
-
-# create a TREX
-from labfreed.TREX.data_model import TREX, DateSegment, NumericSegment, BoolSegment, AlphanumericSegment, TextSegment, BinarySegment
-
-trex = TREX(name_='DEMO-TREX')
-
-trex.segments.append(DateSegment(key='START',value='20240505T1204'))
-trex.segments.append(DateSegment(key='STOP', value=datetime(year=2024,month=5,day=5,hour=13,minute=6)) )
-
-trex.segments.append(NumericSegment(key='TEMP',type='KEL', value=10.15) )
-trex.segments.append(BoolSegment(key='OK', value=False) )
-trex.segments.append(AlphanumericSegment(key='COMMENT', value='FOO') )
-trex.segments.append(TextSegment(key='COMMENT2', value='£') )
-trex.segments.append(TextSegment(key='COMMENT2', value='BAR') )
-
-# if the sting is already in base36 you have to be explicit
-from labfreed.utilities.base36 import base36
-trex.segments.append(TextSegment(key='COMMENT3', value=base36('1URIOQ7')) )
-
-# table
-table = TREX_Table(key='TABLE', 
-                   column_headers=[
-                                    ColumnHeader(key='COL1', type='HUR'), 
-                                    ColumnHeader(key='COL2', type='T.A'),
-                                    ColumnHeader(key='COL3', type='T.D'),
-                                    ColumnHeader(key='COL4', type='T.B')
-                                    ],
-                   data=[
-                       TableRow()
-                   ])
-trex.segments.append(table)
-
-if trex.is_valid():
-    print(trex.data)
-else:
-    trex.print_validation_messages()
-    
-
-p = PACID_With_Extensions(pac_id=pac, extensions=[trex])
-print(p.serialize())
-
-
-
-
-
-# for convenience a TREX can be created from a dict
-trex2 = TREX(name_='DEMO-TREX2')
-trex2.update(   
-                    {
-                        'STOP': datetime(year=2024,month=5,day=5,hour=13,minute=6),
-                        'TEMP': Quantity(value=10.15, unit_name='meter', unit_symbol='m'),
-                        'OK':False,
-                        'COMMENT': 'FOO',
-                        'COMMENT2':'£'
-                    }
-)
-
-d = trex2.dict()
-
-
-
-    
-
-
-
-
-
-```
-<!-- END EXAMPLES -->
-
-
-
-## Change Log
-
-### v0.0.9
-- supports PAC-ID, PAC-CAT, TREX and DisplayName
-- ok-ish test coverage

labfreed-0.0.13/examples.py

@@ -1,114 +0,0 @@
-from datetime import datetime
-from typing import Annotated
-
-# Parse a PAC ID
-from labfreed.PAC_ID.data_model import PACID, IDSegment
-from labfreed.parse_pac import PAC_Parser, PACID_With_Extensions
-from utility_types import Quantity
-pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/BAL500/1234'
-pac = PAC_Parser().parse_pac_id(pac_str)
-
-## Check validity
-pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234'
-pac = PAC_Parser().parse_pac_id(pac_str)
-is_valid = pac.is_valid()
-print('PAC-ID is valid: {is_valid}')
-
-# Show recommendations
-pac.print_validation_messages()
-
-
-
-
-## Parse a PAC-ID with extensions
-pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/BAL500/1234*N$N/WM633OV3E5DGJW2BEG0PDM1EA7*SUM$TREX/WEIGHT$GRM:67.89'
-pac = PAC_Parser().parse_pac_with_extensions(pac_str)
-
-# Display Name
-display_names = pac.get_extension('N')
-print(f'\nDisplay names: {display_names}')
-
-# TREX
-from labfreed.TREX.data_model import TREX, ColumnHeader, TREX_Table, TableRow
-trexes = pac.get_extension_of_type('TREX')
-trex:TREX = trexes[0]
-v = trex.get_segment('WEIGHT').to_python_type()
-
-
-
-
-## Create a PAC-ID
-from labfreed.utilities.well_known_keys import WellKnownKeys
-pac = PACID(issuer='METTORIUS:COM', identifier=[IDSegment(key=WellKnownKeys.SERIAL, value='1234')])
-pac_str = pac.serialize()
-pac_str = pac.serialize()
-print(pac_str)
-
-
-
-
-# create a TREX
-from labfreed.TREX.data_model import TREX, DateSegment, NumericSegment, BoolSegment, AlphanumericSegment, TextSegment, BinarySegment
-
-trex = TREX(name_='DEMO-TREX')
-
-trex.segments.append(DateSegment(key='START',value='20240505T1204'))
-trex.segments.append(DateSegment(key='STOP', value=datetime(year=2024,month=5,day=5,hour=13,minute=6)) )
-
-trex.segments.append(NumericSegment(key='TEMP',type='KEL', value=10.15) )
-trex.segments.append(BoolSegment(key='OK', value=False) )
-trex.segments.append(AlphanumericSegment(key='COMMENT', value='FOO') )
-trex.segments.append(TextSegment(key='COMMENT2', value='£') )
-trex.segments.append(TextSegment(key='COMMENT2', value='BAR') )
-
-# if the sting is already in base36 you have to be explicit
-from labfreed.utilities.base36 import base36
-trex.segments.append(TextSegment(key='COMMENT3', value=base36('1URIOQ7')) )
-
-# table
-table = TREX_Table(key='TABLE', 
-                   column_headers=[
-                                    ColumnHeader(key='COL1', type='HUR'), 
-                                    ColumnHeader(key='COL2', type='T.A'),
-                                    ColumnHeader(key='COL3', type='T.D'),
-                                    ColumnHeader(key='COL4', type='T.B')
-                                    ],
-                   data=[
-                       TableRow()
-                   ])
-trex.segments.append(table)
-
-if trex.is_valid():
-    print(trex.data)
-else:
-    trex.print_validation_messages()
-    
-
-p = PACID_With_Extensions(pac_id=pac, extensions=[trex])
-print(p.serialize())
-
-
-
-
-
-# for convenience a TREX can be created from a dict
-trex2 = TREX(name_='DEMO-TREX2')
-trex2.update(   
-                    {
-                        'STOP': datetime(year=2024,month=5,day=5,hour=13,minute=6),
-                        'TEMP': Quantity(value=10.15, unit_name='meter', unit_symbol='m'),
-                        'OK':False,
-                        'COMMENT': 'FOO',
-                        'COMMENT2':'£'
-                    }
-)
-
-d = trex2.dict()
-
-
-
-    
-
-
-
-

labfreed-0.0.13/update_readme.py

@@ -1,27 +0,0 @@
-# update_readme.py
-start_marker = "<!-- BEGIN EXAMPLES -->"
-end_marker = "<!-- END EXAMPLES -->"
-
-with open("examples.py", encoding='utf-8') as ex_file:
-    example_code = ex_file.read()
-
-# Optional: Format as Markdown code block
-example_code_md = f"```python\n{example_code}\n```"
-
-with open("README.md", encoding='utf-8') as readme_file:
-    readme = readme_file.read()
-
-if not readme:
-    raise ValueError('README.md is empty')
-
-# Replace the section between markers
-new_readme = (
-    readme.split(start_marker)[0]
-    + start_marker + "\n"
-    + example_code_md + "\n"
-    + end_marker
-    + readme.split(end_marker)[1]
-)
-
-with open("README.md", "w", encoding='utf-8') as readme_file:
-    readme_file.write(new_readme)