Mercurial > hgrepos > Python > libs > ConfigMix
changeset 718:c983152740b0
Docs for Configuration: all methods including alteriatives
| author | Franz Glasner <f.glasner@feldmann-mg.com> |
|---|---|
| date | Wed, 16 Aug 2023 11:31:31 +0200 |
| parents | 65ff0f61af37 |
| children | 3547dea62ef6 |
| files | docs/apidoc.rst |
| diffstat | 1 files changed, 75 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/apidoc.rst Wed Aug 16 09:29:08 2023 +0200 +++ b/docs/apidoc.rst Wed Aug 16 11:31:31 2023 +0200 @@ -30,22 +30,96 @@ .. autoclass:: Configuration :members: - :exclude-members: py_getvarl, py_getvarl_s, py_interpolate_variables + :exclude-members: getvar, py_getvar, fast_getvar, + getvar_s, py_getvar_s, fast_getvar_s, + getvarl, py_getvarl, fast_getvarl, + getvarl_s, py_getvarl_s, fast_getvarl_s, + interpolate_variables, py_interpolate_variables, + fast_interpolate_variables :undoc-members: :special-members: __getitem__, __getattr__, __contains__ + .. method:: getvar + + For documentation and the signature see :meth:`py_getvar`. + + This method is an alias of :func:`py_getvar` or + :func:`fast_getvar` -- depending on the availability of the + :mod:`configmix._speedups` module. + + .. automethod:: py_getvar + + Pure-Python implementation. + + .. method:: fast_getvar + + Implemented in C in :mod:`configmix._speedups`. + + .. method:: getvar_s + + For documentation and the signature see :meth:`py_getvar_s`. + + This method is an alias of :func:`py_getvar_s` or + :func:`fast_getvar_s` -- depending on the availability of the + :mod:`configmix._speedups` module. + + .. automethod:: py_getvar_s + + Pure-Python implementation. + + .. method:: fast_getvar_s + + Implemented in C in :mod:`configmix._speedups`. + + .. method:: getvarl + + For documentation and the signature see :meth:`py_getvarl`. + + This method is an alias of :func:`py_getvarl` or + :func:`fast_getvarl` -- depending on the availability of the + :mod:`configmix._speedups` module. + .. automethod:: py_getvarl Pure-Python implementation. + .. method:: fast_getvarl + + Implemented in C in :mod:`configmix._speedups`. + + .. method:: getvarl_s + + For documentation and the signature see :meth:`py_getvarl_s`. + + This method is an alias of :func:`py_getvarl_s` or + :func:`fast_getvarl_s` -- depending on the availability of the + :mod:`configmix._speedups` module. + .. automethod:: py_getvarl_s Pure-Python implementation. + .. method:: fast_getvarl_s + + Implemented in C in :mod:`configmix._speedups`. + + .. method:: interpolate_variables + + For documentation and the signature see + :meth:`py_interpolate_variables`. + + This method is an alias of :func:`py_interpolate_variables` + or :func:`fast_interpolate_variables` -- depending on the + availability of the :mod:`configmix._speedups` module. + .. automethod:: py_interpolate_variables Pure-Python implementation. + .. method:: fast_interpolate_variables + + Implemented in C in :mod:`configmix._speedups`. + .. autoclass:: CoercingMethodsMixin :members: :undoc-members:
