dcicutils 8.8.4.1b24__py3-none-any.whl → 8.8.4.1b27__py3-none-any.whl

dcicutils/file_utils.py

@@ -97,28 +97,35 @@ def normalize_path(value: Union[str, pathlib.Path], absolute: bool = False, expa
         return ""
     if expand_home is True:
         value = os.path.expanduser(value)
-    elif (expand_home is False) and (os.name == "posix") and value.startswith(home := HOME_DIRECTORY + os.sep):
-        value = "~/" + value[len(home):]
+    elif (expand_home is False) and (os.name == "posix"):
+        if value.startswith(home := HOME_DIRECTORY + os.sep):
+            value = "~/" + value[len(home):]
+        elif value == HOME_DIRECTORY:
+            value = "~"
     if absolute is True:
         value = os.path.abspath(value)
     return value
 
 
-def get_file_size(file: str) -> Optional[int]:
+def get_file_size(file: str, raise_exception: bool = True) -> Optional[int]:
     try:
         return os.path.getsize(file) if isinstance(file, str) else None
     except Exception:
+        if raise_exception is True:
+            raise
         return None
 
 
-def get_file_modified_datetime(file: str) -> Optional[datetime]:
+def get_file_modified_datetime(file: str, raise_exception: bool = True) -> Optional[datetime]:
     try:
         return datetime.fromtimestamp(os.path.getmtime(file)) if isinstance(file, str) else None
     except Exception:
+        if raise_exception is True:
+            raise
         return None
 
 
-def are_files_equal(filea: str, fileb: str) -> bool:
+def are_files_equal(filea: str, fileb: str, raise_exception: bool = True) -> bool:
     """
     Returns True iff the contents of the two given files are exactly the same.
     """
@@ -135,10 +142,12 @@ def are_files_equal(filea: str, fileb: str) -> bool:
                         break
         return True
     except Exception:
+        if raise_exception is True:
+            raise
         return False
 
 
-def compute_file_md5(file: str) -> str:
+def compute_file_md5(file: str, raise_exception: bool = True) -> str:
     """
     Returns the md5 checksum for the given file.
     """
@@ -151,10 +160,12 @@ def compute_file_md5(file: str) -> str:
                 md5.update(chunk)
         return md5.hexdigest()
     except Exception:
+        if raise_exception is True:
+            raise
         return ""
 
 
-def compute_file_etag(file: str) -> Optional[str]:
+def compute_file_etag(file: str, raise_exception: bool = True) -> Optional[str]:
     """
     Returns the AWS S3 "etag" for the given file; this value is md5-like but
     not the same as a normal md5. We use this to compare that a file in S3
@@ -164,6 +175,8 @@ def compute_file_etag(file: str) -> Optional[str]:
         with io.open(file, "rb") as f:
             return _compute_file_etag(f)
     except Exception:
+        if raise_exception is True:
+            raise
         return None
 
 

dcicutils/http_utils.py

@@ -8,24 +8,32 @@ from dcicutils.tmpfile_utils import temporary_file
 def download(url: str, suffix: Optional[str] = None, binary: bool = True,
              progress: Optional[Callable] = None) -> 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.
+    Context manager to download the given URL into a temporary file and yields the file
+    path to it. An optional file suffix may be specified for this temporary file name.
+    Defaults to binary file mode; if not desired then pass False as the binary argument.
     """
-    if not callable(progress):
-        progress = None
     with temporary_file(suffix=suffix) as file:
-        response = requests.get(url, stream=True)
-        if progress:
-            nbytes = 0
-            nbytes_total = None
-            if isinstance(content_length := response.headers.get("Content-Length"), str) and content_length.isdigit():
-                nbytes_total = int(content_length)
-        with open(file, "wb" if binary is True else "w") as f:
-            for chunk in response.iter_content(chunk_size=8192):
-                if chunk:
-                    f.write(chunk)
-                if progress:
-                    nbytes += len(chunk)
-                    progress(nbytes, nbytes_total)
+        download_to(url, file, binary=binary, progress=progress)
         yield file
+
+
+def download_to(url: str, file: str, binary: bool = True, progress: Optional[Callable] = None) -> None:
+    """
+    Download the given URL into the given file. Defaults to binary
+    file mode; if not desired then pass False as the binary argument.
+    """
+    if not callable(progress):
+        progress = None
+    response = requests.get(url, stream=True)
+    if progress:
+        nbytes = 0
+        nbytes_total = None
+        if isinstance(content_length := response.headers.get("Content-Length"), str) and content_length.isdigit():
+            nbytes_total = int(content_length)
+    with open(file, "wb" if binary is True else "w") as f:
+        for chunk in response.iter_content(chunk_size=8192):
+            if chunk:
+                f.write(chunk)
+            if progress:
+                nbytes += len(chunk)
+                progress(nbytes, nbytes_total)

{dcicutils-8.8.4.1b24.dist-info → dcicutils-8.8.4.1b27.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dcicutils
-Version: 8.8.4.1b24
+Version: 8.8.4.1b27
 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.4.1b24.dist-info → dcicutils-8.8.4.1b27.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=WKEe985ioa9QNHVllRp8gxaKxB7hAnN-anKnz4CPfv4,9970
+dcicutils/file_utils.py,sha256=9JRyXciF7AoDKWRBryglsMg5f3VGL_ymg_hSMnxUVKk,10464
 dcicutils/function_cache_decorator.py,sha256=XMyiEGODVr2WoAQ68vcoX_9_Xb9p8pZXdXl7keU8i2g,10026
 dcicutils/glacier_utils.py,sha256=Q4CVXsZCbP-SoZIsZ5NMcawDfelOLzbQnIlQn-GdlTo,34149
-dcicutils/http_utils.py,sha256=Je5ErNjR5e6lfSXGRncK_lcR_-zP38PIpmHjApy9Wi4,1289
+dcicutils/http_utils.py,sha256=tNfH5JA-OwbQKEvD5HPJ3lcp2TSIZ4rnl__4d4JO8Gw,1583
 dcicutils/jh_utils.py,sha256=Gpsxb9XEzggF_-Eq3ukjKvTnuyb9V1SCSUXkXsES4Kg,11502
 dcicutils/kibana/dashboards.json,sha256=wHMB_mpJ8OaYhRRgvpZuihaB2lmSF64ADt_8hkBWgQg,16225
 dcicutils/kibana/readme.md,sha256=3KmHF9FH6A6xwYsNxRFLw27q0XzHYnjZOlYUnn3VkQQ,2164
@@ -73,8 +73,8 @@ 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.4.1b24.dist-info/LICENSE.txt,sha256=qnwSmfnEWMl5l78VPDEzAmEbLVrRqQvfUQiHT0ehrOo,1102
-dcicutils-8.8.4.1b24.dist-info/METADATA,sha256=H9ymET-TyxVVJIAbebjNgrUh3CKcsveWK4ptxbhC5bo,3440
-dcicutils-8.8.4.1b24.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-dcicutils-8.8.4.1b24.dist-info/entry_points.txt,sha256=51Q4F_2V10L0282W7HFjP4jdzW4K8lnWDARJQVFy_hw,270
-dcicutils-8.8.4.1b24.dist-info/RECORD,,
+dcicutils-8.8.4.1b27.dist-info/LICENSE.txt,sha256=qnwSmfnEWMl5l78VPDEzAmEbLVrRqQvfUQiHT0ehrOo,1102
+dcicutils-8.8.4.1b27.dist-info/METADATA,sha256=j8Dc5eU279IAbIgHb1k4afO4eElDYIPF7zGZ9k9Dppo,3440
+dcicutils-8.8.4.1b27.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+dcicutils-8.8.4.1b27.dist-info/entry_points.txt,sha256=51Q4F_2V10L0282W7HFjP4jdzW4K8lnWDARJQVFy_hw,270
+dcicutils-8.8.4.1b27.dist-info/RECORD,,