plots.schemas
=============

.. py:module:: plots.schemas


Attributes
----------

.. autoapisummary::

   plots.schemas.RCPARAMS
   plots.schemas.schema


Exceptions
----------

.. autoapisummary::

   plots.schemas.SchemaNotFoundError


Classes
-------

.. autoapisummary::

   plots.schemas.Schema


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

.. py:data:: RCPARAMS
   :value: ['backends', 'lines', 'patches', 'hatches', 'font', 'text', 'latex', 'axes', 'dates', 'xtick',...


.. py:class:: Schema(parent=None, **kwargs)

   Bases: :py:obj:`dict`


   Class for containing and maintaining global style settings.


   .. py:attribute:: PROTECTED_KEYS
      :value: ['_parent']



   .. py:method:: apply(*keys)


   .. py:method:: get(key)

      Get the value of a schema key.

      :param key: The name of the schema key to get.
      :type key: str

      .. rubric:: Example

      >>> schema.set(font="verdana")
      >>> schema.get("font")
      'verdana'



   .. py:attribute:: parsers


   .. py:method:: set(**kwargs)

      Set the value of a schema key.

      :param \*\*kwargs: The schema keys and values to set.

      .. rubric:: Example

      >>> schema.set(font="verdana")
      >>> with schema.set(font="comic sans"):
      ...     print(schema.font)
      ...
      comic sans
      >>> print(schema.font)
      verdana



   .. py:method:: use(name)

      Use a named schema.

      :param name: The name of the schema to use, or path to a user-implemented schema.
      :type name: str

      .. rubric:: Example

      >>> schema.use("default")
      >>> schema.use("~/custom.yaml")



.. py:exception:: SchemaNotFoundError

   Bases: :py:obj:`FileNotFoundError`


   File not found.


.. py:data:: schema