Added force= option for deleting assets/versions or rejecting probation.

Author: LTLA

src/pygobbler/reject_probation.py

@@ -1,7 +1,7 @@
 from . import _utils as ut
 
 
-def reject_probation(project: str, asset: str, version: str, staging: str, url: str):
+def reject_probation(project: str, asset: str, version: str, staging: str, url: str, force: bool = False):
     """
     Reject a probational upload of a version of a project's asset.
 
@@ -20,5 +20,9 @@ def reject_probation(project: str, asset: str, version: str, staging: str, url:
 
         url:
             URL to the Gobbler REST API.
+
+        force:
+            Whether the version should be forcibly rejected and removed if it contains invalid files.
+            If this needs to be set to ``True``, users may need to call :py:func:`~gobbler.refresh_usage.refresh_usage`` afterwards to correct project-level usage statistics.
     """
-    ut.dump_request(staging, url, "reject_probation", { "project": project, "asset": asset, "version": version })
+    ut.dump_request(staging, url, "reject_probation", { "project": project, "asset": asset, "version": version, "force": force })

src/pygobbler/remove_asset.py

@@ -1,7 +1,7 @@
 from . import _utils as ut
 
 
-def remove_asset(project: str, asset: str, staging: str, url: str):
+def remove_asset(project: str, asset: str, staging: str, url: str, force: bool = False):
     """
     Remove an asset of a project from the registry.
 
@@ -17,5 +17,9 @@ def remove_asset(project: str, asset: str, staging: str, url: str):
 
         url:
             URL to the Gobbler REST API.
+
+        force:
+            Whether the asset should be forcibly removed if it contains invalid files.
+            If this needs to be set to ``True``, users may need to call :py:func:`~gobbler.refresh_usage.refresh_usage`` afterwards to correct project-level usage statistics.
     """
-    ut.dump_request(staging, url, "delete_asset", { "project": project, "asset": asset })
+    ut.dump_request(staging, url, "delete_asset", { "project": project, "asset": asset, "force": force })

src/pygobbler/remove_version.py

@@ -1,7 +1,7 @@
 from . import _utils as ut
 
 
-def remove_version(project: str, asset: str, version: str, staging: str, url: str):
+def remove_version(project: str, asset: str, version: str, staging: str, url: str, force: bool = False):
     """
     Remove a version of a project asset from the registry.
 
@@ -18,7 +18,12 @@ def remove_version(project: str, asset: str, version: str, staging: str, url: st
         staging:
             Path to the staging directory.
 
+        force:
+            Whether the version should be forcibly removed if it contains invalid files.
+            If this needs to be set to ``True``, users may need to call :py:func:`~gobbler.refresh_usage.refresh_usage`` afterwards to correct project-level usage statistics.
+            Similarly, :py:func:`~gobbler.refresh_latest.refresh_latest` may also need to be called.
+
         url:
             URL to the Gobbler REST API.
     """
-    ut.dump_request(staging, url, "delete_version", { "project": project, "asset": asset, "version": version })
+    ut.dump_request(staging, url, "delete_version", { "project": project, "asset": asset, "version": version, "force": force })