:tocdepth: 3

:py:mod:`gws.base.storage.core`
===============================

.. py:module:: gws.base.storage.core

.. autoapi-nested-parse::

   Storage object.



**Source code:** :source:`gws.base.storage.core<gws/base/storage/core.py>`



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



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


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

   Storage configuration

   .. py:attribute:: categoryName
      :type:  Optional[str]

      category name

   .. py:attribute:: providerUid
      :type:  Optional[str]

      storage provider uid


.. py:class:: Object


   Bases: :py:obj:`gws.Node`

   Configurable GWS object.

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

   .. py:attribute:: storageProvider
      :type:  gws.StorageProvider

   .. py:method:: configure()

      Configuration hook.


   .. py:method:: configure_provider()

   .. py:method:: get_state_for(user)

   .. py:method:: handle_request(req: gws.WebRequester, p: Request) -> Response

   .. py:method:: props(user)

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

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



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


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

   Object properties.

   .. py:attribute:: state
      :type:  State


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


   Bases: :py:obj:`gws.Request`

   Command request.

   .. py:attribute:: entryData
      :type:  Optional[dict]

   .. py:attribute:: entryName
      :type:  Optional[str]

   .. py:attribute:: verb
      :type:  Verb


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


   Bases: :py:obj:`gws.Response`

   Command response.

   .. py:attribute:: data
      :type:  Optional[dict]

   .. py:attribute:: state
      :type:  State


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


   Bases: :py:obj:`gws.Data`

   Basic data object.

   This object can be instantiated by passing one or or ``dict`` arguments
   and/or keyword args. All dicts keys and keywords become attributes of the object.

   Accessing an undefined attribute returns ``None`` and no error is raised,
   unless the attribute name starts with an underscore.

   .. py:attribute:: canCreate
      :type:  bool

   .. py:attribute:: canDelete
      :type:  bool

   .. py:attribute:: canRead
      :type:  bool

   .. py:attribute:: canWrite
      :type:  bool

   .. py:attribute:: names
      :type:  list[str]


.. py:class:: Verb


   Bases: :py:obj:`gws.Enum`

   Enumeration type.

   Despite being declared as extending ``Enum`` (for IDE support), this class is actually just a simple object
   and intended to be used as a collection of attributes. It doesn't provide any ``Enum``-specific utilities.

   The rationale behind this is that we need ``Enum`` members (e.g. ``Color.RED``) to be scalars,
   and not complex objects as in the standard ``Enum``.

   .. py:attribute:: delete
      :value: 'delete'


   .. py:attribute:: list
      :value: 'list'


   .. py:attribute:: read
      :value: 'read'


   .. py:attribute:: write
      :value: 'write'