dcicutils 8.8.6.1b3__py3-none-any.whl → 8.8.6.1b5__py3-none-any.whl

dcicutils/portal_object_utils.py

@@ -1,6 +1,5 @@
 from copy import deepcopy
 from functools import lru_cache
-import re
 from typing import Any, Callable, List, Optional, Tuple, Type, Union
 from dcicutils.data_readers import RowReader
 from dcicutils.misc_utils import create_readonly_object
@@ -14,11 +13,9 @@ class PortalObject:
 
     _PROPERTY_DELETION_SENTINEL = RowReader.CELL_DELETION_SENTINEL
 
-    def __init__(self, data: dict, portal: Portal = None,
-                 schema: Optional[Union[dict, Schema]] = None, type: Optional[str] = None) -> None:
+    def __init__(self, data: dict, portal: Optional[Portal] = None, type: Optional[str] = None) -> None:
         self._data = data if isinstance(data, dict) else {}
         self._portal = portal if isinstance(portal, Portal) else None
-        self._schema = schema if isinstance(schema, dict) else (schema.data if isinstance(schema, Schema) else None)
         self._type = type if isinstance(type, str) else ""
 
     @property
@@ -32,7 +29,7 @@ class PortalObject:
     @property
     @lru_cache(maxsize=1)
     def type(self) -> str:
-        return self._type or Portal.get_schema_type(self._data) or (Schema(self._schema).type if self._schema else "")
+        return self._type or Portal.get_schema_type(self._data) or ""
 
     @property
     @lru_cache(maxsize=1)
@@ -47,7 +44,7 @@ class PortalObject:
     @property
     @lru_cache(maxsize=1)
     def schema(self) -> Optional[dict]:
-        return self._schema if self._schema else (self._portal.get_schema(self.type) if self._portal else None)
+        return self._portal.get_schema(self.type) if self._portal else None
 
     def copy(self) -> PortalObject:
         return PortalObject(deepcopy(self.data), portal=self.portal, type=self.type)
@@ -59,39 +56,29 @@ class PortalObject:
         Returns the list of all identifying property names of this Portal object which actually have values.
         Implicitly include "uuid" and "identifier" properties as identifying properties if they are actually
         properties in the object schema, and favor these (first); defavor "aliases"; no other ordering defined.
+        Changed (2024-05-26) to use portal_utils.get_identifying_property_names; migrating some intricate stuff there.
         """
-        if not (schema := self.schema) or not (schema_identifying_properties := schema.get("identifyingProperties")):
-            return None
-        identifying_properties = []
-        for identifying_property in schema_identifying_properties:
-            if identifying_property not in ["uuid", "identifier", "aliases"]:
-                if self._data.get(identifying_property):
-                    identifying_properties.append(identifying_property)
-        if self._data.get("identifier"):
-            identifying_properties.insert(0, "identifier")
-        if self._data.get("uuid"):
-            identifying_properties.insert(0, "uuid")
-        if "aliases" in schema_identifying_properties and self._data.get("aliases"):
-            identifying_properties.append("aliases")
-        return identifying_properties or None
+        # Migrating to and unifying this in portal_utils.Portal.get_identifying_paths (2024-05-26).
+        return self._portal.get_identifying_property_names(self.type, portal_object=self._data) if self._portal else []
 
     @lru_cache(maxsize=8192)
     def lookup(self, raw: bool = False,
                ref_lookup_strategy: Optional[Callable] = None) -> Tuple[Optional[PortalObject], Optional[str], int]:
+        if not (identifying_paths := self._get_identifying_paths(ref_lookup_strategy=ref_lookup_strategy)):
+            return None, None, 0
         nlookups = 0
         first_identifying_path = None
         try:
-            if identifying_paths := self._get_identifying_paths(ref_lookup_strategy=ref_lookup_strategy):
-                for identifying_path in identifying_paths:
-                    if not first_identifying_path:
-                        first_identifying_path = identifying_path
-                    nlookups += 1
-                    if (value := self._portal.get(identifying_path, raw=raw)) and (value.status_code == 200):
-                        return (
-                            PortalObject(value.json(), portal=self._portal, type=self.type if raw else None),
-                            identifying_path,
-                            nlookups
-                        )
+            for identifying_path in identifying_paths:
+                if not first_identifying_path:
+                    first_identifying_path = identifying_path
+                nlookups += 1
+                if self._portal and (item := self._portal.get(identifying_path, raw=raw)) and (item.status_code == 200):
+                    return (
+                        PortalObject(item.json(), portal=self._portal, type=self.type if raw else None),
+                        identifying_path,
+                        nlookups
+                    )
         except Exception:
             pass
         return None, first_identifying_path, nlookups
@@ -158,65 +145,16 @@ class PortalObject:
         return diffs
 
     @lru_cache(maxsize=1)
-    def _get_identifying_paths(self, ref_lookup_strategy: Optional[Callable] = None) -> Optional[List[str]]:
-        """
-        Returns a list of the possible Portal URL paths identifying this Portal object.
-        """
-        identifying_paths = []
-        if not (identifying_properties := self.identifying_properties):
-            if self.uuid:
-                if self.type:
-                    identifying_paths.append(f"/{self.type}/{self.uuid}")
-                identifying_paths.append(f"/{self.uuid}")
-            return identifying_paths
-        for identifying_property in identifying_properties:
-            if identifying_value := self._data.get(identifying_property):
-                if identifying_property == "uuid":
-                    if self.type:
-                        identifying_paths.append(f"/{self.type}/{identifying_value}")
-                    identifying_paths.append(f"/{identifying_value}")
-                # For now at least we include the path both with and without the schema type component,
-                # as for some identifying values, it works (only) with, and some, it works (only) without.
-                # For example: If we have FileSet with "accession", an identifying property, with value
-                # SMAFSFXF1RO4 then /SMAFSFXF1RO4 works but /FileSet/SMAFSFXF1RO4 does not; and
-                # conversely using "submitted_id", also an identifying property, with value
-                # UW_FILE-SET_COLO-829BL_HI-C_1 then /UW_FILE-SET_COLO-829BL_HI-C_1 does
-                # not work but /FileSet/UW_FILE-SET_COLO-829BL_HI-C_1 does work.
-                elif isinstance(identifying_value, list):
-                    for identifying_value_item in identifying_value:
-                        if self.type:
-                            identifying_paths.append(f"/{self.type}/{identifying_value_item}")
-                        identifying_paths.append(f"/{identifying_value_item}")
-                else:
-                    # TODO: Import from somewhere ...
-                    lookup_options = 0
-                    if schema := self.schema:
-                        # TODO: Hook into the ref_lookup_strategy thing in structured_data to make
-                        # sure we check accession format (since it does not have a pattern).
-                        if callable(ref_lookup_strategy):
-                            lookup_options, ref_validator = ref_lookup_strategy(
-                                self._portal, self.type, schema, identifying_value)
-                            if callable(ref_validator):
-                                if ref_validator(schema, identifying_property, identifying_value) is False:
-                                    continue
-                        if pattern := schema.get("properties", {}).get(identifying_property, {}).get("pattern"):
-                            if not re.match(pattern, identifying_value):
-                                # If this identifying value is for a (identifying) property which has a
-                                # pattern, and the value does NOT match the pattern, then do NOT include
-                                # this value as an identifying path, since it cannot possibly be found.
-                                continue
-                    if not lookup_options:
-                        lookup_options = Portal.LOOKUP_DEFAULT
-                    if Portal.is_lookup_root_first(lookup_options):
-                        identifying_paths.append(f"/{identifying_value}")
-                    if Portal.is_lookup_specified_type(lookup_options) and self.type:
-                        identifying_paths.append(f"/{self.type}/{identifying_value}")
-                    if Portal.is_lookup_root(lookup_options) and not Portal.is_lookup_root_first(lookup_options):
-                        identifying_paths.append(f"/{identifying_value}")
-                    if Portal.is_lookup_subtypes(lookup_options):
-                        for subtype_name in self._portal.get_schema_subtype_names(self.type):
-                            identifying_paths.append(f"/{subtype_name}/{identifying_value}")
-        return identifying_paths or None
+    def _get_identifying_paths(self, all: bool = True,
+                               ref_lookup_strategy: Optional[Callable] = None) -> Optional[List[str]]:
+        if not self._portal and (uuid := self.uuid):
+            if all is True and (type := self.type):
+                return [f"/{type}/{uuid}", f"/{uuid}"]
+            return [f"/{uuid}"]
+        # Migrating to and unifying this in portal_utils.Portal.get_identifying_paths (2024-05-26).
+        return self._portal.get_identifying_paths(self._data,
+                                                  portal_type=self.schema, all=all,
+                                                  lookup_strategy=ref_lookup_strategy) if self._portal else None
 
     def _normalized_refs(self, refs: List[dict]) -> Tuple[PortalObject, int]:
         """

dcicutils/portal_utils.py

@@ -50,15 +50,16 @@ class Portal:
     FILE_TYPE_SCHEMA_NAME = "File"
 
     # Object lookup strategies; on a per-reference (type/value) basis, used currently ONLY by
-    # structured_data.py; controlled by an optional ref_lookup_strategy callable; default is
+    # structured_data.py; controlled by an optional lookup_strategy callable; default is
     # lookup at root path but after the specified type path lookup, and then lookup all subtypes;
     # can choose to lookup root path first, or not lookup root path at all, or not lookup
-    # subtypes at all; the ref_lookup_strategy callable if specified should take a type_name
+    # subtypes at all; the lookup_strategy callable if specified should take a type_name
     # and value (string) arguements and return an integer of any of the below ORed together.
     # The main purpose of this is optimization; to minimize portal lookups; since for example,
     # currently at least, /{type}/{accession} does not work but /{accession} does; so we
     # currently (smaht-portal/.../ingestion_processors) use LOOKUP_ROOT_FIRST for this.
     # And current usage NEVER has LOOKUP_SUBTYPES turned OFF; but support just in case.
+    LOOKUP_UNDEFINED = 0
     LOOKUP_SPECIFIED_TYPE = 0x0001
     LOOKUP_ROOT = 0x0002
     LOOKUP_ROOT_FIRST = 0x0004 | LOOKUP_ROOT
@@ -207,23 +208,6 @@ class Portal:
     def vapp(self) -> Optional[TestApp]:
         return self._vapp
 
-    @staticmethod
-    def is_lookup_specified_type(lookup_options: int) -> bool:
-        return (lookup_options &
-                Portal.LOOKUP_SPECIFIED_TYPE) == Portal.LOOKUP_SPECIFIED_TYPE
-
-    @staticmethod
-    def is_lookup_root(lookup_options: int) -> bool:
-        return (lookup_options & Portal.LOOKUP_ROOT) == Portal.LOOKUP_ROOT
-
-    @staticmethod
-    def is_lookup_root_first(lookup_options: int) -> bool:
-        return (lookup_options & Portal.LOOKUP_ROOT_FIRST) == Portal.LOOKUP_ROOT_FIRST
-
-    @staticmethod
-    def is_lookup_subtypes(lookup_options: int) -> bool:
-        return (lookup_options & Portal.LOOKUP_SUBTYPES) == Portal.LOOKUP_SUBTYPES
-
     def get(self, url: str, follow: bool = True,
             raw: bool = False, database: bool = False, raise_for_status: bool = False, **kwargs) -> OptionalResponse:
         url = self.url(url, raw, database)
@@ -307,7 +291,10 @@ class Portal:
 
     @lru_cache(maxsize=100)
     def get_schema(self, schema_name: str) -> Optional[dict]:
-        return get_schema(self.schema_name(schema_name), portal_vapp=self.vapp, key=self.key)
+        try:
+            return get_schema(self.schema_name(schema_name), portal_vapp=self.vapp, key=self.key)
+        except Exception:
+            return None
 
     @lru_cache(maxsize=1)
     def get_schemas(self) -> dict:
@@ -419,53 +406,204 @@ class Portal:
         return schemas_super_type_map.get(type_name, [])
 
     @function_cache(maxsize=100, serialize_key=True)
-    def get_identifying_paths(self, portal_object: dict, portal_type: Optional[str] = None) -> List[str]:
+    def get_identifying_paths(self, portal_object: dict, portal_type: Optional[Union[str, dict]] = None,
+                              all: bool = True, lookup_strategy: Optional[Union[Callable, bool]] = None) -> List[str]:
         """
-        Returns the list of the identifying Portal (URL) paths for the given Portal object. Favors any
-        uuid based path and defavors aliases based paths (ala self.get_identifying_property_names);
-        no other ordering defined. Returns empty list of none or otherwise not found.
+        Returns the list of the identifying Portal (URL) paths for the given Portal object. Favors any uuid
+        and identifier based paths and defavors aliases based paths (ala self.get_identifying_property_names);
+        no other ordering defined. Returns an empty list if no identifying properties or otherwise not found.
+        Note that this is a newer version of what was in portal_object_utils and just uses the ref_lookup_stratey
+        module directly, as it no longer needs to be exposed (to smaht-portal/ingester and smaht-submitr) and so
+        this is a first step toward internalizing it to structured_data/portal_utils/portal_object_utils usages.
         """
+        def is_lookup_specified_type(lookup_options: int) -> bool:
+            return (lookup_options & Portal.LOOKUP_SPECIFIED_TYPE) == Portal.LOOKUP_SPECIFIED_TYPE
+        def is_lookup_root(lookup_options: int) -> bool:  # noqa
+            return (lookup_options & Portal.LOOKUP_ROOT) == Portal.LOOKUP_ROOT
+        def is_lookup_root_first(lookup_options: int) -> bool:  # noqa
+            return (lookup_options & Portal.LOOKUP_ROOT_FIRST) == Portal.LOOKUP_ROOT_FIRST
+        def is_lookup_subtypes(lookup_options: int) -> bool:  # noqa
+            return (lookup_options & Portal.LOOKUP_SUBTYPES) == Portal.LOOKUP_SUBTYPES
+
         results = []
         if not isinstance(portal_object, dict):
             return results
-        if not isinstance(portal_type, str) or not portal_type:
-            if not (portal_type := self.get_schema_type(portal_object)):
-                return results
+        if not (isinstance(portal_type, str) and portal_type):
+            if isinstance(portal_type, dict):
+                # It appears that the given portal_type is an actual schema dictionary.
+                portal_type = self.schema_name(portal_type.get("title"))
+            if not (isinstance(portal_type, str) and portal_type):
+                if not (portal_type := self.get_schema_type(portal_object)):
+                    return results
+        if not callable(lookup_strategy):
+            lookup_strategy = None if lookup_strategy is False else Portal._lookup_strategy
         for identifying_property in self.get_identifying_property_names(portal_type):
-            if identifying_value := portal_object.get(identifying_property):
-                if isinstance(identifying_value, list):
-                    for identifying_value_item in identifying_value:
+            if not (identifying_value := portal_object.get(identifying_property)):
+                continue
+            # The get_identifying_property_names call above ensures uuid is first if it is in the object.
+            # And also note that ALL schemas do in fact have identifyingProperties which do in fact have
+            # uuid, except for a couple "Test" ones, and (for some reason) SubmittedItem; otherwise we
+            # might have a special case to check the Portal object explicitly for uuid, but no need.
+            if identifying_property == "uuid":
+                #
+                # Note this idiosyncrasy with Portal paths: the only way we do NOT get a (HTTP 301) redirect
+                # is if we use the lower-case-dashed-plural based version of the path, e.g. all of these:
+                #
+                # - /d13d06c1-218e-4f61-aaf0-91f226248b3c
+                # - /d13d06c1-218e-4f61-aaf0-91f226248b3c/
+                # - /FileFormat/d13d06c1-218e-4f61-aaf0-91f226248b3c
+                # - /FileFormat/d13d06c1-218e-4f61-aaf0-91f226248b3c/
+                # - /files-formats/d13d06c1-218e-4f61-aaf0-91f226248b3c
+                #
+                # Will result in a (HTTP 301) redirect to:
+                #
+                # - /files-formats/d13d06c1-218e-4f61-aaf0-91f226248b3c/
+                #
+                # Unfortunately, this code here has no reasonable way of getting that lower-case-dashed-plural
+                # based name (e.g. file-formats) from the schema/portal type name (e.g. FileFormat); as the
+                # information is contained, for this example, in the snovault.collection decorator for the
+                # endpoint definition in smaht-portal/.../types/file_format.py. Unfortunately merely because
+                # behind-the-scenes an extra round-trip HTTP request will occur, but happens automatically.
+                # And note the disction of just using /{uuid} here rather than /{type}/{uuid} as in the else
+                # statement below is not really necessary; just here for emphasis that this is all that's needed.
+                #
+                if all is True:
+                    results.append(f"/{portal_type}/{identifying_value}")
+                results.append(f"/{identifying_value}")
+            elif isinstance(identifying_value, list):
+                for identifying_value_item in identifying_value:
+                    if identifying_value_item:
                         results.append(f"/{portal_type}/{identifying_value_item}")
-                elif identifying_property == "uuid":
+                        if all is True:
+                            results.append(f"/{identifying_value_item}")
+            else:
+                lookup_options = Portal.LOOKUP_UNDEFINED
+                if schema := self.get_schema(portal_type):
+                    if callable(lookup_strategy):
+                        lookup_options, validator = lookup_strategy(self._portal, self.type, schema, identifying_value)
+                        if callable(validator):
+                            if validator(schema, identifying_property, identifying_value) is False:
+                                continue
+                    if pattern := schema.get("properties", {}).get(identifying_property, {}).get("pattern"):
+                        if not re.match(pattern, identifying_value):
+                            # If this identifying value is for a (identifying) property which has a
+                            # pattern, and the value does NOT match the pattern, then do NOT include
+                            # this value as an identifying path, since it cannot possibly be found.
+                            continue
+                if lookup_options == Portal.LOOKUP_UNDEFINED:
+                    lookup_options = Portal.LOOKUP_DEFAULT
+                if is_lookup_root_first(lookup_options):
                     results.append(f"/{identifying_value}")
-                else:
-                    results.append(f"/{portal_type}/{identifying_value}")
+                if is_lookup_specified_type(lookup_options) and self.type:
+                    results.append(f"/{self.type}/{identifying_value}")
+                if is_lookup_root(lookup_options) and not is_lookup_root_first(lookup_options):
+                    results.append(f"/{identifying_value}")
+                if is_lookup_subtypes(lookup_options):
+                    for subtype_name in self._portal.get_schema_subtype_names(self.type):
+                        results.append(f"/{subtype_name}/{identifying_value}")
         return results
 
     @function_cache(maxsize=100, serialize_key=True)
-    def get_identifying_property_names(self, schema: Union[str, dict]) -> List[str]:
+    def get_identifying_property_names(self, schema: Union[str, dict],
+                                       portal_object: Optional[dict] = None) -> List[str]:
         """
-        Returns the list of identifying property names for the given Portal schema, which may
-        be either a schema name or a schema object; empty list of none or otherwise not found.
+        Returns the list of identifying property names for the given Portal schema, which may be
+        either a schema name or a schema object. If a Portal object is also given then restricts this
+        set of identifying properties to those which actually have values within this Portal object.
+        Favors the uuid and identifier property names and defavors the aliases property name; no other
+        ordering imposed. Returns empty list if no identifying properties or otherwise not found.
         """
         results = []
         if isinstance(schema, str):
-            try:
-                if not (schema := self.get_schema(schema)):
-                    return results
-            except Exception:
+            if not (schema := self.get_schema(schema)):
                 return results
         elif not isinstance(schema, dict):
             return results
         if not (identifying_properties := get_identifying_properties(schema)):
             return results
-        identifying_properties = [*identifying_properties]
-        for favored_identifying_property in reversed(["uuid", "identifier"]):
+        identifying_properties = list(set(identifying_properties))  # paranoid dedup
+        identifying_properties = [*identifying_properties]  # copy so as not to change schema if given
+        favored_identifying_properties = ["uuid", "identifier"]
+        defavored_identifying_properties = ["aliases"]
+        for favored_identifying_property in reversed(favored_identifying_properties):
             if favored_identifying_property in identifying_properties:
                 identifying_properties.remove(favored_identifying_property)
                 identifying_properties.insert(0, favored_identifying_property)
+        for defavored_identifying_property in defavored_identifying_properties:
+            if defavored_identifying_property in identifying_properties:
+                identifying_properties.remove(defavored_identifying_property)
+                identifying_properties.append(defavored_identifying_property)
+        if isinstance(portal_object, dict):
+            for identifying_property in [*identifying_properties]:
+                if portal_object.get(identifying_property) is None:
+                    identifying_properties.remove(identifying_property)
         return identifying_properties
 
+    @staticmethod
+    def _lookup_strategy(portal: Portal, type_name: str, schema: dict, value: str) -> (int, Optional[str]):
+        #
+        # Note this slight odd situation WRT object lookups by submitted_id and accession:
+        # -----------------------------+-----------------------------------------------+---------------+
+        # PATH                         | EXAMPLE                                       | LOOKUP RESULT |
+        # -----------------------------+-----------------------------------------------+---------------+
+        # /submitted_id                | //UW_FILE-SET_COLO-829BL_HI-C_1               | NOT FOUND     |
+        # /UnalignedReads/submitted_id | /UnalignedReads/UW_FILE-SET_COLO-829BL_HI-C_1 | FOUND         |
+        # /SubmittedFile/submitted_id  | /SubmittedFile/UW_FILE-SET_COLO-829BL_HI-C_1  | FOUND         |
+        # /File/submitted_id           | /File/UW_FILE-SET_COLO-829BL_HI-C_1           | NOT FOUND     |
+        # -----------------------------+-----------------------------------------------+---------------+
+        # /accession                   | /SMAFSFXF1RO4                                 | FOUND         |
+        # /UnalignedReads/accession    | /UnalignedReads/SMAFSFXF1RO4                  | NOT FOUND     |
+        # /SubmittedFile/accession     | /SubmittedFile/SMAFSFXF1RO4                   | NOT FOUND     |
+        # /File/accession              | /File/SMAFSFXF1RO4                            | FOUND         |
+        # -----------------------------+-----------------------------------------------+---------------+
+        #
+        def ref_validator(schema: Optional[dict],
+                          property_name: Optional[str], property_value: Optional[str]) -> Optional[bool]:
+            """
+            Returns False iff objects of type represented by the given schema, CANNOT be referenced with
+            a Portal path using the given property name and its given property value, otherwise returns None.
+
+            For example, if the schema is for UnalignedReads 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 (e.g. dcicutils.structured_data.Portal.ref_exists)
+            will continue executing its default behavior, which is to check other ways in which the given type
+            CANNOT 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. It is assumed/guaranteed 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 Portal._is_accession_id(property_value):
+                        return False
+            return None
+
+        DEFAULT_RESULT = (Portal.LOOKUP_DEFAULT, ref_validator)
+        if not value:
+            return DEFAULT_RESULT
+        if not schema:
+            if not isinstance(portal, Portal) or not (schema := portal.get_schema(type_name)):
+                return DEFAULT_RESULT
+        if schema_properties := schema.get("properties"):
+            if schema_properties.get("accession") and Portal._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_RESULT
+
+    @staticmethod
+    def _is_accession_id(value: str) -> bool:
+        # This is here for now because of problems with circular dependencies.
+        # See: smaht-portal/.../schema_formats.py/is_accession(instance) ...
+        return isinstance(value, str) and re.match(r"^SMA[1-9A-Z]{9}$", value) is not None
+
     def url(self, url: str, raw: bool = False, database: bool = False) -> str:
         if not isinstance(url, str) or not url:
             return "/"

dcicutils/submitr/ref_lookup_strategy.py

@@ -2,39 +2,45 @@ import re
 from typing import Optional
 from dcicutils.structured_data import Portal
 
+# This function is exposed (to smaht-portal/ingester and smaht-submitr) only because previously,
+# before it was fully developed, we had differing behaviors; but this has been unified; so this
+# could now be internalized to structured_data, and portal_object_utils (TODO).
+
 
 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
+    # Note this slight odd situation WRT object lookups by submitted_id and accession:
+    # -----------------------------+-----------------------------------------------+---------------+
+    # PATH                         | EXAMPLE                                       | LOOKUP RESULT |
+    # -----------------------------+-----------------------------------------------+---------------+
+    # /submitted_id                | //UW_FILE-SET_COLO-829BL_HI-C_1               | NOT FOUND     |
+    # /UnalignedReads/submitted_id | /UnalignedReads/UW_FILE-SET_COLO-829BL_HI-C_1 | FOUND         |
+    # /SubmittedFile/submitted_id  | /SubmittedFile/UW_FILE-SET_COLO-829BL_HI-C_1  | FOUND         |
+    # /File/submitted_id           | /File/UW_FILE-SET_COLO-829BL_HI-C_1           | NOT FOUND     |
+    # -----------------------------+-----------------------------------------------+---------------+
+    # /accession                   | /SMAFSFXF1RO4                                 | FOUND         |
+    # /UnalignedReads/accession    | /UnalignedReads/SMAFSFXF1RO4                  | NOT FOUND     |
+    # /SubmittedFile/accession     | /SubmittedFile/SMAFSFXF1RO4                   | NOT FOUND     |
+    # /File/accession              | /File/SMAFSFXF1RO4                            | FOUND         |
+    # -----------------------------+-----------------------------------------------+---------------+
     #
     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.
+        Returns False iff objects of type represented by the given schema, CANNOT be referenced with
+        a Portal path using the given property name and its 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.
+        For example, if the schema is for UnalignedReads 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 (e.g. dcicutils.structured_data.Portal.ref_exists)
+        will continue executing its default behavior, which is to check other ways in which the given type
+        CANNOT 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.
+        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. It is assumed/guaranteed 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"):
@@ -62,6 +68,6 @@ def ref_lookup_strategy(portal: Portal, type_name: str, schema: dict, value: str
 
 
 # This is here for now because of problems with circular dependencies.
-# See: smaht-portal/.../schema_formats.py
+# See: smaht-portal/.../schema_formats.py/is_accession(instance) ...
 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.6.1b3.dist-info → dcicutils-8.8.6.1b5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dcicutils
-Version: 8.8.6.1b3
+Version: 8.8.6.1b5
 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.6.1b3.dist-info → dcicutils-8.8.6.1b5.dist-info}/RECORD

@@ -47,8 +47,8 @@ dcicutils/log_utils.py,sha256=7pWMc6vyrorUZQf-V-M3YC6zrPgNhuV_fzm9xqTPph0,10883
 dcicutils/misc_utils.py,sha256=zHwsxxEn24muLBP7mDvMa8I9VdMejwW8HMuCL5xbhhw,107690
 dcicutils/obfuscation_utils.py,sha256=fo2jOmDRC6xWpYX49u80bVNisqRRoPskFNX3ymFAmjw,5963
 dcicutils/opensearch_utils.py,sha256=V2exmFYW8Xl2_pGFixF4I2Cc549Opwe4PhFi5twC0M8,1017
-dcicutils/portal_object_utils.py,sha256=gDXRgPsRvqCFwbC8WatsuflAxNiigOnqr0Hi93k3AgE,15422
-dcicutils/portal_utils.py,sha256=54e0utkLQxQv2_bD37P1ZGeyG63b2W7nCte6KT9eCY0,33402
+dcicutils/portal_object_utils.py,sha256=ryNoSFKEdaj4Y5MPryVanK2Hg32-Kg6r0BwvOPf2Ov0,11227
+dcicutils/portal_utils.py,sha256=ySXVOgMkfJN2x5o5ZpTw9PamdcvCDLstIj1m0Gmwu-o,44070
 dcicutils/progress_bar.py,sha256=UT7lxb-rVF_gp4yjY2Tg4eun1naaH__hB4_v3O85bcE,19468
 dcicutils/project_utils.py,sha256=qPdCaFmWUVBJw4rw342iUytwdQC0P-XKpK4mhyIulMM,31250
 dcicutils/qa_checkers.py,sha256=cdXjeL0jCDFDLT8VR8Px78aS10hwNISOO5G_Zv2TZ6M,20534
@@ -66,15 +66,15 @@ dcicutils/snapshot_utils.py,sha256=ymP7PXH6-yEiXAt75w0ldQFciGNqWBClNxC5gfX2FnY,2
 dcicutils/ssl_certificate_utils.py,sha256=F0ifz_wnRRN9dfrfsz7aCp4UDLgHEY8LaK7PjnNvrAQ,9707
 dcicutils/structured_data.py,sha256=sm8x08ckPZcIcyBaSlQRGrOD3YL9d09gz-xB3_TAWGE,64516
 dcicutils/submitr/progress_constants.py,sha256=5bxyX77ql8qEJearfHEvsvXl7D0GuUODW0T65mbRmnE,2895
-dcicutils/submitr/ref_lookup_strategy.py,sha256=Js2cVznTmgjciLWBPLCvMiwLIHXjDn3jww-gJPjYuFw,3467
+dcicutils/submitr/ref_lookup_strategy.py,sha256=VJN-Oo0LLna6Vo2cu47eC-eU-yUC9NFlQP29xajejVU,4741
 dcicutils/task_utils.py,sha256=MF8ujmTD6-O2AC2gRGPHyGdUrVKgtr8epT5XU8WtNjk,8082
 dcicutils/tmpfile_utils.py,sha256=irmN6Otvtxyum-7qr5h9GIzDs9rtFFyUsGQyqJXd_y4,2997
 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=_Y9EmL3D2dUZhxucxHvrtmmlbZmK4FpSsHEb7rGSJLU,3265
-dcicutils-8.8.6.1b3.dist-info/LICENSE.txt,sha256=qnwSmfnEWMl5l78VPDEzAmEbLVrRqQvfUQiHT0ehrOo,1102
-dcicutils-8.8.6.1b3.dist-info/METADATA,sha256=yvHwO7ib7srO20JLRYmG_InTcRd7LnrOZu1A6AYdLU0,3439
-dcicutils-8.8.6.1b3.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-dcicutils-8.8.6.1b3.dist-info/entry_points.txt,sha256=51Q4F_2V10L0282W7HFjP4jdzW4K8lnWDARJQVFy_hw,270
-dcicutils-8.8.6.1b3.dist-info/RECORD,,
+dcicutils-8.8.6.1b5.dist-info/LICENSE.txt,sha256=qnwSmfnEWMl5l78VPDEzAmEbLVrRqQvfUQiHT0ehrOo,1102
+dcicutils-8.8.6.1b5.dist-info/METADATA,sha256=eDrvr1n8DzjE9FOjKSWjHho43PyTQWvejmH-V4X-DXQ,3439
+dcicutils-8.8.6.1b5.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+dcicutils-8.8.6.1b5.dist-info/entry_points.txt,sha256=51Q4F_2V10L0282W7HFjP4jdzW4K8lnWDARJQVFy_hw,270
+dcicutils-8.8.6.1b5.dist-info/RECORD,,