cwltool.argparser
=================

.. py:module:: cwltool.argparser

.. autoapi-nested-parse::

   Command line argument parsing for cwltool.



Classes
-------

.. autoapisummary::

   cwltool.argparser.FSAction
   cwltool.argparser.FSAppendAction
   cwltool.argparser.FileAction
   cwltool.argparser.DirectoryAction
   cwltool.argparser.FileAppendAction
   cwltool.argparser.DirectoryAppendAction
   cwltool.argparser.AppendAction


Functions
---------

.. autoapisummary::

   cwltool.argparser.arg_parser
   cwltool.argparser.get_default_args
   cwltool.argparser.add_argument
   cwltool.argparser.generate_parser


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

.. py:function:: arg_parser()

.. py:function:: get_default_args()

   Get default values of cwltool's command line options.


.. py:class:: FSAction(option_strings, dest, nargs = None, urljoin = urllib.parse.urljoin, base_uri = '', **kwargs)

   Bases: :py:obj:`argparse.Action`

   .. autoapi-inheritance-diagram:: cwltool.argparser.FSAction
      :parts: 1


   Base action for our custom actions.


   .. py:attribute:: objclass
      :type:  str | None
      :value: None



   .. py:attribute:: urljoin


   .. py:attribute:: base_uri
      :value: ''



   .. py:method:: __call__(parser, namespace, values, option_string = None)


.. py:class:: FSAppendAction(option_strings, dest, nargs = None, urljoin = urllib.parse.urljoin, base_uri = '', **kwargs)

   Bases: :py:obj:`argparse.Action`

   .. autoapi-inheritance-diagram:: cwltool.argparser.FSAppendAction
      :parts: 1


   Appending version of the base action for our custom actions.


   .. py:attribute:: objclass
      :type:  str | None
      :value: None



   .. py:attribute:: urljoin


   .. py:attribute:: base_uri
      :value: ''



   .. py:method:: __call__(parser, namespace, values, option_string = None)


.. py:class:: FileAction(option_strings, dest, nargs = None, urljoin = urllib.parse.urljoin, base_uri = '', **kwargs)

   Bases: :py:obj:`FSAction`

   .. autoapi-inheritance-diagram:: cwltool.argparser.FileAction
      :parts: 1


   Base action for our custom actions.


   .. py:attribute:: objclass
      :type:  str | None
      :value: 'File'



.. py:class:: DirectoryAction(option_strings, dest, nargs = None, urljoin = urllib.parse.urljoin, base_uri = '', **kwargs)

   Bases: :py:obj:`FSAction`

   .. autoapi-inheritance-diagram:: cwltool.argparser.DirectoryAction
      :parts: 1


   Base action for our custom actions.


   .. py:attribute:: objclass
      :type:  str | None
      :value: 'Directory'



.. py:class:: FileAppendAction(option_strings, dest, nargs = None, urljoin = urllib.parse.urljoin, base_uri = '', **kwargs)

   Bases: :py:obj:`FSAppendAction`

   .. autoapi-inheritance-diagram:: cwltool.argparser.FileAppendAction
      :parts: 1


   Appending version of the base action for our custom actions.


   .. py:attribute:: objclass
      :type:  str | None
      :value: 'File'



.. py:class:: DirectoryAppendAction(option_strings, dest, nargs = None, urljoin = urllib.parse.urljoin, base_uri = '', **kwargs)

   Bases: :py:obj:`FSAppendAction`

   .. autoapi-inheritance-diagram:: cwltool.argparser.DirectoryAppendAction
      :parts: 1


   Appending version of the base action for our custom actions.


   .. py:attribute:: objclass
      :type:  str | None
      :value: 'Directory'



.. py:class:: AppendAction(option_strings, dest, nargs = None, **kwargs)

   Bases: :py:obj:`argparse.Action`

   .. autoapi-inheritance-diagram:: cwltool.argparser.AppendAction
      :parts: 1


   An argparse action that clears the default values if any value is provided.


   .. py:method:: __call__(parser, namespace, values, option_string = None)


.. py:function:: add_argument(toolparser, name, inptype, records, description = '', default = None, input_required = True, urljoin = urllib.parse.urljoin, base_uri = '')

.. py:function:: generate_parser(toolparser, tool, namemap, records, input_required = True, urljoin = urllib.parse.urljoin, base_uri = '')

   Generate an ArgumentParser for the given CWL Process.