1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
# Copyright 2009 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
"""
Useful functions for dealing with Zope adapters.
"""
__metaclass__ = type
__all__ = [
'nearest_adapter',
'nearest_context_with_adapter',
'nearest_provides_or_adapted',
]
from zope.component import queryAdapter
# XXX mars 2008-07-17
# This function should be moved into lazr.canonicalurl.
# See bug #185958.
from canonical.launchpad.webapp.publisher import canonical_url_iterator
from canonical.launchpad.webapp.interfaces import NoCanonicalUrl
def nearest_context_with_adapter(obj, interface, name=u''):
"""Find the nearest adapter in the url chain between obj and interface.
The function looks upward though the canonical url chain and returns a
tuple of (object, adapter).
:return (None, None): if there is no object that has such an adapter
in the url chain.
"""
for current_obj in canonical_url_iterator(obj):
adapter = queryAdapter(current_obj, interface, name=name)
if adapter is not None:
return (current_obj, adapter)
return (None, None)
def nearest_adapter(obj, interface, name=u''):
"""Find the nearest adapter in the url chain between obj and interface.
The function looks upward though the canonical url chain and returns
the first adapter it finds.
:return None: if there is no object that has such an adapter in the url
chain.
"""
context, adapter = nearest_context_with_adapter(obj, interface, name=name)
# Will be None, None if not found.
return adapter
def nearest_provides_or_adapted(obj, interface):
"""Find the nearest object that provides or can be adapted to `interface`.
The function looks upward through the canonical url chain.
:return None: if there is no object that provides or can be adapted in
the url chain.
"""
try:
for curr_obj in canonical_url_iterator(obj):
# If the curr_obj implements the interface, it is returned.
impl = interface(curr_obj, None)
if impl is not None:
return impl
except NoCanonicalUrl:
# Do not break when canonical URL is not defined for an object.
pass
return None
|