| Name | plone.app.uuid JSON |
| Version |
2.2.3
JSON |
| download |
| home_page | http://plone.org |
| Summary | Plone integration for the basic plone.uuid package |
| upload_time | 2024-01-19 09:30:47 |
| maintainer | |
| docs_url | None |
| author | Martin Aspeli |
| requires_python | >=3.8 |
| license | GPL |
| keywords |
plone
uuid
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Introduction
============
This package integrates the low-level `plone.uuid`_ into Plone-the-
application. In particular, it:
* Registers a ``portal_catalog`` indexer for the ``UID`` index that allows an
object's UUID to be indexed.
This name is intentionally chosen to be the same as the Archetypes UID()
attribute, which is already indexed by Plone. The effect is that the UID
catalog attribute/metadata is now generalised to all content that supports the
``plone.uuid`` protocol.
As of version 1.7, ``Products.Archetypes`` depends on ``plone.uuid`` and
implements an ``IUUID`` adapter suitable for Archetypes content. It also
uses the ``plone.uuid`` ``IUUIDGenerator`` utility to generate UUIDs for
(new) content, although note that UUIDs generated by the pre-1.7 UUID
algorithm, whilst different, cannot collide with the UUIDs generated by
the default ``IUUIDGenerator`` implementation.
It follows that the `plone.uuid`_ ``IUUID`` adapter and ``@@uuid`` view are
now the preferred, generalised way to look up a UUID for an object.
* Registers a utility view, ``@@redirect-to-uuid``. You can use this with
a URL like::
http://example.org/some/path/@@redirect-to-uuid/b2dc6f7a-9d17-11df-8788-58b035f3cfa0
This will then redirect to the object identified by that URL.
*Hint:* You can use the ``@@uuid`` view from `plone.uuid`_ to render a
UUID. In TAL, you can do something like::
<a tal:attributes="href string:${portal_url}/@@redirect-to-uuid/${obj/@@uuid}">Click here</a>
* Provides several utility methods in the ``plone.app.uuid.utils`` module:
``uuidToPhysicalPath(uuid)``
Returns the physical path (relative to the ZODB root) as a string of the
object with the given UUID, or None if it cannot be found.
``uuidToURL(uuid)``
Returns the absolute URL of the object with the given UUID, or None if it
cannot be found.
``uuidToObject(uuid)``
Returns the content object associated with the given UUID, or None if it
cannot be found.
Please see the `plone.uuid`_ package for more details about how UUIDs are
generated and can be accessed.
.. _plone.uuid: http://pypi.python.org/pypi/plone.uuid
Changelog
=========
.. You should *NOT* be adding new change log entries to this file.
You should create a file in the news directory instead.
For helpful instructions, please see:
https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst
.. towncrier release notes start
2.2.3 (2024-01-19)
------------------
Internal:
- Update configuration files.
[plone devs] (7723aeaf)
2.2.2 (2023-03-22)
------------------
Internal:
- Update configuration files.
[plone devs] (b2d5d4a5)
2.2.1 (2022-10-11)
------------------
Bug fixes:
- Process the catalog queue before looking up in the catalog
[ale-rt] (#15)
2.2.0 (2022-08-30)
------------------
Bug fixes:
- Add optional security check for uuidToObject [anirudhhkashyap] (#13)
2.1.0 (2021-12-29)
------------------
New features:
- Speed up ``uuidToPhysicalPath`` and ``uuidToObject``.
Do this by using an IndexQuery to only query the UID index.
Note: of the four functions in ``utils.py``, only ``uuidToObject`` checks the security.
For the other functions, it is up to the caller to do this, if needed.
We may change this in the future, but for now the behavior should be the same as in previous versions.
[maurits] (#11)
2.0.2 (2020-04-20)
------------------
Bug fixes:
- Minor packaging updates. (#1)
2.0.1 (2020-03-13)
------------------
Bug fixes:
- Fix use case where UID to object is failing.
[rodfersou] (#8)
- Initialize towncrier.
[gforcada] (#2548)
2.0.0 (2018-11-02)
------------------
Breaking changes:
- Fix test that fails since it raises zExceptions.NotFound instead of zope.publisher.interfaces.NotFound.
(This makes the tests incompatible with Zope 2.13.)
[pbauer]
Bug fixes:
- Fix deprecation warning on zope.site.hooks import.
[pbauer]
1.2 (2017-07-03)
----------------
New features:
- Remove unittest2 dependency
[kakshay21]
1.1.3 (2017-02-12)
------------------
Bug fixes:
- Fix test in Zope 4.
[davisagli]
1.1.2 (2016-11-17)
------------------
Bug fixes:
- Update code to follow Plone styleguide.
[gforcada]
1.1.1 (2016-08-10)
------------------
Fixes:
- Use zope.interface decorator.
[gforcada]
1.1 (2014-02-19)
----------------
- Make the test setup independent from basic content types in the
PLONE_FIXTURE.
[timo]
1.0 - 2011-05-13
-----------------
- Release 1.0 Final.
[esteele]
- Add MANIFEST.in.
[WouterVH]
1.0b2 - 2011-01-03
------------------
- Use user id instead of user name to fix tests.
[davisagli]
1.0b1 - 2010-11-27
------------------
- Initial release
Raw data
{
"_id": null,
"home_page": "http://plone.org",
"name": "plone.app.uuid",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "plone uuid",
"author": "Martin Aspeli",
"author_email": "optilude@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/3f/3b/82b98dbab18969005bdb5575dca11919951eefe84309567145fba3b8ccb8/plone.app.uuid-2.2.3.tar.gz",
"platform": null,
"description": "Introduction\n============\n\nThis package integrates the low-level `plone.uuid`_ into Plone-the-\napplication. In particular, it:\n\n* Registers a ``portal_catalog`` indexer for the ``UID`` index that allows an\n object's UUID to be indexed.\n\n This name is intentionally chosen to be the same as the Archetypes UID()\n attribute, which is already indexed by Plone. The effect is that the UID\n catalog attribute/metadata is now generalised to all content that supports the\n ``plone.uuid`` protocol.\n\n As of version 1.7, ``Products.Archetypes`` depends on ``plone.uuid`` and\n implements an ``IUUID`` adapter suitable for Archetypes content. It also\n uses the ``plone.uuid`` ``IUUIDGenerator`` utility to generate UUIDs for\n (new) content, although note that UUIDs generated by the pre-1.7 UUID\n algorithm, whilst different, cannot collide with the UUIDs generated by\n the default ``IUUIDGenerator`` implementation.\n\n It follows that the `plone.uuid`_ ``IUUID`` adapter and ``@@uuid`` view are\n now the preferred, generalised way to look up a UUID for an object.\n* Registers a utility view, ``@@redirect-to-uuid``. You can use this with\n a URL like::\n\n http://example.org/some/path/@@redirect-to-uuid/b2dc6f7a-9d17-11df-8788-58b035f3cfa0\n\n This will then redirect to the object identified by that URL.\n\n *Hint:* You can use the ``@@uuid`` view from `plone.uuid`_ to render a\n UUID. In TAL, you can do something like::\n\n <a tal:attributes=\"href string:${portal_url}/@@redirect-to-uuid/${obj/@@uuid}\">Click here</a>\n* Provides several utility methods in the ``plone.app.uuid.utils`` module:\n\n ``uuidToPhysicalPath(uuid)``\n Returns the physical path (relative to the ZODB root) as a string of the\n object with the given UUID, or None if it cannot be found.\n\n ``uuidToURL(uuid)``\n Returns the absolute URL of the object with the given UUID, or None if it\n cannot be found.\n\n ``uuidToObject(uuid)``\n Returns the content object associated with the given UUID, or None if it\n cannot be found.\n\nPlease see the `plone.uuid`_ package for more details about how UUIDs are\ngenerated and can be accessed.\n\n.. _plone.uuid: http://pypi.python.org/pypi/plone.uuid\n\nChangelog\n=========\n\n.. You should *NOT* be adding new change log entries to this file.\n You should create a file in the news directory instead.\n For helpful instructions, please see:\n https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst\n\n.. towncrier release notes start\n\n2.2.3 (2024-01-19)\n------------------\n\nInternal:\n\n\n- Update configuration files.\n [plone devs] (7723aeaf)\n\n\n2.2.2 (2023-03-22)\n------------------\n\nInternal:\n\n\n- Update configuration files.\n [plone devs] (b2d5d4a5)\n\n\n2.2.1 (2022-10-11)\n------------------\n\nBug fixes:\n\n\n- Process the catalog queue before looking up in the catalog\n [ale-rt] (#15)\n\n\n2.2.0 (2022-08-30)\n------------------\n\nBug fixes:\n\n\n- Add optional security check for uuidToObject [anirudhhkashyap] (#13)\n\n\n2.1.0 (2021-12-29)\n------------------\n\nNew features:\n\n\n- Speed up ``uuidToPhysicalPath`` and ``uuidToObject``.\n Do this by using an IndexQuery to only query the UID index.\n Note: of the four functions in ``utils.py``, only ``uuidToObject`` checks the security.\n For the other functions, it is up to the caller to do this, if needed.\n We may change this in the future, but for now the behavior should be the same as in previous versions.\n [maurits] (#11)\n\n\n2.0.2 (2020-04-20)\n------------------\n\nBug fixes:\n\n\n- Minor packaging updates. (#1)\n\n\n2.0.1 (2020-03-13)\n------------------\n\nBug fixes:\n\n\n- Fix use case where UID to object is failing.\n [rodfersou] (#8)\n- Initialize towncrier.\n [gforcada] (#2548)\n\n\n2.0.0 (2018-11-02)\n------------------\n\nBreaking changes:\n\n- Fix test that fails since it raises zExceptions.NotFound instead of zope.publisher.interfaces.NotFound.\n (This makes the tests incompatible with Zope 2.13.)\n [pbauer]\n\nBug fixes:\n\n- Fix deprecation warning on zope.site.hooks import.\n [pbauer]\n\n\n1.2 (2017-07-03)\n----------------\n\nNew features:\n\n- Remove unittest2 dependency\n [kakshay21]\n\n\n1.1.3 (2017-02-12)\n------------------\n\nBug fixes:\n\n- Fix test in Zope 4.\n [davisagli]\n\n\n1.1.2 (2016-11-17)\n------------------\n\nBug fixes:\n\n- Update code to follow Plone styleguide.\n [gforcada]\n\n\n1.1.1 (2016-08-10)\n------------------\n\nFixes:\n\n- Use zope.interface decorator.\n [gforcada]\n\n\n1.1 (2014-02-19)\n----------------\n\n- Make the test setup independent from basic content types in the\n PLONE_FIXTURE.\n [timo]\n\n\n1.0 - 2011-05-13\n-----------------\n- Release 1.0 Final.\n [esteele]\n\n- Add MANIFEST.in.\n [WouterVH]\n\n\n1.0b2 - 2011-01-03\n------------------\n- Use user id instead of user name to fix tests.\n [davisagli]\n\n\n1.0b1 - 2010-11-27\n------------------\n\n- Initial release\n",
"bugtrack_url": null,
"license": "GPL",
"summary": "Plone integration for the basic plone.uuid package",
"version": "2.2.3",
"project_urls": {
"Homepage": "http://plone.org"
},
"split_keywords": [
"plone",
"uuid"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ad372a92787942b3d3ef59626d318beb95d961940c2c60758323c80bf955258a",
"md5": "87af59e99e5dc708cb43aaea3ed4ee8f",
"sha256": "cc69b7a0ff8e0f5d02ab22c48b08b145716d92dbeb862f8c4d2cc6a5f3090ec7"
},
"downloads": -1,
"filename": "plone.app.uuid-2.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "87af59e99e5dc708cb43aaea3ed4ee8f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10067,
"upload_time": "2024-01-19T09:30:45",
"upload_time_iso_8601": "2024-01-19T09:30:45.597247Z",
"url": "https://files.pythonhosted.org/packages/ad/37/2a92787942b3d3ef59626d318beb95d961940c2c60758323c80bf955258a/plone.app.uuid-2.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3f3b82b98dbab18969005bdb5575dca11919951eefe84309567145fba3b8ccb8",
"md5": "d2fa3cfc661a789e46161628a7974218",
"sha256": "063008306fe4d94f68f29aa5cfab97f1d59dd30ff80b1571f53a5743cb1cfdfc"
},
"downloads": -1,
"filename": "plone.app.uuid-2.2.3.tar.gz",
"has_sig": false,
"md5_digest": "d2fa3cfc661a789e46161628a7974218",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 19763,
"upload_time": "2024-01-19T09:30:47",
"upload_time_iso_8601": "2024-01-19T09:30:47.521376Z",
"url": "https://files.pythonhosted.org/packages/3f/3b/82b98dbab18969005bdb5575dca11919951eefe84309567145fba3b8ccb8/plone.app.uuid-2.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-19 09:30:47",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "plone.app.uuid"
}
