dcicutils 8.8.1.1b27__py3-none-any.whl → 8.8.1.1b28__py3-none-any.whl

dcicutils/submitr/ref_lookup_strategy.py

@@ -0,0 +1,67 @@
+import re
+from typing import Optional
+from dcicutils.structured_data import Portal
+
+
+def ref_lookup_strategy(portal: Portal, type_name: str, schema: dict, value: str) -> (int, Optional[str]):
+    #
+    # FYI: Note this situation WRT object lookups ...
+    #
+    # /{submitted_id}                # NOT FOUND
+    # /UnalignedReads/{submitted_id} # OK
+    # /SubmittedFile/{submitted_id}  # OK
+    # /File/{submitted_id}           # NOT FOUND
+    #
+    # /{accession}                   # OK
+    # /UnalignedReads/{accession}    # NOT FOUND
+    # /SubmittedFile/{accession}     # NOT FOUND
+    # /File/{accession}              # OK
+    #
+    def ref_validator(schema: Optional[dict],
+                      property_name: Optional[str], property_value: Optional[str]) -> Optional[bool]:
+        """
+        Returns False iff the type represented by the given schema, can NOT be referenced by
+        the given property name with the given property value, otherwise returns None.
+
+        For example, if the schema is for the UnalignedReads type and the property name
+        is accession, then we will return False iff the given property value is NOT a properly
+        formatted accession ID. Otherwise, we will return None, which indicates that the
+        caller (in dcicutils.structured_data.Portal.ref_exists) will continue executing
+        its default behavior, which is to check other ways in which the given type can NOT
+        be referenced by the given value, i.e. it checks other identifying properties for
+        the type and makes sure any patterns (e.g. for submitted_id or uuid) are ahered to.
+
+        The goal (in structured_data) being to detect if a type is being referenced in such
+        a way that cannot possibly be allowed, i.e. because none of its identifying types
+        are in the required form (if indeed there any requirements). Note that it is guaranteed
+        that the given property name is indeed an identifying property for the given type.
+        """
+        if property_format := schema.get("properties", {}).get(property_name, {}).get("format"):
+            if (property_format == "accession") and (property_name == "accession"):
+                if not _is_accession_id(property_value):
+                    return False
+        return None
+
+    DEFAULT_RESPONSE = (Portal.LOOKUP_DEFAULT, ref_validator)
+
+    if not value:
+        return DEFAULT_RESPONSE
+    if not schema:
+        if not isinstance(portal, Portal) or not (schema := portal.get_schema(type_name)):
+            return DEFAULT_RESPONSE
+    if schema_properties := schema.get("properties"):
+        if schema_properties.get("accession") and _is_accession_id(value):
+            # Case: lookup by accession (only by root).
+            return Portal.LOOKUP_ROOT, ref_validator
+        elif schema_property_info_submitted_id := schema_properties.get("submitted_id"):
+            if schema_property_pattern_submitted_id := schema_property_info_submitted_id.get("pattern"):
+                if re.match(schema_property_pattern_submitted_id, value):
+                    # Case: lookup by submitted_id (only by specified type).
+                    return Portal.LOOKUP_SPECIFIED_TYPE, ref_validator
+    return DEFAULT_RESPONSE
+
+
+# This is here for now because of problems with circular dependencies.
+# See: smaht-portal/.../schema_formats.py
+def _is_accession_id(value: str) -> bool:
+    return isinstance(value, str) and re.match(r"^SMA[1-9A-Z]{9}$", value) is not None

{dcicutils-8.8.1.1b27.dist-info → dcicutils-8.8.1.1b28.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dcicutils
-Version: 8.8.1.1b27
+Version: 8.8.1.1b28
 Summary: Utility package for interacting with the 4DN Data Portal and other 4DN resources
 Home-page: https://github.com/4dn-dcic/utils
 License: MIT

{dcicutils-8.8.1.1b27.dist-info → dcicutils-8.8.1.1b28.dist-info}/RECORD

@@ -64,14 +64,15 @@ dcicutils/snapshot_utils.py,sha256=ymP7PXH6-yEiXAt75w0ldQFciGNqWBClNxC5gfX2FnY,2
 dcicutils/ssl_certificate_utils.py,sha256=F0ifz_wnRRN9dfrfsz7aCp4UDLgHEY8LaK7PjnNvrAQ,9707
 dcicutils/structured_data.py,sha256=IjiLOLsxtINOEaz3oVSEscA4lW-t6u9dFfW-NRCRmfs,58451
 dcicutils/submitr/progress_constants.py,sha256=5bxyX77ql8qEJearfHEvsvXl7D0GuUODW0T65mbRmnE,2895
+dcicutils/submitr/ref_lookup_strategy.py,sha256=Js2cVznTmgjciLWBPLCvMiwLIHXjDn3jww-gJPjYuFw,3467
 dcicutils/task_utils.py,sha256=MF8ujmTD6-O2AC2gRGPHyGdUrVKgtr8epT5XU8WtNjk,8082
 dcicutils/tmpfile_utils.py,sha256=n95XF8dZVbQRSXBZTGToXXfSs3JUVRyN6c3ZZ0nhAWI,1403
 dcicutils/trace_utils.py,sha256=g8kwV4ebEy5kXW6oOrEAUsurBcCROvwtZqz9fczsGRE,1769
 dcicutils/validation_utils.py,sha256=cMZIU2cY98FYtzK52z5WUYck7urH6JcqOuz9jkXpqzg,14797
 dcicutils/variant_utils.py,sha256=2H9azNx3xAj-MySg-uZ2SFqbWs4kZvf61JnK6b-h4Qw,4343
 dcicutils/zip_utils.py,sha256=rnjNv_k6L9jT2SjDSgVXp4BEJYLtz9XN6Cl2Fy-tqnM,2027
-dcicutils-8.8.1.1b27.dist-info/LICENSE.txt,sha256=qnwSmfnEWMl5l78VPDEzAmEbLVrRqQvfUQiHT0ehrOo,1102
-dcicutils-8.8.1.1b27.dist-info/METADATA,sha256=10eVXu2Pbsp3riFUY08fAjFnIkywJg2qPNTJqjJ9Noc,3357
-dcicutils-8.8.1.1b27.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-dcicutils-8.8.1.1b27.dist-info/entry_points.txt,sha256=51Q4F_2V10L0282W7HFjP4jdzW4K8lnWDARJQVFy_hw,270
-dcicutils-8.8.1.1b27.dist-info/RECORD,,
+dcicutils-8.8.1.1b28.dist-info/LICENSE.txt,sha256=qnwSmfnEWMl5l78VPDEzAmEbLVrRqQvfUQiHT0ehrOo,1102
+dcicutils-8.8.1.1b28.dist-info/METADATA,sha256=BQjxloCg_4ksew6yyy1O5C9CSZ8VUTQrsqgfq1_K9D4,3357
+dcicutils-8.8.1.1b28.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+dcicutils-8.8.1.1b28.dist-info/entry_points.txt,sha256=51Q4F_2V10L0282W7HFjP4jdzW4K8lnWDARJQVFy_hw,270
+dcicutils-8.8.1.1b28.dist-info/RECORD,,