dcicutils 8.8.4.1b11__tar.gz → 8.8.4.1b13__tar.gz

{dcicutils-8.8.4.1b11 → dcicutils-8.8.4.1b13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dcicutils
-Version: 8.8.4.1b11
+Version: 8.8.4.1b13
 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.1b11 → dcicutils-8.8.4.1b13}/dcicutils/file_utils.py

@@ -1,10 +1,12 @@
 import glob
 import os
 import pathlib
+from datetime import datetime
 import random
 import string
+from tempfile import gettempdir as get_temporary_directory
 from typing import List, Optional, Union
-from dcicutils.tmpfile_utils import create_temporary_file_name
+from uuid import uuid4 as uuid
 
 
 def search_for_file(file: str,
@@ -101,9 +103,15 @@ def are_files_equal(filea: str, fileb: str) -> bool:
         return False
 
 
-def create_random_file(file: Optional[str] = None,
-                       prefix: Optional[str] = None, suffix: Optional[str] = None,
+def create_random_file(file: Optional[str] = None, prefix: Optional[str] = None, suffix: Optional[str] = None,
                        nbytes: int = 1024, binary: bool = False, line_length: Optional[int] = None) -> str:
+    """
+    Write to the given file (name/path) some random content. If the given file is None then writes
+    to a temporary file. In either case, returns the file written to. The of bytes written is 1024
+    by default be can be specified with the nbytes argument; default to writing ASCII text but if
+    the binary argument is True then writes binary data as well; if not binary the content is in
+    lines of 80 characters each; use the line_length argumetn in this case to change the line length.
+    """
     if not isinstance(nbytes, int) or nbytes < 0:
         nbytes = 0
     if not isinstance(file, str) or not file:
@@ -111,7 +119,8 @@ def create_random_file(file: Optional[str] = None,
             prefix = ""
         if not isinstance(suffix, str):
             suffix = ""
-        file = create_temporary_file_name(prefix=prefix, suffix=suffix)
+        file = f"{datetime.utcnow().strftime('%Y%m%d%H%M%S')}{str(uuid()).replace('-', '')}"
+        file = os.path.join(get_temporary_directory(), file)
     with open(file, "wb" if binary is True else "w") as f:
         if binary is True:
             f.write(os.urandom(nbytes))

{dcicutils-8.8.4.1b11 → dcicutils-8.8.4.1b13}/dcicutils/tmpfile_utils.py

@@ -1,8 +1,11 @@
 from contextlib import contextmanager
+from datetime import datetime
 import os
 import shutil
 import tempfile
+from uuid import uuid4 as uuid
 from typing import List, Optional, Union
+from dcicutils.file_utils import create_random_file
 
 
 @contextmanager
@@ -15,14 +18,32 @@ def temporary_directory() -> str:
 
 
 @contextmanager
-def temporary_file(name: Optional[str] = None, suffix: Optional[str] = None,
+def temporary_file(name: Optional[str] = None, prefix: Optional[str] = None, suffix: Optional[str] = None,
                    content: Optional[Union[str, bytes, List[str]]] = None) -> str:
     with temporary_directory() as tmp_directory_name:
-        tmp_file_name = os.path.join(tmp_directory_name, name or tempfile.mktemp(dir="")) + (suffix or "")
-        with open(tmp_file_name, "wb" if isinstance(content, bytes) else "w") as tmp_file:
+        tmp_file_name = f"{prefix or ''}{name or tempfile.mktemp(dir='')}{suffix or ''}"
+        tmp_file_path = os.path.join(tmp_directory_name, tmp_file_name)
+        with open(tmp_file_path, "wb" if isinstance(content, bytes) else "w") as tmp_file:
             if content is not None:
                 tmp_file.write("\n".join(content) if isinstance(content, list) else content)
-        yield tmp_file_name
+        yield tmp_file_path
+
+
+def create_temporary_file_name(prefix: Optional[str] = None, suffix: Optional[str] = None) -> str:
+    """
+    Generates and returns the full path to file within the system temporary directory.
+    """
+    random_string = f"{datetime.utcnow().strftime('%Y%m%d%H%M%S')}{str(uuid()).replace('-', '')}"
+    tmp_file_name = f"{prefix or ''}{random_string}{suffix or ''}"
+    return os.path.join(tempfile.gettempdir(), tmp_file_name)
+
+
+@contextmanager
+def temporary_random_file(prefix: Optional[str] = None, suffix: Optional[str] = None,
+                          nbytes: int = 1024, binary: bool = False, line_length: Optional[int] = None) -> str:
+    with temporary_file(prefix=prefix, suffix=suffix) as tmp_file_path:
+        create_random_file(tmp_file_path, nbytes=nbytes, binary=binary, line_length=line_length)
+        yield tmp_file_path
 
 
 def remove_temporary_directory(tmp_directory_name: str) -> None:
@@ -39,15 +60,6 @@ def remove_temporary_directory(tmp_directory_name: str) -> None:
         shutil.rmtree(tmp_directory_name)
 
 
-def create_temporary_file_name(prefix: Optional[str] = None, suffix: Optional[str] = None) -> str:
-    """
-    Generates and returns the full path to file within the system temporary directory.
-    """
-    with tempfile.NamedTemporaryFile(prefix=prefix, suffix=suffix, delete=False) as tmp_file:
-        tmp_file_name = tmp_file.name
-    return tmp_file_name
-
-
 def remove_temporary_file(tmp_file_name: str) -> bool:
     """
     Removes the given file; but ONLY if it is (somewhere) within the system temporary directory.

{dcicutils-8.8.4.1b11 → dcicutils-8.8.4.1b13}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dcicutils"
-version = "8.8.4.1b11"  # TODO: To become 8.8.5
+version = "8.8.4.1b13"  # 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"