labfreed 0.0.18__py2.py3-none-any.whl → 0.0.20__py2.py3-none-any.whl

labfreed/{QR_Generator → IO}/generate_qr.py

@@ -364,16 +364,16 @@ class VisualMarker:
 app = typer.Typer()
 
 
-def generate_qr_with_markers(url, text="PAC", title=None, direction = Direction.LEFT_TO_RIGHT): 
+def _generate_qr_with_markers(qr_str, text, title, direction): 
     if title:
     #try to use standard size 10. Go bigger if 10 does not fit the data
         try:
-            qr = segno.make_qr(url, error="L", version=10)
+            qr = segno.make_qr(qr_str, error="L", version=10)
         except DataOverflowError as e:
-            qr = segno.make_qr(url, error="L")
+            qr = segno.make_qr(qr_str, error="L")
         v = qr.version
     else: 
-        qr = segno.make_qr(url, error="L")
+        qr = segno.make_qr(qr_str, error="L")
         v = qr.version
     
     if(qr.mode != "alphanumeric"):
@@ -396,42 +396,18 @@ def generate_qr_with_markers(url, text="PAC", title=None, direction = Direction.
         combined_matrix = np.concatenate((title_marker, padding, qr_matrix, padding, visual_marker), axis=append_axis)
     else:
         combined_matrix = np.concatenate((qr_matrix, padding, visual_marker), axis=append_axis)
-    
+        
     return combined_matrix
-    
-def generate_qr_with_markers_file(url, text="PAC", title=None, direction = Direction.LEFT_TO_RIGHT, fmt='svg', path=str):
-    combined_matrix = generate_qr_with_markers(url, text="PAC", title=None, direction = Direction.LEFT_TO_RIGHT)
-    outfile = f'{path}.{fmt}'
-    match fmt:
-        case 'png':
-            segno.writers.write_png(combined_matrix, combined_matrix.shape[::-1], out=outfile, border=9)
-        case 'svg':
-            segno.writers.write_svg(combined_matrix, combined_matrix.shape[::-1], out=outfile, border=9)
 
-    
-def generate_qr_with_markers_uri(url, text="PAC", title=None, direction = Direction.LEFT_TO_RIGHT, fmt='svg'):
-    combined_matrix = generate_qr_with_markers(url, text="PAC", title=None, direction = Direction.LEFT_TO_RIGHT)
+def save_qr_with_markers(url, text="PAC", title=None, direction = Direction.LEFT_TO_RIGHT, fmt='png', path='qr'):
+    combined_matrix = _generate_qr_with_markers(url, text="PAC", title=None, direction = Direction.LEFT_TO_RIGHT)
+    outfile = f'{path}.{fmt}'
     match fmt:
         case 'png':
-            out = segno.writers.as_png_data_uri(combined_matrix, combined_matrix.shape[::-1], border=9)
+            writers.write_png(combined_matrix, combined_matrix.shape[::-1], out=outfile, border=9)
         case 'svg':
-            out = segno.writers.as_svg_data_uri(combined_matrix, combined_matrix.shape[::-1], border=9)
-    return out    
-
-def generate_qr_with_markers_svg(url, text="PAC", title=None, direction = Direction.LEFT_TO_RIGHT, width=None, height=None, border=9, svg_omitsize=False):
-    combined_matrix = generate_qr_with_markers(url, text="PAC", title=None, direction = Direction.LEFT_TO_RIGHT)
-    with io.BytesIO() as out:
-        version = combined_matrix.shape[::-1]
-        scalex = width  / (version[0] + 2*border)   if width else 1
-        scaley = height / (version[1] + 2*border)   if height else 1
-        scale = min(scalex, scaley)
-        segno.writers.write_svg(combined_matrix, version, out, border=border, 
-                                  xmldecl=False, svgns=True, scale=scale, omitsize=svg_omitsize
-                                  )
-        s = out.getvalue().decode()
-    return s    
-
-
+            writers.write_svg(combined_matrix, combined_matrix.shape[::-1], out=outfile, border=9)
+            
 
 
 
@@ -440,8 +416,7 @@ def main(url: Annotated[str, typer.Argument(help="The PAC-ID to be rendered as Q
     text: Annotated[str, typer.Option(help="The text of the PAC decoration.")] = "PAC",
     direction: Annotated[Direction, typer.Option(help="The position/direction of the PAC decoration.")] = Direction.TOP_TO_BOTTOM):
 
-    img = generate_qr_with_markers(url, text=text, direction=direction) 
-    img.save('generated_codes', f"{outfile}.svg", format='svg')
+    save_qr_with_markers(url, text=text, direction=direction, path=outfile) 
     
 
 

labfreed/{parse_pac.py → IO/parse_pac.py}

@@ -9,9 +9,9 @@ from labfreed.PAC_ID.extensions import Extension, UnknownExtension
 from labfreed.TREX.data_model import TREX
 
 
-from .PAC_ID.data_model import *
+from ..PAC_ID.data_model import *
 
-from .validation import ValidationMessage, LabFREEDValidationError
+from ..validation import ValidationMessage, LabFREEDValidationError
 
 
 

labfreed/PAC_ID/extensions.py

@@ -1,8 +1,5 @@
 
 from abc import ABC, abstractproperty, abstractstaticmethod
-from types import MappingProxyType
-
-from pydantic import Field
 
 from labfreed.validation import BaseModelWithValidationMessages
 from labfreed.PAC_ID.data_model import PACID

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/__init__.py

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

labfreed/utilities/utility_types.py

@@ -1,37 +1,7 @@
-from functools import cache
-import json
-from pathlib import Path
-
-from rich import print
-
-from typing import Any, Tuple
-from typing_extensions import Annotated 
-from pydantic import BaseModel, AfterValidator
-import quantities as pq
-from quantities import  units
+from pydantic import BaseModel
 
 from labfreed.TREX.unece_units import unece_units           
                 
-def validate_unit(unit_name:str) -> str :
-    """
-    Pydantic validator function for the unit.
-    Checks if the unit is a valid unit.
-    
-
-    Args:
-        unit (str): unit symbol, e.g. 'kg'
-
-    Returns:
-        str: the input unit. 
-        
-    Errors:
-        raises an AssertionError if validation fails
-    """
-    if hasattr(pq, unit_name):
-        return unit_name
-    else:
-        assert False
-
 
 class Unit(BaseModel):
     name: str

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.18.dist-info → labfreed-0.0.20.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: labfreed
-Version: 0.0.18
+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
@@ -41,7 +41,7 @@ pip install labfreed
 ### Parse a simple PAC-ID
 
 ```python
-from labfreed.parse_pac import PAC_Parser
+from labfreed.IO.parse_pac import PAC_Parser
 
 # Parse the PAC-ID
 pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234'
@@ -53,17 +53,44 @@ is_valid = pac_id.is_valid()
 print(f'PAC-ID is valid: {is_valid}')
 ```
 ```text
->> [Error during execution: No module named 'quantities']
+>> PAC-ID is valid: True
 ```
 ### 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()
+pac_id.print_validation_messages(target='markdown')
 ```
 ```text
->> [Error during execution: name 'pac_id' is not defined]
+>> =======================================
+>> Validation Results
+>> ---------------------------------------
+>> 
+>>  Recommendation  in      id segment value bal500
+>> 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
+>> 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
+```
+### Save as QR Code
+
+```python
+from labfreed.IO.generate_qr import save_qr_with_markers
+
+save_qr_with_markers(pac_str, fmt='png')
+```
+```text
+>> Large QR: Provided URL is not alphanumeric!
+>> Size: 29
+>> Version: 3
+>> Error Level: M
 ```
 ### PAC-CAT
 
@@ -75,7 +102,15 @@ if isinstance(pac_id, PAC_CAT):
     pac_id.print_categories()
 ```
 ```text
->> [Error during execution: name 'PAC_Parser' is not defined]
+>> Main Category
+>> ----------
+>> key 	 (): 	 -DR
+>> id 	 (21): 	 XQ908756
+>> Category
+>> ------ 
+>> key 	 (): 	 -MD
+>> model_number 	 (240): 	 bal500
+>> serial_number 	 (21): 	 @1234
 ```
 ### Parse a PAC-ID with extensions
 PAC-ID can have extensions. Here we parse a PAC-ID with attached display names and summary.
@@ -89,7 +124,7 @@ display_names = pac_id.get_extension('N') # display name has name 'N'
 print(display_names)
 ```
 ```text
->> [Error during execution: name 'PAC_Parser' is not defined]
+>> Display names: My Balance ❤️
 ```
 ```python
 # TREX
@@ -99,7 +134,7 @@ v = trex.get_segment('WEIGHT').to_python_type()
 print(f'WEIGHT = {v}')
 ```
 ```text
->> [Error during execution: name 'pac_id' is not defined]
+>> WEIGHT = 67.89 g
 ```
 ### Create a PAC-ID with Extensions
 
@@ -109,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.
@@ -139,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'])
@@ -147,26 +182,35 @@ 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
-d = trex.dict()
+trex.print_validation_messages(target='markdown')
 ```
 ```text
->> [Error during execution: No module named 'quantities']
+>> =======================================
+>> 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
 
 ```python
-from labfreed.parse_pac import PACID_With_Extensions
+from labfreed.IO.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)
 ```
 ```text
->> [Error during execution: No module named 'quantities']
+>> 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 -->
 
@@ -174,9 +218,13 @@ print(pac_str)
 
 ## Change Log
 
-### v0.0.17
-- dependencies are installed automatically
+### v0.0.20
+- bugfix in TREX table to dict conversion
+- markdown compatible validation printing 
 
-### v0.0.16
+### v0.0.19
 - supports PAC-ID, PAC-CAT, TREX and DisplayName
+- QR generation 
 - ok-ish test coverage
+
+

labfreed-0.0.20.dist-info/RECORD

@@ -0,0 +1,21 @@
+labfreed/__init__.py,sha256=JJg9mHM5goSWphrIerAaoiUjcOEZ7AXqGJIlmFog-pA,88
+labfreed/validation.py,sha256=he9utRxQwks4ro94AVi8t5rU4jgRcA-6uz1XEmqoAnM,6359
+labfreed/DisplayNameExtension/DisplayNameExtension.py,sha256=l9JZY2eRS0V-H5h3-WXIHiiBJuljns-_e_t9Bp84_CU,1155
+labfreed/IO/generate_qr.py,sha256=wdZSf51Id03xSY8liK2RfB7WyGAw9O4s0VhZzrkAa-g,16680
+labfreed/IO/parse_pac.py,sha256=2c-HXkiQdUrGTL8zGb5CmO9l6ZrCb07rrTMMKdMi3_o,6253
+labfreed/PAC_CAT/__init__.py,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
+labfreed/PAC_CAT/data_model.py,sha256=dGwcQGLy1Dk6SFbs9utxKQKm_4ROZrXdv618APlQg7M,14308
+labfreed/PAC_ID/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+labfreed/PAC_ID/data_model.py,sha256=g09qgC-TV6fjJw9VyDF6mTJ6co2i2RKZc0Z-BmiiUIQ,7483
+labfreed/PAC_ID/extensions.py,sha256=YKIE-aFf1jdL4sqCqUe3txjnP8-dA2zCJrT5lBSjvuE,1092
+labfreed/TREX/UneceUnits.json,sha256=kwfQSp_nTuWbADfBBgqTWrvPl6XtM5SedEVLbMJrM7M,898953
+labfreed/TREX/data_model.py,sha256=tGgjp76wbS1MSS1Ep842CZyintsbecTZrlapj8WwGH8,29704
+labfreed/TREX/parse.py,sha256=86962VEJpkrTcT436iFIB5dNed5WHABzpjxRjkA3PXo,2043
+labfreed/TREX/unece_units.py,sha256=scPKdsPzY1neAdFOhA08_tRZaR-yplM8mBhIzzDqZBk,3006
+labfreed/utilities/base36.py,sha256=_yX8aQ1OwrK5tnJU1NUEzQSFGr9xAVnNvPObpNzCPYs,2895
+labfreed/utilities/utility_types.py,sha256=dM0qZgshF3cHJThVzia7UIAOdkNLKukAaaduLqKSaMY,2195
+labfreed/utilities/well_known_keys.py,sha256=nqk66kHdSwJTJfMKlP-xQbBglS8F_NoWsGkfOVITFN0,331
+labfreed-0.0.20.dist-info/licenses/LICENSE,sha256=gHFOv9FRKHxO8cInP3YXyPoJnuNeqrvcHjaE_wPSsQ8,1100
+labfreed-0.0.20.dist-info/WHEEL,sha256=Dyt6SBfaasWElUrURkknVFAZDHSTwxg3PaTza7RSbkY,100
+labfreed-0.0.20.dist-info/METADATA,sha256=phvfg_T1RGixhz1rN27aqGk7xRlxLNs_yjj-Ts2Pc-k,6961
+labfreed-0.0.20.dist-info/RECORD,,

labfreed/utilities/extension_intertpreters.py

@@ -1,4 +0,0 @@
-from labfreed.DisplayNameExtension.DisplayNameExtension import DisplayNames
-from labfreed.TREX.data_model import TREX
-
-

labfreed-0.0.18.dist-info/RECORD

@@ -1,22 +0,0 @@
-labfreed/__init__.py,sha256=reRp78_6uZrtmaZRtPjFWADn6svJqLZMou47EfBjrmU,88
-labfreed/parse_pac.py,sha256=7y65HO1A3OEr5zftiEtrCaiLLI_8LoRPtQpPcKUNVik,6251
-labfreed/validation.py,sha256=QwkZWJhAjWbPUZtJJwjVYsw9TxeFhdbZaKjrPPIpuAA,5937
-labfreed/DisplayNameExtension/DisplayNameExtension.py,sha256=l9JZY2eRS0V-H5h3-WXIHiiBJuljns-_e_t9Bp84_CU,1155
-labfreed/PAC_CAT/__init__.py,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
-labfreed/PAC_CAT/data_model.py,sha256=dGwcQGLy1Dk6SFbs9utxKQKm_4ROZrXdv618APlQg7M,14308
-labfreed/PAC_ID/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-labfreed/PAC_ID/data_model.py,sha256=g09qgC-TV6fjJw9VyDF6mTJ6co2i2RKZc0Z-BmiiUIQ,7483
-labfreed/PAC_ID/extensions.py,sha256=bvuZnlNKUdwsDLrPm8fyifqPn_PR4wCVkkScFnvRiuM,1158
-labfreed/QR_Generator/generate_qr.py,sha256=A4Bw_UESaB_igTDV2Y7a5T7vdz2Sb3yZCfHM0qKnu0M,18091
-labfreed/TREX/UneceUnits.json,sha256=kwfQSp_nTuWbADfBBgqTWrvPl6XtM5SedEVLbMJrM7M,898953
-labfreed/TREX/data_model.py,sha256=neKYBc5_S4t-v86DSaWLq81VJF4oS6eFUch3ChPTYJA,29705
-labfreed/TREX/parse.py,sha256=86962VEJpkrTcT436iFIB5dNed5WHABzpjxRjkA3PXo,2043
-labfreed/TREX/unece_units.py,sha256=scPKdsPzY1neAdFOhA08_tRZaR-yplM8mBhIzzDqZBk,3006
-labfreed/utilities/base36.py,sha256=_yX8aQ1OwrK5tnJU1NUEzQSFGr9xAVnNvPObpNzCPYs,2895
-labfreed/utilities/extension_intertpreters.py,sha256=B3IFJLfVMJQuPfBBtX6ywlDUZEi7_x6tY4g8V7SpWSs,124
-labfreed/utilities/utility_types.py,sha256=Zhk8Mu4hHjkn1gs8oh7vOxxaT7L7wLMVG40ZOWCKGK4,2865
-labfreed/utilities/well_known_keys.py,sha256=nqk66kHdSwJTJfMKlP-xQbBglS8F_NoWsGkfOVITFN0,331
-labfreed-0.0.18.dist-info/licenses/LICENSE,sha256=gHFOv9FRKHxO8cInP3YXyPoJnuNeqrvcHjaE_wPSsQ8,1100
-labfreed-0.0.18.dist-info/WHEEL,sha256=Dyt6SBfaasWElUrURkknVFAZDHSTwxg3PaTza7RSbkY,100
-labfreed-0.0.18.dist-info/METADATA,sha256=FiS8P177t3OE6BwQMsQCUhg4y4GQihwmU4-U98WacAU,5382
-labfreed-0.0.18.dist-info/RECORD,,