Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
erp5
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Analytics
Analytics
Repository
Value Stream
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Commits
Open sidebar
Lu Xu
erp5
Commits
709f2b5a
Commit
709f2b5a
authored
Feb 13, 2014
by
Jérome Perrin
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
XMLMatrix: update some docstrings
parent
6139b201
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
24 additions
and
52 deletions
+24
-52
product/ERP5Type/XMLMatrix.py
product/ERP5Type/XMLMatrix.py
+24
-52
No files found.
product/ERP5Type/XMLMatrix.py
View file @
709f2b5a
...
@@ -43,6 +43,7 @@ class XMLMatrix(Folder):
...
@@ -43,6 +43,7 @@ class XMLMatrix(Folder):
"""
"""
A mix-in class which provides a matrix like
A mix-in class which provides a matrix like
access to objects. Matrices are of any dimension.
access to objects. Matrices are of any dimension.
A single XMLMatrix may contain multiple matrices,
A single XMLMatrix may contain multiple matrices,
of different dimension. Each matrix is associated to
of different dimension. Each matrix is associated to
a so-called 'base_id'.
a so-called 'base_id'.
...
@@ -66,8 +67,7 @@ class XMLMatrix(Folder):
...
@@ -66,8 +67,7 @@ class XMLMatrix(Folder):
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
'getCell'
)
'getCell'
)
def
getCell
(
self
,
*
kw
,
**
kwd
):
def
getCell
(
self
,
*
kw
,
**
kwd
):
"""
"""Access a cell by its coordinates and base_id.
Access a cell at row and column
"""
"""
if
getattr
(
aq_base
(
self
),
'index'
,
None
)
is
None
:
if
getattr
(
aq_base
(
self
),
'index'
,
None
)
is
None
:
return
None
return
None
...
@@ -84,8 +84,7 @@ class XMLMatrix(Folder):
...
@@ -84,8 +84,7 @@ class XMLMatrix(Folder):
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
'getCellProperty'
)
'getCellProperty'
)
def
getCellProperty
(
self
,
*
kw
,
**
kwd
):
def
getCellProperty
(
self
,
*
kw
,
**
kwd
):
"""
"""Get a property of a cell by its coordinates and base_id.
Get a property of a cell at row and column
"""
"""
base_id
=
kwd
.
get
(
'base_id'
,
"cell"
)
base_id
=
kwd
.
get
(
'base_id'
,
"cell"
)
cell
=
self
.
getCell
(
*
kw
,
**
kwd
)
cell
=
self
.
getCell
(
*
kw
,
**
kwd
)
...
@@ -97,9 +96,8 @@ class XMLMatrix(Folder):
...
@@ -97,9 +96,8 @@ class XMLMatrix(Folder):
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
'hasCell'
)
'hasCell'
)
def
hasCell
(
self
,
*
kw
,
**
kwd
):
def
hasCell
(
self
,
*
kw
,
**
kwd
):
"""
"""Checks if matrix corresponding to base_id contains cell specified by
Checks if matrix corresponding to base_id contains cell specified
*kw coordinates.
by *kw coordinates.
"""
"""
return
self
.
getCell
(
*
kw
,
**
kwd
)
is
not
None
return
self
.
getCell
(
*
kw
,
**
kwd
)
is
not
None
...
@@ -126,9 +124,7 @@ class XMLMatrix(Folder):
...
@@ -126,9 +124,7 @@ class XMLMatrix(Folder):
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
'hasInRange'
)
'hasInRange'
)
def
hasInRange
(
self
,
*
kw
,
**
kwd
):
def
hasInRange
(
self
,
*
kw
,
**
kwd
):
"""
"""Checks if coordinates are in the range of the matrix for this base_id
Checks if *kw coordinates are in the range of the
matrix in kwd['base_id'].
"""
"""
if
getattr
(
aq_base
(
self
),
'index'
,
None
)
is
None
:
if
getattr
(
aq_base
(
self
),
'index'
,
None
)
is
None
:
return
0
return
0
...
@@ -206,10 +202,7 @@ class XMLMatrix(Folder):
...
@@ -206,10 +202,7 @@ class XMLMatrix(Folder):
security
.
declareProtected
(
Permissions
.
ModifyPortalContent
,
'setCellRange'
)
security
.
declareProtected
(
Permissions
.
ModifyPortalContent
,
'setCellRange'
)
def
setCellRange
(
self
,
*
kw
,
**
kwd
):
def
setCellRange
(
self
,
*
kw
,
**
kwd
):
"""
"""Update the matrix ranges using provided lists of indexes (kw).
Update the matrix ranges using provided lists of indexes (kw).
Any number of list can be provided
"""
"""
self
.
_setCellRange
(
*
kw
,
**
kwd
)
self
.
_setCellRange
(
*
kw
,
**
kwd
)
self
.
reindexObject
()
self
.
reindexObject
()
...
@@ -217,17 +210,7 @@ class XMLMatrix(Folder):
...
@@ -217,17 +210,7 @@ class XMLMatrix(Folder):
security
.
declareProtected
(
Permissions
.
ModifyPortalContent
,
security
.
declareProtected
(
Permissions
.
ModifyPortalContent
,
'_updateCellRange'
)
'_updateCellRange'
)
def
_updateCellRange
(
self
,
base_id
,
**
kw
):
def
_updateCellRange
(
self
,
base_id
,
**
kw
):
"""
"""Update cell range based on asCellRange type based method.
The asCellRange script is Portal Type dependent
which is not the case with this kind of code
a better implementation consists in defining asCellRange as a
generic method at matrix level (OverridableMethod(portal_type))
which lookups for script in class, meta_type and PT form
interaction could be implemented with interaction workflow
this method should be renamed updateCellRange or updateMatrixCellRange
base_id is parameter of updateCellRange
asCellRange scripts should be unified if possible
"""
"""
script
=
self
.
_getTypeBasedMethod
(
'asCellRange'
,
**
kw
)
script
=
self
.
_getTypeBasedMethod
(
'asCellRange'
,
**
kw
)
if
script
is
None
:
if
script
is
None
:
...
@@ -248,9 +231,8 @@ class XMLMatrix(Folder):
...
@@ -248,9 +231,8 @@ class XMLMatrix(Folder):
security
.
declareProtected
(
Permissions
.
ModifyPortalContent
,
security
.
declareProtected
(
Permissions
.
ModifyPortalContent
,
'_renameCellRange'
)
'_renameCellRange'
)
def
_renameCellRange
(
self
,
*
kw
,
**
kwd
):
def
_renameCellRange
(
self
,
*
kw
,
**
kwd
):
"""
"""Rename a range for a matrix, this method can also handle a change in
Rename a range for a matrix, this method can
the size of a matrix
also handle a changement of the size of a matrix
"""
"""
base_id
=
kwd
.
get
(
'base_id'
,
'cell'
)
base_id
=
kwd
.
get
(
'base_id'
,
'cell'
)
...
@@ -337,10 +319,8 @@ class XMLMatrix(Folder):
...
@@ -337,10 +319,8 @@ class XMLMatrix(Folder):
security
.
declareProtected
(
Permissions
.
ModifyPortalContent
,
security
.
declareProtected
(
Permissions
.
ModifyPortalContent
,
'renameCellRange'
)
'renameCellRange'
)
def
renameCellRange
(
self
,
*
kw
,
**
kwd
):
def
renameCellRange
(
self
,
*
kw
,
**
kwd
):
"""
"""Update the matrix ranges using provided lists of indexes (kw).
Update the matrix ranges using provided lists of indexes (kw).
This keep cell values when dimensions are added or removed.
This keep cell values if we add/remove dimensions
Any number of list can be provided
"""
"""
self
.
_renameCellRange
(
*
kw
,
**
kwd
)
self
.
_renameCellRange
(
*
kw
,
**
kwd
)
self
.
reindexObject
()
self
.
reindexObject
()
...
@@ -380,9 +360,8 @@ class XMLMatrix(Folder):
...
@@ -380,9 +360,8 @@ class XMLMatrix(Folder):
security
.
declareProtected
(
Permissions
.
ModifyPortalContent
,
'newCellContent'
)
security
.
declareProtected
(
Permissions
.
ModifyPortalContent
,
'newCellContent'
)
def
newCellContent
(
self
,
cell_id
,
portal_type
=
None
,
**
kw
):
def
newCellContent
(
self
,
cell_id
,
portal_type
=
None
,
**
kw
):
"""
"""Creates a new content as a cell.
Creates a new content as a cell. This method is
This method is meant to be overriden by subclasses.
meant to be overriden by subclasses.
"""
"""
if
portal_type
is
None
:
if
portal_type
is
None
:
for
x
in
self
.
allowedContentTypes
():
for
x
in
self
.
allowedContentTypes
():
...
@@ -396,8 +375,7 @@ class XMLMatrix(Folder):
...
@@ -396,8 +375,7 @@ class XMLMatrix(Folder):
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
'getCellKeyList'
)
'getCellKeyList'
)
def
getCellKeyList
(
self
,
base_id
=
'cell'
):
def
getCellKeyList
(
self
,
base_id
=
'cell'
):
"""
"""Returns a list of possible keys as tuples
Returns a list of possible keys as tuples
"""
"""
if
getattr
(
aq_base
(
self
),
'index'
,
None
)
is
None
:
if
getattr
(
aq_base
(
self
),
'index'
,
None
)
is
None
:
return
()
return
()
...
@@ -420,8 +398,7 @@ class XMLMatrix(Folder):
...
@@ -420,8 +398,7 @@ class XMLMatrix(Folder):
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
'keyToId'
)
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
'keyToId'
)
def
keyToId
(
self
,
kw
,
base_id
=
'cell'
):
def
keyToId
(
self
,
kw
,
base_id
=
'cell'
):
"""
"""Converts a key into a cell id
Converts a key into a cell id
"""
"""
index
=
self
.
index
[
base_id
]
index
=
self
.
index
[
base_id
]
cell_id_list
=
[
base_id
]
cell_id_list
=
[
base_id
]
...
@@ -436,8 +413,7 @@ class XMLMatrix(Folder):
...
@@ -436,8 +413,7 @@ class XMLMatrix(Folder):
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
'getCellIdList'
)
'getCellIdList'
)
def
getCellIdList
(
self
,
base_id
=
'cell'
):
def
getCellIdList
(
self
,
base_id
=
'cell'
):
"""
"""Returns a list of possible ids as tuples
Returns a list of possible ids as tuples
"""
"""
if
getattr
(
aq_base
(
self
),
'index'
,
None
)
is
None
:
if
getattr
(
aq_base
(
self
),
'index'
,
None
)
is
None
:
return
()
return
()
...
@@ -467,8 +443,7 @@ class XMLMatrix(Folder):
...
@@ -467,8 +443,7 @@ class XMLMatrix(Folder):
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
'getCellValueList'
)
'getCellValueList'
)
def
getCellValueList
(
self
,
base_id
=
'cell'
):
def
getCellValueList
(
self
,
base_id
=
'cell'
):
"""
"""Returns a list of cell values as tuples
Returns a list of cell values as tuples
"""
"""
result
=
[]
result
=
[]
append
=
result
.
append
append
=
result
.
append
...
@@ -485,8 +460,7 @@ class XMLMatrix(Folder):
...
@@ -485,8 +460,7 @@ class XMLMatrix(Folder):
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
'getMatrixList'
)
'getMatrixList'
)
def
getMatrixList
(
self
):
def
getMatrixList
(
self
):
"""
"""Return possible base_id values
Return possible base_id values
"""
"""
if
getattr
(
aq_base
(
self
),
'index'
,
None
)
is
None
:
if
getattr
(
aq_base
(
self
),
'index'
,
None
)
is
None
:
return
()
return
()
...
@@ -494,8 +468,7 @@ class XMLMatrix(Folder):
...
@@ -494,8 +468,7 @@ class XMLMatrix(Folder):
security
.
declareProtected
(
Permissions
.
ModifyPortalContent
,
'delMatrix'
)
security
.
declareProtected
(
Permissions
.
ModifyPortalContent
,
'delMatrix'
)
def
delMatrix
(
self
,
base_id
=
'cell'
):
def
delMatrix
(
self
,
base_id
=
'cell'
):
"""
"""Delete all cells for a given base_id
Delete all cells for a given base_id
XXX BAD NAME: make a difference between deleting matrix and matrix cells
XXX BAD NAME: make a difference between deleting matrix and matrix cells
"""
"""
...
@@ -516,8 +489,7 @@ class XMLMatrix(Folder):
...
@@ -516,8 +489,7 @@ class XMLMatrix(Folder):
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
security
.
declareProtected
(
Permissions
.
AccessContentsInformation
,
'_checkConsistency'
)
'_checkConsistency'
)
def
_checkConsistency
(
self
,
fixit
=
0
):
def
_checkConsistency
(
self
,
fixit
=
0
):
"""
"""Constraint API.
Constraint API.
"""
"""
# Check useless cells
# Check useless cells
to_delete_set
=
set
()
to_delete_set
=
set
()
...
@@ -607,7 +579,8 @@ class XMLMatrix(Folder):
...
@@ -607,7 +579,8 @@ class XMLMatrix(Folder):
security
.
declareProtected
(
Permissions
.
ModifyPortalContent
,
'notifyAfterUpdateRelatedContent'
)
security
.
declareProtected
(
Permissions
.
ModifyPortalContent
,
'notifyAfterUpdateRelatedContent'
)
def
notifyAfterUpdateRelatedContent
(
self
,
previous_category_url
,
new_category_url
):
def
notifyAfterUpdateRelatedContent
(
self
,
previous_category_url
,
new_category_url
):
"""
"""Hook called when a category is renamed.
We must do some matrix range update in the event matrix range
We must do some matrix range update in the event matrix range
is defined by a category
is defined by a category
"""
"""
...
@@ -625,8 +598,7 @@ class XMLMatrix(Folder):
...
@@ -625,8 +598,7 @@ class XMLMatrix(Folder):
self
.
_renameCellRange
(
*
new_cell_range
,
**
kwd
)
self
.
_renameCellRange
(
*
new_cell_range
,
**
kwd
)
class
TempXMLMatrix
(
XMLMatrix
):
class
TempXMLMatrix
(
XMLMatrix
):
"""
"""Temporary XMLMatrix.
Temporary XMLMatrix.
If we need Base services (categories, edit, etc) in temporary objects
If we need Base services (categories, edit, etc) in temporary objects
we shoud used TempBase
we shoud used TempBase
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment