dcicutils 8.8.4.1b3__tar.gz → 8.8.4.1b4__tar.gz

{dcicutils-8.8.4.1b3 → dcicutils-8.8.4.1b4}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: dcicutils
-Version: 8.8.4.1b3
+Version: 8.8.4.1b4
 Summary: Utility package for interacting with the 4DN Data Portal and other 4DN resources
 Home-page: https://github.com/4dn-dcic/utils
 License: MIT
 Author: 4DN-DCIC Team
 Author-email: support@4dnucleome.org
-Requires-Python: >=3.8,<3.12
+Requires-Python: >=3.8,<3.13
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
@@ -26,8 +26,8 @@ Requires-Dist: PyJWT (>=2.6.0,<3.0.0)
 Requires-Dist: PyYAML (>=6.0.1,<7.0.0)
 Requires-Dist: appdirs (>=1.4.4,<2.0.0)
 Requires-Dist: aws-requests-auth (>=0.4.2,<1)
-Requires-Dist: boto3 (>=1.28.57,<2.0.0)
-Requires-Dist: botocore (>=1.31.57,<2.0.0)
+Requires-Dist: boto3 (>=1.34.90,<2.0.0)
+Requires-Dist: botocore (>=1.34.90,<2.0.0)
 Requires-Dist: chardet (>=5.2.0,<6.0.0)
 Requires-Dist: docker (>=4.4.4,<5.0.0)
 Requires-Dist: elasticsearch (==7.13.4)

{dcicutils-8.8.4.1b3 → dcicutils-8.8.4.1b4}/dcicutils/file_utils.py

@@ -58,15 +58,21 @@ def search_for_file(file: str,
         return None if single else []
 
 
-def normalize_file_path(path: str, including_home_directory: bool = False) -> str:
+def normalize_file_path(path: str, home_directory: bool = True) -> str:
+    """
+    Normalizes the given file path name and returns. Does things like remove multiple
+    consecutive slashes and redundant/unnecessary parent paths; if the home_directory
+    argument is True (the default) then also handles the special tilde home directory
+    component/convention and uses this in the result if applicable.
+    """
     if not isinstance(path, str) or not path:
         path = os.getcwd()
     path = os.path.normpath(path)
-    home_directory = os.path.expanduser("~")
-    if path.startswith("~"):
+    home_directory = os.path.expanduser("~") if home_directory is True else None
+    if home_directory and path.startswith("~"):
         path = os.path.join(home_directory, path[2 if path.startswith("~/") else 1:])
     path = os.path.abspath(path)
-    if including_home_directory and (os.name == "posix"):
+    if home_directory and (os.name == "posix"):
         if path.startswith(home_directory) and path != home_directory:
             path = "~/" + pathlib.Path(path).relative_to(home_directory).as_posix()
     return path

{dcicutils-8.8.4.1b3 → dcicutils-8.8.4.1b4}/dcicutils/http_utils.py

@@ -6,6 +6,11 @@ from dcicutils.tmpfile_utils import temporary_file
 
 @contextmanager
 def download(url: str, suffix: Optional[str] = None, binary: bool = True) -> Optional[str]:
+    """
+    Context manager to ownload the given URL into a temporary file and yields the file
+    path to it. An optional file suffix may be specified. Defaults to binary file mode;
+    if this is not desired then pass False as the binary argument.
+    """
     with temporary_file(suffix=suffix) as file:
         response = requests.get(url, stream=True)
         with open(file, "wb" if binary is True else "w") as f:

{dcicutils-8.8.4.1b3 → dcicutils-8.8.4.1b4}/dcicutils/misc_utils.py

@@ -14,6 +14,7 @@ import json
 import logging
 import math
 import os
+import platform
 import pytz
 import re
 import rfc3986.validators
@@ -2682,3 +2683,18 @@ def get_app_specific_directory() -> str:
     N.B. This is has been tested on MacOS and Linux but not on Windows.
     """
     return appdirs.user_data_dir()
+
+
+def get_os_name() -> str:
+    if os_name := platform.system():
+        if os_name == "Darwin": return "osx"  # noqa
+        elif os_name == "Linux": return "linux"  # noqa
+        elif os_name == "Windows": return "windows"  # noqa
+    return ""
+
+
+def get_cpu_architecture_name() -> str:
+    if os_architecture_name := platform.machine():
+        if os_architecture_name == "x86_64": return "amd64"  # noqa
+        return os_architecture_name
+    return ""

{dcicutils-8.8.4.1b3 → dcicutils-8.8.4.1b4}/dcicutils/zip_utils.py

@@ -51,6 +51,11 @@ def unpack_gz_file_to_temporary_file(file: str, suffix: Optional[str] = None) ->
 
 def extract_file_from_zip(zip_file: str, file_to_extract: str,
                           destination_file: str, raise_exception: bool = True) -> bool:
+    """
+    Extracts from the given zip file, the given file to extract, writing it to the
+    given destination file. Returns True if all is well, otherwise False, or if the
+    raise_exception argument is True (the default), then raises and exception on error.
+    """
     try:
         if not (destination_directory := os.path.dirname(destination_file)):
             destination_directory = os.getcwd()

{dcicutils-8.8.4.1b3 → dcicutils-8.8.4.1b4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dcicutils"
-version = "8.8.4.1b3"  # TODO: To become 8.8.5
+version = "8.8.4.1b4"  # TODO: To become 8.8.5
 description = "Utility package for interacting with the 4DN Data Portal and other 4DN resources"
 authors = ["4DN-DCIC Team <support@4dnucleome.org>"]
 license = "MIT"
@@ -37,9 +37,9 @@ classifiers = [
 
 
 [tool.poetry.dependencies]
-python = ">=3.8,<3.12"
-boto3 = "^1.28.57"
-botocore = "^1.31.57"
+python = ">=3.8,<3.13"
+boto3 = "^1.34.90"
+botocore = "^1.34.90"
 # The DCIC portals (cgap-portal and fourfront) are very particular about which ElasticSearch version.
 # This value is intentionally pinned and must not be changed casually.
 elasticsearch = "7.13.4"
@@ -70,8 +70,8 @@ webtest = "^2.0.34"
 
 
 [tool.poetry.dev-dependencies]
-boto3-stubs = "^1.28.57"
-botocore-stubs = "^1.31.57"
+boto3-stubs = "^1.34.90"
+botocore-stubs = "^1.34.90"
 coverage = ">=7.2.3"
 # Loaded manually in GA workflow for coverage because a dependency on 2to3
 # in its docopts dependency makes a problem for laoding it here in poetry. -kmp 7-Apr-2023