labfreed 0.2.0b2__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.0b2"
+__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/category_base.py

@@ -41,7 +41,7 @@ class Category(LabFREED_BaseModel):
     
     
     def __str__(self):
-        s = '\n'.join( [f'{field_name} \t ({field_info.alias or ''}): \t {getattr(self, field_name)}' for  field_name, field_info in self.model_fields.items() if getattr(self, field_name)]) 
+        s = '\n'.join( [f"{field_name} \t ({field_info.alias or ''}): \t {getattr(self, field_name)}" for  field_name, field_info in self.model_fields.items() if getattr(self, field_name)]) 
         return s 
 
 

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/pac_id_resolver/cit_v1.py

@@ -110,7 +110,7 @@ class CIT_v1(LabFREED_BaseModel):
             i = int(m.group(1)) - 1 # CIT is 1 based
             seg = pac.identifier[i] if i < len(pac.identifier) else None
             if seg:
-                return f"{(seg.key + ':') if seg.key else ""}{seg.value}"
+                return f"{(seg.key + ':') if seg.key else ''}{seg.value}"
             
         elif m := re.match(r'\{idVal(\w+)\}', value):
             k = m.group(1)

{labfreed-0.2.0b2.dist-info → labfreed-0.2.2.dist-info}/METADATA

@@ -1,10 +1,11 @@
 Metadata-Version: 2.4
 Name: labfreed
-Version: 0.2.0b2
+Version: 0.2.2
 Summary: Python implementation of LabFREED building blocks
 Author-email: Reto Thürer <thuerer.r@buchi.com>
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
@@ -30,11 +31,8 @@ Provides-Extra: dev
 
 # 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)
+[![PyPI](https://img.shields.io/pypi/v/labfreed.svg)](https://pypi.org/project/labfreed/) ![Python Version](https://img.shields.io/pypi/pyversions/labfreed) [![Test Labfreed](https://github.com/retothuerer/LabFREED/actions/workflows/run-tests.yml/badge.svg)](https://github.com/retothuerer/LabFREED/actions/workflows/run-tests.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) 
 
-<!--
-[![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](https://labfreed.wega-it.com) building blocks.
 
@@ -72,14 +70,13 @@ pip install labfreed
 # import built ins
 import os
 
-target = 'console'
+
 ```
 ### Parse a simple PAC-ID
 
 ```python
 # Parse the PAC-ID
-from labfreed.labfreed_infrastructure import LabFREED_ValidationError  # noqa: E402
-from labfreed import PAC_ID, LabFREED_ValidationError  # noqa: E402, F811
+from labfreed import PAC_ID, LabFREED_ValidationError  
 
 pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234'
 try:
@@ -98,36 +95,36 @@ Note that the PAC-ID -- while valid -- uses characters which are not recommended
 There is a nice function to highlight problems
 
 ```python
-pac.print_validation_messages(target=target)
+pac.print_validation_messages()
 ```
 ```text
 >> Validation Results                                                                                                                   
 >> ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
 >> │ RECOMMENDATION  in id segment value bal500                                                                                        │
->> │ Characters 'b','a','l' 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:bal500/21:@1234                                                                                 │
+>> │ 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                                                                                 │
+>> │ HTTPS://PAC.METTORIUS.COM/-MD/240:bal500/21:👉@👈1234                                                                             │
 >> ├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
 >> │ RECOMMENDATION  in id segment value bal500                                                                                        │
->> │ Characters 'b','a','l' 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:bal500/21:@1234                                                                                 │
+>> │ 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                                                                                 │
+>> │ HTTPS://PAC.METTORIUS.COM/-MD/240:bal500/21:👉@👈1234                                                                             │
 >> └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
 ```
 ### Save as QR Code
 
 ```python
-from labfreed.qr import save_qr_with_markers  # noqa: E402
+from labfreed.qr import save_qr_with_markers  
 
 save_qr_with_markers(pac_str, fmt='png')
 ```
@@ -142,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  # noqa: E402
+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):
@@ -198,8 +195,8 @@ print(f'WEIGHT = {v.value}')
 #### Create PAC-ID
 
 ```python
-from labfreed.pac_id import PAC_ID, IDSegment  # noqa: E402
-from labfreed.well_known_keys.labfreed.well_known_keys import WellKnownKeys  # noqa: E402
+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')])
 pac_str = pac.to_url()
@@ -213,10 +210,10 @@ 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  # noqa: E402
-from labfreed.trex.python_convenience.pyTREX import pyTREX  # noqa: E402
-from labfreed.trex.python_convenience.data_table import DataTable  # noqa: E402
-from labfreed.trex.python_convenience.quantity import Quantity  # noqa: E402
+from datetime import datetime  
+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 = {
@@ -241,40 +238,40 @@ trex = mydata.to_trex()
 
 
 # Validation also works the same way for TREX
-trex.print_validation_messages(target=target)
+trex.print_validation_messages()
 ```
 ```text
 >> Validation Results                                            
 >> ┌────────────────────────────────────────────────────────────┐
 >> │ ERROR  in TREX table column Date                           │
->> │ Column header key contains invalid characters: 'a','t','e' │
+>> │ Column header key contains invalid characters: 'e','t','a' │
 >> │                                                            │
 >> │ 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:20250423T142912.783:T:FOO::                             │
->> │  1.1:20250423T142912.783:T:BAR::                           │
->> │  1.3:20250423T142912.783:F:BLUBB                           │
+>> │ +TABLE$$DURATION$HUR:D👉ate👈$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                           │
 >> └────────────────────────────────────────────────────────────┘
 ```
 #### Combine PAC-ID and TREX and serialize
 
 ```python
-from labfreed.well_known_extensions import TREX_Extension  # noqa: E402
+from labfreed.well_known_extensions import TREX_Extension  
 pac.extensions = [TREX_Extension(name='MYTREX', trex=trex)]
 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:20250423T142912.783:T:FOO::1.1:20250423T142912.783:T:BAR::1.3:20250423T142912.783: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  # noqa: E402
+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')       
@@ -282,7 +279,7 @@ cit = load_cit(p)
 
 # validate the CIT
 cit.is_valid
-cit.print_validation_messages(target=target)
+cit.print_validation_messages()
 ```
 ```python
 # get a second cit
@@ -325,6 +322,39 @@ for sg in service_groups:
 
 
 
+<!-- BEGIN CHANGELOG -->
 ## Change Log
-[> Change Log](/CHANGELOG.md)
+### v0.2.2
+- minor changes for better access of subfunctions. No change in existing API
+  
+### v0.2.1
+- improved docu. no code changes
+
+### v0.2.0b2
+- improvements in api consistency and ease of use
+- restructured code for better separation of concerns
+- support for coupling information table v1
+
+### v0.1.1
+- minor internal improvements and bugfixes
+  
+### v0.1.0
+- DRAFT Support for PAC-ID Resolver
+
+### v0.0.20
+- bugfix in TREX table to dict conversion
+- markdown compatible validation printing 
+
+### v0.0.19
+- supports PAC-ID, PAC-CAT, TREX and DisplayName
+- QR generation 
+- ok-ish test coverage
+<!-- END CHANGELOG -->
+
+# Attributions
+The following tools were used:
+- [pdoc](https://pdoc.dev/) was a great help with generating documentation
+- [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)
 

{labfreed-0.2.0b2.dist-info → labfreed-0.2.2.dist-info}/RECORD

@@ -1,9 +1,9 @@
-labfreed/__init__.py,sha256=_YHojMJFgforbYySrmNfyMkkZw5AI-Dyg9TsutHvIA8,226
-labfreed/labfreed_infrastructure.py,sha256=V-5sLhqKkfckKim5VxlB_D1qIzk-Ztxfx4VIlwaR6Jc,10850
-labfreed/pac_cat/__init__.py,sha256=rJ2dFTN8aErTvGf4xwcNZ04xrbTieLAE2v5C2bmgPOA,507
-labfreed/pac_cat/category_base.py,sha256=gx3c5xLrwJw5EXQtV70m8cV0E1scO4Kan02f8p7xLDo,1801
-labfreed/pac_cat/pac_cat.py,sha256=UxWyPsuZsekq3ZmHSQLBdB1tocvVlxz_FOQXxHg_dlU,5800
-labfreed/pac_cat/predefined_categories.py,sha256=BEf7rxN5IcKVhuxMNhdfQ_1xnkax5l8Z1pJMRIROKpw,8510
+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=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
@@ -11,7 +11,7 @@ labfreed/pac_id/pac_id.py,sha256=IWXYlKFjQKB_9U5bINWC5_Lb5pcVbuleocvGs79A28w,530
 labfreed/pac_id/url_parser.py,sha256=016Gd-V2OORDN2toAZEPmnXobrWNVVXM_zICBrQtqGY,5863
 labfreed/pac_id/url_serializer.py,sha256=3D5pwcAP4ZrCQ22BRtxIwqWrFtZuY9913hCLPJNeyPI,2845
 labfreed/pac_id_resolver/__init__.py,sha256=RNBlrDOSR42gmSNH9wJVhK_xwEX45cvTKVgWW2bjh7Q,113
-labfreed/pac_id_resolver/cit_v1.py,sha256=9dwbQLaRwGq_SDxuuuyDFtpUfx9mZrgGSM0Ed9kFbHE,5800
+labfreed/pac_id_resolver/cit_v1.py,sha256=G5CitglgN9Vg0yoNPApcgcI1GjOgW6k4HUwqpJgINKQ,5800
 labfreed/pac_id_resolver/cit_v2.py,sha256=J7KsYUKSz4k7lqSHmLnouRY-etEbwmcj35O5SqVRm-o,11594
 labfreed/pac_id_resolver/resolver.py,sha256=x0XR0aWQVLptjtEwft8VPjggJEd8leTypQPUdzSyBaI,2160
 labfreed/pac_id_resolver/services.py,sha256=TPoH6YlSwa0hmawHpOiMwIpBAinhoRhMSoexop0YscI,2462
@@ -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.0b2.dist-info/licenses/LICENSE,sha256=gHFOv9FRKHxO8cInP3YXyPoJnuNeqrvcHjaE_wPSsQ8,1100
-labfreed-0.2.0b2.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-labfreed-0.2.0b2.dist-info/METADATA,sha256=xSn5iHfaUb3dCz03cLCDev8s3X0Dcu4L_lz9VcQzDEc,17240
-labfreed-0.2.0b2.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,,