dcicutils 8.8.4.1b3__py3-none-any.whl → 8.8.4.1b4__py3-none-any.whl

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/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/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/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.dist-info → dcicutils-8.8.4.1b4.dist-info}/METADATA

@@ -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.dist-info → dcicutils-8.8.4.1b4.dist-info}/RECORD

@@ -28,10 +28,10 @@ dcicutils/es_utils.py,sha256=ZksLh5ei7kRUfiFltk8sd2ZSfh15twbstrMzBr8HNw4,7541
 dcicutils/exceptions.py,sha256=4giQGtpak-omQv7BP6Ckeu91XK5fnDosC8gfdmN_ccA,9931
 dcicutils/ff_mocks.py,sha256=6RKS4eUiu_Wl8yP_8V0CaV75w4ZdWxdCuL1CVlnMrek,36918
 dcicutils/ff_utils.py,sha256=oIhuZPnGtfwj6bWyCc1u23JbMB_6InPp01ZqUOljd8M,73123
-dcicutils/file_utils.py,sha256=7Y58GW7hUCWaXcreGDx0iYKrnXdwago8uRA_671ITgU,3277
+dcicutils/file_utils.py,sha256=v8-cdOv6a-8CVbaKvUcEOFjWYVXPtrU8AZgBZ_T9ytU,3653
 dcicutils/function_cache_decorator.py,sha256=XMyiEGODVr2WoAQ68vcoX_9_Xb9p8pZXdXl7keU8i2g,10026
 dcicutils/glacier_utils.py,sha256=Q4CVXsZCbP-SoZIsZ5NMcawDfelOLzbQnIlQn-GdlTo,34149
-dcicutils/http_utils.py,sha256=UKIsP-e8NOZN_4ScLDoFA4Bd1ifYBLTl6RrwvRfuAPY,549
+dcicutils/http_utils.py,sha256=RB0x9hRMZM9Xd1x00c5J0iUzUdYzIQR0XKFiQ94HWO0,807
 dcicutils/jh_utils.py,sha256=Gpsxb9XEzggF_-Eq3ukjKvTnuyb9V1SCSUXkXsES4Kg,11502
 dcicutils/kibana/dashboards.json,sha256=wHMB_mpJ8OaYhRRgvpZuihaB2lmSF64ADt_8hkBWgQg,16225
 dcicutils/kibana/readme.md,sha256=3KmHF9FH6A6xwYsNxRFLw27q0XzHYnjZOlYUnn3VkQQ,2164
@@ -44,7 +44,7 @@ dcicutils/license_policies/park-lab-gpl-pipeline.jsonc,sha256=vLZkwm3Js-kjV44nug
 dcicutils/license_policies/park-lab-pipeline.jsonc,sha256=9qlY0ASy3iUMQlr3gorVcXrSfRHnVGbLhkS427UaRy4,283
 dcicutils/license_utils.py,sha256=d1cq6iwv5Ju-VjdoINi6q7CPNNL7Oz6rcJdLMY38RX0,46978
 dcicutils/log_utils.py,sha256=7pWMc6vyrorUZQf-V-M3YC6zrPgNhuV_fzm9xqTPph0,10883
-dcicutils/misc_utils.py,sha256=hdL7FP2fMTX6OuJ9SXyAS4BLvrNUBLk8XOQHRw_EeiI,105041
+dcicutils/misc_utils.py,sha256=lbvH1ahdTw1DZUhkP-SN1bqZo3Qg8NNs2cCUNtaVbMs,105516
 dcicutils/obfuscation_utils.py,sha256=fo2jOmDRC6xWpYX49u80bVNisqRRoPskFNX3ymFAmjw,5963
 dcicutils/opensearch_utils.py,sha256=V2exmFYW8Xl2_pGFixF4I2Cc549Opwe4PhFi5twC0M8,1017
 dcicutils/portal_object_utils.py,sha256=gDXRgPsRvqCFwbC8WatsuflAxNiigOnqr0Hi93k3AgE,15422
@@ -72,9 +72,9 @@ dcicutils/tmpfile_utils.py,sha256=n95XF8dZVbQRSXBZTGToXXfSs3JUVRyN6c3ZZ0nhAWI,14
 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=dEnUZ1GHfJHPmqXBIqYRorsClSeUTPADoBMxp9TWacI,2994
-dcicutils-8.8.4.1b3.dist-info/LICENSE.txt,sha256=qnwSmfnEWMl5l78VPDEzAmEbLVrRqQvfUQiHT0ehrOo,1102
-dcicutils-8.8.4.1b3.dist-info/METADATA,sha256=-2XbSvptAw3-Hd3TsDWU4bG97BjDOjhMVGG26T-lOBA,3396
-dcicutils-8.8.4.1b3.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-dcicutils-8.8.4.1b3.dist-info/entry_points.txt,sha256=51Q4F_2V10L0282W7HFjP4jdzW4K8lnWDARJQVFy_hw,270
-dcicutils-8.8.4.1b3.dist-info/RECORD,,
+dcicutils/zip_utils.py,sha256=_Y9EmL3D2dUZhxucxHvrtmmlbZmK4FpSsHEb7rGSJLU,3265
+dcicutils-8.8.4.1b4.dist-info/LICENSE.txt,sha256=qnwSmfnEWMl5l78VPDEzAmEbLVrRqQvfUQiHT0ehrOo,1102
+dcicutils-8.8.4.1b4.dist-info/METADATA,sha256=cddMbLW_q0x49LbY99E3nCOHwzVpoNUk7cYmzrwSPhk,3396
+dcicutils-8.8.4.1b4.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+dcicutils-8.8.4.1b4.dist-info/entry_points.txt,sha256=51Q4F_2V10L0282W7HFjP4jdzW4K8lnWDARJQVFy_hw,270
+dcicutils-8.8.4.1b4.dist-info/RECORD,,