yannweb/lodel2_mirror
1
0
Fork 0
mirror of https://github.com/yweber/lodel2.git synced 2026-01-13 10:12:15 +01:00
Code Releases Activity

Documentation cleaning on lodel.leapi.datahandlers

Browse source
This commit is contained in:
Roland Haroutiounian 2017-03-31 09:04:42 +02:00
commit 969f93d13e
1 changed files with 34 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

70
lodel/leapi/datahandlers/__init__.py
View file

@ -1,62 +1,60 @@
from lodel.leapi.datahandlers.base_classes import DataHandler
DataHandler.load_base_handlers()
##@defgroup lodel2_datahandlers Datahandlers
#@ingroup lodel2_leapi
#@ingroup lodel2_em
## @defgroup lodel2_datahandlers Datahandlers
# @ingroup lodel2_leapi
# @ingroup lodel2_em
##@defgroup lodel2_dh_checks Datahandlers datas checking
#@ingroup lodel2_datahandlers
## @defgroup lodel2_dh_checks Datahandlers datas checking
# @ingroup lodel2_datahandlers
##@package lodel.leapi.datahandlers Lodel2 datahandlers
## @package lodel.leapi.datahandlers Lodel2 datahandlers
#
#Datahandlers are object that handles datas check, construction and
#consistency check
# Datahandlers are object that handles datas check, construction and
# consistency check
#
##@page lodel2_dh_checks_page Datahandlers datas checking
#@ingroup lodel2_dh_checks
## @page lodel2_dh_checks_page Datahandlers datas checking
# @ingroup lodel2_dh_checks
#
#@section lodel2_dh_check_mech Datas checking mechanism
# @section lodel2_dh_check_mech Datas checking mechanism
#
#The data checking mechanism is divided into 3 stages :
# 1. **value checking** : a basic value check. Example : is len(value) < 52
# 2. **data construction** : for datas that needs to be modified. Example :
#a date that will be transformed into a Datetime object associated with
#a timezone
# 3. **data consistency checking** : perform a consistency checking on the
#object from the "point of view" of the current field. Example : is the given
#lodel_id an identifier of a Article
# The data checking mechanism is divided into 3 stages :
# 1. **value checking** : a basic value check. Example : is len(value) < 52 ?
# 2. **data construction** : for data that needs to be modified. Example :
# a date that will be transformed into a Datetime object associated with a
# timezone
# 3. **data consistency checking** : performs a consistency checking on the
# object from the "point of view" of the current field. Example : is the
# given lodel_id an identifier of an Article ?
#
#@subsection lodel2_dh_check_impl Implementation
# @subsection lodel2_dh_check_impl Implementation
#
#Those three stages are implemented by 3 datahandlers methods :
# Those three stages are implemented by 3 datahandlers methods :
# - @ref base_classes.DataHandler.check_data_value() "check_data_value"
# - @ref base_classes.DataHandler.construct_data() "construct_data"
# - @ref base_classes.DataHandler.check_data_value() "check_data_consitency"
#
#@note To ensure the calls of the base classes methods child classes implements
#those method with a '_' preffix :
# @note To ensure the calls of the base classes methods child classes implements
# those method with a '_' prefix :
# - @ref base_classes.DataHandler._check_data_value "_check_data_value()"
# - @ref base_classes.DataHandler._construct_data() "_construct_data"
# - @ref base_classes.DataHandler._check_data_value() "_check_data_consitency"
#
#Examples of child classes can be found @ref datahandlers.datas "here"
# Examples of child classes can be found @ref datahandlers.datas "here"
#
#@subsubsection lodel2_dh_datas_construction Datas construction
# @subsubsection lodel2_dh_datas_construction Datas construction
#
#Datas construction is a bit tricky. When constructing a data handled by a
#datahandler we may need to have access to other datas in the object (see
#@ref base_classes.DataHandler.construct_data() "construct_data() arguments").
# When constructing a data handled by a datahandler we may need to have access
# to other datas in the object (see @ref base_classes.DataHandler.construct_data() "construct_data() arguments").
#
#The problem reside in the construction order, if we need other datas we have
#to be sure that they are allready constructed. To achieve this goal the datas
#dict given as arguement to
#@ref base_classes.DataHandler.construct_data() "construct_data()" is an
#@ref base_classes.DatasConstructor "DatasConstructor" instance. This class
#check if a data is constructed when trying to access to it, if not it runs
#the corresponding construct_data() (and have a circular dependencies detection
#mechanism)
# The problem resides in the construction order, if we need other data we have
# to be sure that they are already constructed. To achieve this goal the data
# dictionary given as arguement to @ref base_classes.DataHandler.construct_data() "construct_data()"
# is a @ref base_classes.DatasConstructor "DatasConstructor" instance. This class
# checks if a data is constructed when trying to access it, if not it runs
# the corresponding construct_data() (and have a circular dependencies detection
# mechanism)
#
#@see base_classes.DatasConstructor.