labfreed 0.0.15__py2.py3-none-any.whl → 0.0.16__py2.py3-none-any.whl

labfreed/PAC_CAT/data_model.py

@@ -138,6 +138,19 @@ class PAC_CAT(PACID):
                     )
             return self
         
+    def print_categories(self):
+        s = ''
+        for i, c in enumerate(self.categories):
+            if i == 0:
+                title = 'Main Category\n----------'
+            else:
+                title = 'Category\n------ '
+            
+            s += f'{title}\n'
+            s += str(c)
+            s += '\n'
+        print(s)
+        
         
     # @classmethod
     # def from_categories(cls, issuer:str, categories:list[Category]):
@@ -198,6 +211,11 @@ class Category(BaseModelWithValidationMessages):
         return self
     
     
+    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)]) 
+        return s
+    
+    
     # def to_identifier_category(self, use_short_notation=False):
     #     '''Creates a Category with the correct segments. 
     #        Segments are in order of the Pydantic model fields. 
@@ -261,14 +279,14 @@ class Material_Device(Category):
             self.add_validation_message(
                     source=f"Category {self.key}",
                     type="Error",
-                    msg=f'Category key {self.key} is missing mandatory field Model NUmber',
+                    msg=f'Category key {self.key} is missing mandatory field Model Number',
                     highlight_pattern = f"{self.key}"
             )
         if not self.serial_number:
             self.add_validation_message(
                     source=f"Category {self.key}",
                     type="Error",
-                    msg=f'Category key {self.key} is missing mandatory field Serial NUmber',
+                    msg=f'Category key {self.key} is missing mandatory field Serial Number',
                     highlight_pattern = f"{self.key}"
             )
     
@@ -286,7 +304,7 @@ class Material_Substance(Category):
             self.add_validation_message(
                     source=f"Category {self.key}",
                     type="Error",
-                    msg=f'Category key {self.key} is missing mandatory field Product NUmber',
+                    msg=f'Category key {self.key} is missing mandatory field Product Number',
                     highlight_pattern = f"{self.key}"
             )
     
@@ -328,19 +346,19 @@ class Data_Abstract(Category, ABC):
                     highlight_pattern = f"{self.key}"
             )
 
-class Data_Result(Category):
+class Data_Result(Data_Abstract):
     key: str = Field(default='-DR', frozen=True)
     
-class Data_Method(Category):
+class Data_Method(Data_Abstract):
     key: str = Field(default='-DM', frozen=True)
     
-class Data_Calibration(Category):
+class Data_Calibration(Data_Abstract):
     key: str = Field(default='-DC', frozen=True)
     
-class Data_Progress(Category):
+class Data_Progress(Data_Abstract):
     key: str = Field(default='-DP', frozen=True)
     
-class Data_Static(Category):
+class Data_Static(Data_Abstract):
     key: str = Field(default='-DS', frozen=True)
     
     

labfreed/TREX/data_model.py

@@ -654,6 +654,7 @@ class TREX(Extension, BaseModelWithValidationMessages):
                     data.append(r)
                     
                 self.segments.append(TREX_Table(key=k, column_headers=headers, data=data))
+        return self
                    
                 
     def dict(self):

labfreed/__init__.py

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

{labfreed-0.0.15.dist-info → labfreed-0.0.16.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: labfreed
-Version: 0.0.15
+Version: 0.0.16
 Summary: Python implementation of LabFREED building blocks
 Author-email: Reto Thürer <thuerer.r@buchi.com>
 Description-Content-Type: text/markdown
@@ -32,13 +32,9 @@ pip install labfreed
 
 
 ## Usage Examples
+> ⚠️ **Note:** These examples are building on each other. Imports and parsing are not repeated in each example.
 <!-- BEGIN EXAMPLES -->
-```python
-
-```
-
-### Parse a simple PAC-ID 
-The
+### Parse a simple PAC-ID
 
 ```python
 from labfreed.parse_pac import PAC_Parser
@@ -51,33 +47,54 @@ pac_id = PAC_Parser().parse(pac_str).pac_id
 pac_id = PAC_Parser().parse(pac_str).pac_id
 is_valid = pac_id.is_valid()
 print('PAC-ID is valid: {is_valid}')
-# >> PAC-ID is valid: {is_valid}
 ```
-
-Show recommendations:
-Note that the PAC-ID, while valid uses characters, which are not recommended (results in larger QR code).
+```text
+>> PAC-ID is valid: {is_valid}
+```
+### 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()
-# >>
-#   =======================================
-#   Validation Results
-#   ---------------------------------------
-
-#   Recommendation  in      id segment value bal500
-#   HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234
-#   Characters a b l 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
 ```
+```text
+>> =======================================
+>> Validation Results
+>> ---------------------------------------
+>> 
+>>  Recommendation  in      id segment value bal500
+>> HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234
+>> Characters a b l 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
+```
+### PAC-CAT
 
+```python
+from labfreed.PAC_CAT.data_model import PAC_CAT
+pac_str = 'HTTPS://PAC.METTORIUS.COM/-DR/XQ908756/-MD/bal500/@1234'
+pac_id = PAC_Parser().parse(pac_str).pac_id
+if isinstance(pac_id, PAC_CAT):
+    pac_id.print_categories()
+```
+```text
+>> 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.
 
@@ -87,17 +104,21 @@ pac_id = PAC_Parser().parse(pac_str)
 
 # Display Name
 display_names = pac_id.get_extension('N') # display name has name 'N'
-print(f'\n {display_names}')
-# >> Display names: My Balance ❤️
-
+print(display_names)
+```
+```text
+>> Display names: My Balance ❤️
+```
+```python
 # TREX
 trexes = pac_id.get_extension_of_type('TREX')
 trex = trexes[0] # there could be multiple trexes. In this example there is only one, though
 v = trex.get_segment('WEIGHT').to_python_type() 
 print(f'WEIGHT = {v}')
-# >> WEIGHT = 67.89 g
 ```
-
+```text
+>> WEIGHT = 67.89 g
+```
 ### Create a PAC-ID with Extensions
 
 #### Create PAC-ID
@@ -108,10 +129,11 @@ from labfreed.utilities.well_known_keys import WellKnownKeys
 
 pac_id = PACID(issuer='METTORIUS:COM', identifier=[IDSegment(key=WellKnownKeys.SERIAL, value='1234')])
 pac_str = pac_id.serialize()
-pac_str = pac_id.serialize()
 print(pac_str)
 ```
-
+```text
+>> HTTPS://PAC.METTORIUS:COM/21:1234
+```
 #### Create a TREX 
 TREX can conveniently be created from a python dictionary.
 Note that utility types for Quantity (number with unit) and table are needed
@@ -149,7 +171,6 @@ if trex.get_nested_validation_messages():
 # Side Note: The TREX can be turned back into a dict
 d = trex.dict()
 ```
-
 #### Combine PAC-ID and TREX and serialize
 
 ```python
@@ -159,13 +180,15 @@ pac_with_trex = PACID_With_Extensions(pac_id=pac_id, extensions=[trex])
 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:20250408T204437.738:T:FOO::1.1:20250408T204437.739:T:BAR::1.3:20250408T204437.739:F:BLUBB
+```
 <!-- END EXAMPLES -->
 
 
 
 ## Change Log
 
-### v0.0.9
+### v0.0.16
 - supports PAC-ID, PAC-CAT, TREX and DisplayName
 - ok-ish test coverage

{labfreed-0.0.15.dist-info → labfreed-0.0.16.dist-info}/RECORD

@@ -1,22 +1,21 @@
-labfreed/__init__.py,sha256=2kxIKF8hbBacIqi0RgHcYqemImSCpb62ejkGUuOMMkY,88
+labfreed/__init__.py,sha256=Bx3Ykihdaac7BJzcEOfffIQE93gFlCOZ5gbFfrusCx8,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 copy.py,sha256=JWMVkwkX9vWZayOLOzdTHk3VZVYBuyupumNqL-cWCxU,9611
-labfreed/PAC_CAT/data_model.py,sha256=pcib1lEQuqejWP7dfmPUtLakz-y-zeDb9CIe94Jmz0A,13677
+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/TREX/UneceUnits.json,sha256=kwfQSp_nTuWbADfBBgqTWrvPl6XtM5SedEVLbMJrM7M,898953
-labfreed/TREX/data_model.py,sha256=_xhnYGMcMPa0uf_020epq88zqHT1wdsUPC2ELJcSRWE,29684
+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.15.dist-info/licenses/LICENSE,sha256=gHFOv9FRKHxO8cInP3YXyPoJnuNeqrvcHjaE_wPSsQ8,1100
-labfreed-0.0.15.dist-info/WHEEL,sha256=BXjIu84EnBiZ4HkNUBN93Hamt5EPQMQ6VkF7-VZ_Pu0,100
-labfreed-0.0.15.dist-info/METADATA,sha256=dxqZ7E2CeiqTaYKXuDLn4mxRSv3mH9aqRH96CS2EfFw,4997
-labfreed-0.0.15.dist-info/RECORD,,
+labfreed-0.0.16.dist-info/licenses/LICENSE,sha256=gHFOv9FRKHxO8cInP3YXyPoJnuNeqrvcHjaE_wPSsQ8,1100
+labfreed-0.0.16.dist-info/WHEEL,sha256=BXjIu84EnBiZ4HkNUBN93Hamt5EPQMQ6VkF7-VZ_Pu0,100
+labfreed-0.0.16.dist-info/METADATA,sha256=XNosyku7BkYyTkg7p1gFADu7xRdp7yWQ1VOucTdODck,5883
+labfreed-0.0.16.dist-info/RECORD,,

labfreed/PAC_CAT/data_model copy.py

@@ -1,232 +0,0 @@
-# import re
-# from typing import Optional
-# from typing_extensions import Self
-# from pydantic import Field, ValidationInfo, computed_field, conlist, model_validator, field_validator
-
-# from abc import ABC, abstractproperty, abstractstaticmethod
-
-# from labfreed.PAC_ID.data_model import PACID
-
-# from ..utilities.well_known_keys import WellKnownKeys
-# from labfreed.validation import BaseModelWithValidationMessages, ValidationMessage, hsegment_pattern, domain_name_pattern
-
-
-# # class IDSegment(BaseModelWithValidationMessages):
-# #     key:str|None = None
-# #     value:str  
-    
-# #     @model_validator(mode="after")
-# #     def validate_segment(self):
-# #         key = self.key or ""
-# #         value = self.value 
-        
-# #         # MUST be a valid hsegment according to RFC 1738, but without * (see PAC-ID Extension)
-# #         # This means it must be true for both, key and value
-# #         if not_allowed_chars := set(re.sub(hsegment_pattern, '', key)):
-# #             self.add_validation_message(
-# #                     source=f"id segment key {key}",
-# #                     type="Error",
-# #                     msg=f"{' '.join(not_allowed_chars)} must not be used.",
-# #                     recommendation = "The segment key must be a valid hsegment",
-# #                     highlight_pattern = key,
-# #                     highlight_sub = not_allowed_chars
-# #             )
-        
-# #         if not_allowed_chars := set(re.sub(hsegment_pattern, '', value)):
-# #             self.add_validation_message(
-# #                     source=f"id segment key {value}",
-# #                     type="Error",
-# #                     msg=f"{' '.join(not_allowed_chars)} must not be used.",
-# #                     recommendation = "The segment key must be a valid hsegment",
-# #                     highlight_pattern = value,
-# #                     highlight_sub = not_allowed_chars
-# #             )
-
-# #         # Segment key SHOULD be limited to A-Z, 0-9, and -+..
-# #         if not_recommended_chars := set(re.sub(r'[A-Z0-9-:+]', '', key)):
-# #             self.add_validation_message(
-# #                     source=f"id segment key {key}",
-# #                     type="Recommendation",
-# #                     msg=f"{' '.join(not_recommended_chars)} should not be used.",
-# #                     recommendation = "SHOULD be limited to A-Z, 0-9, and -+",
-# #                     highlight_pattern = key,
-# #                     highlight_sub = not_recommended_chars
-# #                 )
-            
-# #         # Segment key should be in Well know keys
-# #         if key and key not in [k.value for k in WellKnownKeys]:
-# #             self.add_validation_message(
-# #                     source=f"id segment key {key}",
-# #                     type="Recommendation",
-# #                     msg=f"{key} is not a well known segment key.",
-# #                     recommendation = "RECOMMENDED to be a well-known id segment key.",
-# #                     highlight_pattern = key
-# #                 )
-            
-            
-# #         # Segment value SHOULD be limited to A-Z, 0-9, and -+..
-# #         if not_recommended_chars := set(re.sub(r'[A-Z0-9-:+]', '', value)):
-# #             self.add_validation_message(
-# #                     source=f"id segment value {value}",
-# #                     type="Recommendation",
-# #                     msg=f"Characters {' '.join(not_recommended_chars)} should not be used.",
-# #                     recommendation = "SHOULD be limited to A-Z, 0-9, and -+",
-# #                     highlight_pattern = value,
-# #                     highlight_sub = not_recommended_chars
-# #                 )
-            
-# #         # Segment value SHOULD be limited to A-Z, 0-9, and :-+ for new designs.
-# #         # this means that ":" in key or value is problematic
-# #         if ':' in key:
-# #             self.add_validation_message(
-# #                     source=f"id segment key {key}",
-# #                     type="Recommendation",
-# #                     msg=f"Character ':' should not be used in segment key, since this character is used to separate key and value this can lead to undefined behaviour.",
-# #                     highlight_pattern = key
-# #                 )
-# #         if ':' in value:
-# #             self.add_validation_message(
-# #                     source=f"id segment value {value}",
-# #                     type="Recommendation",
-# #                     msg=f"Character ':' should not be used in segment value, since this character is used to separate key and value this can lead to undefined behaviour.",
-# #                     highlight_pattern = value
-# #                 )
-                
-# #         return self
-     
-  
-    
-
-
-
-
-# class PAC_CAT(PACID):
-        
-#     @computed_field
-#     @property
-#     def categories(self) -> list[Category]:
-#         categories = list()
-#         c = Category(segments=[])
-#         categories.append(c)
-#         for s in self.segments:
-#             # new category starts with "-"
-#             if s.value[0] == '-':
-#                 cat_key = s.value
-#                 c = Category(key=cat_key, segments=[])
-#                 categories.append(c)
-#             else:
-#                 c.segments.append(s)
-            
-#         # the first category might have no segments. remove categories without segments
-#         if not categories[0].segments:
-#             categories = categories[1:]
-                
-#         return categories
-    
-#     @model_validator(mode='after')
-#     def check_keys_are_unique_in_each_category(self) -> Self:
-#         for c in self.categories:
-#             keys = [s.key for s in c.segments if s.key]
-#             duplicate_keys = [k for k in set(keys) if keys.count(k) > 1]
-#             if duplicate_keys:
-#                 for k in duplicate_keys:
-#                     self.add_validation_message(
-#                         source=f"identifier {k}",
-#                         type="Error",
-#                         msg=f"Duplicate key {k} in category {c.key}",
-#                         highlight_pattern = k
-#                     )
-#             return self
-        
-#     # @model_validator(mode='after')
-#     # def check_length(self) -> Self:
-#     #     l = 0
-#     #     for s in self.segments:
-#     #         if s.key:
-#     #             l += len(s.key)
-#     #             l += 1 # for ":"
-#     #         l += len(s.value)
-#     #     l += len(self.segments) - 1 # account for "/" separating the segments
-        
-#     #     if l > 256:
-#     #         self.add_validation_message(
-#     #                     source=f"identifier",
-#     #                     type="Error",
-#     #                     msg=f'Identifier is {l} characters long, Identifier must not exceed 256 characters.',
-#     #                     highlight_pattern = ""
-#     #                 )
-#     #     return self
-       
-#     @staticmethod 
-#     def from_categories(categories:list[Category]) :
-#         segments = list()
-#         for c in categories:
-#             if c.key:
-#                 segments.append(IDSegment(value=c.key))
-#             segments.extend(c.segments)
-#         return Identifier(segments=segments)
-        
-    
-
-
-
-# # class PACID(BaseModelWithValidationMessages):
-# #     issuer:str
-# #     identifier: Identifier
-    
-# #     @model_validator(mode="after")
-# #     def validate_issuer(self):
-# #         if not re.fullmatch(domain_name_pattern, self.issuer):
-# #             self.add_validation_message(
-# #                     source="PAC-ID",
-# #                     type="Error",
-# #                     highlight_pattern=self.issuer,
-# #                     msg=f"Issuer must be a valid domain name. "
-# #                 )
-         
-# #         # recommendation that A-Z, 0-9, -, and . should be used
-# #         if not_recommended_chars := set(re.sub(r'[A-Z0-9\.-]', '', self.issuer)):
-# #             self.add_validation_message(
-# #                     source="PAC-ID",
-# #                     type="Recommendation",
-# #                     highlight_pattern=self.issuer,
-# #                     highlight_sub=not_recommended_chars,
-# #                     msg=f"Characters {' '.join(not_recommended_chars)} should not be used. Issuer SHOULD contain only the characters A-Z, 0-9, -, and . "
-# #                 )
-# #         return self
-    
-# #     def __str__(self):
-# #         id_segments = ''
-# #         for s in self.identifier.segments:
-# #             if s.key:
-# #                 id_segments += f'/{s.key}:{s.value}'
-# #             else:
-# #                 id_segments += f'/{s.value}'
-    
-# #         out = f"HTTPS://PAC.{self.issuer}{id_segments}"
-# #         return out
-    
-    
-    
-    
-# # class PACID_With_Extensions(BaseModelWithValidationMessages):
-# #     pac_id: PACID
-# #     extensions: list[Extension] = Field(default_factory=list)
-    
-# #     def __str__(self):
-# #         out = str(self.pac_id)
-# #         out += '*'.join(str(e) for e in self.extensions)
-        
-# #     def get_extension_of_type(self, type:str) -> list[Extension]:
-# #         return [e for e in self.extensions if e.type == type]
-    
-# #     def get_extension(self, name:str) -> Extension|None:
-# #         out = [e for e in self.extensions if e.name == name]
-# #         if not out:
-# #             return None
-# #         return out[0]
-        
-
-
-
-