kotti.interfaces

interface kotti.interfaces.INode[source]

Marker interface for all nodes (and subclasses)

interface kotti.interfaces.IContent[source]

Extends: kotti.interfaces.INode

Marker interface for all nodes of type Content (and subclasses thereof)

interface kotti.interfaces.IDocument[source]

Extends: kotti.interfaces.IContent

Marker interface for all nodes of type Document (and subclasses thereof)

interface kotti.interfaces.IFile[source]

Extends: kotti.interfaces.IContent

Marker interface for all nodes of type File (and subclasses thereof)

interface kotti.interfaces.IImage[source]

Extends: kotti.interfaces.IFile

Marker interface for all nodes of type Image (and subclasses thereof)

interface kotti.interfaces.IDefaultWorkflow[source]

Marker interface for content classes that want to use the default workflow

interface kotti.interfaces.INavigationRoot[source]

Marker interface for content nodes / classes that want to be the root for the navigation.

Considering a content tree like this:

- /a
  - /a/a
  - /a/b (provides INavigationRoot)
    - /a/b/a
    - /a/b/b
    - /a/b/c
  - a/c

The root item for the navigation will be ``/a/b`` for everey context in
or below ``/a/b`` and ``/a`` for every other item.
interface kotti.interfaces.IBlobStorage[source]

This is the minimal interface that needs to be implemented by file storage providers.

The provider lookup is performed by a “dotted name lookup” from the protocol part of the URL in the kotti.filestorage option. The provider will be passed the complete URL upon initialization. This can be used by implementations for their configuration

For example:

kotti.filestorage = kotti_filestore.filestore:///var/files

will cause kotti_filestore.filestore to be instanciated with kotti_filestore.filestore:///var/files being passed as the URL upon initialization.

Because this option is parsed as an URL, your class name must be all lower case (scheme part of URLs is not case sensitive).

See the kotti_filestore package’s documentation for an example.

__init__(url)[source]

The constructor is passed an already parsed URL containing the desired configuration options (see above).

Parameters:url (yurl.URL) – URL from the PasteDeploy config file
read(id)[source]

Get the data for an object with the given ID.

Parameters:id (unicode) – ID of the file object
Result:Data / value of the file object
Return type:bytes
write(data)[source]

Create an object with the given data as its contents. Delete all previous contents that might already have existed.

Parameters:data (unicode) – Data / value to store
Result:ID of the data bucket that can be used for future calls to read
Return type:bytes
delete(id)[source]

Delete the object with the given ID.

Parameters:id (unicode) – ID of the file object
Result:Success
Return type:bool