A mini language for reuse of information
Project description
visaplan.plone.infohubs
This product establishes a “mini language” for the calculation and re-use of information in Plone instances during the processing of a single request, e.g. when creating breadcrumbs; e.g., if the login state is important for the breadcrumb for /foo, that same state might be important for the /foo/bar breadcrumb as well.
It is part of the footing of the “Unitracc family” of Plone sites which are maintained by visaplan GmbH, Bochum, Germany; the mini-language was established during the development of the now factored-out package visaplan.plone.breadcrumbs.
The purpose of this package (for now) is not to provide new functionality but to factor out existing functionality from our former monolithic Zope product. Thus, it is more likely to lose functionality during further development (as parts of it will be forked out into their own packages, or some functionality may even become obsolete because there are better alternatives in standard Plone components).
Features
The info dictionary holds the collected information of interest during processing of the request.
The hub dictionary holds the tools which were used to get those information chunks.
For some named tools, there are abbreviations available (e.g. pc for portal_catalog), mostly for historical reasons.
Examples
This add-on can be seen in action at the following sites:
Documentation
Full documentation for end users can be found in the “docs” folder.
Installation and usage
Add visaplan.plone.infohubs to the requirements of your add-on.
Then, in your own code:
from visaplan.plone.infohubs import make_hubs
...
# in some function or method where you have a meaningful context:
hub, info = make_hubs(self.context)
someval = info['some_known_key']
While getting the information for the given key some_known_key, the used tools will be stored in the hub dictionary, and other information found on the way will be stored in the info dictionary.
Contribute
Issue Tracker: https://github.com/visaplan/visaplan.plone.infohubs/issues
Source Code: https://github.com/visaplan/visaplan.plone.infohubs
Support
If you are having issues, please let us know; please use the issue tracker mentioned above.
License
The project is licensed under the GPLv2.
Contributors
Tobias Herp, tobias.herp@visaplan.com
Changelog
1.2.0 (unreleased)
New Features:
info key my_translation: a proxy to get the appropriate language version for an object given by path or uid
Hard dependencies removed:
Package |
Depending features |
|---|---|
|
|
|
|
visaplan.plone.pdfexport |
|
visaplan.plone.unitracctool |
|
[tobiasherp]
1.1.0 (2020-07-15)
New Features:
info key my_translation: a proxy to get the appropriate language version for an object given by path or uid
[tobiasherp]
1.0.2 (2019-05-09)
convenience function context_tuple, e.g. for methods with optional hub and info arguments
Explicitly raise TypeErrors instead of using assertions (context_and_form_tuple, context_tuple)
New info keys counter and counters
[tobiasherp]
1.0.1 (2019-01-31)
info['my_uid'] uses plone.uuid.interfaces.IUUID directly [tobiasherp]
1.0 (2018-09-17)
Initial release. [tobiasherp]
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file visaplan.plone.infohubs-1.2.0.dev4.tar.gz.
File metadata
- Download URL: visaplan.plone.infohubs-1.2.0.dev4.tar.gz
- Upload date:
- Size: 26.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.19.0 setuptools/41.0.1 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/2.7.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | eccf929ea5bd52991755588104573c102695bd276b59cb08800ed4674bc4c27c |
|
| MD5 | b28e9339df227e2026011d897ec0c8dc |
|
| BLAKE2b-256 | e41aeaeb0191713ae1325ae71d315766182d41dabebd0ba07d88ce46eefab66a |
