sphinx-toolbox Demo - Overloads

class <{{ sig_prename_tag }} class="sig-prename descclassname"> tests.test_output.overloads_demo. <{{ sig_prename_tag }} class="sig-name descname"> Bar [source]
<{{ sig_prename_tag }} class="sig-name descname"> __getitem__ ( 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 %}

item ( Union [ int , slice ])

Return type{% if docutils_version >= (0, 18) %} : {% endif %}

Union [ str , List [ str ]]

Overloads{% if docutils_version >= (0, 18) %} : {% endif %}
<{{ sig_prename_tag }} class="sig-name descname"> __module__ = 'tests.test_output.overloads_demo'

Type: str

class <{{ sig_prename_tag }} class="sig-prename descclassname"> tests.test_output.overloads_demo. <{{ sig_prename_tag }} class="sig-name descname"> Foo [source]
<{{ sig_prename_tag }} class="sig-name descname"> __getitem__ ( item ) [source]

Return the item with the given index.

Parameters{% if docutils_version >= (0, 18) %} : {% endif %}

item ( Union [ int , slice ])

Return type{% if docutils_version >= (0, 18) %} : {% endif %}

Union [ str , List [ str ]]

Overloads{% if docutils_version >= (0, 18) %} : {% endif %}

{% if sphinx_version >= (7, 3) %}Added{% else %}New{% endif %} in version 1.2.3.

<{{ sig_prename_tag }} class="sig-name descname"> __module__ = 'tests.test_output.overloads_demo'

Type: str

<{{ sig_prename_tag }} class="sig-prename descclassname"> tests.test_output.overloads_demo. <{{ sig_prename_tag }} class="sig-name descname"> serde ( 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 %}

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 }} class="sig-name descname"> from_dict ( d )

Construct an instance of the class from a dictionary.

Parameters{% if docutils_version >= (0, 18) %} : {% endif %}

d Mapping [ str , Any ]

<{{ sig_prename_tag }} class="sig-prename descclassname"> tests.test_output.overloads_demo. <{{ sig_prename_tag }} class="sig-name descname"> to_dict ( ) {% 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 ]