.. _api:

Developer Interface
===================

.. module:: typedinterpolation

.. py:class:: typedinterpolation.TypedInterpolationMixin

    Mixin class to use with `interpolations <http://docs.python.org/3/library/configparser.html#interpolation-of-values>`_.

    .. py:method:: before_get(self, parser, section, option, value, defaults)

       Use :py:func:`ast.literal_eval`.
       Returns a python literal.

    .. py:method:: before_set(self, parser, section, option, value)

       Convert value to string automatically. Returns a string.

.. py:class:: typedinterpolation.TypedInterpolation

    Interpolation that connects
    :py:class:`typedinterpolation.TypedInterpolationMixin` with
    :py:class:`configparser.Interpolation`.

.. py:class:: typedinterpolation.TypedBasicInterpolation

    Interpolation that connect
    :py:class:`typedinterpolation.TypedInterpolationMixin` with
    :py:class:`configparser.BasicInterpolation`.
    
.. py:class:: typedinterpolation.TypedExtendedInterpolation
    
    Interpolation that connect
    :py:class:`typedinterpolation.TypedInterpolationMixin` with
    :py:class:`configparser.ExtendedInterpolation`.