dcicutils 8.7.0.1b31__tar.gz → 8.7.0.1b33__tar.gz

{dcicutils-8.7.0.1b31 → dcicutils-8.7.0.1b33}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dcicutils
-Version: 8.7.0.1b31
+Version: 8.7.0.1b33
 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.7.0.1b31 → dcicutils-8.7.0.1b33}/dcicutils/file_utils.py

@@ -6,19 +6,21 @@ from typing import List, Optional, Union
 
 def search_for_file(file: str,
                     location: Union[str, Optional[List[str]]] = None,
-                    multiple: bool = True,
-                    recursive: bool = False) -> Union[List[str], Optional[str]]:
+                    recursive: bool = False,
+                    single: bool = False) -> Union[List[str], Optional[str]]:
     """
-    Searches for the actual existence of the given file name, first in the given directory of list
+    Searches for the existence of the given file name, first directly in the given directory or list
     of directories, if specified, and if not then just in the current (working) directory; if the
     given recursive flag is True then also searches all sub-directories of these directories;
-    returns the full path name to the file if found, otherwise None is returned.
+    returns the full path name to the file if found. If the single flag is True then just the
+    first file which is found is returns (as a string), or None if none; if the single flag
+    is False, then all matched files are returned in a list, or and empty list if none.
     """
     if file and isinstance(file, (str, pathlib.PosixPath)):
         if os.path.isabs(file):
             if os.path.exists(file):
-                return file if not multiple else [file]
-            return None if not multiple else []
+                return file if single else [file]
+            return None if single else []
         files_found = []
         if not location:
             location = ["."]
@@ -29,7 +31,7 @@ def search_for_file(file: str,
         for directory in location:
             if isinstance(directory, (str, pathlib.PosixPath)) and os.path.exists(os.path.join(directory, file)):
                 file_found = os.path.abspath(os.path.normpath(os.path.join(directory, file)))
-                if not multiple:
+                if single:
                     return file_found
                 if file_found not in files_found:
                     files_found.append(file_found)
@@ -43,10 +45,10 @@ def search_for_file(file: str,
                 if files:
                     for file_found in files:
                         file_found = os.path.abspath(file_found)
-                        if not multiple:
+                        if single:
                             return file_found
                         if file_found not in files_found:
                             files_found.append(file_found)
         if files_found:
-            return files_found[0] if not multiple else files_found
-        return None if not multiple else []
+            return files_found[0] if single else files_found
+        return None if single else []

{dcicutils-8.7.0.1b31 → dcicutils-8.7.0.1b33}/dcicutils/portal_object_utils.py

@@ -8,9 +8,13 @@ class PortalObject:
 
     def __init__(self, portal: Portal, portal_object: dict, portal_object_type: Optional[str] = None) -> None:
         self._portal = portal
-        self._object = portal_object
+        self._data = portal_object
         self._type = portal_object_type if isinstance(portal_object_type, str) and portal_object_type else None
 
+    @property
+    def data(self):
+        return self._data
+
     @property
     @lru_cache(maxsize=1)
     def schema(self):
@@ -19,12 +23,12 @@ class PortalObject:
     @property
     @lru_cache(maxsize=1)
     def schema_type(self):
-        return self._type or Portal.get_schema_type(self._object)
+        return self._type or Portal.get_schema_type(self._data)
 
     @property
     @lru_cache(maxsize=1)
     def schema_types(self):
-        return self._type or Portal.get_schema_types(self._object)
+        return self._type or Portal.get_schema_types(self._data)
 
     @property
     @lru_cache(maxsize=1)
@@ -36,7 +40,7 @@ class PortalObject:
     @property
     @lru_cache(maxsize=1)
     def uuid(self) -> Optional[str]:
-        return PortalObject.get_uuid(self._object)
+        return PortalObject.get_uuid(self._data)
 
     @staticmethod
     def get_uuid(portal_object: dict) -> Optional[str]:
@@ -53,13 +57,13 @@ class PortalObject:
         identifying_properties = []
         for identifying_property in self.schema_identifying_properties:
             if identifying_property not in ["uuid", "identifier", "aliases"]:
-                if self._object.get(identifying_property):
+                if self._data.get(identifying_property):
                     identifying_properties.append(identifying_property)
-        if self._object.get("identifier"):
+        if self._data.get("identifier"):
             identifying_properties.insert(0, "identifier")
-        if self._object.get("uuid"):
+        if self._data.get("uuid"):
             identifying_properties.insert(0, "uuid")
-        if "aliases" in self.schema_identifying_properties and self._object.get("aliases"):
+        if "aliases" in self.schema_identifying_properties and self._data.get("aliases"):
             identifying_properties.append("aliases")
         return identifying_properties
 
@@ -73,7 +77,7 @@ class PortalObject:
             return []
         identifying_paths = []
         for identifying_property in identifying_properties:
-            if (identifying_value := self._object.get(identifying_property)):
+            if (identifying_value := self._data.get(identifying_property)):
                 if identifying_property == "uuid":
                     identifying_paths.append(f"/{identifying_value}")
                 # For now at least we include the path both with and without the schema type component

{dcicutils-8.7.0.1b31 → dcicutils-8.7.0.1b33}/dcicutils/structured_data.py

@@ -116,7 +116,7 @@ class StructuredDataSet:
                              location: Union[str, Optional[List[str]]] = None, recursive: bool = False) -> List[str]:
         upload_files = copy.deepcopy(self.upload_files)
         for upload_file in upload_files:
-            if file_path := search_for_file(upload_file["file"], location, multiple=False, recursive=recursive):
+            if file_path := search_for_file(upload_file["file"], location, recursive=recursive, single=True):
                 upload_file["path"] = file_path
         return upload_files
 

{dcicutils-8.7.0.1b31 → dcicutils-8.7.0.1b33}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dcicutils"
-version = "8.7.0.1b31"  # TODO: To become 8.7.1
+version = "8.7.0.1b33"  # TODO: To become 8.7.1
 description = "Utility package for interacting with the 4DN Data Portal and other 4DN resources"
 authors = ["4DN-DCIC Team <support@4dnucleome.org>"]
 license = "MIT"