Docs for IS_IN_SET

[ Python Tutorial ] [ Python Libraries ] [ web2py epydoc ]

Description

<type 'type'> extends (<class 'gluon.validators.Validator'>,)


    Example:
        Used as::

            INPUT(_type='text', _name='name',
                  requires=IS_IN_SET(['max', 'john'],zero=''))

    The argument of IS_IN_SET must be a list or set::

        >>> IS_IN_SET(['max', 'john'])('max')
        ('max', None)
        >>> IS_IN_SET(['max', 'john'])('massimo')
        ('massimo', 'value not allowed')
        >>> IS_IN_SET(['max', 'john'], multiple=True)(('max', 'john'))
        (('max', 'john'), None)
        >>> IS_IN_SET(['max', 'john'], multiple=True)(('bill', 'john'))
        (('bill', 'john'), 'value not allowed')
        >>> IS_IN_SET(('id1','id2'), ['first label','second label'])('id1') # Traditional way
        ('id1', None)
        >>> IS_IN_SET({'id1':'first label', 'id2':'second label'})('id1')
        ('id1', None)
        >>> import itertools
        >>> IS_IN_SET(itertools.chain(['1','3','5'],['2','4','6']))('1')
        ('1', None)
        >>> IS_IN_SET([('id1','first label'), ('id2','second label')])('id1') # Redundant way
        ('id1', None)

Attributes


IS_IN_SET.__call__	<type 'instancemethod'> belongs to class <type 'instancemethod'>

IS_IN_SET.__class__	<type 'type'> extends (<type 'object'>,) belongs to class <type 'type'> type(object) -> the object's type type(name, bases, dict) -> a new type

IS_IN_SET.__delattr__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__delattr__('name') <==> del x.name

IS_IN_SET.__dict__	<type 'dictproxy'> belongs to class <type 'dictproxy'>

IS_IN_SET.__doc__	<type 'str'> belongs to class <type 'str'> str(object='') -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.

IS_IN_SET.__format__	<type 'method_descriptor'> belongs to class <type 'method_descriptor'> default object formatter

IS_IN_SET.__getattribute__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__getattribute__('name') <==> x.name

IS_IN_SET.__hash__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__hash__() <==> hash(x)

IS_IN_SET.__init__	<type 'instancemethod'> belongs to class <type 'instancemethod'>

IS_IN_SET.__module__	<type 'str'> belongs to class <type 'str'> str(object='') -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.

IS_IN_SET.__new__	<type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'> T.__new__(S, ...) -> a new object with type S, a subtype of T

IS_IN_SET.__reduce__	<type 'method_descriptor'> belongs to class <type 'method_descriptor'> helper for pickle

IS_IN_SET.__reduce_ex__	<type 'method_descriptor'> belongs to class <type 'method_descriptor'> helper for pickle

IS_IN_SET.__repr__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__repr__() <==> repr(x)

IS_IN_SET.__setattr__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__setattr__('name', value) <==> x.name = value

IS_IN_SET.__sizeof__	<type 'method_descriptor'> belongs to class <type 'method_descriptor'> __sizeof__() -> int size of object in memory, in bytes

IS_IN_SET.__str__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__str__() <==> str(x)

IS_IN_SET.__subclasshook__	<type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'> Abstract classes can override this to customize issubclass(). This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

IS_IN_SET.__weakref__	<type 'getset_descriptor'> belongs to class <type 'getset_descriptor'> list of weak references to the object (if defined)

IS_IN_SET.formatter	<type 'instancemethod'> belongs to class <type 'instancemethod'> For some validators returns a formatted version (matching the validator) of value. Otherwise just returns the value.

IS_IN_SET.options	<type 'instancemethod'> belongs to class <type 'instancemethod'>