:py:mod:`obr.cli_util`
======================

.. py:module:: obr.cli_util


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   obr.cli_util.query_impl
   obr.cli_util.check_cli_operations
   obr.cli_util.is_valid_workspace
   obr.cli_util.cli_cmd_setup
   obr.cli_util.copy_to_archive



Attributes
~~~~~~~~~~

.. autoapisummary::

   obr.cli_util.logger


.. py:data:: logger

   

.. py:function:: query_impl(project: obr.signac_wrapper.operations.OpenFOAMProject, input_queries: tuple[str], filters: list[str], quiet: bool, json_file: str, validation_file: str)


.. py:function:: check_cli_operations(project: obr.signac_wrapper.operations.OpenFOAMProject, operations: list[str], list_operations: Optional[Any]) -> bool

   list available operations if none are specified or given the click option or an incorrect op is given


.. py:function:: is_valid_workspace(filters: list = []) -> bool

   This function checks if:
   - the `workspace` folder is not empty, and
   - applying filters would return an empty list


.. py:function:: cli_cmd_setup(kwargs: dict) -> tuple[obr.signac_wrapper.operations.OpenFOAMProject, list[signac.job.Job]]

   This function performs the common pattern of checking project folders for existence and creating the project and extracting the jobs.


.. py:function:: copy_to_archive(repo: Union[git.repo.Repo, None], use_git_repo: bool, src_file: pathlib.Path, target_file: pathlib.Path) -> None

   Copies files to archive repo