:tocdepth: 3

:py:mod:`gws.spec.runtime`
==========================

.. py:module:: gws.spec.runtime

.. autoapi-nested-parse::

   Validate values according to specs



**Source code:** :source:`gws.spec.runtime<gws/spec/runtime.py>`



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



.. py:function:: create(manifest_path: str = None, read_cache=False, write_cache=False) -> Object

.. py:data:: Error

.. py:data:: GeneratorError

.. py:function:: get_spec(manifest_path: str = None, read_cache=False, write_cache=False) -> dict

.. py:data:: LoadError

.. py:class:: Object(gs)


   Bases: :py:obj:`gws.SpecRuntime`

   Specification runtime.

   .. py:attribute:: appBundlePaths
      :value: []


      List of client bundle paths.

   .. py:attribute:: chunks

   .. py:attribute:: index

   .. py:attribute:: manifest

      Application manifest.

   .. py:attribute:: manifestPath

   .. py:attribute:: specs

   .. py:attribute:: strings

   .. py:attribute:: version

      Application version.

   .. py:method:: cli_commands(lang='en')

   .. py:method:: command_descriptor(command_category, command_name)

      Get a command descriptor.

      :param command_category: Command category.
      :param command_name: Command name.

      :returns: A descriptor or ``None`` if the command is not found.


   .. py:method:: get_class(classref, ext_type=None)

      Get a class object for a class reference.

      :param classref: Class reference.
      :param ext_type: Extension type.

      :returns: A class or ``None`` if the reference is not found.


   .. py:method:: get_type(key)

   .. py:method:: object_descriptor(name)

      Get an object descriptor.

      :param type_name: Object type name.

      :returns: A descriptor or ``None`` if the type is not found.


   .. py:method:: parse_classref(classref: gws.ClassRef) -> tuple[Optional[type], str, str]

      Parse a class reference.

      :param classref: Class reference.

      :returns: A tuple ``(class object, class name, extension name)``.


   .. py:method:: read(value, type_name, path='', options=None)

      Read a raw value according to a spec.

      :param value: Raw value from config or request.
      :param type_name: Object type name.
      :param path: Config file path.
      :param options: Read options.

      :returns: A parsed object.


   .. py:method:: register_object(classref, ext_type, cls)

      Dynamically register an extension object.



.. py:data:: ReadError