:tocdepth: 3

:py:mod:`gws.plugin.qgis.project`
=================================

.. py:module:: gws.plugin.qgis.project

.. autoapi-nested-parse::

   Qgis Project API.



**Source code:** :source:`gws.plugin.qgis.project<gws/plugin/qgis/project.py>`



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



.. py:exception:: Error


   Bases: :py:obj:`gws.Error`

   Generic GWS error.


.. py:function:: from_path(path: str) -> Object

.. py:function:: from_store(root: gws.Root, store: Store) -> Object

.. py:function:: from_string(text: str) -> Object

.. py:class:: Object(text: str)


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

   .. py:attribute:: text

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

   .. py:method:: caps() -> gws.plugin.qgis.caps.Caps

   .. py:method:: to_path(path: str)

   .. py:method:: to_store(root: gws.Root, store: Store)

   .. py:method:: to_xml()

   .. py:method:: xml_root() -> gws.XmlElement


.. py:class:: Store(*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:: dbUid
      :type:  str

   .. py:attribute:: path
      :type:  gws.FilePath

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

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

   .. py:attribute:: type
      :type:  StoreType


.. py:class:: StoreType(*args, **kwds)


   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:: file
      :value: 'file'


   .. py:attribute:: postgres
      :value: 'postgres'