labfreed 0.0.19__tar.gz → 0.0.20__tar.gz

{labfreed-0.0.19 → labfreed-0.0.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: labfreed
-Version: 0.0.19
+Version: 0.0.20
 Summary: Python implementation of LabFREED building blocks
 Author-email: Reto Thürer <thuerer.r@buchi.com>
 Description-Content-Type: text/markdown
@@ -19,7 +19,7 @@ Requires-Dist: typer>=0.15.2
 [![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.
+This is a Python implementation of [LabFREED](https://labfreed.wega-it.com) building blocks.
 
 ## Supported Building Blocks
 - PAC-ID
@@ -60,7 +60,7 @@ Note that the PAC-ID -- while valid -- uses characters which are not recommended
 There is a nice function to highlight problems
 
 ```python
-pac_id.print_validation_messages()
+pac_id.print_validation_messages(target='markdown')
 ```
 ```text
 >> =======================================
@@ -68,15 +68,15 @@ pac_id.print_validation_messages()
 >> ---------------------------------------
 >> 
 >>  Recommendation  in      id segment value bal500
->> HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234
->> Characters l a b should not be used.
+>> HTTPS://PAC.METTORIUS.COM/-MD/🔸b🔸🔸a🔸🔸l🔸500/@1234
+>> Characters b l a should not be used.
 >> 
 >>  Recommendation  in      id segment value @1234
->> HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234
+>> HTTPS://PAC.METTORIUS.COM/-MD/bal500/🔸@🔸1234
 >> Characters @ should not be used.
 >> 
 >>  Warning  in     Category -MD
->> HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234
+>> 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
 ```
 ### Save as QR Code
@@ -144,12 +144,12 @@ print(f'WEIGHT = {v}')
 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_id = PACID(issuer='METTORIUS.COM', identifier=[IDSegment(key=WellKnownKeys.SERIAL, value='1234')])
 pac_str = pac_id.serialize()
 print(pac_str)
 ```
 ```text
->> HTTPS://PAC.METTORIUS:COM/21:1234
+>> HTTPS://PAC.METTORIUS.COM/21:1234
 ```
 #### Create a TREX 
 TREX can conveniently be created from a python dictionary.
@@ -174,7 +174,7 @@ trex.update(
 )
 
 # Create a table
-table = DataTable(['DURATION', 'DATE', 'OK', 'COMMENT'])
+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'])
@@ -182,11 +182,23 @@ table.append([                                                 1.3,  datetime.no
 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
+trex.print_validation_messages(target='markdown')
+```
+```text
+>> =======================================
+>> Validation Results
+>> ---------------------------------------
+>> 
+>>  Error  in       TREX table column Date
+>> DEMO$TREX/STOP$T.D:20240505T1306+TEMP$KEL:10.15+OK$T.B:F+COMMENT$T.A:FOO+COMMENT2$T.T:12G3+TABLE$$DURATION$HUR:D🔸a🔸🔸t🔸🔸e🔸$T.D:OK$T.B:COMMENT$T.A::1:20250409T094048.268:T:FOO::1.1:20250409T094048.268:T:BAR::1.3:20250409T094048.268:F:BLUBB
+>> Column header key contains invalid characters: e,t,a
+```
+```python
+# there is an error. 'Date' uses lower case. Lets fix it
 d = trex.dict()
+d['TABLE'].col_names[1] = 'DATE'
+trex = TREX(name_='DEMO') 
+trex.update(d)
 ```
 #### Combine PAC-ID and TREX and serialize
 
@@ -198,7 +210,7 @@ pac_str = pac_with_trex.serialize()
 print(pac_str)
 ```
 ```text
->> HTTPS://PAC.METTORIUS:COM/21:1234*DEMO$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:20250409T082814.766:T:FOO::1.1:20250409T082814.766:T:BAR::1.3:20250409T082814.766:F:BLUBB
+>> HTTPS://PAC.METTORIUS.COM/21:1234*DEMO$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:20250409T094048.268:T:FOO::1.1:20250409T094048.268:T:BAR::1.3:20250409T094048.268:F:BLUBB
 ```
 <!-- END EXAMPLES -->
 
@@ -206,7 +218,13 @@ print(pac_str)
 
 ## Change Log
 
+### 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
+
+

{labfreed-0.0.19 → labfreed-0.0.20}/README.md

@@ -6,7 +6,7 @@
 [![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.
+This is a Python implementation of [LabFREED](https://labfreed.wega-it.com) building blocks.
 
 ## Supported Building Blocks
 - PAC-ID
@@ -47,7 +47,7 @@ Note that the PAC-ID -- while valid -- uses characters which are not recommended
 There is a nice function to highlight problems
 
 ```python
-pac_id.print_validation_messages()
+pac_id.print_validation_messages(target='markdown')
 ```
 ```text
 >> =======================================
@@ -55,15 +55,15 @@ pac_id.print_validation_messages()
 >> ---------------------------------------
 >> 
 >>  Recommendation  in      id segment value bal500
->> HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234
->> Characters l a b should not be used.
+>> HTTPS://PAC.METTORIUS.COM/-MD/🔸b🔸🔸a🔸🔸l🔸500/@1234
+>> Characters b l a should not be used.
 >> 
 >>  Recommendation  in      id segment value @1234
->> HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234
+>> HTTPS://PAC.METTORIUS.COM/-MD/bal500/🔸@🔸1234
 >> Characters @ should not be used.
 >> 
 >>  Warning  in     Category -MD
->> HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234
+>> 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
 ```
 ### Save as QR Code
@@ -131,12 +131,12 @@ print(f'WEIGHT = {v}')
 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_id = PACID(issuer='METTORIUS.COM', identifier=[IDSegment(key=WellKnownKeys.SERIAL, value='1234')])
 pac_str = pac_id.serialize()
 print(pac_str)
 ```
 ```text
->> HTTPS://PAC.METTORIUS:COM/21:1234
+>> HTTPS://PAC.METTORIUS.COM/21:1234
 ```
 #### Create a TREX 
 TREX can conveniently be created from a python dictionary.
@@ -161,7 +161,7 @@ trex.update(
 )
 
 # Create a table
-table = DataTable(['DURATION', 'DATE', 'OK', 'COMMENT'])
+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'])
@@ -169,11 +169,23 @@ table.append([                                                 1.3,  datetime.no
 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
+trex.print_validation_messages(target='markdown')
+```
+```text
+>> =======================================
+>> Validation Results
+>> ---------------------------------------
+>> 
+>>  Error  in       TREX table column Date
+>> DEMO$TREX/STOP$T.D:20240505T1306+TEMP$KEL:10.15+OK$T.B:F+COMMENT$T.A:FOO+COMMENT2$T.T:12G3+TABLE$$DURATION$HUR:D🔸a🔸🔸t🔸🔸e🔸$T.D:OK$T.B:COMMENT$T.A::1:20250409T094048.268:T:FOO::1.1:20250409T094048.268:T:BAR::1.3:20250409T094048.268:F:BLUBB
+>> Column header key contains invalid characters: e,t,a
+```
+```python
+# there is an error. 'Date' uses lower case. Lets fix it
 d = trex.dict()
+d['TABLE'].col_names[1] = 'DATE'
+trex = TREX(name_='DEMO') 
+trex.update(d)
 ```
 #### Combine PAC-ID and TREX and serialize
 
@@ -185,7 +197,7 @@ pac_str = pac_with_trex.serialize()
 print(pac_str)
 ```
 ```text
->> HTTPS://PAC.METTORIUS:COM/21:1234*DEMO$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:20250409T082814.766:T:FOO::1.1:20250409T082814.766:T:BAR::1.3:20250409T082814.766:F:BLUBB
+>> HTTPS://PAC.METTORIUS.COM/21:1234*DEMO$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:20250409T094048.268:T:FOO::1.1:20250409T094048.268:T:BAR::1.3:20250409T094048.268:F:BLUBB
 ```
 <!-- END EXAMPLES -->
 
@@ -193,7 +205,12 @@ print(pac_str)
 
 ## Change Log
 
+### 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
+- ok-ish test coverage
+

{labfreed-0.0.19 → labfreed-0.0.20}/examples.py

@@ -17,7 +17,7 @@ print(f'PAC-ID is valid: {is_valid}')
 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()
+pac_id.print_validation_messages(target='markdown')
 
 '''
 ### Save as QR Code
@@ -65,7 +65,7 @@ print(f'WEIGHT = {v}')
 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_id = PACID(issuer='METTORIUS.COM', identifier=[IDSegment(key=WellKnownKeys.SERIAL, value='1234')])
 pac_str = pac_id.serialize()
 print(pac_str)
 
@@ -93,7 +93,7 @@ trex.update(
 )
 
 # Create a table
-table = DataTable(['DURATION', 'DATE', 'OK', 'COMMENT'])
+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'])
@@ -101,11 +101,13 @@ table.append([                                                 1.3,  datetime.no
 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
+trex.print_validation_messages(target='markdown')
+''''''
+# there is an error. 'Date' uses lower case. Lets fix it
 d = trex.dict()
+d['TABLE'].col_names[1] = 'DATE'
+trex = TREX(name_='DEMO') 
+trex.update(d)
 
 ''' 
 #### Combine PAC-ID and TREX and serialize

{labfreed-0.0.19 → labfreed-0.0.20}/labfreed/TREX/data_model.py

@@ -436,7 +436,7 @@ class TREX_Table(TREX_Segment):
             self.add_validation_message(
                     source=f"Table {self.key}",
                     type="Error",
-                    msg=f"Size mismatch: Table header contains {self.col_names} keys, while most rows have {most_common_len}",
+                    msg=f"Size mismatch: Table header contains {self.column_names} keys, while most rows have {most_common_len}",
                     highlight_pattern = self.key
             )
             expected_row_len = most_common_len
@@ -527,7 +527,7 @@ class TREX_Table(TREX_Segment):
                     r.append(Quantity(value=e.value, unit=unit))
                 else:
                     r.append(e.value_to_python_type())
-                table.append(r)
+            table.append(r)
         return table
         
         

{labfreed-0.0.19 → labfreed-0.0.20}/labfreed/__init__.py

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

{labfreed-0.0.19 → labfreed-0.0.20}/labfreed/validation.py

@@ -113,7 +113,7 @@ class BaseModelWithValidationMessages(BaseModel):
         return filter_warnings(self.get_nested_validation_messages())
     
     
-    def print_validation_messages(self, str_to_highlight_in=None):
+    def print_validation_messages(self, str_to_highlight_in=None, target='console'):
         if not str_to_highlight_in:
             str_to_highlight_in = str(self)
         msgs = self.get_nested_validation_messages()
@@ -133,7 +133,13 @@ class BaseModelWithValidationMessages(BaseModel):
                 
             text = Text.from_markup(f'\n [bold {color}]{m.type} [/bold {color}] in \t {m.source}' )
             print(text)
-            formatted_highlight = m.emphazised_highlight.replace('emph', f'bold {color}')
+            match target:
+                case 'markdown':
+                    formatted_highlight = m.emphazised_highlight.replace('emph', f'🔸').replace('[/', '').replace('[', '').replace(']', '')
+                case 'console':     
+                    formatted_highlight = m.emphazised_highlight.replace('emph', f'bold {color}')
+                case 'html':
+                    formatted_highlight = m.emphazised_highlight.replace('emph', f'b').replace('[', '<').replace(']', '>')
             fmtd = str_to_highlight_in.replace(m.highlight, formatted_highlight)
             fmtd = Text.from_markup(fmtd)
             print(fmtd)

labfreed-0.0.19/labfreed/IO/generate_label.py

@@ -1,81 +0,0 @@
-import os
-
-from .generate_qr import generate_qr_with_markers_svg
-
-from labfreed.PAC_ID.data_model import  PACID
-from labfreed.DisplayNameExtension.DisplayNameExtension import DisplayNames
-from labfreed.IO.parse_pac import PACID_With_Extensions
-
-
-    
-
-    
-def generate_label_200_100(pac_url, pac:PACID_With_Extensions):
-    title, infos = get_label_fields(pac)
-    pac_svg = generate_qr_with_markers_svg(pac_url, height=60, width=100, border=0)
-    label = _generate_label(pac_svg, 200, 100, title, infos)
-    return label
-
-def generate_label_credit_card_size(pac_url, pac:PACID_With_Extensions):
-    title, infos = get_label_fields(pac)
-    pac_svg = generate_qr_with_markers_svg(pac_url, height=100, width=200, border=0)
-    label = _generate_label(pac_svg, 240, 150, title, infos)
-    return label
-    
-    
-def _generate_label(qr_svg, width, height, title=None, infos=[]):
-    if not qr_svg:
-        raise ValueError("no valid qr given")
-    env = Environment(
-		loader=FileSystemLoader(os.path.join(os.path.dirname(__file__), "templates")),
-		autoescape=select_autoescape()
-	)
-    template = env.get_template("pac_label.jinja.svg")
-    svg = template.render(width=width, height= height, pac_qr=qr_svg, title=title, info1=infos[0], info2=infos[1], info3=infos[2])
-    
-    return svg
-
-
-
-def get_label_fields(pac:PACID_With_Extensions) -> tuple[str, list[tuple[str, str]]]:
-    '''
-    returns a list of exactly length 3. Containing either info tuples (key value) or None
-    '''
-    if dn_extension := next((e for e in pac.extensions if isinstance(e, DisplayNames)), None): #find extension of type DisplayName
-        title = dn_extension.display_names[0]
-    else:
-        title = ""
-    
-    infos = []
-    cat = pac.pac_id.identifier.categories[0]
-    for s in cat.segments:
-        lbl = pretty_print_segment_label(cat.key, s.key)
-        infos.append((lbl, s.value))
-        
-    while len(infos) < 3:
-        infos.append(None)
-    
-    if len(infos) > 3:
-        infos = infos[0:3]
-           
-    return title,infos
-
-
-def pretty_print_segment_label(category:str, segment_key:str):
-    if not segment_key:
-        return 'no key'
-    
-    cat = CAT_from_category_key(category)
-    if cat:
-        alias_to_field = {v.alias: k for k, v in cat.model_fields.items() if v.alias}
-        segment_label = alias_to_field.get(segment_key, segment_key)
-        segment_label = segment_label.replace('_', ' ').title()
-        
-        segment_label = segment_label.replace('Id', 'ID')
-        
-    else:
-        segment_label = segment_key
-    
-    return segment_label
-    
-