Skip to content

erp5
erp5
Commit 7be5370d authored by Julien Muchembled's avatar Julien Muchembled
Browse files
Options

Unindent AppliedRule to our convention

parent 1f5a2987
Hide whitespace changes
Inline Side-by-side
Showing with 228 additions and 228 deletions
product/ERP5/Document/AppliedRule.py
View file @ 7be5370d
...@@ -41,241 +41,241 @@ TREE_DELIVERED_CACHE_KEY = 'AppliedRule._isTreeDelivered_cache' ...@@ -41,241 +41,241 @@ TREE_DELIVERED_CACHE_KEY = 'AppliedRule._isTreeDelivered_cache'
TREE_DELIVERED_CACHE_ENABLED = 'TREE_DELIVERED_CACHE_ENABLED' TREE_DELIVERED_CACHE_ENABLED = 'TREE_DELIVERED_CACHE_ENABLED'
class AppliedRule(XMLObject, ExplainableMixin): class AppliedRule(XMLObject, ExplainableMixin):
"""
An applied rule holds a list of simulation movements.
An applied rule points to an instance of Rule (which defines the actual
rule to apply with its parameters) through the specialise relation.
An applied rule can expand itself (look at its direct parent and take
conclusions on what should be inside).
An applied rule can tell if it is stable (if its children are consistent
with what would be expanded from its direct parent).
An applied rule can tell if any of his direct children is divergent (not
consistent with the delivery).
All algorithms are implemented by the rule.
"""
# CMF Type Definition
meta_type = 'ERP5 Applied Rule'
portal_type = 'Applied Rule'
# Declarative security
security = ClassSecurityInfo()
security.declareObjectProtected(Permissions.AccessContentsInformation)
# Default Properties
property_sheets = ( PropertySheet.Base
, PropertySheet.XMLObject
, PropertySheet.SimpleItem
, PropertySheet.CategoryCore
, PropertySheet.AppliedRule
)
# Declarative interfaces
zope.interface.implements(interfaces.IMovementCollection,)
def tpValues(self) :
""" show the content in the left pane of the ZMI """
return self.objectValues()
security.declareProtected(Permissions.AccessContentsInformation,
'isAccountable')
def isAccountable(self, movement):
"""Tells whether generated movement needs to be accounted or not."""
return self.getSpecialiseValue().isAccountable(movement)
security.declareProtected(Permissions.ModifyPortalContent, 'expand')
@UnrestrictedMethod
def expand(self, **kw):
""" """
An applied rule holds a list of simulation movements. Expands the current movement downward.
An applied rule points to an instance of Rule (which defines the actual -> new status -> expanded
rule to apply with its parameters) through the specialise relation.
An applied rule can expand itself (look at its direct parent and take An applied rule can be expanded only if its parent movement
conclusions on what should be inside). is expanded.
"""
tv = getTransactionalVariable()
cache = tv.setdefault(TREE_DELIVERED_CACHE_KEY, {})
cache_enabled = cache.get(TREE_DELIVERED_CACHE_ENABLED, 0)
# enable cache
if not cache_enabled:
cache[TREE_DELIVERED_CACHE_ENABLED] = 1
rule = self.getSpecialiseValue()
if rule is not None:
rule.expand(self,**kw)
# disable and clear cache
if not cache_enabled:
try:
del tv[TREE_DELIVERED_CACHE_KEY]
except KeyError:
pass
security.declareProtected(Permissions.ModifyPortalContent, 'solve')
def solve(self, solution_list):
"""
Solve inconsistency according to a certain number of solutions
templates. This updates the
An applied rule can tell if it is stable (if its children are consistent -> new status -> solved
with what would be expanded from its direct parent).
An applied rule can tell if any of his direct children is divergent (not This applies a solution to an applied rule. Once
consistent with the delivery). the solution is applied, the parent movement is checked.
If it does not diverge, the rule is reexpanded. If not,
diverge is called on the parent movement.
"""
rule = self.getSpecialiseValue()
if rule is not None:
rule.solve(self)
All algorithms are implemented by the rule. security.declareProtected(Permissions.ModifyPortalContent, 'diverge')
def diverge(self):
""" """
-> new status -> diverged
# CMF Type Definition This basically sets the rule to "diverged"
meta_type = 'ERP5 Applied Rule' and blocks expansion process
portal_type = 'Applied Rule' """
rule = self.getSpecialiseValue()
# Declarative security if rule is not None:
security = ClassSecurityInfo() rule.diverge(self)
security.declareObjectProtected(Permissions.AccessContentsInformation)
# Solvers
# Default Properties security.declareProtected(Permissions.AccessContentsInformation,
property_sheets = ( PropertySheet.Base 'isStable')
, PropertySheet.XMLObject def isStable(self):
, PropertySheet.SimpleItem """
, PropertySheet.CategoryCore Tells whether the rule is stable or not.
, PropertySheet.AppliedRule """
) return self.getSpecialiseValue().isStable(self)
# Declarative interfaces
zope.interface.implements(interfaces.IMovementCollection,)
def tpValues(self) :
""" show the content in the left pane of the ZMI """
return self.objectValues()
security.declareProtected(Permissions.AccessContentsInformation,
'isAccountable')
def isAccountable(self, movement):
"""Tells whether generated movement needs to be accounted or not."""
return self.getSpecialiseValue().isAccountable(movement)
security.declareProtected(Permissions.ModifyPortalContent, 'expand')
@UnrestrictedMethod
def expand(self, **kw):
"""
Expands the current movement downward.
-> new status -> expanded
An applied rule can be expanded only if its parent movement
is expanded.
"""
tv = getTransactionalVariable()
cache = tv.setdefault(TREE_DELIVERED_CACHE_KEY, {})
cache_enabled = cache.get(TREE_DELIVERED_CACHE_ENABLED, 0)
# enable cache
if not cache_enabled:
cache[TREE_DELIVERED_CACHE_ENABLED] = 1
rule = self.getSpecialiseValue()
if rule is not None:
rule.expand(self,**kw)
# disable and clear cache
if not cache_enabled:
try:
del tv[TREE_DELIVERED_CACHE_KEY]
except KeyError:
pass
security.declareProtected(Permissions.ModifyPortalContent, 'solve')
def solve(self, solution_list):
"""
Solve inconsistency according to a certain number of solutions
templates. This updates the
-> new status -> solved
This applies a solution to an applied rule. Once
the solution is applied, the parent movement is checked.
If it does not diverge, the rule is reexpanded. If not,
diverge is called on the parent movement.
"""
rule = self.getSpecialiseValue()
if rule is not None:
rule.solve(self)
security.declareProtected(Permissions.ModifyPortalContent, 'diverge')
def diverge(self):
"""
-> new status -> diverged
This basically sets the rule to "diverged"
and blocks expansion process
"""
rule = self.getSpecialiseValue()
if rule is not None:
rule.diverge(self)
# Solvers
security.declareProtected(Permissions.AccessContentsInformation,
'isStable')
def isStable(self):
"""
Tells whether the rule is stable or not.
"""
return self.getSpecialiseValue().isStable(self)
security.declareProtected(Permissions.AccessContentsInformation,
'isDivergent')
def isDivergent(self, sim_mvt):
"""
Tells whether generated sim_mvt is divergent or not.
"""
return self.getSpecialiseValue().isDivergent(sim_mvt)
security.declareProtected(Permissions.AccessContentsInformation,
'getDivergenceList')
def getDivergenceList(self, sim_mvt):
"""
Returns a list Divergence descriptors
"""
return self.getSpecialiseValue().getDivergenceList(sim_mvt)
security.declareProtected(Permissions.AccessContentsInformation,
'isRootAppliedRule')
def isRootAppliedRule(self):
"""
Returns 1 is this is a root applied rule
"""
return self.getParentValue().getMetaType() == "ERP5 Simulation Tool"
security.declareProtected(Permissions.AccessContentsInformation,
'getRootAppliedRule')
def getRootAppliedRule(self):
"""Return the root applied rule.
useful if some reindexing is needed from inside
"""
if self.getParentValue().getMetaType() == "ERP5 Simulation Tool":
return self
return self.getParentValue().getRootAppliedRule()
def _isTreeDelivered(self):
"""
Checks if submovements of this applied rule (going down the complete
simulation tree) have a delivery relation.
Returns True if at least one is delivered, False if none of them are.
see SimulationMovement._isTreeDelivered
"""
tv = getTransactionalVariable()
cache = tv.setdefault(TREE_DELIVERED_CACHE_KEY, {})
cache_enabled = cache.get(TREE_DELIVERED_CACHE_ENABLED, 0)
def getTreeDelivered(applied_rule):
for movement in applied_rule.objectValues():
if movement._isTreeDelivered():
return True
return False
rule_key = self.getRelativeUrl()
if cache_enabled:
try:
return cache[rule_key]
except:
result = getTreeDelivered(self)
cache[rule_key] = result
return result
else:
return getTreeDelivered(self)
security.declareProtected(Permissions.AccessContentsInformation,
'getMovementList')
def getMovementList(self, portal_type=None, **kw):
"""
Return a list of movements.
"""
return self.objectValues(portal_type=RuleMixin.movement_type)
security.declareProtected(Permissions.AccessContentsInformation,
'getIndexableChildSimulationMovementValueList')
def getIndexableChildSimulationMovementValueList(self):
return [x for x in self.getIndexableChildValueList()
if x.getPortalType() == 'Simulation Movement']
security.declarePublic('recursiveImmediateReindexSimulationMovement') security.declareProtected(Permissions.AccessContentsInformation,
def recursiveImmediateReindexSimulationMovement(self, **kw): 'isDivergent')
""" def isDivergent(self, sim_mvt):
Applies immediateReindexObject recursively to Simulation Movements """
""" Tells whether generated sim_mvt is divergent or not.
# Reindex direct children """
root_indexable = int(getattr(self.getPortalObject(), 'isIndexable', 1)) return self.getSpecialiseValue().isDivergent(sim_mvt)
for movement in self.objectValues():
if movement.isIndexable and root_indexable: security.declareProtected(Permissions.AccessContentsInformation,
movement.immediateReindexObject(**kw) 'getDivergenceList')
# Go recursively def getDivergenceList(self, sim_mvt):
for movement in self.objectValues(): """
for applied_rule in movement.objectValues(): Returns a list Divergence descriptors
applied_rule.recursiveImmediateReindexSimulationMovement(**kw) """
return self.getSpecialiseValue().getDivergenceList(sim_mvt)
security.declarePublic('recursiveReindexSimulationMovement')
def recursiveReindexSimulationMovement(self, activate_kw=None, **kw): security.declareProtected(Permissions.AccessContentsInformation,
if self.isIndexable: 'isRootAppliedRule')
if activate_kw is None: def isRootAppliedRule(self):
activate_kw = {} """
Returns 1 is this is a root applied rule
reindex_kw = self.getDefaultReindexParameterDict() """
if reindex_kw is not None: return self.getParentValue().getMetaType() == "ERP5 Simulation Tool"
reindex_activate_kw = reindex_kw.pop('activate_kw', None)
if reindex_activate_kw is not None:
reindex_activate_kw = reindex_activate_kw.copy()
if activate_kw is not None:
# activate_kw parameter takes precedence
reindex_activate_kw.update(activate_kw)
activate_kw = reindex_activate_kw
kw.update(reindex_kw)
group_id_list = []
if kw.get("group_id", "") not in ('', None):
group_id_list.append(kw.get("group_id", ""))
if kw.get("sql_catalog_id", "") not in ('', None):
group_id_list.append(kw.get("sql_catalog_id", ""))
group_id = ' '.join(group_id_list)
self.activate(group_method_id='portal_catalog/catalogObjectList',
expand_method_id='getIndexableChildSimulationMovementValueList',
alternate_method_id='alternateReindexObject',
group_id=group_id,
serialization_tag=self.getRootDocumentPath(),
**activate_kw).recursiveImmediateReindexSimulationMovement(**kw)
security.declareProtected(Permissions.AccessContentsInformation,
'getRootAppliedRule')
def getRootAppliedRule(self):
"""Return the root applied rule.
useful if some reindexing is needed from inside
"""
if self.getParentValue().getMetaType() == "ERP5 Simulation Tool":
return self
return self.getParentValue().getRootAppliedRule()
def _isTreeDelivered(self):
"""
Checks if submovements of this applied rule (going down the complete
simulation tree) have a delivery relation.
Returns True if at least one is delivered, False if none of them are.
see SimulationMovement._isTreeDelivered
"""
tv = getTransactionalVariable()
cache = tv.setdefault(TREE_DELIVERED_CACHE_KEY, {})
cache_enabled = cache.get(TREE_DELIVERED_CACHE_ENABLED, 0)
def getTreeDelivered(applied_rule):
for movement in applied_rule.objectValues():
if movement._isTreeDelivered():
return True
return False
rule_key = self.getRelativeUrl()
if cache_enabled:
try:
return cache[rule_key]
except:
result = getTreeDelivered(self)
cache[rule_key] = result
return result
else:
return getTreeDelivered(self)
security.declareProtected(Permissions.AccessContentsInformation,
'getMovementList')
def getMovementList(self, portal_type=None, **kw):
"""
Return a list of movements.
"""
return self.objectValues(portal_type=RuleMixin.movement_type)
security.declareProtected(Permissions.AccessContentsInformation,
'getIndexableChildSimulationMovementValueList')
def getIndexableChildSimulationMovementValueList(self):
return [x for x in self.getIndexableChildValueList()
if x.getPortalType() == 'Simulation Movement']
security.declarePublic('recursiveImmediateReindexSimulationMovement')
def recursiveImmediateReindexSimulationMovement(self, **kw):
"""
Applies immediateReindexObject recursively to Simulation Movements
"""
# Reindex direct children
root_indexable = int(getattr(self.getPortalObject(), 'isIndexable', 1))
for movement in self.objectValues():
if movement.isIndexable and root_indexable:
movement.immediateReindexObject(**kw)
# Go recursively
for movement in self.objectValues():
for applied_rule in movement.objectValues():
applied_rule.recursiveImmediateReindexSimulationMovement(**kw)
security.declarePublic('recursiveReindexSimulationMovement')
def recursiveReindexSimulationMovement(self, activate_kw=None, **kw):
if self.isIndexable:
if activate_kw is None:
activate_kw = {}
reindex_kw = self.getDefaultReindexParameterDict()
if reindex_kw is not None:
reindex_activate_kw = reindex_kw.pop('activate_kw', None)
if reindex_activate_kw is not None:
reindex_activate_kw = reindex_activate_kw.copy()
if activate_kw is not None:
# activate_kw parameter takes precedence
reindex_activate_kw.update(activate_kw)
activate_kw = reindex_activate_kw
kw.update(reindex_kw)
group_id_list = []
if kw.get("group_id", "") not in ('', None):
group_id_list.append(kw.get("group_id", ""))
if kw.get("sql_catalog_id", "") not in ('', None):
group_id_list.append(kw.get("sql_catalog_id", ""))
group_id = ' '.join(group_id_list)
self.activate(
group_method_id='portal_catalog/catalogObjectList',
expand_method_id='getIndexableChildSimulationMovementValueList',
alternate_method_id='alternateReindexObject',
group_id=group_id,
serialization_tag=self.getRootDocumentPath(),
**activate_kw).recursiveImmediateReindexSimulationMovement(**kw)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7