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

labfreed/IO/parse_pac.py

@@ -19,12 +19,13 @@ from ..validation import ValidationMessage, LabFREEDValidationError
 
 
 class PACID_With_Extensions(BaseModelWithValidationMessages):
-    pac_id: PACID
+    pac_id: PACID = Field(serialization_alias='pac')
     extensions: list[Extension] = Field(default_factory=list)
     
     def __str__(self):
         out = str(self.pac_id)
         out += '*'.join(str(e) for e in self.extensions)
+        return out
         
     def get_extension_of_type(self, type:str) -> list[Extension]:
         return [e for e in self.extensions if e.type == type]
@@ -87,7 +88,7 @@ class PAC_Parser():
     def __init__(self, extension_interpreters:dict[str, Extension]=None):
         self.extension_interpreters = extension_interpreters or {'TREX': TREX, 'N': DisplayNames}
         
-    def parse(self, pac_url:str) -> PACID_With_Extensions:
+    def parse(self, pac_url:str, suppress_errors=False) -> PACID_With_Extensions:
         if '*' in pac_url:
             id_str, ext_str = pac_url.split('*', 1)
         else:
@@ -98,8 +99,8 @@ class PAC_Parser():
         extensions = self._parse_extensions(ext_str)
         
         pac_with_extension = PACID_With_Extensions(pac_id=pac_id, extensions=extensions)
-        if not pac_with_extension.is_valid():
-            raise LabFREEDValidationError(validation_msgs = pac_with_extension.get_nested_validation_messages())
+        if not pac_with_extension.is_valid() and not suppress_errors:
+            raise LabFREEDValidationError(validation_msgs = pac_with_extension.get_nested_validation_messages(), model=pac_with_extension)
         
         return pac_with_extension
             

labfreed/PAC_CAT/data_model.py

@@ -4,7 +4,11 @@ from abc import ABC
 from typing import Self
 from pydantic import Field, computed_field, model_validator
 
-from labfreed.validation import BaseModelWithValidationMessages
+from rich import print
+from rich.text import Text
+from rich.table import Table
+
+from labfreed.validation import BaseModelWithValidationMessages, ValidationMsgLevel
 
 from ..PAC_ID.data_model import PACID, IDSegment
 
@@ -14,7 +18,7 @@ class PAC_CAT(PACID):
     ''' 
     Extends a PAC-ID with interpretation of the identifier as categories
     '''
-    categories:list[Category] = Field(default_factory=list())
+    categories:list[Category] = Field(default_factory=list)
     
     @property
     def identifier(self) -> list[IDSegment]:
@@ -132,24 +136,37 @@ class PAC_CAT(PACID):
                 for k in duplicate_keys:
                     self.add_validation_message(
                         source=f"identifier {k}",
-                        type="Error",
+                        level = ValidationMsgLevel.ERROR,
                         msg=f"Duplicate key {k} in category {c.key}",
                         highlight_pattern = k
                     )
             return self
         
     def print_categories(self):
+        
+        table = Table(title=f'Categories in {str(self)}', show_header=False)
+        table.add_column('0')
+        table.add_column('1')
         s = ''
         for i, c in enumerate(self.categories):
             if i == 0:
-                title = 'Main Category\n----------'
+                title = Text('Main Category', style='bold')
             else:
-                title = 'Category\n------ '
+                title = Text('Category', style='bold')
+            
+            table.add_row(title)
             
-            s += f'{title}\n'
-            s += str(c)
-            s += '\n'
-        print(s)
+            for field_name, field_info in c.model_fields.items():
+                if not getattr(c, field_name):
+                    continue
+                table.add_row(f"{field_name} ({field_info.alias or ''})",
+                              f" {getattr(c, field_name)}"
+                              )      
+            table.add_section()        
+        print(table)
+        
+ 
+
         
         
     # @classmethod
@@ -175,7 +192,7 @@ class Category(BaseModelWithValidationMessages):
         "populate_by_name": True
     }
     key:str
-    additional_segments: list[IDSegment] = Field(default_factory=list)   
+    additional_segments: list[IDSegment] = Field(default_factory=list, exclude=True)   
     
     @computed_field
     @property
@@ -202,18 +219,21 @@ class Category(BaseModelWithValidationMessages):
     @model_validator(mode='after')
     def warn_unusual_category_key(self):
         ''' this base class is instantiated only if the key is not a known category key'''
-        self.add_validation_message(
-                    source=f"Category {self.key}",
-                    type="Warning",
-                    msg=f'Category key {self.key} is not a well known key. It is recommended to use well known keys only',
-                    highlight_pattern = f"{self.key}"
-        )
+        if type(self) is Category:
+            self.add_validation_message(
+                        source=f"Category {self.key}",
+                        level = ValidationMsgLevel.RECOMMENDATION,
+                        msg=f'Category key {self.key} is not a well known key. It is recommended to use well known keys only',
+                        highlight_pattern = f"{self.key}"
+            )
         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):
@@ -278,14 +298,14 @@ class Material_Device(Category):
         if not self.model_number:
             self.add_validation_message(
                     source=f"Category {self.key}",
-                    type="Error",
+                    level = ValidationMsgLevel.ERROR,
                     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",
+                    level = ValidationMsgLevel.ERROR,
                     msg=f'Category key {self.key} is missing mandatory field Serial Number',
                     highlight_pattern = f"{self.key}"
             )
@@ -303,7 +323,7 @@ class Material_Substance(Category):
         if not self.product_number:
             self.add_validation_message(
                     source=f"Category {self.key}",
-                    type="Error",
+                    level = ValidationMsgLevel.ERROR,
                     msg=f'Category key {self.key} is missing mandatory field Product Number',
                     highlight_pattern = f"{self.key}"
             )
@@ -321,7 +341,7 @@ class Material_Consumable(Category):
         if not self.product_number:
             self.add_validation_message(
                     source=f"Category {self.key}",
-                    type="Error",
+                    level = ValidationMsgLevel.ERROR,
                     msg=f"Category key {self.key} is missing mandatory field 'Product Number'",
                     highlight_pattern = f"{self.key}"
             )
@@ -341,7 +361,7 @@ class Data_Abstract(Category, ABC):
         if not self.id:
             self.add_validation_message(
                     source=f"Category {self.key}",
-                    type="Error",
+                    level = ValidationMsgLevel.ERROR,
                     msg=f"Category key {self.key} is missing mandatory field 'ID'",
                     highlight_pattern = f"{self.key}"
             )

labfreed/PAC_ID/data_model.py

@@ -6,7 +6,7 @@ from pydantic import Field, ValidationInfo, computed_field, conlist, model_valid
 from abc import ABC, abstractproperty, abstractstaticmethod
 
 from ..utilities.well_known_keys import WellKnownKeys
-from labfreed.validation import BaseModelWithValidationMessages, ValidationMessage, hsegment_pattern, domain_name_pattern
+from labfreed.validation import BaseModelWithValidationMessages, ValidationMessage, ValidationMsgLevel, hsegment_pattern, domain_name_pattern
 
 
 class IDSegment(BaseModelWithValidationMessages):
@@ -23,9 +23,8 @@ class IDSegment(BaseModelWithValidationMessages):
         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",
+                    level = ValidationMsgLevel.ERROR,
+                    msg=f"{' '.join(not_allowed_chars)} must not be used. The segment key must be a valid hsegment",
                     highlight_pattern = key,
                     highlight_sub = not_allowed_chars
             )
@@ -33,9 +32,8 @@ class IDSegment(BaseModelWithValidationMessages):
         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",
+                    level = ValidationMsgLevel.ERROR,
+                    msg=f"{' '.join(not_allowed_chars)} must not be used. The segment key must be a valid hsegment",
                     highlight_pattern = value,
                     highlight_sub = not_allowed_chars
             )
@@ -44,9 +42,8 @@ class IDSegment(BaseModelWithValidationMessages):
         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 -+",
+                    level = ValidationMsgLevel.RECOMMENDATION,
+                    msg=f"{' '.join(not_recommended_chars)} should not be used. Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+' ",
                     highlight_pattern = key,
                     highlight_sub = not_recommended_chars
                 )
@@ -55,10 +52,10 @@ class IDSegment(BaseModelWithValidationMessages):
         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
+                    level = ValidationMsgLevel.RECOMMENDATION,
+                    msg=f"{key} is not a well known segment key. It is RECOMMENDED to use well-known keys.",
+                    highlight_pattern = key,
+                    highlight_sub=[key]
                 )
             
             
@@ -66,9 +63,8 @@ class IDSegment(BaseModelWithValidationMessages):
         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 -+",
+                    level = ValidationMsgLevel.RECOMMENDATION,
+                    msg=f"Characters {' '.join(not_recommended_chars)} should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+' ",
                     highlight_pattern = value,
                     highlight_sub = not_recommended_chars
                 )
@@ -78,14 +74,14 @@ class IDSegment(BaseModelWithValidationMessages):
         if ':' in key:
             self.add_validation_message(
                     source=f"id segment key {key}",
-                    type="Recommendation",
+                    level = ValidationMsgLevel.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",
+                    level = ValidationMsgLevel.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
                 )
@@ -96,7 +92,7 @@ class IDSegment(BaseModelWithValidationMessages):
 
 class PACID(BaseModelWithValidationMessages):
     issuer:str
-    identifier: conlist(IDSegment, min_length=1) = Field(..., default_factory=list()) # type: ignore # exclude=True prevents this from being serialized by Pydantic
+    identifier: conlist(IDSegment, min_length=1) = Field(..., default_factory=list) # type: ignore # exclude=True prevents this from being serialized by Pydantic
         
         
     @model_validator(mode='after')
@@ -113,9 +109,8 @@ class PACID(BaseModelWithValidationMessages):
         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 = ""
+                        level = ValidationMsgLevel.ERROR,
+                        msg=f'Identifier is {l} characters long, Identifier must not exceed 256 characters.'
                     )
         return self
        
@@ -125,7 +120,7 @@ class PACID(BaseModelWithValidationMessages):
         if not re.fullmatch(domain_name_pattern, self.issuer):
             self.add_validation_message(
                     source="PAC-ID",
-                    type="Error",
+                    level = ValidationMsgLevel.ERROR,
                     highlight_pattern=self.issuer,
                     msg=f"Issuer must be a valid domain name. "
                 )
@@ -134,7 +129,7 @@ class PACID(BaseModelWithValidationMessages):
         if not_recommended_chars := set(re.sub(r'[A-Z0-9\.-]', '', self.issuer)):
             self.add_validation_message(
                     source="PAC-ID",
-                    type="Recommendation",
+                    level = ValidationMsgLevel.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 . "
@@ -150,7 +145,7 @@ class PACID(BaseModelWithValidationMessages):
             for k in duplicate_keys:
                 self.add_validation_message(
                     source=f"identifier {k}",
-                    type="Recommendation",
+                    level = ValidationMsgLevel.RECOMMENDATION,
                     msg=f"Duplicate segment key {k}. This will probably lead to undefined behaviour",
                     highlight_pattern = k
                 )

labfreed/PAC_ID_Resolver/cit.yaml

@@ -0,0 +1,92 @@
+origin: PAC.METTORIUS.COM
+
+macros:     
+    shop: &shop
+      service_type: userhandover-generic
+      service_name: Shop
+      application_intents:
+        - showdevicemanual-apinilabs
+      template_url: https://mettorius.com/shop/an={$.pac.identifier.categories[1].segments['240'].value}
+        
+    manual: &manual
+      service_type: userhandover-generic
+      service_name: Manual
+      application_intents:
+        - showdevicemanual-apinilabs
+      template_url: https://mettorius.com/om/an={$..*['240'].value}
+        
+    CoA: &coa
+      service_type: userhandover-generic
+      service_name: CoA
+      application_intents:
+        - showCoA-apinilabs
+      template_url: https://mettorius.com/downloads/an={$..*['240'].value}
+
+    dummy: &dummy
+      service_type: userhandover-generic
+      application_intents:
+        - dummy
+      template_url: https://mettorius.com/
+
+
+cit:
+# Test
+- if: mettorius.com == $.pac.issuer
+  entries:
+  - <<: *shop
+  - <<: *manual
+
+# Instruments
+- if: mettorius.com == $.pac.issuer AND $.pac.id.categories['-MD']
+  entries:
+  - <<: *shop
+  - <<: *manual
+    
+
+# Consumables
+- if: mettorius.com == $.pac.issuer AND $.pac.id.categories['-MC']
+  entries:
+  - <<: *shop
+  - <<: *manual
+  - <<: *coa
+
+
+
+# Showcase for logic
+##############################
+
+# multiline string
+- if: "($.pac.issuer == mettorius.com) 
+       AND $.pac.id.categories['-MD']"
+  entries:
+  - <<: *dummy
+    service_name: multiline applicable_if
+
+# folded string
+- if: | 
+    ($.pac.issuer == mettorius.com) 
+    AND $.pac.id.categories['-MD']
+  entries:
+  - <<: *dummy
+    service_name: folded applicable_if
+
+# multiline  string
+- if: | 
+    NOT NOT ($.pac.issuer == mettorius.com) 
+    AND $.pac.id.categories['-MD']
+  entries:
+  - <<: *dummy
+    service_name: multiline applicable_if
+
+- if: NOT ($.pac.issuer != METTORIUS.COM)
+  entries:
+  - <<: *dummy
+    service_name: _3
+
+
+
+
+
+
+
+

labfreed/PAC_ID_Resolver/data_types.py

@@ -0,0 +1,85 @@
+from concurrent.futures import ThreadPoolExecutor, as_completed
+from enum import Enum, auto
+from pydantic import BaseModel, Field, field_validator
+from requests import RequestException, request, ConnectionError, ReadTimeout
+from rich import print
+from rich.table import Table
+
+from labfreed.validation import BaseModelWithValidationMessages
+
+
+class CITEntry(BaseModelWithValidationMessages):
+    service_name: str
+    application_intents:list[str]
+    service_type:str
+    template_url:str
+    
+
+class CITBlock(BaseModelWithValidationMessages):
+    applicable_if: str  = Field(default='True', alias='if')
+    entries: list[CITEntry]
+    
+    @field_validator('applicable_if', mode='before')
+    @classmethod
+    def convert_if(cls, v):
+        return v if v is not None else 'True'
+    
+
+class CIT(BaseModelWithValidationMessages):
+    origin: str = ''
+    macros:dict = Field(default_factory=dict)
+    cit: list[CITBlock] = Field(default_factory=list)
+    
+    
+
+class ServiceState(Enum):
+    ACTIVE = auto()
+    INACTIVE = auto()
+    UNKNOWN = auto()
+    
+class Service(BaseModelWithValidationMessages):
+    service_name: str
+    application_intents:list[str]
+    service_type:str
+    url:str
+    active:ServiceState =ServiceState.UNKNOWN
+    
+    def check_state(self):
+        try:
+            r = request('get',self.url, timeout=2)
+            if r.status_code < 400:
+                self.active = ServiceState.ACTIVE
+            else: 
+                self.active = ServiceState.INACTIVE
+        except RequestException as e:
+            print(f"Request failed: {e}")
+            self.active = ServiceState.INACTIVE
+            
+    
+class CITEvaluated(BaseModelWithValidationMessages):
+    origin: str = ""
+    services: list[Service] = Field(default_factory=list)
+    
+    def update_states(self):
+        with ThreadPoolExecutor(max_workers=10) as executor:
+            futures = [executor.submit(s.check_state) for s in self.services]
+            for _ in as_completed(futures):
+                pass  # just wait for all to finish
+    
+    def __str__(self):
+        out = [f'CIT (origin {self.origin})']
+        for s in self.services:
+            out.append(f'{s.service_name}\t\t\t{s.url}')
+        return '\n'.join(out)
+    
+    def print(self):
+        table = Table(title=f"Services from origin '{self.origin}")
+
+        table.add_column("Service Name")
+        table.add_column("URL")
+        table.add_column('Reachable')
+        
+        for s in self.services:
+            table.add_row(s.service_name, s.url, s.active.name)
+
+        print(table)