weaver.processes.builtin.collection_processor
=============================================

.. py:module:: weaver.processes.builtin.collection_processor

.. autoapi-nested-parse::

   Retrieves relevant data or files resolved from a collection reference using its metadata, queries and desired outputs.







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

.. py:data:: CUR_DIR
   :value: b'.'


.. py:data:: LOGGER

.. py:data:: OUTPUT_CWL_JSON
   :value: 'cwl.output.json'


.. py:function:: process_collection(collection_input: weaver.typedefs.JobValueCollection, input_definition: weaver.typedefs.ProcessInputOutputItem, output_dir: weaver.typedefs.Path, logger: weaver.utils.LoggerHandler = LOGGER) -> List[weaver.typedefs.CWL_IO_FileValue]

   Processor of a :term:`Collection`.

   This function is intended to be employed either as a standalone :term:`Builtin Process` (for validating resolution)
   or as an intermediate :term:`Collection` resolution when submitted as input for another :term:`Process` execution.

   :param collection_input:
       Collection Input parameters with minimally the URI to the collection used as reference.
       Can contain additional filtering or hint format parameters.
   :param input_definition:
       Process input definition that indicates the target types, formats and schema to retrieve from the collection.
   :param output_dir: Directory to write the output (provided by the :term:`CWL` definition).
   :param logger: Optional logger handler to employ.
   :return: Resolved data references.


.. py:function:: process_cwl(collection_input: weaver.typedefs.JobValueCollection, input_definition: weaver.typedefs.ProcessInputOutputItem, output_dir: weaver.typedefs.Path) -> weaver.typedefs.CWL_IO_ValueMap

.. py:function:: main(*args: str) -> None