.. _f-baseclasses:

module ``activities.base_classes``
==================================





.. inheritance-diagram:: mathenjeu.activities.base_classes


Short summary
+++++++++++++

module ``mathenjeu.activities.base_classes``

Base classes.


:githublink:`%|py|6`




Classes
+++++++

+--------------------------------------------------------------------------+------------------------------------------------+
| class                                                                    | truncated documentation                        |
+==========================================================================+================================================+
| :class:`Activity <mathenjeu.activities.base_classes.Activity>`           | Defines an activity, a question, a game...     |
+--------------------------------------------------------------------------+------------------------------------------------+
| :class:`ActivityGroup <mathenjeu.activities.base_classes.ActivityGroup>` | Defines a set of activities.                   |
+--------------------------------------------------------------------------+------------------------------------------------+
| :class:`Base <mathenjeu.activities.base_classes.Base>`                   | Base class.                                    |
+--------------------------------------------------------------------------+------------------------------------------------+
| :class:`Display <mathenjeu.activities.base_classes.Display>`             | Defines how an activity should be displayed.   |
+--------------------------------------------------------------------------+------------------------------------------------+
| :class:`LanguageBase <mathenjeu.activities.base_classes.LanguageBase>`   | Base class for language specific content.      |
+--------------------------------------------------------------------------+------------------------------------------------+
| :class:`Notion <mathenjeu.activities.base_classes.Notion>`               | Defines what an activity intents to introduce. |
+--------------------------------------------------------------------------+------------------------------------------------+






Properties
++++++++++

+-------------------------------------------------------------------------+-------------------------+
| property                                                                | truncated documentation |
+=========================================================================+=========================+
| :meth:`Fields <mathenjeu.activities.base_classes.Activity.Fields>`      | Returns all the fields. |
+-------------------------------------------------------------------------+-------------------------+
| :meth:`Fields <mathenjeu.activities.base_classes.ActivityGroup.Fields>` | Returns all the fields. |
+-------------------------------------------------------------------------+-------------------------+
| :meth:`Fields <mathenjeu.activities.base_classes.Base.Fields>`          | Returns all the fields. |
+-------------------------------------------------------------------------+-------------------------+
| :meth:`Fields <mathenjeu.activities.base_classes.Display.Fields>`       | Returns all the fields. |
+-------------------------------------------------------------------------+-------------------------+
| :meth:`Fields <mathenjeu.activities.base_classes.LanguageBase.Fields>`  | Returns all the fields. |
+-------------------------------------------------------------------------+-------------------------+
| :meth:`Fields <mathenjeu.activities.base_classes.Notion.Fields>`        | Returns all the fields. |
+-------------------------------------------------------------------------+-------------------------+
| :meth:`Id <mathenjeu.activities.base_classes.Activity.Id>`              | Returns the identifier. |
+-------------------------------------------------------------------------+-------------------------+
| :meth:`Id <mathenjeu.activities.base_classes.ActivityGroup.Id>`         | Returns the identifier. |
+-------------------------------------------------------------------------+-------------------------+
| :meth:`Id <mathenjeu.activities.base_classes.Base.Id>`                  | Returns the identifier. |
+-------------------------------------------------------------------------+-------------------------+
| :meth:`Id <mathenjeu.activities.base_classes.Display.Id>`               | Returns the identifier. |
+-------------------------------------------------------------------------+-------------------------+
| :meth:`Id <mathenjeu.activities.base_classes.LanguageBase.Id>`          | Returns the identifier. |
+-------------------------------------------------------------------------+-------------------------+
| :meth:`Id <mathenjeu.activities.base_classes.Notion.Id>`                | Returns the identifier. |
+-------------------------------------------------------------------------+-------------------------+




Static Methods
++++++++++++++

+------------------------------------------------------------------------------------------+-------------------------+
| staticmethod                                                                             | truncated documentation |
+==========================================================================================+=========================+
| :py:meth:`_format_value <mathenjeu.activities.base_classes.Activity._format_value>`      |                         |
+------------------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_format_value <mathenjeu.activities.base_classes.ActivityGroup._format_value>` |                         |
+------------------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_format_value <mathenjeu.activities.base_classes.Base._format_value>`          |                         |
+------------------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_format_value <mathenjeu.activities.base_classes.Display._format_value>`       |                         |
+------------------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_format_value <mathenjeu.activities.base_classes.LanguageBase._format_value>`  |                         |
+------------------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_format_value <mathenjeu.activities.base_classes.Notion._format_value>`        |                         |
+------------------------------------------------------------------------------------------+-------------------------+




Methods
+++++++

+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| method                                                                                      | truncated documentation                                           |
+=============================================================================================+===================================================================+
| :py:meth:`__getitem__ <mathenjeu.activities.base_classes.Activity.__getitem__>`             | Returns the value associated to a field.                          |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :py:meth:`__getitem__ <mathenjeu.activities.base_classes.ActivityGroup.__getitem__>`        | Retrieves the question.                                           |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :py:meth:`__getitem__ <mathenjeu.activities.base_classes.Base.__getitem__>`                 | Returns the value associated to a field.                          |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :py:meth:`__getitem__ <mathenjeu.activities.base_classes.Display.__getitem__>`              | Returns the value associated to a field.                          |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :py:meth:`__getitem__ <mathenjeu.activities.base_classes.LanguageBase.__getitem__>`         | Returns the value associated to a field.                          |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :py:meth:`__getitem__ <mathenjeu.activities.base_classes.Notion.__getitem__>`               | Returns the value associated to a field.                          |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.activities.base_classes.Activity.__init__>`                   |                                                                   |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.activities.base_classes.ActivityGroup.__init__>`              |                                                                   |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.activities.base_classes.Base.__init__>`                       |                                                                   |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.activities.base_classes.Display.__init__>`                    |                                                                   |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.activities.base_classes.LanguageBase.__init__>`               |                                                                   |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.activities.base_classes.Notion.__init__>`                     |                                                                   |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :py:meth:`__iter__ <mathenjeu.activities.base_classes.ActivityGroup.__iter__>`              | To iterate on activities.                                         |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :py:meth:`__len__ <mathenjeu.activities.base_classes.ActivityGroup.__len__>`                | Returns the number of activities.                                 |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :py:meth:`__repr__ <mathenjeu.activities.base_classes.Activity.__repr__>`                   | Usual                                                             |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :py:meth:`__repr__ <mathenjeu.activities.base_classes.ActivityGroup.__repr__>`              | Usual                                                             |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :py:meth:`__repr__ <mathenjeu.activities.base_classes.Base.__repr__>`                       | Usual                                                             |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :py:meth:`__repr__ <mathenjeu.activities.base_classes.Display.__repr__>`                    | Usual                                                             |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :py:meth:`__repr__ <mathenjeu.activities.base_classes.LanguageBase.__repr__>`               | Usual                                                             |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :py:meth:`__repr__ <mathenjeu.activities.base_classes.Notion.__repr__>`                     | Usual                                                             |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :meth:`expected_answers <mathenjeu.activities.base_classes.ActivityGroup.expected_answers>` | Returns the expected answers aliases.                             |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :meth:`get_display_item <mathenjeu.activities.base_classes.ActivityGroup.get_display_item>` | Returns a displayable number.                                     |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :meth:`get_next <mathenjeu.activities.base_classes.ActivityGroup.get_next>`                 | Computes the next question or returns None if does not exist.     |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :meth:`get_previous <mathenjeu.activities.base_classes.ActivityGroup.get_previous>`         | Computes the previous question or returns None if does not exist. |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :meth:`to_dict <mathenjeu.activities.base_classes.Activity.to_dict>`                        | Returns all values as a dictionary.                               |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :meth:`to_dict <mathenjeu.activities.base_classes.ActivityGroup.to_dict>`                   | Returns all values as a dictionary.                               |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :meth:`to_dict <mathenjeu.activities.base_classes.Base.to_dict>`                            | Returns all values as a dictionary.                               |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :meth:`to_dict <mathenjeu.activities.base_classes.Display.to_dict>`                         | Returns all values as a dictionary.                               |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :meth:`to_dict <mathenjeu.activities.base_classes.LanguageBase.to_dict>`                    | Returns all values as a dictionary.                               |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :meth:`to_dict <mathenjeu.activities.base_classes.Notion.to_dict>`                          | Returns all values as a dictionary.                               |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: mathenjeu.activities.base_classes
    :members:
    :special-members: __init__
    :show-inheritance: