rclone-api 1.0.34__tar.gz → 1.0.35__tar.gz

{rclone_api-1.0.34 → rclone_api-1.0.35}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rclone_api
-Version: 1.0.34
+Version: 1.0.35
 Summary: rclone api in python
 Home-page: https://github.com/zackees/rclone-api
 Maintainer: Zachary Vorhies
@@ -127,7 +127,7 @@ if listing.files:
 # Delete a File
 print("\n=== Deleting a File ===")
 file_to_delete = f"dst:{BUCKET_NAME}/zachs_video/sample.png_copy"
-rclone.deletefiles([file_to_delete])
+rclone.delete_files([file_to_delete])
 print(f"Deleted {file_to_delete}")
 
 # Walk Through a Directory

{rclone_api-1.0.34 → rclone_api-1.0.35}/README.md

@@ -110,7 +110,7 @@ if listing.files:
 # Delete a File
 print("\n=== Deleting a File ===")
 file_to_delete = f"dst:{BUCKET_NAME}/zachs_video/sample.png_copy"
-rclone.deletefiles([file_to_delete])
+rclone.delete_files([file_to_delete])
 print(f"Deleted {file_to_delete}")
 
 # Walk Through a Directory

{rclone_api-1.0.34 → rclone_api-1.0.35}/pyproject.toml

@@ -15,7 +15,7 @@ dependencies = [
     "python-dotenv>=1.0.0",
 ]
 # Change this with the version number bump.
-version = "1.0.34"
+version = "1.0.35"
 
 [tool.setuptools]
 package-dir = {"" = "src"}

rclone_api-1.0.35/src/rclone_api/deprecated.py

@@ -0,0 +1,24 @@
+import functools
+import warnings
+
+
+def deprecated(new_func_name: str):
+    """Decorator to mark functions as deprecated.
+
+    Args:
+        new_func_name: The name of the function that should be used instead.
+    """
+
+    def decorator(func):
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            warnings.warn(
+                f"{func.__name__}() is deprecated; use {new_func_name}() instead.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return decorator

{rclone_api-1.0.34 → rclone_api-1.0.35}/src/rclone_api/rclone.py

@@ -15,6 +15,7 @@ from typing import Generator
 from rclone_api import Dir
 from rclone_api.config import Config
 from rclone_api.convert import convert_to_filestr_list, convert_to_str
+from rclone_api.deprecated import deprecated
 from rclone_api.diff import DiffItem, diff_stream_from_running_process
 from rclone_api.dir_listing import DirListing
 from rclone_api.exec import RcloneExec
@@ -224,7 +225,7 @@ class Rclone:
         cmd_list: list[str] = ["purge", str(path)]
         return self._run(cmd_list)
 
-    def deletefiles(
+    def delete_files(
         self, files: str | File | list[str] | list[File]
     ) -> subprocess.CompletedProcess:
         """Delete a directory"""
@@ -276,6 +277,12 @@ class Rclone:
         assert out is not None
         return out
 
+    @deprecated("delete_files")
+    def deletefiles(
+        self, files: str | File | list[str] | list[File]
+    ) -> subprocess.CompletedProcess:
+        return self.delete_files(files)
+
     def exists(self, path: Dir | Remote | str | File) -> bool:
         """Check if a file or directory exists."""
         arg: str = convert_to_str(path)

{rclone_api-1.0.34 → rclone_api-1.0.35}/src/rclone_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rclone_api
-Version: 1.0.34
+Version: 1.0.35
 Summary: rclone api in python
 Home-page: https://github.com/zackees/rclone-api
 Maintainer: Zachary Vorhies
@@ -127,7 +127,7 @@ if listing.files:
 # Delete a File
 print("\n=== Deleting a File ===")
 file_to_delete = f"dst:{BUCKET_NAME}/zachs_video/sample.png_copy"
-rclone.deletefiles([file_to_delete])
+rclone.delete_files([file_to_delete])
 print(f"Deleted {file_to_delete}")
 
 # Walk Through a Directory

{rclone_api-1.0.34 → rclone_api-1.0.35}/src/rclone_api.egg-info/SOURCES.txt

@@ -24,6 +24,7 @@ src/rclone_api/__init__.py
 src/rclone_api/cli.py
 src/rclone_api/config.py
 src/rclone_api/convert.py
+src/rclone_api/deprecated.py
 src/rclone_api/diff.py
 src/rclone_api/dir.py
 src/rclone_api/dir_listing.py

{rclone_api-1.0.34 → rclone_api-1.0.35}/tests/test_copy.py

@@ -71,7 +71,7 @@ class RcloneCopyTests(unittest.TestCase):
         listing = rclone.ls(f"dst:{BUCKET_NAME}/zachs_video/", glob=f"*{new_name}")
         self.assertEqual(len(listing.files), 1)
         self.assertEqual(listing.dirs, [])
-        rclone.deletefiles([new_path])
+        rclone.delete_files([new_path])
         print("done")
 
     def test_copyfiles(self) -> None:
@@ -98,7 +98,7 @@ class RcloneCopyTests(unittest.TestCase):
         exists = rclone.exists(dest_file)
         self.assertTrue(exists)
 
-        rclone.deletefiles(delete_list)
+        rclone.delete_files(delete_list)
         print("done")