z3c.proxy 0.6.1

ObjectMover

To use an object mover, pass a contained object to the class. The contained object should implement IContained. It should be contained in a container that has an adapter to INameChooser.

Setup test container and proxies:

>>> from zope.interface import implements
>>> from zope.container.interfaces import INameChooser
>>> from zope.copypastemove import ExampleContainer
>>> from z3c.proxy.container import ProxyAwareObjectMover

>>> class ContainerLocationProxyStub(ContainerLocationProxy):
...
...     implements(INameChooser)
...
...     def chooseName(self, name, ob):
...        while name in self:
...            name += '_'
...        return name

>>> container = ExampleContainer()
>>> container2 = ExampleContainer()

>>> ob = Contained()
>>> proxy = ContainerLocationProxyStub(container)
>>> proxy[u'foo'] = ob
>>> ob = proxy[u'foo']
>>> mover = ProxyAwareObjectMover(ob)

In addition to moving objects, object movers can tell you if the object is movable:

>>> mover.moveable()
1

which, at least for now, they always are. A better question to ask is whether we can move to a particular container. Right now, we can always move to a container of the same class:

>>> proxy2 = ContainerLocationProxyStub(container2)
>>> mover.moveableTo(proxy2)
1

>>> mover.moveableTo({})
Traceback (most recent call last):
...
TypeError: Container is not a valid Zope container.

Of course, once we’ve decided we can move an object, we can use the mover to do so:

>>> mover.moveTo(proxy2)
u'foo'

>>> list(proxy)
[]

>>> list(proxy2)
[u'foo']

>>> ob = proxy2[u'foo']
>>> ob.__parent__ is proxy2
True

We can also specify a name:

>>> mover.moveTo(proxy2, u'bar')
u'bar'

>>> list(proxy2)
[u'bar']

>>> ob = proxy2[u'bar']
>>> ob.__parent__ is proxy2
True

>>> ob.__name__
u'bar'

But we may not use the same name given, if the name is already in use:

>>> proxy2[u'splat'] = 1
>>> mover.moveTo(proxy2, u'splat')
u'splat_'

>>> l = list(proxy2)
>>> l.sort()
>>> l
[u'splat', u'splat_']

>>> ob = proxy2[u'splat_']
>>> ob.__name__
u'splat_'

If we try to move to an invalid container, we’ll get an error:

>>> mover.moveTo({})
Traceback (most recent call last):
...
TypeError: Container is not a valid Zope container.

ObjectCopier

To use an object copier, pass a contained object to the class. The contained object should implement IContained. It should be contained in a container that has an adapter to INameChooser.

Setup test container and proxies:

>>> from z3c.proxy.container import ProxyAwareObjectCopier
>>> class ContainerLocationProxyStub(ContainerLocationProxy):
...
...     implements(INameChooser)
...
...     def chooseName(self, name, ob):
...        while name in self:
...            name += '_'
...        return name

>>> container = ExampleContainer()
>>> container2 = ExampleContainer()

>>> proxy = ContainerLocationProxyStub(container)
>>> proxy[u'foo'] = ob = Contained()
>>> ob = proxy[u'foo']
>>> copier = ProxyAwareObjectCopier(ob)

In addition to moving objects, object copiers can tell you if the object is movable:

>>> copier.copyable()
1

which, at least for now, they always are. A better question to ask is whether we can copy to a particular container. Right now, we can always copy to a container of the same class:

>>> proxy2 = ContainerLocationProxyStub(container2)
>>> copier.copyableTo(proxy2)
1

>>> copier.copyableTo({})
Traceback (most recent call last):
...
TypeError: Container is not a valid Zope container.

Of course, once we’ve decided we can copy an object, we can use the copier to do so:

>>> copier.copyTo(proxy2)
u'foo'

>>> list(proxy)
[u'foo']

>>> list(proxy2)
[u'foo']

>>> ob.__parent__ is proxy
1

>>> proxy2[u'foo'] is ob
0

>>> proxy2[u'foo'].__parent__ is proxy2
1

>>> proxy2[u'foo'].__name__
u'foo'

We can also specify a name:

>>> copier.copyTo(proxy2, u'bar')
u'bar'

>>> l = list(proxy2)
>>> l.sort()
>>> l
[u'bar', u'foo']

>>> ob.__parent__ is proxy
1

>>> proxy2[u'bar'] is ob
0

>>> proxy2[u'bar'].__parent__ is proxy2
1

>>> proxy2[u'bar'].__name__
u'bar'

But we may not use the same name given, if the name is already in use:

>>> copier.copyTo(proxy2, u'bar')
u'bar_'

>>> l = list(proxy2)
>>> l.sort()
>>> l
[u'bar', u'bar_', u'foo']

>>> proxy2[u'bar_'].__name__
u'bar_'

If we try to copy to an invalid container, we’ll get an error:

>>> copier.copyTo({})
Traceback (most recent call last):
...
TypeError: Container is not a valid Zope container.

ProxyAwareContainerItemRenamer

This adapter uses IObjectMover to move an item within the same container to a different name. We need to first setup an adapter for IObjectMover:

Setup test container and proxies:

>>> from zope.container.sample import SampleContainer
>>> from zope.copypastemove import ContainerItemRenamer
>>> from zope.copypastemove import IObjectMover
>>> from z3c.proxy.container import ProxyAwareContainerItemRenamer

>>> import zope.component
>>> from zope.container.interfaces import IContained
>>> zope.component.provideAdapter(ProxyAwareObjectMover, [IContained],
...     IObjectMover)

>>> class ContainerLocationProxyStub(ContainerLocationProxy):
...
...     implements(INameChooser)
...
...     def chooseName(self, name, ob):
...        while name in self:
...            name += '_'
...        return name

To rename an item in a container, instantiate a ContainerItemRenamer with the container:

>>> container = SampleContainer()
>>> proxy = ContainerLocationProxyStub(container)
>>> renamer = ProxyAwareContainerItemRenamer(container)

For this example, we’ll rename an item ‘foo’:

>>> from z3c.proxy.container import _unproxy
>>> foo = Contained()
>>> proxy['foo'] = foo
>>> proxy['foo'] == _unproxy(foo)
True

to ‘bar’:

>>> renamer.renameItem('foo', 'bar')
>>> proxy['foo'] is foo
Traceback (most recent call last):
KeyError: 'foo'

>>> proxy['bar'] == _unproxy(foo)
True

If the item being renamed isn’t in the container, a NotFoundError is raised:

>>> renamer.renameItem('foo', 'bar') # doctest:+ELLIPSIS
Traceback (most recent call last):
ItemNotFoundError: (<...SampleContainer...>, 'foo')

If the new item name already exists, a DuplicationError is raised:

>>> renamer.renameItem('bar', 'bar')
Traceback (most recent call last):
DuplicationError: bar is already in use

0.6.1 (2010-08-23)

• Added doctest to long_description to render on PyPI.

0.6.0 (2010-08-23)

• Replaced zope.app.container by zope.container.

• Using Python’s doctest module instead of deprecated zope.testing.doctestunit.

0.5.0 (2008-04-12)

• Initial Release