:tocdepth: 3

:py:mod:`gws.base.action`
=========================

.. py:module:: gws.base.action


**Source code:** :source:`gws.base.action<gws/base/action/__init__.py>`


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   cli/index.rst
   core/index.rst
   manager/index.rst



Package Contents
----------------



.. py:class:: Config(*args, **kwargs)


   Bases: :py:obj:`gws.ConfigWithAccess`

   Basic config with permissions.


.. py:function:: get_action_for_cli(root: gws.Root, action_name: str, project_uid: Optional[str] = None) -> Optional[gws.Action]

   Get an action object by its name and optional project UID.

   If no project UID is provided, it searches for the action in the global scope and then in all projects.


.. py:class:: Object


   Bases: :py:obj:`gws.Action`

   Generic action object, the parent of all action objects.

   .. py:method:: props(user)

      Generate a ``Props`` struct for this object.

      :param user: The user for which the props should be generated.



.. py:function:: parse_cli_request(root: gws.Root, command_category: gws.CommandCategory, command_name: str, params: dict, read_options=None)

   Parse a CLI request and return the action handler and request object.


.. py:class:: Props(*args, **kwargs)


   Bases: :py:obj:`gws.Props`

   Object properties.

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