Handler Reference

The handlers Module

A collection of file handlers.

ciowarehouse2.handlers.includeme(configurator)[source]

Function to include CioWarehouse2 handlers.

Parameters:

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

The handlers.directory Module

A file handlerxs for directories.

ciowarehouse2.handlers.directory.includeme(configurator: Configurator)[source]

Function to include directory handler.

Parameters:

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

class ciowarehouse2.handlers.directory.HandlerDirectory[source]

Class to manage a directory.

The handlers.text Module

A file handler for text files.

ciowarehouse2.handlers.text.includeme(configurator: Configurator)[source]

Function to include a text handler.

Parameters:

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

class ciowarehouse2.handlers.text.HandlerText[source]

Class to manage a text file.

view(request: Request, warehouse: Warehouse, ciopath: CioPath, ts_factory=None) str | None[source]

Return a string containing HTML to display the file.

See: lib.handler.Handler.view()

The handlers.code Module

A file handler for files of code (language, regex…).

ciowarehouse2.handlers.code.includeme(configurator: Configurator)[source]

Function to include a code handler.

Parameters:

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

class ciowarehouse2.handlers.code.HandlerCode[source]

Class to manage a code file.

view(request: Request, warehouse: Warehouse, ciopath: CioPath, ts_factory=None) str | None[source]

Return a string containing HTML to display the file.

See: lib.handler.Handler.view()

The handlers.config Module

A file handler for config files.

ciowarehouse2.handlers.config.includeme(configurator: Configurator)[source]

Function to include a configuration handler.

Parameters:

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

class ciowarehouse2.handlers.config.HandlerConfig[source]

Class to manage a config config file.

view(request: Request, warehouse: Warehouse, ciopath: CioPath, ts_factory=None) str | None[source]

Return a string containing HTML to display the file.

See: lib.handler.Handler.view()

The handlers.image Module

A file handler for Web images.

ciowarehouse2.handlers.image.includeme(configurator: Configurator)[source]

Function to include an image handler.

Parameters:

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

class ciowarehouse2.handlers.image.HandlerImage[source]

Class to manage an Web image.

match(ciotype: CioType) bool[source]

Check whether this file handler matches with the CioType.

See: lib.handler.Handler.match()

view(request: Request, warehouse: Warehouse, ciopath: CioPath, ts_factory=None) str | None[source]

Return a string containing HTML to display the file.

See: lib.handler.Handler.view()

The handlers.audio Module

A file handler for audios.

ciowarehouse2.handlers.audio.includeme(configurator: Configurator)[source]

Function to include an audio handler.

Parameters:

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

class ciowarehouse2.handlers.audio.HandlerAudio[source]

Class to manage an audio.

match(ciotype: CioType) bool[source]

Check whether this file handler matches with the CioType.

See: lib.handler.Handler.match()

view(request: Request, warehouse: Warehouse, ciopath: CioPath, ts_factory=None) str | None[source]

Return a string containing HTML to display the file.

See: lib.handler.Handler.view()

The handlers.video Module

A file handler for videos.

ciowarehouse2.handlers.video.includeme(configurator: Configurator)[source]

Function to include a video handler.

Parameters:

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

class ciowarehouse2.handlers.video.HandlerVideo[source]

Class to manage an video.

match(ciotype: CioType) bool[source]

Check whether this file handler matches with the CioType.

See: lib.handler.Handler.match()

view(request: Request, warehouse: Warehouse, ciopath: CioPath, ts_factory=None) str | None[source]

Return a string containing HTML to display the file.

See: lib.handler.Handler.view()

The handlers.pdf Module

A file handler for PDF file.

ciowarehouse2.handlers.pdf.includeme(configurator: Configurator)[source]

Function to include a PDF handler.

Parameters:

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

class ciowarehouse2.handlers.pdf.HandlerPdf[source]

Class to manage a PDF file.

view(request: Request, warehouse: Warehouse, ciopath: CioPath, ts_factory=None) str | None[source]

Return a string containing HTML to display the file.

See: lib.handler.Handler.view()