Docs for IS_IMAGE

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

Description


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





































Checks if file uploaded through file input was saved in one of selected
image formats and has dimensions (width and height) within given boundaries.

Does *not* check for maximum file size (use IS_LENGTH for that). Returns
validation failure if no data was uploaded.

Supported file formats: BMP, GIF, JPEG, PNG.

Code parts taken from
http://mail.python.org/pipermail/python-list/2007-June/617126.html

Args:
extensions: iterable containing allowed *lowercase* image file extensions
('jpg' extension of uploaded file counts as 'jpeg')
maxsize: iterable containing maximum width and height of the image
minsize: iterable containing minimum width and height of the image

Use (-1, -1) as minsize to pass image size check.

Examples:
Check if uploaded file is in any of supported image formats:

INPUT(_type='file', _name='name', requires=IS_IMAGE())

Check if uploaded file is either JPEG or PNG:

INPUT(_type='file', _name='name',
requires=IS_IMAGE(extensions=('jpeg', 'png')))

Check if uploaded file is PNG with maximum size of 200x200 pixels:

INPUT(_type='file', _name='name',
requires=IS_IMAGE(extensions=('png'), maxsize=(200, 200)))


Attributes


IS_IMAGE._IS_IMAGE__bmp <type 'instancemethod'> belongs to class <type 'instancemethod'>

IS_IMAGE._IS_IMAGE__gif <type 'instancemethod'> belongs to class <type 'instancemethod'>

IS_IMAGE._IS_IMAGE__jpeg <type 'instancemethod'> belongs to class <type 'instancemethod'>

IS_IMAGE._IS_IMAGE__png <type 'instancemethod'> belongs to class <type 'instancemethod'>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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