Docs for IS_UPLOAD_FILENAME

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

Description

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


    Checks if name and extension of file uploaded through file input matches
    given criteria.

    Does *not* ensure the file type in any way. Returns validation failure
    if no data was uploaded.

    Args:
        filename: filename (before dot) regex
        extension: extension (after dot) regex
        lastdot: which dot should be used as a filename / extension separator:
            True means last dot, eg. file.png -> file / png
            False means first dot, eg. file.tar.gz -> file / tar.gz
        case: 0 - keep the case, 1 - transform the string into lowercase (default),
            2 - transform the string into uppercase

    If there is no dot present, extension checks will be done against empty
    string and filename checks against whole value.

    Examples:
        Check if file has a pdf extension (case insensitive):

        INPUT(_type='file', _name='name',
                requires=IS_UPLOAD_FILENAME(extension='pdf'))

        Check if file has a tar.gz extension and name starting with backup:

        INPUT(_type='file', _name='name',
                requires=IS_UPLOAD_FILENAME(filename='backup.*',
                extension='tar.gz', lastdot=False))

        Check if file has no extension and name matching README
        (case sensitive):

            INPUT(_type='file', _name='name',
                requires=IS_UPLOAD_FILENAME(filename='^README$',
                extension='^$', case=0)

Attributes


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

IS_UPLOAD_FILENAME.__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_UPLOAD_FILENAME.__delattr__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__delattr__('name') <==> del x.name

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

IS_UPLOAD_FILENAME.__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_UPLOAD_FILENAME.__format__	<type 'method_descriptor'> belongs to class <type 'method_descriptor'> default object formatter

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

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

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

IS_UPLOAD_FILENAME.__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_UPLOAD_FILENAME.__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_UPLOAD_FILENAME.__reduce__	<type 'method_descriptor'> belongs to class <type 'method_descriptor'> helper for pickle

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

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

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

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

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

IS_UPLOAD_FILENAME.__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_UPLOAD_FILENAME.__weakref__	<type 'getset_descriptor'> belongs to class <type 'getset_descriptor'> list of weak references to the object (if defined)

IS_UPLOAD_FILENAME.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.