cwl_utils.types
===============

.. py:module:: cwl_utils.types

.. autoapi-nested-parse::

   Shared Python type definitions for commons JSON like CWL objects.



Attributes
----------

.. autoapisummary::

   cwl_utils.types.built_in_types
   cwl_utils.types.CWLDirectoryType
   cwl_utils.types.CWLFileType
   cwl_utils.types.CWLOutputType
   cwl_utils.types.CWLObjectType
   cwl_utils.types.SinkType


Classes
-------

.. autoapisummary::

   cwl_utils.types.CWLRuntimeParameterContext
   cwl_utils.types.CWLParameterContext
   cwl_utils.types.DirentType


Functions
---------

.. autoapisummary::

   cwl_utils.types.is_cwl_parameter_context_key
   cwl_utils.types.is_directory
   cwl_utils.types.is_directory_key
   cwl_utils.types.is_file
   cwl_utils.types.is_file_key
   cwl_utils.types.is_file_or_directory


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

.. py:data:: built_in_types
   :type:  list[str]
   :value: ['null', 'boolean', 'int', 'long', 'float', 'double', 'string', 'File', 'Directory', 'stdin',...


.. py:data:: CWLDirectoryType

.. py:data:: CWLFileType

.. py:type:: CWLOutputType
   :canonical: bool | str | int | float | CWLFileType | CWLDirectoryType | MutableSequence['CWLOutputType | None'] | MutableMapping[str, 'CWLOutputType | None']


.. py:type:: CWLObjectType
   :canonical: MutableMapping[str, CWLOutputType | None]


.. py:type:: SinkType
   :canonical: CWLOutputType | CWLObjectType


.. py:class:: CWLRuntimeParameterContext

   Bases: :py:obj:`TypedDict`

   .. autoapi-inheritance-diagram:: cwl_utils.types.CWLRuntimeParameterContext
      :parts: 1


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:attribute:: outdir
      :type:  str


   .. py:attribute:: tmpdir
      :type:  str


   .. py:attribute:: cores
      :type:  float | str


   .. py:attribute:: ram
      :type:  float | str


   .. py:attribute:: outdirSize
      :type:  float | str


   .. py:attribute:: tmpdirSize
      :type:  float | str


   .. py:attribute:: exitCode
      :type:  int


.. py:class:: CWLParameterContext

   Bases: :py:obj:`TypedDict`

   .. autoapi-inheritance-diagram:: cwl_utils.types.CWLParameterContext
      :parts: 1


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:attribute:: inputs
      :type:  CWLObjectType


   .. py:attribute:: self
      :type:  CWLOutputType | None


   .. py:attribute:: runtime
      :type:  CWLRuntimeParameterContext


.. py:class:: DirentType

   Bases: :py:obj:`TypedDict`

   .. autoapi-inheritance-diagram:: cwl_utils.types.DirentType
      :parts: 1


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:attribute:: entry
      :type:  Required[str]


   .. py:attribute:: entryname
      :type:  str


   .. py:attribute:: writable
      :type:  bool


.. py:function:: is_cwl_parameter_context_key(key)

.. py:function:: is_directory(value)

.. py:function:: is_directory_key(key)

.. py:function:: is_file(value)

.. py:function:: is_file_key(key)

.. py:function:: is_file_or_directory(value)

