borgmatic/borgmatic/actions/list.py

import json
import logging

import borgmatic.borg.list
import borgmatic.config.validate

logger = logging.getLogger(__name__)


def run_list(
    repository,
    storage,
    local_borg_version,
    list_arguments,
    global_arguments,
    local_path,
    remote_path,
):
    '''
    Run the "list" action for the given repository and archive.

    If list_arguments.json is True, yield the JSON output from listing the archive.
    '''
    if list_arguments.repository is None or borgmatic.config.validate.repositories_match(
        repository, list_arguments.repository
    ):
        if not list_arguments.json:  # pragma: nocover
            if list_arguments.find_paths:
                logger.answer(f'{repository.get("label", repository["path"])}: Searching archives')
            elif not list_arguments.archive:
                logger.answer(f'{repository.get("label", repository["path"])}: Listing archives')
        list_arguments.archive = borgmatic.borg.rlist.resolve_archive_name(
            repository['path'],
            list_arguments.archive,
            storage,
            local_borg_version,
            global_arguments,
            local_path,
            remote_path,
        )
        json_output = borgmatic.borg.list.list_archive(
            repository['path'],
            storage,
            local_borg_version,
            list_arguments,
            global_arguments,
            local_path,
            remote_path,
        )
        if json_output:  # pragma: nocover
            yield json.loads(json_output)