module activities.base_classes

Short summary

module mathenjeu.activities.base_classes

Base classes.

source on GitHub

Classes

class	truncated documentation
Activity	Defines an activity, a question, a game…
ActivityGroup	Defines a set of activities.
Base	Base class.
Display	Defines how an activity should be displayed.
LanguageBase	Base class for language specific content.
Notion	Defines what an activity intents to introduce.

Properties

property	truncated documentation
Fields	Returns all the fields.
Fields	Returns all the fields.
Fields	Returns all the fields.
Fields	Returns all the fields.
Fields	Returns all the fields.
Fields	Returns all the fields.
Id	Returns the identifier.
Id	Returns the identifier.
Id	Returns the identifier.
Id	Returns the identifier.
Id	Returns the identifier.
Id	Returns the identifier.

Static Methods

staticmethod	truncated documentation
_format_value
_format_value
_format_value
_format_value
_format_value
_format_value

Methods

method	truncated documentation
__getitem__	Returns the value associated to a field.
__getitem__	Retrieves the question.
__getitem__	Returns the value associated to a field.
__getitem__	Returns the value associated to a field.
__getitem__	Returns the value associated to a field.
__getitem__	Returns the value associated to a field.
__init__
__init__
__init__
__init__
__init__
__init__
__iter__	To iterate on activities.
__len__	Returns the number of activities.
__repr__	Usual
__repr__	Usual
__repr__	Usual
__repr__	Usual
__repr__	Usual
__repr__	Usual
expected_answers	Returns the expected answers aliases.
get_display_item	Returns a displayable number.
get_next	Computes the next question or returns None if does not exist.
get_previous	Computes the previous question or returns None if does not exist.
to_dict	Returns all values as a dictionary.
to_dict	Returns all values as a dictionary.
to_dict	Returns all values as a dictionary.
to_dict	Returns all values as a dictionary.
to_dict	Returns all values as a dictionary.
to_dict	Returns all values as a dictionary.

Documentation

Base classes.

source on GitHub

class mathenjeu.activities.base_classes.Activity(eid, name, lang, title, notion=None, description=None, content=None)

Bases : mathenjeu.activities.base_classes.LanguageBase

Defines an activity, a question, a game…

source on GitHub

Paramètres

• eid – identifier

• name – unique name

• lang – language

• title – display name

• notion – notion (Notion)

• description – description

• content – content

source on GitHub

__init__(eid, name, lang, title, notion=None, description=None, content=None)

Paramètres

• eid – identifier

• name – unique name

• lang – language

• title – display name

• notion – notion (Notion)

• description – description

• content – content

source on GitHub

class mathenjeu.activities.base_classes.ActivityGroup(eid, name, acts=None)

Bases : mathenjeu.activities.base_classes.Base

Defines a set of activities.

source on GitHub

Paramètres

• eid – identifier

• name – unique name

• acts – set of activities

source on GitHub

__getitem__(item)

Retrieves the question.

Paramètres

item – item

Renvoie

Activity

source on GitHub

__init__(eid, name, acts=None)

Paramètres

• eid – identifier

• name – unique name

• acts – set of activities

source on GitHub

__iter__()

To iterate on activities.

source on GitHub

__len__()

Returns the number of activities.

source on GitHub

expected_answers()

Returns the expected answers aliases.

source on GitHub

get_display_item(item)

Returns a displayable number.

Paramètres

item – item number

Renvoie

string

source on GitHub

get_next(current)

Computes the next question or returns None if does not exist.

Paramètres

current – current question

Renvoie

next question or None

source on GitHub

get_previous(current)

Computes the previous question or returns None if does not exist.

Paramètres

current – previous question

Renvoie

next question or None

source on GitHub

class mathenjeu.activities.base_classes.Base(eid, name)

Bases : object

Base class.

source on GitHub

Paramètres

• eid – entity id

• name – unique name (mostly for logging)

source on GitHub

property Fields

Returns all the fields.

source on GitHub

property Id

Returns the identifier.

source on GitHub

__getitem__(field)

Returns the value associated to a field.

Paramètres

field – field

Renvoie

value

source on GitHub

__init__(eid, name)

Paramètres

• eid – entity id

• name – unique name (mostly for logging)

source on GitHub

__repr__()

Usual

source on GitHub

static _format_value(v)

to_dict()

Returns all values as a dictionary.

source on GitHub

class mathenjeu.activities.base_classes.Display(eid, name)

Bases : mathenjeu.activities.base_classes.Base

Defines how an activity should be displayed.

source on GitHub

Paramètres

• eid – unique identifier

• name – name

source on GitHub

__init__(eid, name)

Paramètres

• eid – unique identifier

• name – name

source on GitHub

class mathenjeu.activities.base_classes.LanguageBase(eid, name, lang)

Bases : mathenjeu.activities.base_classes.Base

Base class for language specific content.

source on GitHub

Paramètres

• eid – entity id

• name – unique name (mostly for logging)

• lang – language

source on GitHub

__init__(eid, name, lang)

Paramètres

• eid – entity id

• name – unique name (mostly for logging)

• lang – language

source on GitHub

class mathenjeu.activities.base_classes.Notion(eid, name, lang, domain=None, level=None, depends=None, content=None)

Bases : mathenjeu.activities.base_classes.LanguageBase

Defines what an activity intents to introduce.

source on GitHub

Paramètres

• eid – identifier

• name – unique name

• domain – domain (maths, …)

• lang – language

• level – level, grade…

• depends – is there any needed notion to know before knowing this one?, should be a list of Notion.

• content – data

source on GitHub

__init__(eid, name, lang, domain=None, level=None, depends=None, content=None)

Paramètres

• eid – identifier

• name – unique name

• domain – domain (maths, …)

• lang – language

• level – level, grade…

• depends – is there any needed notion to know before knowing this one?, should be a list of Notion.

• content – data

source on GitHub