.. -*- coding: utf-8 -*-

Package API Documentation
=========================

.. contents::
   :local:

Package :mod:`configmix`
------------------------

.. automodule:: configmix
   :members:
   :ignore-module-all:


Module :mod:`configmix.compat`
------------------------------

.. automodule:: configmix.compat
   :members:
   :undoc-members:


Module :mod:`configmix.config`
------------------------------

.. automodule:: configmix.config
   :ignore-module-all:

   .. autoclass:: Configuration
      :members:
      :undoc-members:
      :special-members: __getitem__, __getattr__, __contains__

   .. autoclass:: CoercingMethodsMixin
      :members:
      :undoc-members:

   While not instantiable directly, but only by
   :meth:`Configuration.jailed`, the API use will want to know its interface:

   .. autoclass:: _JailedConfiguration
      :members:
      :undoc-members:
      :special-members: __getitem__, __getattr__, __len__, __bool__, __iter__, __contains__

   Some public helper functions:

   .. autofunction:: py_quote

   .. autofunction:: py_unquote

   .. autofunction:: py_pathstr2path


Module :mod:`configmix.constants`
---------------------------------

.. automodule:: configmix.constants
   :members:


Module :mod:`configmix.ini`
---------------------------

.. automodule:: configmix.ini
   :members:
   :ignore-module-all:


Module :mod:`configmix.json`
----------------------------

.. automodule:: configmix.json
   :members:
   :ignore-module-all:


Module :mod:`configmix.py`
--------------------------

.. automodule:: configmix.py
   :members:
   :ignore-module-all:

      
Module :mod:`configmix.toml`
----------------------------

.. automodule:: configmix.toml
   :members:
   :ignore-module-all:      


Module :mod:`configmix.variables`
---------------------------------

.. automodule:: configmix.variables
   :members:
   :ignore-module-all:


Module :mod:`configmix.yaml`
----------------------------

.. automodule:: configmix.yaml
   :members:
   :ignore-module-all:


Module :mod:`configmix._speedups`
---------------------------------

.. module:: configmix._speedups
   :synopsis: Optional alternate implementations for some functions
	      in C using Python's C-API
   	    
    This module is implemented in C using Python's C-API.
    It contains alternate implementations for some heavily used
    functions and/or methods. The module functions are not supposed to be
    called directly. Their signatures may or may not match their
    pure-Python equivalents because they may be called by appropriate
    tiny Python wrappers.

    This module is optional.

    The module is only available for CPython >= 3.7 and uses its stable API.