Back to index

moin  1.9.0~rc2
Public Member Functions
MoinMoin.support.werkzeug.datastructures.TypeConversionDict Class Reference
Inheritance diagram for MoinMoin.support.werkzeug.datastructures.TypeConversionDict:
Inheritance graph
[legend]

List of all members.

Public Member Functions

def get

Detailed Description

Works like a regular dict but the :meth:`get` method can perform
type conversions.  :class:`MultiDict` and :class:`CombinedMultiDict`
are subclasses of this class and provide the same feature.

.. versionadded:: 0.5

Definition at line 154 of file datastructures.py.


Member Function Documentation

def MoinMoin.support.werkzeug.datastructures.TypeConversionDict.get (   self,
  key,
  default = None,
  type = None 
)
Return the default value if the requested data doesn't exist.
If `type` is provided and is a callable it should convert the value,
return it or raise a :exc:`ValueError` if that is not possible.  In
this case the function will return the default as if the value was not
found:

>>> d = TypeConversionDict(foo='42', bar='blub')
>>> d.get('foo', type=int)
42
>>> d.get('bar', -1, type=int)
-1

:param key: The key to be looked up.
:param default: The default value to be returned if the key can't
        be looked up.  If not further specified `None` is
        returned.
:param type: A callable that is used to cast the value in the
     :class:`MultiDict`.  If a :exc:`ValueError` is raised
     by this callable the default value is returned.

Reimplemented in MoinMoin.support.werkzeug.datastructures.CombinedMultiDict.

Definition at line 162 of file datastructures.py.

00162 
00163     def get(self, key, default=None, type=None):
00164         """Return the default value if the requested data doesn't exist.
00165         If `type` is provided and is a callable it should convert the value,
00166         return it or raise a :exc:`ValueError` if that is not possible.  In
00167         this case the function will return the default as if the value was not
00168         found:
00169 
00170         >>> d = TypeConversionDict(foo='42', bar='blub')
00171         >>> d.get('foo', type=int)
00172         42
00173         >>> d.get('bar', -1, type=int)
00174         -1
00175 
00176         :param key: The key to be looked up.
00177         :param default: The default value to be returned if the key can't
00178                         be looked up.  If not further specified `None` is
00179                         returned.
00180         :param type: A callable that is used to cast the value in the
00181                      :class:`MultiDict`.  If a :exc:`ValueError` is raised
00182                      by this callable the default value is returned.
00183         """
00184         try:
00185             rv = self[key]
00186             if type is not None:
00187                 rv = type(rv)
00188         except (KeyError, ValueError):
00189             rv = default
00190         return rv
00191 

Here is the caller graph for this function:


The documentation for this class was generated from the following file: