comparison docs/apidoc.rst @ 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
comparison
equal deleted inserted replaced
717:65ff0f61af37 718:c983152740b0
28 .. automodule:: configmix.config 28 .. automodule:: configmix.config
29 :ignore-module-all: 29 :ignore-module-all:
30 30
31 .. autoclass:: Configuration 31 .. autoclass:: Configuration
32 :members: 32 :members:
33 :exclude-members: py_getvarl, py_getvarl_s, py_interpolate_variables 33 :exclude-members: getvar, py_getvar, fast_getvar,
34 getvar_s, py_getvar_s, fast_getvar_s,
35 getvarl, py_getvarl, fast_getvarl,
36 getvarl_s, py_getvarl_s, fast_getvarl_s,
37 interpolate_variables, py_interpolate_variables,
38 fast_interpolate_variables
34 :undoc-members: 39 :undoc-members:
35 :special-members: __getitem__, __getattr__, __contains__ 40 :special-members: __getitem__, __getattr__, __contains__
36 41
42 .. method:: getvar
43
44 For documentation and the signature see :meth:`py_getvar`.
45
46 This method is an alias of :func:`py_getvar` or
47 :func:`fast_getvar` -- depending on the availability of the
48 :mod:`configmix._speedups` module.
49
50 .. automethod:: py_getvar
51
52 Pure-Python implementation.
53
54 .. method:: fast_getvar
55
56 Implemented in C in :mod:`configmix._speedups`.
57
58 .. method:: getvar_s
59
60 For documentation and the signature see :meth:`py_getvar_s`.
61
62 This method is an alias of :func:`py_getvar_s` or
63 :func:`fast_getvar_s` -- depending on the availability of the
64 :mod:`configmix._speedups` module.
65
66 .. automethod:: py_getvar_s
67
68 Pure-Python implementation.
69
70 .. method:: fast_getvar_s
71
72 Implemented in C in :mod:`configmix._speedups`.
73
74 .. method:: getvarl
75
76 For documentation and the signature see :meth:`py_getvarl`.
77
78 This method is an alias of :func:`py_getvarl` or
79 :func:`fast_getvarl` -- depending on the availability of the
80 :mod:`configmix._speedups` module.
81
37 .. automethod:: py_getvarl 82 .. automethod:: py_getvarl
38 83
39 Pure-Python implementation. 84 Pure-Python implementation.
40 85
86 .. method:: fast_getvarl
87
88 Implemented in C in :mod:`configmix._speedups`.
89
90 .. method:: getvarl_s
91
92 For documentation and the signature see :meth:`py_getvarl_s`.
93
94 This method is an alias of :func:`py_getvarl_s` or
95 :func:`fast_getvarl_s` -- depending on the availability of the
96 :mod:`configmix._speedups` module.
97
41 .. automethod:: py_getvarl_s 98 .. automethod:: py_getvarl_s
42 99
43 Pure-Python implementation. 100 Pure-Python implementation.
44 101
102 .. method:: fast_getvarl_s
103
104 Implemented in C in :mod:`configmix._speedups`.
105
106 .. method:: interpolate_variables
107
108 For documentation and the signature see
109 :meth:`py_interpolate_variables`.
110
111 This method is an alias of :func:`py_interpolate_variables`
112 or :func:`fast_interpolate_variables` -- depending on the
113 availability of the :mod:`configmix._speedups` module.
114
45 .. automethod:: py_interpolate_variables 115 .. automethod:: py_interpolate_variables
46 116
47 Pure-Python implementation. 117 Pure-Python implementation.
118
119 .. method:: fast_interpolate_variables
120
121 Implemented in C in :mod:`configmix._speedups`.
48 122
49 .. autoclass:: CoercingMethodsMixin 123 .. autoclass:: CoercingMethodsMixin
50 :members: 124 :members:
51 :undoc-members: 125 :undoc-members:
52 126