Operation

class pyvips.voperation.Introspect(operation_name)[source]

Build introspection data for operations.

Make an operation, introspect it, and build a structure representing everything we know about it.

class pyvips.voperation.Operation(pointer)[source]

Call libvips operations.

This class wraps the libvips VipsOperation class.

set(name, flags, match_image, value)[source]

Set a GObject property.

The value is converted to the property type, if possible.

static call(operation_name, *args, **kwargs)[source]

Call a libvips operation.

Use this method to call any libvips operation. For example:

black_image = pyvips.Operation.call('black', 10, 10)

See the Introduction for notes on how this works.

static generate_docstring(operation_name)[source]

Make a google-style docstring.

This is used to generate help() output.

static generate_sphinx(operation_name)[source]

Make a sphinx-style docstring.

This is used to generate the off-line docs.

static generate_sphinx_all()[source]

Generate sphinx documentation.

This generates a .rst file for all auto-generated image methods. Use it to regenerate the docs with something like:

$ python -c "import pyvips; pyvips.Operation.generate_sphinx_all()" > x

And copy-paste the file contents into doc/vimage.rst in the appropriate place.

pyvips.voperation.cache_set_max(mx)[source]

Set the maximum number of operations libvips will cache.

pyvips.voperation.cache_set_max_mem(mx)[source]

Limit the operation cache by memory use.

pyvips.voperation.cache_set_max_files(mx)[source]

Limit the operation cache by number of open files.

pyvips.voperation.cache_set_trace(trace)[source]

Turn on libvips cache tracing.

pyvips.voperation.cache_get_max()[source]

Get the maximum number of operations libvips will cache.

pyvips.voperation.cache_get_max_mem()[source]

Get the operation cache limit by memory use.

pyvips.voperation.cache_get_max_files()[source]

Get the operation cache limit by number of open files.

pyvips.voperation.cache_get_size()[source]

Get the current size of the operations cache.

pyvips.voperation.block_untrusted_set(state)[source]

Set the block state for all untrusted operations.

pyvips.voperation.operation_block_set(name, state)[source]

Set the block state for a named operation.