weaver.wps_restapi.processes.utils
==================================

.. py:module:: weaver.wps_restapi.processes.utils






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

.. py:data:: LOGGER

.. py:function:: resolve_process_tag(request: weaver.typedefs.PyramidRequest, process_query: bool = False) -> str

   Obtain the tagged :term:`Process` reference from request path and/or query according to available information.

   Whether the :term:`Process` is specified by path or query, another ``version`` query can be provided to specify
   the desired revision by itself. This ``version`` query is considered only if another version indication is not
   already specified in the :term:`Process` reference using the tagged semantic.

   When ``process_query = False``, possible combinations are as follows:

   - ``/processes/{processID}:{version}``
   - ``/processes/{processID}?version={version}``

   When ``process_query = True``, possible combinations are as follows:

   - ``/...?process={processID}:{version}``
   - ``/...?process={processID}&version={version}``

   :param request: Request from which to retrieve the process reference.
   :param process_query: Whether the process ID reference is located in request path or ``process={id}`` query.


.. py:function:: get_processes_filtered_by_valid_schemas(request: weaver.typedefs.PyramidRequest, detail: bool = True, links: bool = True) -> Tuple[List[weaver.typedefs.JSON], List[str], Dict[str, Optional[int]], bool, int]

   Validates the processes summary schemas and returns them into valid/invalid lists.

   :returns: List of valid process and invalid processes IDs for manual cleanup, along with filtering parameters.


.. py:function:: get_process_list_links(request: weaver.typedefs.PyramidRequest, paging: Dict[str, int], total: Optional[int], provider: Optional[weaver.datatype.Service] = None) -> List[weaver.typedefs.JSON]

   Obtains a list of all relevant links for the corresponding :term:`Process` listing defined by query parameters.

   :raises IndexError: if the paging values are out of bounds compared to available total :term:`Process`.