Skip to main content

Add btrees in annotations

Project description

Documentation

Target audience

This is a package for integrators.

Installation and goal

Add collective.btrees to the eggs in your buildout. Add it to the zcml too, if you are on Plone 3.2 or lower. No need for further installation in the Plone UI.

This makes some small adapters available to store btrees in annotations on an object. There are adapters for all the btrees in the BTrees module. The adapters make the public methods of btrees available in the adapter. Use this when you want this and when you understand what this means. :-)

Example usage

Usually you will want to create an own adapter to override some settings, at least the key used to store the annotations. Put this in an adapters.py:

from zope.interface import implements
from zope.interface import Interface
from collective.btrees.interfaces import IOOBTreeContainer
from collective.btrees.adapters import OOBTreeContainer

class IFormValuesContainer(IOOBTreeContainer):
    pass

class FormValuesContainer(OOBTreeContainer):

    implements(IFormValuesContainer)
    ANNO_KEY = 'my.package.formvalues'

    def _check_key(self, key):
        if not isinstance(key, basestring):
            raise TypeError("base string expected as key")

    def _check_value(self, value):
        if not isinstance(value, dict):
            raise TypeError("dictionary expected as value")

Register the adapter in zcml:

<adapter
    for="zope.interface.Interface"
    provides=".adapters.IFormValuesContainer"
    factory=".adapters.FormValuesContainer"
    />

Use it within for example a browser view to store the request form dictionary in the btree (if this for some reason makes sense for your website):

container = IFormValuesContainer(self.context)
key = 'my key'  # maybe use the user id as key
value = self.request.form
container.insert(key, value)
container.get(key)  # will return value

Compatibility

I have tried this on Plone 3.3 and 4.1. It will likely work on other versions as well.

Authors

Maurits van Rees

Changelog

1.1 (2012-06-05)

  • Changed setup.py url to point to the github collective. [maurits]

1.0 (2012-05-16)

  • Initial release [maurits]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

collective.btrees-1.1.zip (15.1 kB view details)

Uploaded Source

File details

Details for the file collective.btrees-1.1.zip.

File metadata

File hashes

Hashes for collective.btrees-1.1.zip
Algorithm Hash digest
SHA256 50f6c47cd6e08aba473f6f52ddbb1cecfd00af021beec6c73e7fdf0ac647fd33
MD5 f26a1fb2adb9012898cdbf0e7de0eeae
BLAKE2b-256 65645083b6469626b55188e6eebb4250c47278f71db4911e76a9ddcd580cc99c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page