Skip to content

Add support for status option in sync command #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
const-cloudinary merged 1 commit into from
Feb 24, 2025
Merged

Add support for status option in sync command #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions cloudinary_cli/modules/sync.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,17 +38,19 @@
help="Specify the batch size for deleting remote assets.")
@option("-fm", "--folder-mode", type=Choice(['fixed', 'dynamic'], case_sensitive=False),
help="Specify folder mode explicitly. By default uses cloud mode configured in your cloud.", hidden=True)
@option("-st", "--status", type=Choice(['all', 'active', 'pending'], case_sensitive=False),
help="Specify asset status. Server default: active.", default=None)
@option("-o", "--optional_parameter", multiple=True, nargs=2, help="Pass optional parameters as raw strings.")
@option("-O", "--optional_parameter_parsed", multiple=True, nargs=2,
help="Pass optional parameters as interpreted strings.")
@option("--dry-run", is_flag=True, help="Simulate the sync operation without making any changes.")
def sync(local_folder, cloudinary_folder, push, pull, include_hidden, concurrent_workers, force, keep_unique,
deletion_batch_size, folder_mode, optional_parameter, optional_parameter_parsed, dry_run):
deletion_batch_size, folder_mode, status, optional_parameter, optional_parameter_parsed, dry_run):
if push == pull:
raise UsageError("Please use either the '--push' OR '--pull' options")

sync_dir = SyncDir(local_folder, cloudinary_folder, include_hidden, concurrent_workers, force, keep_unique,
deletion_batch_size, folder_mode, optional_parameter, optional_parameter_parsed, dry_run)
deletion_batch_size, folder_mode, status, optional_parameter, optional_parameter_parsed, dry_run)
result = True
if push:
result = sync_dir.push()
Expand All @@ -63,7 +65,7 @@ def sync(local_folder, cloudinary_folder, push, pull, include_hidden, concurrent

class SyncDir:
def __init__(self, local_dir, remote_dir, include_hidden, concurrent_workers, force, keep_deleted,
deletion_batch_size, folder_mode, optional_parameter, optional_parameter_parsed, dry_run):
deletion_batch_size, folder_mode, status, optional_parameter, optional_parameter_parsed, dry_run):
self.local_dir = local_dir
self.remote_dir = remote_dir.strip('/')
self.user_friendly_remote_dir = self.remote_dir if self.remote_dir else '/'
Expand Down Expand Up @@ -100,7 +102,7 @@ def __init__(self, local_dir, remote_dir, include_hidden, concurrent_workers, fo
logger.info(f"Cloudinary folder '{self.user_friendly_remote_dir}' does not exist "
f"({self.folder_mode} folder mode).")
else:
raw_remote_files = query_cld_folder(self.remote_dir, self.folder_mode)
raw_remote_files = query_cld_folder(self.remote_dir, self.folder_mode, status)
if len(raw_remote_files):
logger.info(
f"Found {len(raw_remote_files)} items in Cloudinary folder '{self.user_friendly_remote_dir}' "
Expand Down
12 changes: 8 additions & 4 deletions cloudinary_cli/utils/api_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,22 @@
_cursor_fields = {"resource": "derived_next_cursor"}


def query_cld_folder(folder, folder_mode):
def query_cld_folder(folder, folder_mode, status=None):
files = {}

folder = folder.strip('/') # omit redundant leading slash and duplicate trailing slashes in query
folder_key = "asset_folder" if folder_mode == "dynamic" else "folder"
folder_query = f"{folder}/*" if folder else "*"
status_value = "(active OR pending)" if status == "all" else status
status_query = f" AND status:{status_value}" if status_value else ""

expression = Search().expression(f"{folder_key}:\"{folder_query}\"").with_field("image_analysis").max_results(500)
search = Search().expression(f"{folder_key}:\"{folder_query}\"{status_query}").with_field("image_analysis").max_results(500)

logger.debug(f"Search expression: {search.to_json()}")

next_cursor = True
while next_cursor:
res = expression.execute()
res = search.execute()

for asset in res['resources']:
rel_path = _relative_path(asset, folder)
Expand All @@ -58,7 +62,7 @@ def query_cld_folder(folder, folder_mode):
}
# use := when switch to python 3.8
next_cursor = res.get('next_cursor')
expression.next_cursor(next_cursor)
search.next_cursor(next_cursor)

return files

Expand Down