labfreed 0.2.1__py3-none-any.whl → 0.2.2__py3-none-any.whl

labfreed/__init__.py

@@ -2,7 +2,10 @@
 Python implementation of LabFREED building blocks
 '''
 
-__version__ = "0.2.1"
+__version__ = "0.2.2"
 
-from labfreed.pac_id import PAC_ID  # noqa: F401
-from labfreed.labfreed_infrastructure import LabFREED_ValidationError  # noqa: F401
+from labfreed.pac_id import *  # noqa: F403
+from labfreed.pac_cat import * # noqa: F403
+from labfreed.pac_id_resolver import * # noqa: F403
+from labfreed.trex import * # noqa: F403
+from labfreed.labfreed_infrastructure import *  # noqa: F403

labfreed/labfreed_infrastructure.py

@@ -177,7 +177,7 @@ class LabFREED_BaseModel(PDOC_Workaround_Base):
     
     
     def print_validation_messages(self, target='console'):
-        msgs = self._get_nested_validation_messages()
+        msgs = self.format_validation_messages(target=target)
         
         table = Table(title="Validation Results", show_header=False, title_justify='left')
 
@@ -185,12 +185,29 @@ class LabFREED_BaseModel(PDOC_Workaround_Base):
             return table.add_column(s, vertical='top')
         col("-")
         
-             
         if not msgs:
             table.add_row('All clear!', end_section=True)
             return
 
         for m in msgs:
+            table.add_row(m)
+            table.add_section()
+
+        logging.info(table)
+        print(table)
+        
+        
+    def format_validation_messages(self, target='console') -> list[str]:
+        """Format validation messages
+
+        Args:
+            target (str, optional): Target format: 'markdown', 'console', 'html', 'html_styled'.
+
+        Returns:
+            list[str]: formated messages
+        """
+        formatted_msg = list()
+        for m in self.validation_messages():
             if m.level == ValidationMsgLevel.ERROR:
                 color = 'red'
             else:
@@ -213,12 +230,9 @@ class LabFREED_BaseModel(PDOC_Workaround_Base):
             txt =       f'[bold {color}]{m.level.name} [/bold {color}] in {m.source}'
             txt += '\n' + f'{m.msg}'
             txt += '\n\n' + emphazised_highlight
-
-            table.add_row( txt)
-            table.add_section()
-
-        logging.info(table)
-        print(table)
+            
+            formatted_msg.append(txt)
+        return formatted_msg
             
 
         

labfreed/pac_cat/__init__.py

@@ -1,6 +1,9 @@
 from .pac_cat import PAC_CAT
 from .category_base import Category
-from .predefined_categories import Material_Device, Material_Substance, Material_Consumable, Material_Misc, Data_Method, Data_Result, Data_Progress, Data_Calibration, Data_Abstract
+from .predefined_categories import (
+    Material_Device, Material_Substance, Material_Consumable, Material_Misc, Data_Method, Data_Result, Data_Progress, 
+    Data_Calibration, Data_Abstract, category_key_to_class_map
+    )
 
 __all__ = [
     "PAC_CAT",

labfreed/pac_cat/pac_cat.py

@@ -10,7 +10,7 @@ from rich.table import Table
 from labfreed.labfreed_infrastructure import ValidationMsgLevel
 
 from labfreed.pac_cat.category_base import Category
-from labfreed.pac_cat.predefined_categories import Data_Calibration, Data_Method, Data_Progress, Data_Result, Material_Consumable, Material_Device, Material_Misc, Material_Substance, Data_Static
+from labfreed.pac_cat.predefined_categories import category_key_to_class_map
 from labfreed.pac_id.id_segment import IDSegment
 from labfreed.pac_id.pac_id import PAC_ID
 
@@ -68,18 +68,7 @@ class PAC_CAT(PAC_ID):
         category_key = segments[0].value         
         segments.pop(0)
         
-        mapping  = {
-                '-MD': Material_Device,
-                '-MS': Material_Substance,
-                '-MC': Material_Consumable,
-                '-MM': Material_Misc,
-                '-DM': Data_Method,
-                '-DR': Data_Result,
-                '-DC': Data_Calibration,
-                '-DP': Data_Progress,
-                '-DS': Data_Static 
-        }
-        known_cat = mapping.get(category_key)
+        known_cat = category_key_to_class_map.get(category_key)
         
         if not known_cat:
             return Category(key=category_key, segments=segments)
@@ -157,3 +146,5 @@ class PAC_CAT(PAC_ID):
             table.add_section()        
         print(table)
         
+
+        

labfreed/pac_cat/predefined_categories.py

@@ -188,3 +188,14 @@ class Data_Static(Data_Abstract):
     ''' Category segments, which are not defined in the specification'''
     
     
+category_key_to_class_map  = {
+        '-MD': Material_Device,
+        '-MS': Material_Substance,
+        '-MC': Material_Consumable,
+        '-MM': Material_Misc,
+        '-DM': Data_Method,
+        '-DR': Data_Result,
+        '-DC': Data_Calibration,
+        '-DP': Data_Progress,
+        '-DS': Data_Static 
+}

{labfreed-0.2.1.dist-info → labfreed-0.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: labfreed
-Version: 0.2.1
+Version: 0.2.2
 Summary: Python implementation of LabFREED building blocks
 Author-email: Reto Thürer <thuerer.r@buchi.com>
 Requires-Python: >=3.11
@@ -98,30 +98,28 @@ There is a nice function to highlight problems
 pac.print_validation_messages()
 ```
 ```text
->> 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  │
->> │ '+'                                                                                                                           │
->> │                                                                                                                               │
->> │ HTTPS://PAC.METTORIUS.COM/-MD/240:👉bal👈500/21:@1234                                                                         │
->> ├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
->> │ RECOMMENDATION  in id segment value @1234                                                                                     │
->> │ Characters '@' should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+'      │
->> │                                                                                                                               │
->> │ 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  │
->> │ '+'                                                                                                                           │
->> │                                                                                                                               │
->> │ HTTPS://PAC.METTORIUS.COM/-MD/240:👉bal👈500/21:@1234                                                                         │
->> ├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
->> │ RECOMMENDATION  in id segment value @1234                                                                                     │
->> │ Characters '@' should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+'      │
->> │                                                                                                                               │
->> │ HTTPS://PAC.METTORIUS.COM/-MD/240:bal500/21:👉@👈1234                                                                         │
->> └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
+>> Validation Results                                                                                                                   
+>> ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
+>> │ RECOMMENDATION  in id segment value bal500                                                                                        │
+>> │ 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                                                                             │
+>> ├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
+>> │ RECOMMENDATION  in id segment value @1234                                                                                         │
+>> │ Characters '@' should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+'          │
+>> │                                                                                                                                   │
+>> │ HTTPS://PAC.METTORIUS.COM/-MD/240:bal500/21:👉@👈1234                                                                             │
+>> ├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
+>> │ RECOMMENDATION  in id segment value bal500                                                                                        │
+>> │ 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                                                                             │
+>> ├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
+>> │ RECOMMENDATION  in id segment value @1234                                                                                         │
+>> │ Characters '@' should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+'          │
+>> │                                                                                                                                   │
+>> │ HTTPS://PAC.METTORIUS.COM/-MD/240:bal500/21:👉@👈1234                                                                             │
+>> └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
 ```
 ### Save as QR Code
 
@@ -141,7 +139,7 @@ PAC-CAT defines a (optional) way how the identifier is structured.
 PAC_ID.from_url() automatically converts to PAC-CAT if possible.
 
 ```python
-from labfreed.pac_cat import PAC_CAT  
+from labfreed import PAC_CAT  
 pac_str = 'HTTPS://PAC.METTORIUS.COM/-DR/XQ908756/-MD/bal500/@1234'
 pac = PAC_ID.from_url(pac_str)
 if isinstance(pac, PAC_CAT):
@@ -197,7 +195,7 @@ print(f'WEIGHT = {v.value}')
 #### Create PAC-ID
 
 ```python
-from labfreed.pac_id import PAC_ID, IDSegment  
+from labfreed import PAC_ID, IDSegment  
 from labfreed.well_known_keys.labfreed.well_known_keys import WellKnownKeys  
 
 pac = PAC_ID(issuer='METTORIUS.COM', identifier=[IDSegment(key=WellKnownKeys.SERIAL, value='1234')])
@@ -213,9 +211,9 @@ Note that utility types for Quantity (number with unit) and table are needed
 
 ```python
 from datetime import datetime  
-from labfreed.trex.python_convenience.pyTREX import pyTREX  
-from labfreed.trex.python_convenience.data_table import DataTable  
-from labfreed.trex.python_convenience.quantity import Quantity  
+from labfreed.trex.python_convenience import pyTREX  
+from labfreed.trex.python_convenience import DataTable  
+from labfreed.trex.python_convenience import Quantity  
 
 # Value segments of different type
 segments = {
@@ -246,7 +244,7 @@ trex.print_validation_messages()
 >> Validation Results                                            
 >> ┌────────────────────────────────────────────────────────────┐
 >> │ ERROR  in TREX table column Date                           │
->> │ Column header key contains invalid characters: 'a','e','t' │
+>> │ Column header key contains invalid characters: 'e','t','a' │
 >> │                                                            │
 >> │ STOP$T.D:20240505T1306                                     │
 >> │ +TEMP$KEL:10.15                                            │
@@ -254,9 +252,9 @@ trex.print_validation_messages()
 >> │ +COMMENT$T.A:FOO                                           │
 >> │ +COMMENT2$T.T:QMDTNXIKU                                    │
 >> │ +TABLE$$DURATION$HUR:D👉ate👈$T.D:OK$T.B:COMMENT$T.A::     │
->> │  1:20250424T161739.312:T:FOO::                             │
->> │  1.1:20250424T161739.312:T:BAR::                           │
->> │  1.3:20250424T161739.312:F:BLUBB                           │
+>> │  1:20250424T200626.801:T:FOO::                             │
+>> │  1.1:20250424T200626.801:T:BAR::                           │
+>> │  1.3:20250424T200626.801:F:BLUBB                           │
 >> └────────────────────────────────────────────────────────────┘
 ```
 #### Combine PAC-ID and TREX and serialize
@@ -268,12 +266,12 @@ 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:QMDTNXIKU+TABLE$$DURATION$HUR:Date$T.D:OK$T.B:COMMENT$T.A::1:20250424T161739.312:T:FOO::1.1:20250424T161739.312:T:BAR::1.3:20250424T161739.312: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:QMDTNXIKU+TABLE$$DURATION$HUR:Date$T.D:OK$T.B:COMMENT$T.A::1:20250424T200626.801:T:FOO::1.1:20250424T200626.801:T:BAR::1.3:20250424T200626.801:F:BLUBB
 ```
 ## PAC-ID Resolver
 
 ```python
-from labfreed.pac_id_resolver import PAC_ID_Resolver, load_cit  
+from labfreed import PAC_ID_Resolver, load_cit  
 # Get a CIT
 dir = os.path.join(os.getcwd(), 'examples')
 p = os.path.join(dir, 'cit_mine.yaml')       
@@ -299,7 +297,26 @@ for sg in service_groups:
     
 ```
 ```text
->> [Error during execution: No Internet Connection]
+>> Services from origin 'PERSONAL                         
+>> ┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┓
+>> ┃ Service Name ┃ URL                                               ┃ Reachable ┃
+>> ┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━┩
+>> │ CAS Search   │ https://pubchem.ncbi.nlm.nih.gov/#query=7732-18-5 │ ACTIVE    │
+>> └──────────────┴───────────────────────────────────────────────────┴───────────┘
+>>                                     Services from origin 'MY_COMPANY                                    
+>> ┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┓
+>> ┃ Service Name        ┃ URL                                                                ┃ Reachable ┃
+>> ┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━┩
+>> │ Chemical Management │ https://chem-manager.com/METTORIUS.COM/-MS/240:X3511/CAS:7732-18-5 │ INACTIVE  │
+>> └─────────────────────┴────────────────────────────────────────────────────────────────────┴───────────┘
+>>              Services from origin 'METTORIUS.COM              
+>> ┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┓
+>> ┃ Service Name ┃ URL                             ┃ Reachable ┃
+>> ┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━┩
+>> │ CoA          │ https://mettorius.com/CoA.pdf   │ ACTIVE    │
+>> │ MSDS         │ https://mettorius.com/MSDS.pdf  │ ACTIVE    │
+>> │ Shop         │ https://mettorius.com/shop.html │ ACTIVE    │
+>> └──────────────┴─────────────────────────────────┴───────────┘
 ```
 <!-- END EXAMPLES -->
 
@@ -307,6 +324,9 @@ for sg in service_groups:
 
 <!-- BEGIN CHANGELOG -->
 ## Change Log
+### v0.2.2
+- minor changes for better access of subfunctions. No change in existing API
+  
 ### v0.2.1
 - improved docu. no code changes
 
@@ -329,6 +349,7 @@ for sg in service_groups:
 - supports PAC-ID, PAC-CAT, TREX and DisplayName
 - QR generation 
 - ok-ish test coverage
+<!-- END CHANGELOG -->
 
 # Attributions
 The following tools were used:
@@ -336,4 +357,4 @@ The following tools were used:
 - [Pydantic](https://docs.pydantic.dev/latest/)
 - json with UNECE units from (https://github.com/quadient/unece-units/blob/main/python/src/unece_excel_parser/parsedUneceUnits.json)
 - json with GS1 codes from (https://ref.gs1.org/ai/GS1_Application_Identifiers.jsonld)
-<!-- END CHANGELOG -->
+

{labfreed-0.2.1.dist-info → labfreed-0.2.2.dist-info}/RECORD

@@ -1,9 +1,9 @@
-labfreed/__init__.py,sha256=CgFS3IzTYiq7S4f4VZzeneIGDHNBVqFn-9BQ0xCpzbQ,224
-labfreed/labfreed_infrastructure.py,sha256=V-5sLhqKkfckKim5VxlB_D1qIzk-Ztxfx4VIlwaR6Jc,10850
-labfreed/pac_cat/__init__.py,sha256=rJ2dFTN8aErTvGf4xwcNZ04xrbTieLAE2v5C2bmgPOA,507
+labfreed/__init__.py,sha256=uSmYPYE1cNYpdOYNFUoI-chJ0T0Jh_4r50mfhTvzLiY,336
+labfreed/labfreed_infrastructure.py,sha256=SZhwBN66ti5ABH1eHOu3a6j5uRWaMKQ3wb1pj-NlTu0,11322
+labfreed/pac_cat/__init__.py,sha256=S4T-QgzcEDjup44WvHCY3_K30B6_e8ducR--DxBb_DM,554
 labfreed/pac_cat/category_base.py,sha256=lFQNiTUukyhWdaSCAI7CZxLtj6kNtnBCE4UsePwsGqE,1801
-labfreed/pac_cat/pac_cat.py,sha256=UxWyPsuZsekq3ZmHSQLBdB1tocvVlxz_FOQXxHg_dlU,5800
-labfreed/pac_cat/predefined_categories.py,sha256=BEf7rxN5IcKVhuxMNhdfQ_1xnkax5l8Z1pJMRIROKpw,8510
+labfreed/pac_cat/pac_cat.py,sha256=AJUYDsyGOHy-sRRpXpY0awtbf3HCvn3RhMax6ofvYRA,5318
+labfreed/pac_cat/predefined_categories.py,sha256=5wnMCj-CrACV2W4lH13w7qynWIwi506G3uLNcxuJQGg,8832
 labfreed/pac_id/__init__.py,sha256=NGMbzkwQ4txKeT5pxdIZordwHO8J3_q84jzPanjKoHg,675
 labfreed/pac_id/extension.py,sha256=uIs_9aasJ_n7ua067wR7XvtL05H-JZP4f_HtW4qnQDw,1114
 labfreed/pac_id/id_segment.py,sha256=r5JU1SJuRXhZJJxy5T3xjrb598wIDTLpivSJhIUAzjQ,4526
@@ -38,7 +38,7 @@ labfreed/well_known_keys/labfreed/well_known_keys.py,sha256=nqk66kHdSwJTJfMKlP-x
 labfreed/well_known_keys/unece/UneceUnits.json,sha256=kwfQSp_nTuWbADfBBgqTWrvPl6XtM5SedEVLbMJrM7M,898953
 labfreed/well_known_keys/unece/__init__.py,sha256=MSP9lmjg9_D9iqG9Yq2_ajYfQSNS9wIT7FXA1c--59M,122
 labfreed/well_known_keys/unece/unece_units.py,sha256=gNDQk6KGl-nGMf9Ycq_fQ8P2xxKITgLkcQWPd4H49gI,1630
-labfreed-0.2.1.dist-info/licenses/LICENSE,sha256=gHFOv9FRKHxO8cInP3YXyPoJnuNeqrvcHjaE_wPSsQ8,1100
-labfreed-0.2.1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-labfreed-0.2.1.dist-info/METADATA,sha256=TZAAEd3mlli0oXeEkQ7x5kbfpwMI59mx8WVIbS5KxQU,14965
-labfreed-0.2.1.dist-info/RECORD,,
+labfreed-0.2.2.dist-info/licenses/LICENSE,sha256=gHFOv9FRKHxO8cInP3YXyPoJnuNeqrvcHjaE_wPSsQ8,1100
+labfreed-0.2.2.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+labfreed-0.2.2.dist-info/METADATA,sha256=T4rheRh4e31HYkTSjIc4ljZU8oFxxzuQJcEUgeQP1rY,17996
+labfreed-0.2.2.dist-info/RECORD,,