rattail/appypod-rattail
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

[gen] While <obj>.<fieldName> allows to get the 'DB' value of some field, <obj>.getValue allows to get a variant of it, ie, the formatted version (via an internal call to field.getFormattedValue).

Browse source
This commit is contained in:
Gaetan Delannay 2014-09-08 15:13:18 +02:00
parent 8aed007623
commit 71bc58a8b0
9 changed files with 67 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
fields/__init__.py
View file

@ -533,12 +533,14 @@ class Field:
return self.default
return value
def getFormattedValue(self, obj, value, showChanges=False):
def getFormattedValue(self, obj, value, showChanges=False, language=None):
'''p_value is a real p_obj(ect) value from a field from this type. This
method returns a pretty, string-formatted version, for displaying
purposes. Needs to be overridden by some child classes. If
p_showChanges is True, the result must also include the changes that
occurred on p_value across the ages.'''
occurred on p_value across the ages. If the formatting implies
translating some elements, p_language will be used if given, the
user language else.'''
if self.isEmptyValue(obj, value): return ''
return value

4
fields/boolean.py
View file

@ -114,8 +114,8 @@ class Boolean(Field):
return '%s_%s' % (self.labelId, self.trueFalse[value])
return self.yesNo[value]
def getFormattedValue(self, obj, value, showChanges=False):
return obj.translate(self.getValueLabel(value))
def getFormattedValue(self, obj, value, showChanges=False, language=None):
return obj.translate(self.getValueLabel(value), language=language)
def getStorableValue(self, obj, value):
if not self.isEmptyValue(obj, value):

2
fields/computed.py
View file

@ -79,7 +79,7 @@ class Computed(Field):
# self.method is a method that will return the field value
return self.callMethod(obj, self.method, cache=False)
def getFormattedValue(self, obj, value, showChanges=False):
def getFormattedValue(self, obj, value, showChanges=False, language=None):
if not isinstance(value, basestring): return str(value)
return value
# ------------------------------------------------------------------------------

2
fields/date.py
View file

@ -206,7 +206,7 @@ class Date(Field):
except DateTime.DateError, ValueError:
return obj.translate('bad_date')
def getFormattedValue(self, obj, value, showChanges=False):
def getFormattedValue(self, obj, value, showChanges=False, language=None):
if self.isEmptyValue(obj, value): return ''
tool = obj.getTool().appy()
# A problem may occur with some extreme year values. Replace the "year"

2
fields/float.py
View file

@ -81,7 +81,7 @@ class Float(Field):
sheight, persist)
self.pythonType = float
def getFormattedValue(self, obj, value, showChanges=False):
def getFormattedValue(self, obj, value, showChanges=False, language=None):
return sutils.formatNumber(value, sep=self.sep[0],
precision=self.precision, tsep=self.tsep)

2
fields/integer.py
View file

@ -71,7 +71,7 @@ class Integer(Field):
def getStorableValue(self, obj, value):
if not self.isEmptyValue(obj, value): return self.pythonType(value)
def getFormattedValue(self, obj, value, showChanges=False):
def getFormattedValue(self, obj, value, showChanges=False, language=None):
if self.isEmptyValue(obj, value): return ''
return str(value)
# ------------------------------------------------------------------------------

2
fields/ref.py
View file

@ -933,7 +933,7 @@ class Ref(Field):
# object to show is in the request.
return int(req.get('%s_startNumber' % ajaxHookId, 0))
def getFormattedValue(self, obj, value, showChanges=False):
def getFormattedValue(self, obj, value, showChanges=False, language=None):
return value
def getIndexType(self): return 'ListIndex'

72
fields/string.py
View file

@ -55,12 +55,16 @@ class Selection:
# internationalized version of "text" if needed.
self.methodName = methodName
def getText(self, obj, value, appyType):
def getText(self, obj, value, field, language=None):
'''Gets the text that corresponds to p_value.'''
for v, text in appyType.getPossibleValues(obj, ignoreMasterValues=True,\
withTranslations=True):
if v == value:
return text
if language:
withTranslations = language
else:
withTranslations = True
vals = field.getPossibleValues(obj, ignoreMasterValues=True,\
withTranslations=withTranslations)
for v, text in vals:
if v == value: return text
return value
# ------------------------------------------------------------------------------
@ -587,7 +591,7 @@ class String(Field):
return comparator.get()
def getUnilingualFormattedValue(self, obj, value, showChanges=False,
language=None):
userLanguage=None, language=None):
'''If no p_language is specified, this method is called by
m_getFormattedValue for getting a non-multilingual value (ie, in
most cases). Else, this method returns a formatted value for the
@ -599,17 +603,20 @@ class String(Field):
# Value(s) come from a dynamic vocabulary
val = self.validator
if self.isMultiValued():
return [val.getText(obj, v, self) for v in value]
return [val.getText(obj, v, self, language=userLanguage) \
for v in value]
else:
return val.getText(obj, value, self)
return val.getText(obj, value, self, language=userLanguage)
else:
# Value(s) come from a fixed vocabulary whose texts are in
# i18n files.
t = obj.translate
_ = obj.translate
if self.isMultiValued():
res = [t('%s_list_%s' % (self.labelId, v)) for v in value]
res = [_('%s_list_%s' % (self.labelId, v), \
language=userLanguage) for v in value]
else:
res = t('%s_list_%s' % (self.labelId, value))
res = _('%s_list_%s' % (self.labelId, value), \
language=userLanguage)
elif (self.format == String.XHTML) and showChanges:
# Compute the successive changes that occurred on p_value.
res = self.getDiffValue(obj, res, language)
@ -619,32 +626,39 @@ class String(Field):
(res.startswith('\n') or res.startswith('\r\n')): res = ' ' + res
return res
def getFormattedValue(self, obj, value, showChanges=False):
def getFormattedValue(self, obj, value, showChanges=False, language=None):
'''Be careful: p_language represents the UI language, while "languages"
below represents the content language(s) of this field. p_language
can be used, ie, to translate a Selection value.'''
languages = self.getAttribute(obj, 'languages')
if len(languages) == 1:
return self.getUnilingualFormattedValue(obj, value, showChanges)
return self.getUnilingualFormattedValue(obj, value, showChanges,
userLanguage=language)
# Return the dict of values whose individual, language-specific values
# have been formatted via m_getUnilingualFormattedValue.
if not value: return value
res = {}
for lg in languages:
res[lg] = self.getUnilingualFormattedValue(obj, value[lg],
showChanges, lg)
showChanges, language=lg)
return res
def getShownValue(self, obj, value, showChanges=False):
'''For a multilingual field, this method only shows one specific
language part.'''
def getShownValue(self, obj, value, showChanges=False, language=None):
'''Be careful: p_language represents the UI language, while "languages"
below represents the content language(s) of this field. For a
multilingual field, this method only shows one specific language
part.'''
languages = self.getAttribute(obj, 'languages')
if len(languages) == 1:
return self.getUnilingualFormattedValue(obj, value, showChanges)
return self.getUnilingualFormattedValue(obj, value, showChanges,
userLanguage=language)
if not value: return value
# Try to propose the part that is in the user language, or the part of
# the first content language else.
language = obj.getUserLanguage()
if language not in value: language = languages[0]
return self.getUnilingualFormattedValue(obj, value[language],
showChanges, language)
lg = obj.getUserLanguage()
if lg not in value: lg = languages[0]
return self.getUnilingualFormattedValue(obj, value[lg], showChanges,
language=lg)
def extractText(self, value):
'''Extracts pure text from XHTML p_value.'''
@ -684,11 +698,15 @@ class String(Field):
'''Returns the list of possible values for this field (only for fields
with self.isSelect=True). If p_withTranslations is True, instead of
returning a list of string values, the result is a list of tuples
(s_value, s_translation). If p_withBlankValue is True, a blank value
is prepended to the list, excepted if the type is multivalued. If
(s_value, s_translation). Moreover, p_withTranslations can hold a
given language: in this case, this language is used instead of the
user language. If p_withBlankValue is True, a blank value is
prepended to the list, excepted if the type is multivalued. If
p_className is given, p_obj is the tool and, if we need an instance
of p_className, we will need to use obj.executeQuery to find one.'''
if not self.isSelect: raise Exception('This field is not a selection.')
# Get the user language for translations, from "withTranslations".
lg = isinstance(withTranslations, str) and withTranslations or None
req = obj.REQUEST
if ('masterValues' in req) and not ignoreMasterValues:
# Get possible values from self.masterValue
@ -699,7 +717,7 @@ class String(Field):
else:
res = []
for v in values:
res.append( (v, self.getFormattedValue(obj, v)) )
res.append( (v, self.getFormattedValue(obj,v,language=lg)) )
else:
# If this field is an ajax-updatable slave, no need to compute
# possible values: it will be overridden by method self.masterValue
@ -750,13 +768,13 @@ class String(Field):
for value in self.validator:
label = '%s_list_%s' % (self.labelId, value)
if withTranslations:
res.append( (value, obj.translate(label)) )
res.append( (value, obj.translate(label, language=lg)) )
else:
res.append(value)
if withBlankValue and not self.isMultiValued():
# Create the blank value to insert at the beginning of the list
if withTranslations:
blankValue = ('', obj.translate('choose_a_value'))
blankValue = ('', obj.translate('choose_a_value', language=lg))
else:
blankValue = ''
# Insert the blank value in the result

11
gen/wrappers/__init__.py
View file

@ -774,6 +774,17 @@ class AbstractWrapper(object):
if custom: return custom(self, *args, **kwargs)
def getField(self, name): return self.o.getAppyType(name)
def getValue(self, name, formatted=False, language=None):
'''Gets the formatted value of field p_name. If this formatting implies
translating some element, translate them in p_langue, or in the user
language if not specified.'''
field = self.o.getAppyType(name)
obj = self.o
val = field.getValue(obj)
if not formatted: return val
return field.getFormattedValue(obj, val, language=language)
def getLabel(self, name, type='field'):
'''Gets the translated label of field named p_name. If p_type is
"workflow", p_name denotes a workflow state or transition, not a