Introduction
============
Make it possible to use `zope.intid`_ in a Zope environment.
This includes other packages that rely on it such as `zope.keyreference`_
.. _zope.intid: https://pypi.python.org/pypi/zope.intid
.. _zope.keyreference: https://pypi.python.org/pypi/zope.keyreference
Source Code
===========
Contributors please read the document `Process for Plone core's development <https://docs.plone.org/develop/coredev/docs/index.html>`_
Sources are at the `Plone code repository hosted at Github <https://github.com/plone/five.intid>`_.
Usage
=====
First, let make sure the ofs utility provides the interface::
>>> from Products.Five.tests.testing.simplecontent import (
... manage_addSimpleContent)
>>> from zope.intid.interfaces import IIntIds
>>> from five.intid import site
>>> import five.intid.tests as tests
>>> from zope.interface.verify import verifyObject
>>> from zope.component import getAllUtilitiesRegisteredFor
>>> from zope.component.hooks import setSite
>>> tests.setUp(self.app)
Content added before the utility won't be registered (until explicitly
called to). We'll set some up now for later
>>> manage_addSimpleContent(self.folder, 'mycont1', "My Content")
>>> content1 = self.folder.mycont1
`five.intid.site` has convenience functions for adding, get and
removing an IntId utility: `add_intid`, `get_intid`, `del_intid`.
You can install the utility in a specific location::
>>> site.add_intids(self.folder)
>>> folder_intids = site.get_intids(self.folder)
>>> verifyObject(IIntIds, folder_intids)
True
You can tell `add_intids` to find the site root, and install there.
It will be available everywhere::
>>> site.add_intids(self.folder, findroot=True)
>>> root_intids = site.get_intids(self.app)
>>> root_intids
<...IntIds ...>
>>> folder_intids is root_intids
False
And finally, do a remove::
>>> site.del_intids(self.folder, findroot=True)
>>> site.get_intids(self.app)
Traceback (most recent call last):
...
ComponentLookupError: (<InterfaceClass ....IIntIds>, '')
Before we look at intid events, we need to set the traversal
hook. Once we have done this, when we ask for all registered Intids,
we will get the utility from test folder::
>>> setSite(self.folder)
>>> tuple(getAllUtilitiesRegisteredFor(IIntIds))
(<...IntIds ...>,)
When we add content, event will be fired to add keyreference for said
objects the utilities (currently, our content and the utility are
registered)::
>>> manage_addSimpleContent(self.folder, 'mycont2', "My Content")
>>> content2 = self.folder.mycont2
>>> intid = site.get_intids(self.folder)
>>> len(intid.items()) == 1
True
Pre-existing content will raise a keyerror if passed to the intid
utility::
>>> intid.getId(content1)
Traceback (most recent call last):
...
IntIdMissingError: <SimpleContent at /test_folder_1_/mycont1>
We can call the keyreferences, and get the objects back::
>>> intid.items()[0][1]()
<SimpleContent at /test_folder_1_/mycont2>
we can get an object's `intid` from the utility like so::
>>> ob_id = intid.getId(content2)
and get an object back like this::
>>> intid.getObject(ob_id)
<SimpleContent at /test_folder_1_/mycont2>
these objects are acquisition wrapped on retrieval::
>>> from Acquisition import IAcquirer
>>> IAcquirer.providedBy(intid.getObject(ob_id))
True
We can even turn an unwrapped object into a wrapped object by
resolving it from it's intid, also the intid utility should work
even if it is unwrapped::
>>> from Acquisition import aq_base
>>> resolved = intid.getObject(intid.getId(aq_base(content2)))
>>> IAcquirer.providedBy(resolved)
True
>>> unwrapped = aq_base(intid)
>>> unwrapped.getObject(ob_id) == resolved
True
>>> unwrapped.getId(content2) == ob_id
True
When an object is added or removed, subscribers add it to the intid
utility, and fire an event is fired
(zope.intid.interfaces.IIntIdAddedEvent,
zope.intid.interfaces.IIntIdRemovedEvent respectively).
`five.intid` hooks up these events to redispatch as object events. The
tests hook up a simple subscriber to verify that the intid object
events are fired (these events are useful for catalogish tasks).
>>> tests.NOTIFIED[0]
'<SimpleContent at mycont2> <...IntIdAddedEvent object at ...'
Registering and unregistering objects does not fire these events::
>>> tests.NOTIFIED[0] = "No change"
>>> uid = intid.register(content1)
>>> intid.getObject(uid)
<SimpleContent at /test_folder_1_/mycont1>
>>> tests.NOTIFIED[0]
'No change'
>>> intid.unregister(content1)
>>> intid.getObject(uid)
Traceback (most recent call last):
...
ObjectMissingError: ...
>>> tests.NOTIFIED[0]
'No change'
Renaming an object should not break the rewrapping of the object:
>>> self.setRoles(['Manager'])
>>> folder.mycont2.meta_type = 'Folder' # We need a metatype to move
>>> folder.manage_renameObject('mycont2','mycont_new')
>>> moved = intid.getObject(ob_id)
>>> moved
<SimpleContent at /test_folder_1_/mycont_new>
>>> [x.path for x in intid.ids]
['/test_folder_1_/mycont_new']
Nor should moving it:
>>> from OFS.Folder import manage_addFolder
>>> manage_addFolder(self.folder, 'folder2', "folder 2")
>>> cut = folder.manage_cutObjects(['mycont_new'])
>>> ignore = folder.folder2.manage_pasteObjects(cut)
>>> moved = intid.getObject(ob_id)
>>> moved
<SimpleContent at /test_folder_1_/folder2/mycont_new>
>>> moved.aq_parent
<Folder at /test_folder_1_/folder2>
Let's move it back:
>>> cut = folder.folder2.manage_cutObjects(['mycont_new'])
>>> ignore = folder.manage_pasteObjects(cut)
>>> folder.manage_renameObject('mycont_new','mycont2')
We can create an object without acquisition so we can be able to
add intid to it :
>>> from five.intid.tests import DemoPersistent
>>> demo1 = DemoPersistent()
>>> demo1.__parent__ = self.app
>>> from zope.event import notify
>>> from zope.lifecycleevent import ObjectAddedEvent
>>> notify(ObjectAddedEvent(demo1))
>>> nowrappid = intid.getId(demo1)
>>> demo1 == intid.getObject(nowrappid)
True
This is a good time to take a look at keyreferences, the core part of
this system.
Key References in Zope2
=======================
Key references are hashable objects returned by IKeyReference. The
hash produced is a unique identifier for whatever the object is
referencing(another zodb object, a hook for sqlobject, etc).
object retrieval in intid occurs by calling a key reference. This
implementation is slightly different than the zope.intid one due to
acquisition.
The factories returned by IKeyReference must persist and this dictates
being especially careful about references to acquisition wrapped
objects as well as return acq wrapped objects as usually expected in
zope2.
>>> ref = intid.refs[ob_id]
>>> ref
<five.intid.keyreference.KeyReferenceToPersistent object at ...>
The reference object holds a reference to the unwrapped target object
and a property to fetch the app(also, not wrapped ie <type 'ImplicitAcquirerWrapper'>)::
>>> ref.object
<SimpleContent at mycont2>
>>> type(ref.object)
<class 'Products.Five.tests.testing.simplecontent.SimpleContent'>
>>> ref.root
<Application at >
Calling the reference object (or the property wrapped_object) will
return an acquisition object wrapped object (wrapped as it was
created)::
>>> ref.wrapped_object == ref()
True
>>> ref()
<SimpleContent at /test_folder_1_/mycont2>
>>> IAcquirer.providedBy(ref())
True
The resolution mechanism tries its best to end up with the current
request at the end of the acquisition chain, just as it would be
under normal circumstances::
>>> ref.wrapped_object.aq_chain[-1]
<ZPublisher.BaseRequest.RequestContainer object at ...>
The hash calculation is a combination of the database name and the
object's persistent object id(oid)::
>>> ref.dbname
'unnamed'
>>> hash((ref.dbname, ref.object._p_oid)) == hash(ref)
True
>>> tests.tearDown()
Acquisition Loops
=================
five.intid detects loops in acquisition chains in both aq_parent and
__parent__.
Setup a loop::
>>> import Acquisition
>>> class Acq(Acquisition.Acquirer): pass
>>> foo = Acq()
>>> foo.bar = Acq()
>>> foo.__parent__ = foo.bar
Looking for the root on an object with an acquisition loop will raise
an error::
>>> from five.intid import site
>>> site.get_root(foo.bar)
Traceback (most recent call last):
...
AttributeError: __parent__ loop found
Looking for the connection on an object with an acquisition loop will
simply return None::
>>> from five.intid import keyreference
>>> keyreference.connectionOfPersistent(foo.bar)
Unreferenceable
===============
Some objects implement IPersistent but are never actually persisted, or
contain references to such objects. Specifically, CMFCore directory views
contain FSObjects that are never persisted, and DirectoryViewSurrogates
that contain references to such objects. Because FSObjects are never actually
persisted, five.intid's assumption that it can add a
For such objects, the unreferenceable module provides no-op subcribers and
adapters to omit such objects from five.intid handling.
>>> from zope import interface, component
>>> from five.intid import unreferenceable
>>> from Products.CMFCore import FSPythonScript
>>> foo = FSPythonScript.FSPythonScript('foo', __file__)
>>> self.app._setObject('foo', foo)
'foo'
>>> keyref = unreferenceable.KeyReferenceNever(self.app.foo)
Traceback (most recent call last):
...
NotYet
>>> foo in self.app._p_jar._registered_objects
False
Objects with no id
==================
It is possible to attempt to get a key reference for an object that has not
yet been properly added to a container, but would otherwise have a path.
In this case, we raise the NotYet exception to let the calling code defer
as necessary, since the key reference would otherwise resolve the wrong
object (the parent, to be precise) from an incorrect path.
>>> from zope.keyreference.interfaces import IKeyReference
>>> from five.intid.keyreference import KeyReferenceToPersistent
>>> from zope.component import provideAdapter
>>> provideAdapter(KeyReferenceToPersistent)
>>> from OFS.SimpleItem import SimpleItem
>>> item = SimpleItem('').__of__(self.folder)
>>> '/'.join(item.getPhysicalPath())
'/test_folder_1_/'
>>> IKeyReference(item)
Traceback (most recent call last):
...
NotYet: <SimpleItem at >
If the object is placed in a circular containment, IKeyReference(object) should
not be able to adapt, letting the calling code defer as necessary.
Also any object access is defeated and raises a RuntimeError.
This case happened when having a Plone4 site five.intid enabled
(five.intid.site.add_intids(site)) and trying to add a portlet via
@@manage-portlets. plone.portlet.static.static.Assignment seems to have a
circular path at some time.
Creating items with a circular containment
>>> item_b = SimpleItem().__of__(self.folder)
>>> item_b.id = "b"
>>> item_c = SimpleItem().__of__(item_b)
>>> item_c.id = "c"
>>> item_b.__parent__ = item_c
>>> assert item_b.__parent__.__parent__ == item_b
>>> item_b.id
Traceback (most recent call last):
...
RuntimeError: Recursion detected in acquisition wrapper
>>> try:
... IKeyReference(item_c)
... except RuntimeError as exc:
... # expected with zope.interface 5.1+:
... # Recursion detected in acquisition wrapper
... print("Error")
... except TypeError as exc:
... # before zope.interface 5.1 it was not able to lets non-AttributeErrors
... # propagate from descriptors which resultet in a Could Not Adapt TypeError
... print("Error")
Error
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.0.0 (2023-10-07)
------------------
Breaking changes:
- Drop support for python 2.7.
[gforcada] (#1)
Internal:
- Update configuration files.
[plone devs] (cfffba8c)
1.2.7 (2023-02-22)
------------------
Bug fixes:
- Add configuration with plone/meta.
[gforcada] (#1)
1.2.6 (2020-05-06)
------------------
Bug fixes:
- Fix deprecation warnings.
Update ``setup.py`` to depend on ``Zope2`` or ``Zope``, depending on Python version.
[jensens] (#1)
- Fix test to work correctly with ``zope.interface >= 5.1``.
[jensens] (#17)
1.2.5 (2020-03-13)
------------------
Bug fixes:
- Fixed ModuleNotFoundError: No module named 'App.class_init' on Zope 5.
[maurits] (#15)
1.2.4 (2019-10-12)
------------------
Bug fixes:
- Also catch KeyError when traversing to fix creating relations during Copy&Paste in Zope 4.
Fixes https://github.com/plone/Products.CMFPlone/issues/2866
[pbauer] (#12)
- When looking up back-references the lookup using unrestrictedTraverse was way to slow.
A simplified traverse speeds up the lookup by up 80x. [jensens, 2silver] (#14)
1.2.3 (2019-06-19)
------------------
Bug fixes:
- Properly update the persistent objects stored in the initid utility btrees [ale-rt] (#8)
- Also catch KeyError when traversing to fix creating relations during Copy&Paste in Zope 4.
Fixes https://github.com/plone/Products.CMFPlone/issues/2866
[pbauer] (#12)
1.2.2 (2019-05-01)
------------------
Bug fixes:
- Fix oid and root_oid that might have been accidentally converted to text when a DB was migrated from py2.
[pbauer] (#7)
1.2.1 (2019-02-13)
------------------
Bug fixes:
- Avoid a deprecation warning. [gforcada] (#6)
1.2.0 (2018-11-07)
------------------
Bug fixes:
- Fix doctests in Python 3.
[ale-rt]
- Adapt raised errors to changes in zope.intid.
(This makes the tests incompatible with Zope 2.13.)
[pbauer]
1.1.2 (2016-09-09)
------------------
Bug fixes:
- Prevent errors on ``removeIntIdSubscriber`` when the ``IKeyReference`` adapter
raises a ``NotYet``, e.g. because the object does not have a proper path.
[ale-rt]
1.1.1 (2016-08-19)
------------------
Fixes:
- Acquisition-unwrap each item in the aq_iter chain, as ``getSite().__parent__`` might return an object acquired from the original context which breaks the parent loop detection.
[thet]
- Prevent errors on ``moveIntIdSubscriber`` when the ``IKeyReference`` adapter
raises a ``NotYet``, e.g. because the object does not have a proper path.
[ale-rt]
1.1.0 (2016-02-14)
------------------
New:
- Enhancement: follow PEP8 and Plone code conventions
[jensens]
Fixes:
- Fix: Make it work with Acquisition>=4.0.1 (and require the version).
Circular acquisitions were - prior to the above version - not
detected. Now they are and adaption just fails with a "Could not
adapt" for circulars. Any attribute access fails with a verbose
RuntimeError. Cleanup also circular containment workarounds.
[jensens]
1.0.3 - 2012-10-05
------------------
- Make sure the IConnection adapter works for unwrapped persistent
objects.
[davisagli]
1.0.2 - 2011-12-02
------------------
- Only ignore 'temporary' objects in the ObjectAddedEvent event handler.
[mj]
1.0.1 - 2011-11-30
------------------
- Ignore 'temporary' objects (in the Plone portal_factory tool).
[mj]
1.0 - 2011-10-10
----------------
- Remove last `zope.app` dependency.
[hannosch]
- Remove intid browser views.
[hannosch]
- Modernize code, adept to Zope 2.13.
[hannosch]
0.5.2 - January 22, 2011
------------------------
- Import getAllUtilitiesRegisteredFor directly from zope.component and
remove dependency on zope.app.zapi.
[Arfrever]
- Fix chameleon template error.
[robgietema]
0.5.1 - August 4, 2010
----------------------
- Fix tests to pass with the corrected tp_name of ImplicitAcquisitionWrapper
in Acquisition 2.13.1.
[davisagli]
0.5.0 - February 6, 2010
------------------------
- Use only non-deprecated zope imports, five.intid now only supports
Zope 2.12+.
[alecm]
0.4.4 - February 6, 2010
------------------------
- Fix POSKeyError when the root object is not in the same database
than the object you are trying to resolve to.
[thefunny42]
- Fixed all deprecated imports and updated setup.py
[thet, wichert]
- Fixed tests to reflect changed Zope API
[thet]
0.4.3 - July 19, 2009
---------------------
- When looking for an object by path, treat an AttributeError the same as a
NotFound error. unrestrictedTraverse() raises an AttributeError in certain
cases when it can't traverse.
[optilude]
0.4.2 - Apr 26, 2009
--------------------
- Install utility in a more permanent manner.
[alecm]
- Drop `five:traversable` statement. It was deprecated since Zope 2.10.
[hannosch]
- Use `objectEventNotify` from zope.component.event instead of zope.app.event.
The later was deprecated since Zope 2.10.
[hannosch]
- Specify package dependencies.
[hannosch]
0.4.1 - Mar 17, 2009
--------------------
- Fix missing zcml file in prior release
0.4.0 - Mar 17, 2009
--------------------
- Raise NotYet exception in the default keyreference constructor when the
object does not yet have a proper path. This avoids problems of premature
key references being created and pointing to the parent of the object or
a non-existent object.
[optilude]
0.3.0 - Nov 07, 2008
--------------------
- Add unreferenceable implementations of intid event handlers and IKeyReference
to deal with IPersistent objects that are never actually persisted, such as
the CMFCore directory view objects.
[mj]
- Remove the explicit exceptions for CMFCore directory view objects and use
subscriber and adapter registrations against unreferenceable instead.
[mj]
0.2.1 - Nov 05, 2008
--------------------
- Avoid unnecessary adapter lookups in __cmp__ as __cmp__
is called rather often and is performance sensitive.
Cumulative time now 0.080 vs previous 1.820 for 6000 compares
when profiling.
[tesdal]
- Avoid redundant __cmp__ calls in BTree traversal.
[tesdal]
0.2.0 - May 20, 2008
--------------------
- Cleanup documentation a little bit so it can be used for the pypi page.
[wichert]
- Many changes by many people.
[alecm, hannosch, maurits, mborch, reinout, rockt, witsch]
0.1.4 - November 11, 2006
-------------------------
- First public release.
[brcwhit]
Raw data
{
"_id": null,
"home_page": "https://github.com/plone/five.intid",
"name": "five.intid",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "'zope2 intid'",
"author": "Whit Morris",
"author_email": "whit@openplans.org",
"download_url": "https://files.pythonhosted.org/packages/ed/c6/36a3c64302ba1e9bf54345dfbd7edcda50aaabb523310af1e80f7ce95589/five.intid-2.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\nMake it possible to use `zope.intid`_ in a Zope environment. \nThis includes other packages that rely on it such as `zope.keyreference`_\n\n.. _zope.intid: https://pypi.python.org/pypi/zope.intid\n.. _zope.keyreference: https://pypi.python.org/pypi/zope.keyreference\n\nSource Code\n===========\n\nContributors please read the document `Process for Plone core's development <https://docs.plone.org/develop/coredev/docs/index.html>`_\n\nSources are at the `Plone code repository hosted at Github <https://github.com/plone/five.intid>`_.\n\nUsage\n=====\n\nFirst, let make sure the ofs utility provides the interface::\n\n >>> from Products.Five.tests.testing.simplecontent import (\n ... manage_addSimpleContent)\n\n >>> from zope.intid.interfaces import IIntIds\n >>> from five.intid import site\n >>> import five.intid.tests as tests\n >>> from zope.interface.verify import verifyObject\n >>> from zope.component import getAllUtilitiesRegisteredFor\n >>> from zope.component.hooks import setSite\n >>> tests.setUp(self.app)\n\n\nContent added before the utility won't be registered (until explicitly\ncalled to). We'll set some up now for later\n\n >>> manage_addSimpleContent(self.folder, 'mycont1', \"My Content\")\n >>> content1 = self.folder.mycont1\n\n`five.intid.site` has convenience functions for adding, get and\nremoving an IntId utility: `add_intid`, `get_intid`, `del_intid`.\n\nYou can install the utility in a specific location::\n\n >>> site.add_intids(self.folder)\n >>> folder_intids = site.get_intids(self.folder)\n >>> verifyObject(IIntIds, folder_intids)\n True\n\nYou can tell `add_intids` to find the site root, and install there.\nIt will be available everywhere::\n\n >>> site.add_intids(self.folder, findroot=True)\n >>> root_intids = site.get_intids(self.app)\n >>> root_intids\n <...IntIds ...>\n >>> folder_intids is root_intids\n False\n\nAnd finally, do a remove::\n\n >>> site.del_intids(self.folder, findroot=True)\n >>> site.get_intids(self.app)\n Traceback (most recent call last):\n ...\n ComponentLookupError: (<InterfaceClass ....IIntIds>, '')\n\nBefore we look at intid events, we need to set the traversal\nhook. Once we have done this, when we ask for all registered Intids,\nwe will get the utility from test folder::\n\n >>> setSite(self.folder)\n >>> tuple(getAllUtilitiesRegisteredFor(IIntIds))\n (<...IntIds ...>,)\n\n\nWhen we add content, event will be fired to add keyreference for said\nobjects the utilities (currently, our content and the utility are\nregistered)::\n\n >>> manage_addSimpleContent(self.folder, 'mycont2', \"My Content\")\n >>> content2 = self.folder.mycont2\n >>> intid = site.get_intids(self.folder)\n >>> len(intid.items()) == 1\n True\n\nPre-existing content will raise a keyerror if passed to the intid\nutility::\n\n >>> intid.getId(content1)\n Traceback (most recent call last):\n ...\n IntIdMissingError: <SimpleContent at /test_folder_1_/mycont1>\n\nWe can call the keyreferences, and get the objects back::\n\n >>> intid.items()[0][1]()\n <SimpleContent at /test_folder_1_/mycont2>\n\nwe can get an object's `intid` from the utility like so::\n\n >>> ob_id = intid.getId(content2)\n\nand get an object back like this::\n\n >>> intid.getObject(ob_id)\n <SimpleContent at /test_folder_1_/mycont2>\n\nthese objects are acquisition wrapped on retrieval::\n\n >>> from Acquisition import IAcquirer\n >>> IAcquirer.providedBy(intid.getObject(ob_id))\n True\n\n\nWe can even turn an unwrapped object into a wrapped object by\nresolving it from it's intid, also the intid utility should work\neven if it is unwrapped::\n\n >>> from Acquisition import aq_base\n >>> resolved = intid.getObject(intid.getId(aq_base(content2)))\n >>> IAcquirer.providedBy(resolved)\n True\n >>> unwrapped = aq_base(intid)\n >>> unwrapped.getObject(ob_id) == resolved\n True\n >>> unwrapped.getId(content2) == ob_id\n True\n\nWhen an object is added or removed, subscribers add it to the intid\nutility, and fire an event is fired\n(zope.intid.interfaces.IIntIdAddedEvent,\nzope.intid.interfaces.IIntIdRemovedEvent respectively).\n\n`five.intid` hooks up these events to redispatch as object events. The\ntests hook up a simple subscriber to verify that the intid object\nevents are fired (these events are useful for catalogish tasks).\n\n >>> tests.NOTIFIED[0]\n '<SimpleContent at mycont2> <...IntIdAddedEvent object at ...'\n\nRegistering and unregistering objects does not fire these events::\n\n >>> tests.NOTIFIED[0] = \"No change\"\n >>> uid = intid.register(content1)\n >>> intid.getObject(uid)\n <SimpleContent at /test_folder_1_/mycont1>\n\n >>> tests.NOTIFIED[0]\n 'No change'\n\n >>> intid.unregister(content1)\n >>> intid.getObject(uid)\n Traceback (most recent call last):\n ...\n ObjectMissingError: ...\n\n >>> tests.NOTIFIED[0]\n 'No change'\n\nRenaming an object should not break the rewrapping of the object:\n\n >>> self.setRoles(['Manager'])\n >>> folder.mycont2.meta_type = 'Folder' # We need a metatype to move\n >>> folder.manage_renameObject('mycont2','mycont_new')\n >>> moved = intid.getObject(ob_id)\n >>> moved\n <SimpleContent at /test_folder_1_/mycont_new>\n >>> [x.path for x in intid.ids]\n ['/test_folder_1_/mycont_new']\n\nNor should moving it:\n\n >>> from OFS.Folder import manage_addFolder\n >>> manage_addFolder(self.folder, 'folder2', \"folder 2\")\n >>> cut = folder.manage_cutObjects(['mycont_new'])\n >>> ignore = folder.folder2.manage_pasteObjects(cut)\n >>> moved = intid.getObject(ob_id)\n >>> moved\n <SimpleContent at /test_folder_1_/folder2/mycont_new>\n >>> moved.aq_parent\n <Folder at /test_folder_1_/folder2>\n\nLet's move it back:\n\n >>> cut = folder.folder2.manage_cutObjects(['mycont_new'])\n >>> ignore = folder.manage_pasteObjects(cut)\n >>> folder.manage_renameObject('mycont_new','mycont2')\n\nWe can create an object without acquisition so we can be able to\nadd intid to it :\n\n >>> from five.intid.tests import DemoPersistent\n >>> demo1 = DemoPersistent()\n >>> demo1.__parent__ = self.app\n >>> from zope.event import notify\n >>> from zope.lifecycleevent import ObjectAddedEvent\n >>> notify(ObjectAddedEvent(demo1))\n >>> nowrappid = intid.getId(demo1)\n >>> demo1 == intid.getObject(nowrappid)\n True\n\nThis is a good time to take a look at keyreferences, the core part of\nthis system.\n\n\nKey References in Zope2\n=======================\n\nKey references are hashable objects returned by IKeyReference. The\nhash produced is a unique identifier for whatever the object is\nreferencing(another zodb object, a hook for sqlobject, etc).\n\nobject retrieval in intid occurs by calling a key reference. This\nimplementation is slightly different than the zope.intid one due to\nacquisition.\n\nThe factories returned by IKeyReference must persist and this dictates\nbeing especially careful about references to acquisition wrapped\nobjects as well as return acq wrapped objects as usually expected in\nzope2.\n\n >>> ref = intid.refs[ob_id]\n >>> ref\n <five.intid.keyreference.KeyReferenceToPersistent object at ...>\n\nThe reference object holds a reference to the unwrapped target object\nand a property to fetch the app(also, not wrapped ie <type 'ImplicitAcquirerWrapper'>)::\n\n >>> ref.object\n <SimpleContent at mycont2>\n\n >>> type(ref.object)\n <class 'Products.Five.tests.testing.simplecontent.SimpleContent'>\n\n >>> ref.root\n <Application at >\n\nCalling the reference object (or the property wrapped_object) will\nreturn an acquisition object wrapped object (wrapped as it was\ncreated)::\n\n >>> ref.wrapped_object == ref()\n True\n\n >>> ref()\n <SimpleContent at /test_folder_1_/mycont2>\n\n >>> IAcquirer.providedBy(ref())\n True\n\n\n\nThe resolution mechanism tries its best to end up with the current\nrequest at the end of the acquisition chain, just as it would be\nunder normal circumstances::\n\n >>> ref.wrapped_object.aq_chain[-1]\n <ZPublisher.BaseRequest.RequestContainer object at ...>\n\n\nThe hash calculation is a combination of the database name and the\nobject's persistent object id(oid)::\n\n >>> ref.dbname\n 'unnamed'\n\n >>> hash((ref.dbname, ref.object._p_oid)) == hash(ref)\n True\n\n >>> tests.tearDown()\n\nAcquisition Loops\n=================\n\nfive.intid detects loops in acquisition chains in both aq_parent and\n__parent__.\n\nSetup a loop::\n\n >>> import Acquisition\n >>> class Acq(Acquisition.Acquirer): pass\n >>> foo = Acq()\n >>> foo.bar = Acq()\n >>> foo.__parent__ = foo.bar\n\nLooking for the root on an object with an acquisition loop will raise\nan error::\n\n >>> from five.intid import site\n >>> site.get_root(foo.bar)\n Traceback (most recent call last):\n ...\n AttributeError: __parent__ loop found\n\nLooking for the connection on an object with an acquisition loop will\nsimply return None::\n\n >>> from five.intid import keyreference\n >>> keyreference.connectionOfPersistent(foo.bar)\n\nUnreferenceable\n===============\n\nSome objects implement IPersistent but are never actually persisted, or\ncontain references to such objects. Specifically, CMFCore directory views\ncontain FSObjects that are never persisted, and DirectoryViewSurrogates\nthat contain references to such objects. Because FSObjects are never actually\npersisted, five.intid's assumption that it can add a\n\nFor such objects, the unreferenceable module provides no-op subcribers and\nadapters to omit such objects from five.intid handling.\n\n >>> from zope import interface, component\n >>> from five.intid import unreferenceable\n\n >>> from Products.CMFCore import FSPythonScript\n >>> foo = FSPythonScript.FSPythonScript('foo', __file__)\n >>> self.app._setObject('foo', foo)\n 'foo'\n\n >>> keyref = unreferenceable.KeyReferenceNever(self.app.foo)\n Traceback (most recent call last):\n ...\n NotYet\n >>> foo in self.app._p_jar._registered_objects\n False\n\nObjects with no id\n==================\n\nIt is possible to attempt to get a key reference for an object that has not\nyet been properly added to a container, but would otherwise have a path.\nIn this case, we raise the NotYet exception to let the calling code defer\nas necessary, since the key reference would otherwise resolve the wrong\nobject (the parent, to be precise) from an incorrect path.\n\n >>> from zope.keyreference.interfaces import IKeyReference\n >>> from five.intid.keyreference import KeyReferenceToPersistent\n >>> from zope.component import provideAdapter\n >>> provideAdapter(KeyReferenceToPersistent)\n\n >>> from OFS.SimpleItem import SimpleItem\n >>> item = SimpleItem('').__of__(self.folder)\n >>> '/'.join(item.getPhysicalPath())\n '/test_folder_1_/'\n\n >>> IKeyReference(item)\n Traceback (most recent call last):\n ...\n NotYet: <SimpleItem at >\n\n\nIf the object is placed in a circular containment, IKeyReference(object) should\nnot be able to adapt, letting the calling code defer as necessary.\nAlso any object access is defeated and raises a RuntimeError.\n\nThis case happened when having a Plone4 site five.intid enabled\n(five.intid.site.add_intids(site)) and trying to add a portlet via\n@@manage-portlets. plone.portlet.static.static.Assignment seems to have a\ncircular path at some time.\n\nCreating items with a circular containment\n >>> item_b = SimpleItem().__of__(self.folder)\n >>> item_b.id = \"b\"\n >>> item_c = SimpleItem().__of__(item_b)\n >>> item_c.id = \"c\"\n >>> item_b.__parent__ = item_c\n\n >>> assert item_b.__parent__.__parent__ == item_b\n\n >>> item_b.id\n Traceback (most recent call last):\n ...\n RuntimeError: Recursion detected in acquisition wrapper\n\n >>> try:\n ... IKeyReference(item_c)\n ... except RuntimeError as exc:\n ... # expected with zope.interface 5.1+:\n ... # Recursion detected in acquisition wrapper\n ... print(\"Error\")\n ... except TypeError as exc:\n ... # before zope.interface 5.1 it was not able to lets non-AttributeErrors\n ... # propagate from descriptors which resultet in a Could Not Adapt TypeError\n ... print(\"Error\")\n Error\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.0.0 (2023-10-07)\n------------------\n\nBreaking changes:\n\n\n- Drop support for python 2.7.\n [gforcada] (#1)\n\n\nInternal:\n\n\n- Update configuration files.\n [plone devs] (cfffba8c)\n\n\n1.2.7 (2023-02-22)\n------------------\n\nBug fixes:\n\n\n- Add configuration with plone/meta.\n [gforcada] (#1)\n\n\n1.2.6 (2020-05-06)\n------------------\n\nBug fixes:\n\n\n- Fix deprecation warnings.\n Update ``setup.py`` to depend on ``Zope2`` or ``Zope``, depending on Python version.\n [jensens] (#1)\n- Fix test to work correctly with ``zope.interface >= 5.1``.\n [jensens] (#17)\n\n\n1.2.5 (2020-03-13)\n------------------\n\nBug fixes:\n\n\n- Fixed ModuleNotFoundError: No module named 'App.class_init' on Zope 5.\n [maurits] (#15)\n\n\n1.2.4 (2019-10-12)\n------------------\n\nBug fixes:\n\n\n- Also catch KeyError when traversing to fix creating relations during Copy&Paste in Zope 4.\n Fixes https://github.com/plone/Products.CMFPlone/issues/2866\n [pbauer] (#12)\n- When looking up back-references the lookup using unrestrictedTraverse was way to slow.\n A simplified traverse speeds up the lookup by up 80x. [jensens, 2silver] (#14)\n\n\n1.2.3 (2019-06-19)\n------------------\n\nBug fixes:\n\n\n- Properly update the persistent objects stored in the initid utility btrees [ale-rt] (#8)\n- Also catch KeyError when traversing to fix creating relations during Copy&Paste in Zope 4.\n Fixes https://github.com/plone/Products.CMFPlone/issues/2866\n [pbauer] (#12)\n\n\n1.2.2 (2019-05-01)\n------------------\n\nBug fixes:\n\n\n- Fix oid and root_oid that might have been accidentally converted to text when a DB was migrated from py2.\n [pbauer] (#7)\n\n\n1.2.1 (2019-02-13)\n------------------\n\nBug fixes:\n\n\n- Avoid a deprecation warning. [gforcada] (#6)\n\n\n1.2.0 (2018-11-07)\n------------------\n\nBug fixes:\n\n- Fix doctests in Python 3.\n [ale-rt]\n- Adapt raised errors to changes in zope.intid.\n (This makes the tests incompatible with Zope 2.13.)\n [pbauer]\n\n\n1.1.2 (2016-09-09)\n------------------\n\nBug fixes:\n\n- Prevent errors on ``removeIntIdSubscriber`` when the ``IKeyReference`` adapter\n raises a ``NotYet``, e.g. because the object does not have a proper path.\n [ale-rt]\n\n\n1.1.1 (2016-08-19)\n------------------\n\nFixes:\n\n- Acquisition-unwrap each item in the aq_iter chain, as ``getSite().__parent__`` might return an object acquired from the original context which breaks the parent loop detection.\n [thet]\n\n- Prevent errors on ``moveIntIdSubscriber`` when the ``IKeyReference`` adapter\n raises a ``NotYet``, e.g. because the object does not have a proper path.\n [ale-rt]\n\n\n1.1.0 (2016-02-14)\n------------------\n\nNew:\n\n- Enhancement: follow PEP8 and Plone code conventions\n [jensens]\n\nFixes:\n\n- Fix: Make it work with Acquisition>=4.0.1 (and require the version).\n Circular acquisitions were - prior to the above version - not\n detected. Now they are and adaption just fails with a \"Could not\n adapt\" for circulars. Any attribute access fails with a verbose\n RuntimeError. Cleanup also circular containment workarounds.\n [jensens]\n\n1.0.3 - 2012-10-05\n------------------\n\n- Make sure the IConnection adapter works for unwrapped persistent\n objects.\n [davisagli]\n\n1.0.2 - 2011-12-02\n------------------\n\n- Only ignore 'temporary' objects in the ObjectAddedEvent event handler.\n [mj]\n\n1.0.1 - 2011-11-30\n------------------\n\n- Ignore 'temporary' objects (in the Plone portal_factory tool).\n [mj]\n\n1.0 - 2011-10-10\n----------------\n\n- Remove last `zope.app` dependency.\n [hannosch]\n\n- Remove intid browser views.\n [hannosch]\n\n- Modernize code, adept to Zope 2.13.\n [hannosch]\n\n0.5.2 - January 22, 2011\n------------------------\n\n- Import getAllUtilitiesRegisteredFor directly from zope.component and\n remove dependency on zope.app.zapi.\n [Arfrever]\n\n- Fix chameleon template error.\n [robgietema]\n\n0.5.1 - August 4, 2010\n----------------------\n\n- Fix tests to pass with the corrected tp_name of ImplicitAcquisitionWrapper\n in Acquisition 2.13.1.\n [davisagli]\n\n0.5.0 - February 6, 2010\n------------------------\n\n- Use only non-deprecated zope imports, five.intid now only supports\n Zope 2.12+.\n [alecm]\n\n0.4.4 - February 6, 2010\n------------------------\n\n- Fix POSKeyError when the root object is not in the same database\n than the object you are trying to resolve to.\n [thefunny42]\n\n- Fixed all deprecated imports and updated setup.py\n [thet, wichert]\n\n- Fixed tests to reflect changed Zope API\n [thet]\n\n0.4.3 - July 19, 2009\n---------------------\n\n- When looking for an object by path, treat an AttributeError the same as a\n NotFound error. unrestrictedTraverse() raises an AttributeError in certain\n cases when it can't traverse.\n [optilude]\n\n0.4.2 - Apr 26, 2009\n--------------------\n\n- Install utility in a more permanent manner.\n [alecm]\n\n- Drop `five:traversable` statement. It was deprecated since Zope 2.10.\n [hannosch]\n\n- Use `objectEventNotify` from zope.component.event instead of zope.app.event.\n The later was deprecated since Zope 2.10.\n [hannosch]\n\n- Specify package dependencies.\n [hannosch]\n\n0.4.1 - Mar 17, 2009\n--------------------\n\n- Fix missing zcml file in prior release\n\n0.4.0 - Mar 17, 2009\n--------------------\n\n- Raise NotYet exception in the default keyreference constructor when the\n object does not yet have a proper path. This avoids problems of premature\n key references being created and pointing to the parent of the object or\n a non-existent object.\n [optilude]\n\n0.3.0 - Nov 07, 2008\n--------------------\n\n- Add unreferenceable implementations of intid event handlers and IKeyReference\n to deal with IPersistent objects that are never actually persisted, such as\n the CMFCore directory view objects.\n [mj]\n\n- Remove the explicit exceptions for CMFCore directory view objects and use\n subscriber and adapter registrations against unreferenceable instead.\n [mj]\n\n0.2.1 - Nov 05, 2008\n--------------------\n\n- Avoid unnecessary adapter lookups in __cmp__ as __cmp__\n is called rather often and is performance sensitive.\n Cumulative time now 0.080 vs previous 1.820 for 6000 compares\n when profiling.\n [tesdal]\n\n- Avoid redundant __cmp__ calls in BTree traversal.\n [tesdal]\n\n0.2.0 - May 20, 2008\n--------------------\n\n- Cleanup documentation a little bit so it can be used for the pypi page.\n [wichert]\n\n- Many changes by many people.\n [alecm, hannosch, maurits, mborch, reinout, rockt, witsch]\n\n\n0.1.4 - November 11, 2006\n-------------------------\n\n- First public release.\n [brcwhit]\n\n",
"bugtrack_url": null,
"license": "ZPL",
"summary": "Zope support for zope.intid",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/plone/five.intid"
},
"split_keywords": [
"'zope2",
"intid'"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ce1c25c66bfc669113eac8f3fd11c2ae242a6dcfe11b2727ed360f34c2ffde91",
"md5": "59e72baac2615b385afb81cc2198b6d4",
"sha256": "dae44b07e28fdba7424ede7049c3de51444a6be80a5854667a3cdcafa4e36e12"
},
"downloads": -1,
"filename": "five.intid-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "59e72baac2615b385afb81cc2198b6d4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 22629,
"upload_time": "2023-10-06T22:35:25",
"upload_time_iso_8601": "2023-10-06T22:35:25.023877Z",
"url": "https://files.pythonhosted.org/packages/ce/1c/25c66bfc669113eac8f3fd11c2ae242a6dcfe11b2727ed360f34c2ffde91/five.intid-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "edc636a3c64302ba1e9bf54345dfbd7edcda50aaabb523310af1e80f7ce95589",
"md5": "64bbb4299ffe68956c5bdf58a8140175",
"sha256": "b8b31add20aa644cbccd31d118c70de30de977b089ef02a4e4f0fffcad9b44a4"
},
"downloads": -1,
"filename": "five.intid-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "64bbb4299ffe68956c5bdf58a8140175",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 27839,
"upload_time": "2023-10-06T22:35:27",
"upload_time_iso_8601": "2023-10-06T22:35:27.020212Z",
"url": "https://files.pythonhosted.org/packages/ed/c6/36a3c64302ba1e9bf54345dfbd7edcda50aaabb523310af1e80f7ce95589/five.intid-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-06 22:35:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "plone",
"github_project": "five.intid",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "five.intid"
}
JSON
