Helper functions to assist in formatting data when rendering object data.
Render booleans using HTML rather than plain text for the Flask-Admin system using bootstrap markup.
Example
>>> from flask.ext.velox.formatters import bool_admin_formatter
>>> bool_admin_formatter(True)
'<i class="icon-ok"></i>'
>>> bool_admin_formatter(False)
'<i class="icon-remove"></i>'
Parameters: | value (bool) – The value to evaluate against |
---|---|
Returns: | The html value to use |
Return type: | str |
For rendering True / False values in a human friendly way, by default True = Yes and False = No however this can be overriden by passing true and false keyword args with their respective values.
Example
>>> from flask.ext.velox.formatters import bool_formatter
>>> bool_formatter(True)
'Yes'
>>> bool_formatter(False)
'No'
Parameters: |
|
---|---|
Returns: | The value to use |
Return type: | str |
Render a sane date time value, for example: dd/mm/yyyy at HH:MM TZ. All values should be UTC.
Example
>>> import datetime
>>> from flask.ext.velox.formatters import datetime_formatter
>>> now = datetime.datetime.utcnow()
>>> datetime_formatter(now)
'11/04/2014 at 10:49AM UTC'
Parameters: | value (datetime) – Datetime object to format |
---|---|
Returns: | Formatted date time |
Return type: | str |