Handler Reference

The handlers Module

A collection of file handlers.

ciowarehouse.handlers.includeme(configurator)

Function to include CioWarehouse handlers.

Parameters:

configurator (pyramid.config.Configurator) – Object used to do configuration declaration within the application.

The handlers.directory Module

A file handlerxs for directories.

ciowarehouse.handlers.handler_directory.includeme(configurator)

Function to include CioWarehouse a handler.

Parameters:

configurator (pyramid.config.Configurator) – Object used to do configuration declaration within the application.

class ciowarehouse.handlers.handler_directory.HandlerDirectory

Class to manage a directory.

match(extension, filename, content=None, extensions_subset=None)

Check whether this file handler matches with the file filename.

See: handlers.Handler.match()

classmethod thumbnails_obsolete(abs_file, thumb_dir)

Check if thumbnails are obsolete.

See: handlers.Handler.thumbnails_obsolete()

The handlers.directory_cover Module

A file handler for directories with a cover.

ciowarehouse.handlers.handler_directory_cover.includeme(configurator)

Function to include a CioWarehouse handler.

Parameters:

configurator (pyramid.config.Configurator) – Object used to do configuration declaration within the application.

class ciowarehouse.handlers.handler_directory_cover.HandlerDirectoryCover

Class to manage a Cover directory.

classmethod thumbnails_obsolete(abs_file, thumb_dir)

Check if thumbnails are obsolete.

See: ciowarehouse.handlers.Handler.thumbnails_obsolete()

thumbnails(warehouse, abs_file, thumb_dir, request=None, registry=None)

Create the small and large thumbnails representing the file.

See: ciowarehouse.handlers.Handler.thumbnails()

The handlers.handler_image Module

A file handler for images.

ciowarehouse.handlers.handler_image.includeme(configurator)

Function to include CioWarehouse a handler.

Parameters:

configurator (pyramid.config.Configurator) – Object used to do configuration declaration within the application.

class ciowarehouse.handlers.handler_image.HandlerImage

Class to manage an image.

thumbnails(warehouse, abs_file, thumb_dir, request=None, registry=None)

Create the small and large thumbnails representing the file.

See: lib.handler.Handler.thumbnails()

view(request, warehouse, content=None, ts_factory=None)

Return a string containing HTML to display the file.

See: lib.handler.Handler.view()

The handlers.handler_audio Module

A file handler for audios.

ciowarehouse.handlers.handler_audio.includeme(configurator)

Function to include CioWarehouse a handler.

Parameters:

configurator (pyramid.config.Configurator) – Object used to do configuration declaration within the application.

class ciowarehouse.handlers.handler_audio.HandlerAudio

Class to manage an audio.

view(request, warehouse, content=None, ts_factory=None)

Return a string containing HTML to display the file.

See: lib.handler.Handler.view()

The handlers.handler_video Module

A file handler for videos.

ciowarehouse.handlers.handler_video.includeme(configurator)

Function to include CioWarehouse a handler.

Parameters:

configurator (pyramid.config.Configurator) – Object used to do configuration declaration within the application.

class ciowarehouse.handlers.handler_video.HandlerVideo

Class to manage an video.

view(request, warehouse, content=None, ts_factory=None)

Return a string containing HTML to display the file.

See: lib.handler.Handler.view()

The handlers.handler_pdf Module

A file handler for PDF file.

ciowarehouse.handlers.handler_pdf.includeme(configurator)

Function to include CioWarehouse a handler.

Parameters:

configurator (pyramid.config.Configurator) – Object used to do configuration declaration within the application.

class ciowarehouse.handlers.handler_pdf.HandlerPdf

Class to manage a PDF file.

thumbnails(warehouse, abs_file, thumb_dir, request=None, registry=None)

Create the small and large thumbnail representing the file.

See: lib.handler.Handler.thumbnails()

view(request, warehouse, content=None, ts_factory=None)

Return a string containing HTML to display the file.

See: lib.handler.Handler.view()

The handlers.handler_plain Module

A file handler for plain text files.

ciowarehouse.handlers.handler_plain.includeme(configurator)

Function to include CioWarehouse a handler.

Parameters:

configurator (pyramid.config.Configurator) – Object used to do configuration declaration within the application.

class ciowarehouse.handlers.handler_plain.HandlerPlain

Class to manage a plain text file.

infos_complete_fields(warehouse, path, abs_path, whoosh_fields, request=None)

Complete the whoosh_fields dictionary with information found in the metadata file.

See: lib.handler.Handler.infos_complete_fields()

view(request, warehouse, content=None, ts_factory=None)

Return a string containing HTML to display the file.

See: lib.handler.Handler.view()