sphinx-toolbox Demo - Overloads ¶
- class <{{ sig_prename_tag }} class="sig-prename descclassname"> tests.test_output.overloads_demo. {{ sig_prename_tag }}> <{{ sig_prename_tag }} class="sig-name descname"> Bar {{ sig_prename_tag }}> [source] ¶
-
- <{{ sig_prename_tag }} class="sig-name descname"> __getitem__ {{ sig_prename_tag }}> ( item ) [source] ¶
-
Return the item with the given index.
{% if sphinx_version >= (7, 3) %}Added{% else %}New{% endif %} in version 1.2.3.
- Parameters{% if docutils_version >= (0, 18) %} : {% endif %}
- Return type{% if docutils_version >= (0, 18) %} : {% endif %}
- Overloads{% if docutils_version >= (0, 18) %} : {% endif %}
-
-
__getitem__
( item :int
) ->str
-
__getitem__
( item :slice
) ->{% if python_version >= (3, 12) %}List[str]
{% else %}List
[str
]{% endif %}
-
- class <{{ sig_prename_tag }} class="sig-prename descclassname"> tests.test_output.overloads_demo. {{ sig_prename_tag }}> <{{ sig_prename_tag }} class="sig-name descname"> Foo {{ sig_prename_tag }}> [source] ¶
-
- <{{ sig_prename_tag }} class="sig-name descname"> __getitem__ {{ sig_prename_tag }}> ( item ) [source] ¶
-
Return the item with the given index.
- Parameters{% if docutils_version >= (0, 18) %} : {% endif %}
- Return type{% if docutils_version >= (0, 18) %} : {% endif %}
- Overloads{% if docutils_version >= (0, 18) %} : {% endif %}
-
-
__getitem__
( item :int
) ->str
-
__getitem__
( item :slice
) ->{% if python_version >= (3, 12) %}List[str]
{% else %}List
[str
]{% endif %}
-
{% if sphinx_version >= (7, 3) %}Added{% else %}New{% endif %} in version 1.2.3.
- <{{ sig_prename_tag }} class="sig-prename descclassname"> tests.test_output.overloads_demo. {{ sig_prename_tag }}> <{{ sig_prename_tag }} class="sig-name descname"> serde {{ sig_prename_tag }}> ( cls = None , from_key = 'from' , to_key = 'to' ) [source] ¶
-
Decorator to add serialisation and deserialisation capabilities to attrs classes.
- Parameters{% if docutils_version >= (0, 18) %} : {% endif %}
- Return type{% if docutils_version >= (0, 18) %} : {% endif %}
-
Union
[Type
[object
],Callable
[[Type
[object
]],Type
[object
]]] - Overloads{% if docutils_version >= (0, 18) %} : {% endif %}
-
-
serde
( cls :{% if python_version >= (3, 12) %}Type[object]
, from_key :str
= …, to_key :{% else %}Type
[object
], from_key = …, to_key {% endif %}{% if python_version >= (3, 12) %}str
= … ) ->Type[object]
{% else %} = … ) ->Type
[object
]{% endif %} -
serde
( cls :None
= None, from_key {% if python_version >= (3, 12) %} :str
= …, to_key :str
= … ) ->'Callable[[Type[object]], Type[object]]'
{% else %} = …, to_key = … ) ->Callable
[[Type
[object
]],Type
[object
]]{% endif %}
-
Classes decorated with
@serde
will have two new methods added:- classmethod <{{ sig_prename_tag }} class="sig-prename descclassname"> tests.test_output.overloads_demo. {{ sig_prename_tag }}> <{{ sig_prename_tag }} class="sig-name descname"> from_dict {{ sig_prename_tag }}> ( d ) ¶
-
Construct an instance of the class from a dictionary.
- <{{ sig_prename_tag }} class="sig-prename descclassname"> tests.test_output.overloads_demo. {{ sig_prename_tag }}> <{{ sig_prename_tag }} class="sig-name descname"> to_dict {{ sig_prename_tag }}> ( ) {% if sphinx_version >= (4, 1) -%} MutableMapping[str, Any]: {% else -%}→ MutableMapping[str, Any]: {% endif -%} ¶
-
Returns a dictionary containing the contents of the class.
- Return type{% if docutils_version >= (0, 18) %} : {% endif %}
-
MutableMapping
[str
,Any
]