labfreed 0.2.5a22__tar.gz → 0.2.6a2__tar.gz

{labfreed-0.2.5a22 → labfreed-0.2.6a2}/CHANGELOG.md

@@ -2,6 +2,7 @@
 ### v0.2.5
 - resolvers checks service states by default
 - improvements and bugfixes in conversion from python types to TREX
+- follow better naming conventions in CIT v1 
   
 ### v0.2.4
 - improvements in formatting of validation messages

{labfreed-0.2.5a22 → labfreed-0.2.6a2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: labfreed
-Version: 0.2.5a22
+Version: 0.2.6a2
 Summary: Python implementation of LabFREED building blocks
 Author-email: Reto Thürer <thuerer.r@buchi.com>
 Requires-Python: >=3.11
@@ -27,6 +27,10 @@ Requires-Dist: pytest>=8.3.5 ; extra == "dev"
 Requires-Dist: pdoc>=15.0.1 ; extra == "dev"
 Requires-Dist: flit>=3.12.0 ; extra == "dev"
 Requires-Dist: ruff>=0.11.5 ; extra == "dev"
+Project-URL: Documentation, https://github.com/retothuerer/LabFREED?tab=readme-ov-file#readme
+Project-URL: Homepage, https://github.com/retothuerer/LabFREED
+Project-URL: Source, https://github.com/retothuerer/LabFREED
+Project-URL: Tracker, https://github.com/retothuerer/LabFREED/issues
 Provides-Extra: dev
 
 # LabFREED for Python
@@ -101,7 +105,7 @@ pac.print_validation_messages()
 >> Validation Results                                                                                                                   
 >> ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
 >> │ **RECOMMENDATION** in id segment value bal500                                                                                     │
->> │ Characters 'a','l','b' should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+'  │
+>> │ Characters 'b','l','a' should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+'  │
 >> │                                                                                                                                   │
 >> │ HTTPS://PAC.METTORIUS.COM/-MD/240:👉bal👈500/21:@1234                                                                             │
 >> ├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
@@ -111,7 +115,7 @@ pac.print_validation_messages()
 >> │ HTTPS://PAC.METTORIUS.COM/-MD/240:bal500/21:👉@👈1234                                                                             │
 >> ├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
 >> │ **RECOMMENDATION** in id segment value bal500                                                                                     │
->> │ Characters 'a','l','b' should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+'  │
+>> │ Characters 'b','l','a' should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+'  │
 >> │                                                                                                                                   │
 >> │ HTTPS://PAC.METTORIUS.COM/-MD/240:👉bal👈500/21:@1234                                                                             │
 >> ├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
@@ -244,7 +248,7 @@ trex.print_validation_messages()
 >> Validation Results                                            
 >> ┌────────────────────────────────────────────────────────────┐
 >> │ **ERROR** in TREX table column Date                        │
->> │ Column header key contains invalid characters: 'a','t','e' │
+>> │ Column header key contains invalid characters: 'e','a','t' │
 >> │                                                            │
 >> │ STOP$T.D:20240505T1306                                     │
 >> │ +TEMP$KEL:10.15                                            │
@@ -252,9 +256,9 @@ trex.print_validation_messages()
 >> │ +COMMENT$T.A:FOO                                           │
 >> │ +COMMENT2$T.T:12G3                                         │
 >> │ +TABLE$$DURATION$HUR:D👉ate👈$T.D:OK$T.B:COMMENT$T.A::     │
->> │  1:20250425T081731.192:T:FOO::                             │
->> │  1.1:20250425T081731.192:T:BAR::                           │
->> │  1.3:20250425T081731.192:F:BLUBB                           │
+>> │  1:20250430T100239.279:T:FOO::                             │
+>> │  1.1:20250430T100239.280:T:BAR::                           │
+>> │  1.3:20250430T100239.280:F:BLUBB                           │
 >> └────────────────────────────────────────────────────────────┘
 ```
 #### Combine PAC-ID and TREX and serialize
@@ -266,7 +270,7 @@ pac_str = pac.to_url()
 print(pac_str)
 ```
 ```text
->> HTTPS://PAC.METTORIUS.COM/21:1234*MYTREX$TREX/STOP$T.D:20240505T1306+TEMP$KEL:10.15+OK$T.B:F+COMMENT$T.A:FOO+COMMENT2$T.T:12G3+TABLE$$DURATION$HUR:Date$T.D:OK$T.B:COMMENT$T.A::1:20250425T081731.192:T:FOO::1.1:20250425T081731.192:T:BAR::1.3:20250425T081731.192:F:BLUBB
+>> HTTPS://PAC.METTORIUS.COM/21:1234*MYTREX$TREX/STOP$T.D:20240505T1306+TEMP$KEL:10.15+OK$T.B:F+COMMENT$T.A:FOO+COMMENT2$T.T:12G3+TABLE$$DURATION$HUR:Date$T.D:OK$T.B:COMMENT$T.A::1:20250430T100239.279:T:FOO::1.1:20250430T100239.280:T:BAR::1.3:20250430T100239.280:F:BLUBB
 ```
 ## PAC-ID Resolver
 
@@ -292,7 +296,6 @@ cit2.origin = 'MY_COMPANY'
 pac_str = 'HTTPS://PAC.METTORIUS.COM/-MS/X3511/CAS:7732-18-5'
 service_groups = PAC_ID_Resolver(cits=[cit, cit2]).resolve(pac_str)
 for sg in service_groups:
-    sg.update_states()
     sg.print()
     
 ```
@@ -324,6 +327,15 @@ for sg in service_groups:
 
 <!-- BEGIN CHANGELOG -->
 ## Change Log
+### v0.2.5
+- resolvers checks service states by default
+- improvements and bugfixes in conversion from python types to TREX
+- follow better naming conventions in CIT v1 
+  
+### v0.2.4
+- improvements in formatting of validation messages
+- bugfix in DataTable
+ 
 ### v0.2.3
 - improvements in formatting of validation messages
 - bugfix in DisplayNameExtension

{labfreed-0.2.5a22 → labfreed-0.2.6a2}/README.md

@@ -70,7 +70,7 @@ pac.print_validation_messages()
 >> Validation Results                                                                                                                   
 >> ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
 >> │ **RECOMMENDATION** in id segment value bal500                                                                                     │
->> │ Characters 'a','l','b' should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+'  │
+>> │ Characters 'b','l','a' should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+'  │
 >> │                                                                                                                                   │
 >> │ HTTPS://PAC.METTORIUS.COM/-MD/240:👉bal👈500/21:@1234                                                                             │
 >> ├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
@@ -80,7 +80,7 @@ pac.print_validation_messages()
 >> │ HTTPS://PAC.METTORIUS.COM/-MD/240:bal500/21:👉@👈1234                                                                             │
 >> ├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
 >> │ **RECOMMENDATION** in id segment value bal500                                                                                     │
->> │ Characters 'a','l','b' should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+'  │
+>> │ Characters 'b','l','a' should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+'  │
 >> │                                                                                                                                   │
 >> │ HTTPS://PAC.METTORIUS.COM/-MD/240:👉bal👈500/21:@1234                                                                             │
 >> ├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
@@ -213,7 +213,7 @@ trex.print_validation_messages()
 >> Validation Results                                            
 >> ┌────────────────────────────────────────────────────────────┐
 >> │ **ERROR** in TREX table column Date                        │
->> │ Column header key contains invalid characters: 'a','t','e' │
+>> │ Column header key contains invalid characters: 'e','a','t' │
 >> │                                                            │
 >> │ STOP$T.D:20240505T1306                                     │
 >> │ +TEMP$KEL:10.15                                            │
@@ -221,9 +221,9 @@ trex.print_validation_messages()
 >> │ +COMMENT$T.A:FOO                                           │
 >> │ +COMMENT2$T.T:12G3                                         │
 >> │ +TABLE$$DURATION$HUR:D👉ate👈$T.D:OK$T.B:COMMENT$T.A::     │
->> │  1:20250425T081731.192:T:FOO::                             │
->> │  1.1:20250425T081731.192:T:BAR::                           │
->> │  1.3:20250425T081731.192:F:BLUBB                           │
+>> │  1:20250430T100239.279:T:FOO::                             │
+>> │  1.1:20250430T100239.280:T:BAR::                           │
+>> │  1.3:20250430T100239.280:F:BLUBB                           │
 >> └────────────────────────────────────────────────────────────┘
 ```
 #### Combine PAC-ID and TREX and serialize
@@ -235,7 +235,7 @@ pac_str = pac.to_url()
 print(pac_str)
 ```
 ```text
->> HTTPS://PAC.METTORIUS.COM/21:1234*MYTREX$TREX/STOP$T.D:20240505T1306+TEMP$KEL:10.15+OK$T.B:F+COMMENT$T.A:FOO+COMMENT2$T.T:12G3+TABLE$$DURATION$HUR:Date$T.D:OK$T.B:COMMENT$T.A::1:20250425T081731.192:T:FOO::1.1:20250425T081731.192:T:BAR::1.3:20250425T081731.192:F:BLUBB
+>> HTTPS://PAC.METTORIUS.COM/21:1234*MYTREX$TREX/STOP$T.D:20240505T1306+TEMP$KEL:10.15+OK$T.B:F+COMMENT$T.A:FOO+COMMENT2$T.T:12G3+TABLE$$DURATION$HUR:Date$T.D:OK$T.B:COMMENT$T.A::1:20250430T100239.279:T:FOO::1.1:20250430T100239.280:T:BAR::1.3:20250430T100239.280:F:BLUBB
 ```
 ## PAC-ID Resolver
 
@@ -261,7 +261,6 @@ cit2.origin = 'MY_COMPANY'
 pac_str = 'HTTPS://PAC.METTORIUS.COM/-MS/X3511/CAS:7732-18-5'
 service_groups = PAC_ID_Resolver(cits=[cit, cit2]).resolve(pac_str)
 for sg in service_groups:
-    sg.update_states()
     sg.print()
     
 ```
@@ -293,6 +292,15 @@ for sg in service_groups:
 
 <!-- BEGIN CHANGELOG -->
 ## Change Log
+### v0.2.5
+- resolvers checks service states by default
+- improvements and bugfixes in conversion from python types to TREX
+- follow better naming conventions in CIT v1 
+  
+### v0.2.4
+- improvements in formatting of validation messages
+- bugfix in DataTable
+ 
 ### v0.2.3
 - improvements in formatting of validation messages
 - bugfix in DisplayNameExtension

{labfreed-0.2.5a22 → labfreed-0.2.6a2}/labfreed/__init__.py

@@ -2,7 +2,7 @@
 Python implementation of LabFREED building blocks
 '''
 
-__version__ = "0.2.5a22"
+__version__ = "0.2.6a2"
 
 from labfreed.pac_id import *  # noqa: F403
 from labfreed.pac_cat import * # noqa: F403

{labfreed-0.2.5a22 → labfreed-0.2.6a2}/labfreed/labfreed_infrastructure.py

@@ -179,6 +179,7 @@ class LabFREED_BaseModel(PDOC_Workaround_Base):
 
         logging.info(table)
         print(table)
+        return table
         
         
     def format_validation_messages(self, target='console') -> list[str]:
@@ -195,7 +196,7 @@ class LabFREED_BaseModel(PDOC_Workaround_Base):
             if m.level == ValidationMsgLevel.ERROR:
                 color = 'red'
             else:
-                color = 'yellow'
+                color = 'orange'
                 
             match target:
                 case 'markdown':
@@ -217,6 +218,7 @@ class LabFREED_BaseModel(PDOC_Workaround_Base):
                     br = '<br>'
                 
             serialized = str(self)
+            serialized.replace('\n', br)
             emphazised_highlight = self._emphasize_in(m, serialized, fmt=fmt)
             emphazised_highlight = emphazised_highlight.replace('👈👉','') # removes two consecutive markers, to make it cleaner
             

{labfreed-0.2.5a22 → labfreed-0.2.6a2}/labfreed/pac_id/url_parser.py

@@ -1,5 +1,6 @@
 
 
+import logging
 import re
 from types import MappingProxyType
 
@@ -73,6 +74,7 @@ class PAC_Parser():
         pac_id.extensions = extensions
             
         if not pac_id.is_valid and not suppress_validation_errors:
+            logging.error(pac_id.print_validation_messages())
             raise LabFREED_ValidationError(validation_msgs = pac_id._get_nested_validation_messages())
         
         return pac_id

{labfreed-0.2.5a22 → labfreed-0.2.6a2}/labfreed/pac_id_resolver/cit_v1.py

@@ -48,6 +48,7 @@ class CIT_v1(LabFREED_BaseModel):
                                     applicable_if        = cols[3],
                                     template_url         = cols[4]
                                     )
+                entries.append(entry) 
             except ValueError:
                 logging.error(f'invalid line {line}')
                 msg = ValidationMessage(
@@ -59,13 +60,15 @@ class CIT_v1(LabFREED_BaseModel):
                 )
                 errors.append(msg)
 
-            entries.append(entry)           
+                      
         cit = CIT_v1(origin=origin, entries=entries)
         cit._validation_messages.extend(errors)
         cit._csv_original = csv
         return cit
     
-    def evaluate_pac_id(self, pac):
+    def evaluate_pac_id(self, pac:PAC_ID):
+        if not type(pac) is PAC_ID:
+            raise ValueError(f'CIT v1 does only handle PAC-IDs. PAC-CAT it does not know what to do')
         cit_evaluated = ServiceGroup(origin=self.origin)   
         for e in self.entries:
             conditions = e.applicable_if.split(';')

{labfreed-0.2.5a22 → labfreed-0.2.6a2}/labfreed/pac_id_resolver/resolver.py

@@ -19,18 +19,19 @@ __all__ = ["PAC_ID_Resolver"]
 def load_cit(path):
     with open(path, 'r') as f:
         s = f.read()
-        return _cit_from_str(s)
+        return cit_from_str(s)
 
     
-def _cit_from_str(s:str, issuer:str='') -> CIT_v1|CIT_v2:
+def cit_from_str(s:str, origin:str='') -> CIT_v1|CIT_v2:
     try:
         cit_yml= yaml.safe_load(s)
         cit2 = CIT_v2.from_yaml(cit_yml)
+        cit_version = 'v2'
     except Exception:
         cit2 = None
-    
     try:
-        cit1 = CIT_v1.from_csv(s, issuer)
+        cit1 = CIT_v1.from_csv(s, origin)
+        cit_version = 'v1'
     except Exception:
         cit1 = None
     
@@ -50,7 +51,7 @@ def _get_issuer_cit(issuer:str):
     except Exception:
         logging.error(f"Could not get CIT form {issuer}")
         cit_str  = None
-    cit = _cit_from_str(cit_str, issuer=issuer)
+    cit = cit_from_str(cit_str, origin=issuer)
     return cit
     
 
@@ -63,15 +64,23 @@ class PAC_ID_Resolver():
         self._cits = cits
             
         
-    def resolve(self, pac_id:PAC_ID|str, check_service_status=True) -> list[ServiceGroup]:
+    def resolve(self, pac_url:PAC_ID|str, check_service_status=True) -> list[ServiceGroup]:
         '''Resolve a PAC-ID'''
-        if isinstance(pac_id, str):
-            pac_id = PAC_CAT.from_url(pac_id)
+        if isinstance(pac_url, str):
+            pac_id = PAC_CAT.from_url(pac_url)
+            pac_id_catless = PAC_ID.from_url(pac_url, try_pac_cat=False)
                 
+        cits = self._cits.copy()
         if issuer_cit := _get_issuer_cit(pac_id.issuer):
-            self._cits.append(issuer_cit)
+            cits.append(issuer_cit)
          
-        matches = [cit.evaluate_pac_id(pac_id) for cit in self._cits]
+        matches = []
+        for cit in cits:
+            if isinstance(cit, CIT_v1):
+                # cit v1 has no concept of categories and implied keys. It would treat these segments as value segment
+                matches.append(cit.evaluate_pac_id(pac_id_catless))
+            else:
+                matches.append(cit.evaluate_pac_id(pac_id))
         
         if check_service_status:
             for m in matches:

{labfreed-0.2.5a22 → labfreed-0.2.6a2}/pyproject.toml

@@ -39,6 +39,12 @@ dev = [
     "ruff>=0.11.5"
 ]
 
+[project.urls]
+Homepage = "https://github.com/retothuerer/LabFREED"
+Documentation = "https://github.com/retothuerer/LabFREED?tab=readme-ov-file#readme"
+Source = "https://github.com/retothuerer/LabFREED"
+Tracker = "https://github.com/retothuerer/LabFREED/issues"
+
 [tool.flit.module]
 name = "labfreed"