python-fsutil 0.11.0__tar.gz → 0.13.0__tar.gz

{python-fsutil-0.11.0/python_fsutil.egg-info → python-fsutil-0.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-fsutil
-Version: 0.11.0
+Version: 0.13.0
 Summary: high-level file-system operations for lazy devs.
 Author-email: Fabio Caccamo <fabio.caccamo@gmail.com>
 Maintainer-email: Fabio Caccamo <fabio.caccamo@gmail.com>
@@ -132,6 +132,7 @@ import fsutil
 -   [`get_file_size_formatted`](#get_file_size_formatted)
 -   [`get_filename`](#get_filename)
 -   [`get_parent_dir`](#get_parent_dir)
+-   [`get_permissions`](#get_permissions)
 -   [`get_unique_name`](#get_unique_name)
 -   [`is_dir`](#is_dir)
 -   [`is_empty`](#is_empty)
@@ -165,6 +166,7 @@ import fsutil
 -   [`replace_file`](#replace_file)
 -   [`search_dirs`](#search_dirs)
 -   [`search_files`](#search_files)
+-   [`set_permissions`](#set_permissions)
 -   [`split_filename`](#split_filename)
 -   [`split_filepath`](#split_filepath)
 -   [`split_path`](#split_path)
@@ -494,10 +496,17 @@ filename = fsutil.get_filename(path)
 parent_dir = fsutil.get_parent_dir(path, levels=1)
 ```
 
+#### `get_permissions`
+
+```python
+# Get the file/directory permissions.
+permissions = fsutil.get_permissions(path)
+```
+
 #### `get_unique_name`
 
 ```python
-# Gets a unique name for a directory/file ath the given directory path.
+# Get a unique name for a directory/file ath the given directory path.
 unique_name = fsutil.get_unique_name(path, prefix="", suffix="", extension="", separator="-")
 ```
 
@@ -747,6 +756,13 @@ dirs = fsutil.search_dirs(path, pattern="**/*")
 files = fsutil.search_files(path, pattern="**/*.*")
 ```
 
+#### `set_permissions`
+
+```python
+# Set the file/directory permissions.
+fsutil.set_permissions(path, 700)
+```
+
 #### `split_filename`
 
 ```python
@@ -772,14 +788,14 @@ path_names = fsutil.split_path(path)
 
 ```python
 # Write file with the specified content at the given path.
-fsutil.write_file(path, content, append=False, encoding="utf-8")
+fsutil.write_file(path, content, append=False, encoding="utf-8", atomic=False)
 ```
 
 #### `write_file_json`
 
 ```python
 # Write a json file at the given path with the specified data encoded in json format.
-fsutil.write_file_json(path, data, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False)
+fsutil.write_file_json(path, data, encoding="utf-8", atomic=False, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False)
 ```
 
 ## Testing

{python-fsutil-0.11.0 → python-fsutil-0.13.0}/README.md

@@ -74,6 +74,7 @@ import fsutil
 -   [`get_file_size_formatted`](#get_file_size_formatted)
 -   [`get_filename`](#get_filename)
 -   [`get_parent_dir`](#get_parent_dir)
+-   [`get_permissions`](#get_permissions)
 -   [`get_unique_name`](#get_unique_name)
 -   [`is_dir`](#is_dir)
 -   [`is_empty`](#is_empty)
@@ -107,6 +108,7 @@ import fsutil
 -   [`replace_file`](#replace_file)
 -   [`search_dirs`](#search_dirs)
 -   [`search_files`](#search_files)
+-   [`set_permissions`](#set_permissions)
 -   [`split_filename`](#split_filename)
 -   [`split_filepath`](#split_filepath)
 -   [`split_path`](#split_path)
@@ -436,10 +438,17 @@ filename = fsutil.get_filename(path)
 parent_dir = fsutil.get_parent_dir(path, levels=1)
 ```
 
+#### `get_permissions`
+
+```python
+# Get the file/directory permissions.
+permissions = fsutil.get_permissions(path)
+```
+
 #### `get_unique_name`
 
 ```python
-# Gets a unique name for a directory/file ath the given directory path.
+# Get a unique name for a directory/file ath the given directory path.
 unique_name = fsutil.get_unique_name(path, prefix="", suffix="", extension="", separator="-")
 ```
 
@@ -689,6 +698,13 @@ dirs = fsutil.search_dirs(path, pattern="**/*")
 files = fsutil.search_files(path, pattern="**/*.*")
 ```
 
+#### `set_permissions`
+
+```python
+# Set the file/directory permissions.
+fsutil.set_permissions(path, 700)
+```
+
 #### `split_filename`
 
 ```python
@@ -714,14 +730,14 @@ path_names = fsutil.split_path(path)
 
 ```python
 # Write file with the specified content at the given path.
-fsutil.write_file(path, content, append=False, encoding="utf-8")
+fsutil.write_file(path, content, append=False, encoding="utf-8", atomic=False)
 ```
 
 #### `write_file_json`
 
 ```python
 # Write a json file at the given path with the specified data encoded in json format.
-fsutil.write_file_json(path, data, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False)
+fsutil.write_file_json(path, data, encoding="utf-8", atomic=False, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False)
 ```
 
 ## Testing

{python-fsutil-0.11.0 → python-fsutil-0.13.0}/fsutil/__init__.py

@@ -80,6 +80,7 @@ __all__ = [
     "get_file_size_formatted",
     "get_filename",
     "get_parent_dir",
+    "get_permissions",
     "get_unique_name",
     "is_dir",
     "is_empty",
@@ -113,6 +114,7 @@ __all__ = [
     "replace_file",
     "search_dirs",
     "search_files",
+    "set_permissions",
     "split_filename",
     "split_filepath",
     "split_path",
@@ -788,6 +790,17 @@ def get_parent_dir(path: PathIn, *, levels: int = 1) -> str:
     return join_path(path, *([os.pardir] * max(1, levels)))
 
 
+def get_permissions(path: PathIn) -> int:
+    """
+    Get the file/directory permissions.
+    """
+    path = _get_path(path)
+    assert_exists(path)
+    st_mode = os.stat(path).st_mode
+    permissions = int(str(oct(st_mode & 0o777))[2:])
+    return permissions
+
+
 def get_unique_name(
     path: PathIn,
     *,
@@ -797,7 +810,7 @@ def get_unique_name(
     separator: str = "-",
 ) -> str:
     """
-    Gets a unique name for a directory/file ath the given directory path.
+    Get a unique name for a directory/file ath the given directory path.
     """
     path = _get_path(path)
     assert_dir(path)
@@ -1282,6 +1295,16 @@ def search_files(path: PathIn, pattern: str = "**/*.*") -> list[str]:
     return _filter_paths(path, _search_paths(path, pattern), predicate=is_file)
 
 
+def set_permissions(path: PathIn, value: int) -> None:
+    """
+    Set the file/directory permissions.
+    """
+    path = _get_path(path)
+    assert_exists(path)
+    permissions = int(str(value), 8) & 0o777
+    os.chmod(path, permissions)
+
+
 def split_filename(path: PathIn) -> tuple[str, str]:
     """
     Split a filename and returns its basename and extension.
@@ -1314,12 +1337,58 @@ def split_path(path: PathIn) -> list[str]:
     return names
 
 
+def _write_file_atomic(
+    path: PathIn,
+    content: str,
+    *,
+    append: bool = False,
+    encoding: str = "utf-8",
+) -> None:
+    path = _get_path(path)
+    mode = "a" if append else "w"
+    if append:
+        content = read_file(path, encoding=encoding) + content
+    dirpath, _ = split_filepath(path)
+    try:
+        with tempfile.NamedTemporaryFile(
+            mode=mode,
+            dir=dirpath,
+            delete=True,
+            encoding=encoding,
+        ) as file:
+            file.write(content)
+            file.flush()
+            os.fsync(file.fileno())
+            temp_path = file.name
+            if exists(path):
+                set_permissions(temp_path, get_permissions(path))
+            os.replace(temp_path, path)
+    except FileNotFoundError:
+        # success - the NamedTemporaryFile has not been able
+        # to remove the temp file on __exit__ because the temp file
+        # has replaced atomically the file at path.
+        pass
+
+
+def _write_file_non_atomic(
+    path: PathIn,
+    content: str,
+    *,
+    append: bool = False,
+    encoding: str = "utf-8",
+) -> None:
+    mode = "a" if append else "w"
+    with open(path, mode, encoding=encoding) as file:
+        file.write(content)
+
+
 def write_file(
     path: PathIn,
     content: str,
     *,
     append: bool = False,
     encoding: str = "utf-8",
+    atomic: bool = False,
 ) -> None:
     """
     Write file with the specified content at the given path.
@@ -1327,14 +1396,20 @@ def write_file(
     path = _get_path(path)
     assert_not_dir(path)
     make_dirs_for_file(path)
-    mode = "a" if append else "w"
-    with open(path, mode, encoding=encoding) as file:
-        file.write(content)
+    write_file_func = _write_file_atomic if atomic else _write_file_non_atomic
+    write_file_func(
+        path,
+        content,
+        append=append,
+        encoding=encoding,
+    )
 
 
 def write_file_json(
     path: PathIn,
     data: Any,
+    encoding: str = "utf-8",
+    atomic: bool = False,
     **kwargs: Any,
 ) -> None:
     """
@@ -1351,4 +1426,10 @@ def write_file_json(
 
     kwargs.setdefault("default", default_encoder)
     content = json.dumps(data, **kwargs)
-    write_file(path, content)
+    write_file(
+        path,
+        content,
+        append=False,
+        encoding=encoding,
+        atomic=atomic,
+    )

{python-fsutil-0.11.0 → python-fsutil-0.13.0}/fsutil/metadata.py

@@ -4,4 +4,4 @@ __description__ = "high-level file-system operations for lazy devs."
 __email__ = "fabio.caccamo@gmail.com"
 __license__ = "MIT"
 __title__ = "python-fsutil"
-__version__ = "0.11.0"
+__version__ = "0.13.0"

{python-fsutil-0.11.0 → python-fsutil-0.13.0}/pyproject.toml

@@ -85,9 +85,6 @@ exclude = '''
 )/
 '''
 
-[tool.isort]
-profile = "black"
-
 [tool.mypy]
 files = ["fsutil"]
 ignore_missing_imports = true

{python-fsutil-0.11.0 → python-fsutil-0.13.0/python_fsutil.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-fsutil
-Version: 0.11.0
+Version: 0.13.0
 Summary: high-level file-system operations for lazy devs.
 Author-email: Fabio Caccamo <fabio.caccamo@gmail.com>
 Maintainer-email: Fabio Caccamo <fabio.caccamo@gmail.com>
@@ -132,6 +132,7 @@ import fsutil
 -   [`get_file_size_formatted`](#get_file_size_formatted)
 -   [`get_filename`](#get_filename)
 -   [`get_parent_dir`](#get_parent_dir)
+-   [`get_permissions`](#get_permissions)
 -   [`get_unique_name`](#get_unique_name)
 -   [`is_dir`](#is_dir)
 -   [`is_empty`](#is_empty)
@@ -165,6 +166,7 @@ import fsutil
 -   [`replace_file`](#replace_file)
 -   [`search_dirs`](#search_dirs)
 -   [`search_files`](#search_files)
+-   [`set_permissions`](#set_permissions)
 -   [`split_filename`](#split_filename)
 -   [`split_filepath`](#split_filepath)
 -   [`split_path`](#split_path)
@@ -494,10 +496,17 @@ filename = fsutil.get_filename(path)
 parent_dir = fsutil.get_parent_dir(path, levels=1)
 ```
 
+#### `get_permissions`
+
+```python
+# Get the file/directory permissions.
+permissions = fsutil.get_permissions(path)
+```
+
 #### `get_unique_name`
 
 ```python
-# Gets a unique name for a directory/file ath the given directory path.
+# Get a unique name for a directory/file ath the given directory path.
 unique_name = fsutil.get_unique_name(path, prefix="", suffix="", extension="", separator="-")
 ```
 
@@ -747,6 +756,13 @@ dirs = fsutil.search_dirs(path, pattern="**/*")
 files = fsutil.search_files(path, pattern="**/*.*")
 ```
 
+#### `set_permissions`
+
+```python
+# Set the file/directory permissions.
+fsutil.set_permissions(path, 700)
+```
+
 #### `split_filename`
 
 ```python
@@ -772,14 +788,14 @@ path_names = fsutil.split_path(path)
 
 ```python
 # Write file with the specified content at the given path.
-fsutil.write_file(path, content, append=False, encoding="utf-8")
+fsutil.write_file(path, content, append=False, encoding="utf-8", atomic=False)
 ```
 
 #### `write_file_json`
 
 ```python
 # Write a json file at the given path with the specified data encoded in json format.
-fsutil.write_file_json(path, data, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False)
+fsutil.write_file_json(path, data, encoding="utf-8", atomic=False, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False)
 ```
 
 ## Testing

{python-fsutil-0.11.0 → python-fsutil-0.13.0}/tests/test.py

@@ -737,6 +737,12 @@ class fsutil_test_case(unittest.TestCase):
         s = "/root/a/b/c/Document.txt"
         self.assertEqual(fsutil.get_parent_dir(s, levels=6), "/")
 
+    def test_get_permissions(self):
+        path = self.temp_path("a/b/c.txt")
+        fsutil.write_file(path, content="Hello World")
+        permissions = fsutil.get_permissions(path)
+        self.assertEqual(permissions, 644)
+
     def test_get_unique_name(self):
         path = self.temp_path("a/b/c")
         fsutil.create_dir(path)
@@ -1181,6 +1187,13 @@ class fsutil_test_case(unittest.TestCase):
         ]
         self.assertEqual(results, expected_results)
 
+    def test_set_permissions(self):
+        path = self.temp_path("a/b/c.txt")
+        fsutil.write_file(path, content="Hello World")
+        fsutil.set_permissions(path, 777)
+        permissions = fsutil.get_permissions(path)
+        self.assertEqual(permissions, 777)
+
     def test_split_filename(self):
         s = "Document"
         self.assertEqual(fsutil.split_filename(s), ("Document", ""))
@@ -1209,11 +1222,26 @@ class fsutil_test_case(unittest.TestCase):
 
     def test_write_file(self):
         path = self.temp_path("a/b/c.txt")
-        fsutil.write_file(self.temp_path("a/b/c.txt"), content="Hello World")
+        fsutil.write_file(path, content="Hello World")
+        self.assertEqual(fsutil.read_file(path), "Hello World")
+        fsutil.write_file(path, content="Hello Jupiter")
+        self.assertEqual(fsutil.read_file(path), "Hello Jupiter")
+
+    def test_write_file_atomic(self):
+        path = self.temp_path("a/b/c.txt")
+        fsutil.write_file(path, content="Hello World", atomic=True)
         self.assertEqual(fsutil.read_file(path), "Hello World")
-        fsutil.write_file(self.temp_path("a/b/c.txt"), content="Hello Jupiter")
+        fsutil.write_file(path, content="Hello Jupiter", atomic=True)
         self.assertEqual(fsutil.read_file(path), "Hello Jupiter")
 
+    def test_write_file_atomic_permissions_inheritance(self):
+        path = self.temp_path("a/b/c.txt")
+        fsutil.write_file(path, content="Hello World", atomic=False)
+        self.assertEqual(fsutil.get_permissions(path), 644)
+        fsutil.set_permissions(path, 777)
+        fsutil.write_file(path, content="Hello Jupiter", atomic=True)
+        self.assertEqual(fsutil.get_permissions(path), 777)
+
     def test_write_file_with_filename_only(self):
         path = "document.txt"
         fsutil.write_file(path, content="Hello World")
@@ -1230,7 +1258,28 @@ class fsutil_test_case(unittest.TestCase):
             "test_datetime": now,
             "test_decimal": dec,
         }
-        fsutil.write_file_json(self.temp_path("a/b/c.json"), data=data)
+        fsutil.write_file_json(path, data=data)
+        self.assertEqual(
+            fsutil.read_file(path),
+            (
+                "{"
+                f'"test": "Hello World", '
+                f'"test_datetime": "{now.isoformat()}", '
+                f'"test_decimal": "{dec}"'
+                "}"
+            ),
+        )
+
+    def test_write_file_json_atomic(self):
+        path = self.temp_path("a/b/c.json")
+        now = datetime.now()
+        dec = Decimal("3.33")
+        data = {
+            "test": "Hello World",
+            "test_datetime": now,
+            "test_decimal": dec,
+        }
+        fsutil.write_file_json(path, data=data, atomic=True)
         self.assertEqual(
             fsutil.read_file(path),
             (
@@ -1244,11 +1293,16 @@ class fsutil_test_case(unittest.TestCase):
 
     def test_write_file_with_append(self):
         path = self.temp_path("a/b/c.txt")
-        fsutil.write_file(self.temp_path("a/b/c.txt"), content="Hello World")
+        fsutil.write_file(path, content="Hello World")
         self.assertEqual(fsutil.read_file(path), "Hello World")
-        fsutil.write_file(
-            self.temp_path("a/b/c.txt"), content=" - Hello Sun", append=True
-        )
+        fsutil.write_file(path, content=" - Hello Sun", append=True)
+        self.assertEqual(fsutil.read_file(path), "Hello World - Hello Sun")
+
+    def test_write_file_with_append_atomic(self):
+        path = self.temp_path("a/b/c.txt")
+        fsutil.write_file(path, content="Hello World", atomic=True)
+        self.assertEqual(fsutil.read_file(path), "Hello World")
+        fsutil.write_file(path, content=" - Hello Sun", append=True, atomic=True)
         self.assertEqual(fsutil.read_file(path), "Hello World - Hello Sun")