1
=== modified file 'src/lazr/lifecycle/NEWS.txt'
2
--- src/lazr/lifecycle/NEWS.txt	2009-08-31 14:37:56 +0000
3
+++ src/lazr/lifecycle/NEWS.txt	2009-12-03 18:31:09 +0000
4
@@ -2,6 +2,12 @@
5
2
NEWS for lazr.lifecycle
2
NEWS for lazr.lifecycle
6
3
=======================
3
=======================
7
4
4
8
5
1.1 (2009-12-03)
9
6
================
10
7
11
8
- Add IDoNotSnapshot and doNotSnapshot to allow the exclusion of
12
9
certain fields.
13
10
14
5
1.0 (2009-08-31)
11
1.0 (2009-08-31)
15
6
================
12
================
16
7
13
17
8
14
18
=== modified file 'src/lazr/lifecycle/docs/snapshot.txt'
19
--- src/lazr/lifecycle/docs/snapshot.txt	2009-03-05 17:51:50 +0000
20
+++ src/lazr/lifecycle/docs/snapshot.txt	2009-12-03 18:31:09 +0000
21
@@ -5,15 +5,17 @@
22
5
initial state of the object before the modifications. The Snapshot class can
5
initial state of the object before the modifications. The Snapshot class can
23
6
be used to easily represent such states:
6
be used to easily represent such states:
24
7
7
26
8
    >>> from zope.interface import Interface, implements, Attribute
8
    >>> from zope.interface import (
27
9
    ...     alsoProvides, Attribute, Interface, implements)
28
9
    >>> from zope.schema import List, TextLine, Text
10
    >>> from zope.schema import List, TextLine, Text
30
10
    >>> from lazr.lifecycle.snapshot import Snapshot
11
    >>> from lazr.lifecycle.snapshot import doNotSnapshot, Snapshot
31
11
12
32
12
    >>> class IFoo(Interface):
13
    >>> class IFoo(Interface):
33
13
    ...     title = TextLine(title=u'My Title')
14
    ...     title = TextLine(title=u'My Title')
34
14
    ...     description = Text(title=u'Description')
15
    ...     description = Text(title=u'Description')
35
15
    ...     remotes = List(title=u'remotes')
16
    ...     remotes = List(title=u'remotes')
36
16
    ...     totals = Attribute('totals')
17
    ...     totals = Attribute('totals')
37
18
    ...     ignore_me = doNotSnapshot(Attribute('ignored attribute'))
38
17
19
39
18
    >>> class Foo:
20
    >>> class Foo:
40
19
    ...     implements(IFoo)
21
    ...     implements(IFoo)
41
@@ -64,7 +66,7 @@
42
64
    ...
66
    ...
43
65
    SnapshotCreationError: ...
67
    SnapshotCreationError: ...
44
66
68
46
67
If no names argument is supplied, the snapshot will contain all 
69
If no names argument is supplied, the snapshot will contain all
47
68
IFields of the specified interface(s).
70
IFields of the specified interface(s).
48
69
71
49
70
    >>> snapshot = Snapshot(foo, providing=IFoo)
72
    >>> snapshot = Snapshot(foo, providing=IFoo)
50
@@ -73,7 +75,7 @@
51
73
    >>> hasattr(snapshot, 'description')
75
    >>> hasattr(snapshot, 'description')
52
74
    True
76
    True
53
75
77
55
76
(Totals is not a Fields so isn't copied over).
78
Totals is not a Fields so isn't copied over.
56
77
79
57
78
    >>> hasattr(snapshot, 'totals')
80
    >>> hasattr(snapshot, 'totals')
58
79
    False
81
    False
59
@@ -82,6 +84,12 @@
60
82
    >>> snapshot.remotes == ["OK"]
84
    >>> snapshot.remotes == ["OK"]
61
83
    True
85
    True
62
84
86
63
87
Fields can be explicitly ignored if they provide the IDoNotSnapshot
64
88
interface.
65
89
66
90
    >>> hasattr(snapshot, 'ignore_me')
67
91
    False
68
92
69
85
We can also give more than one interface to provide as an iterable. If
93
We can also give more than one interface to provide as an iterable. If
70
86
we don't specify any names, all the names in the given interfaces will
94
we don't specify any names, all the names in the given interfaces will
71
87
be copied:
95
be copied:
72
@@ -166,4 +174,3 @@
73
166
174
74
167
    >>> getSiteManager().unregisterAdapter(snapshot_iterable)
175
    >>> getSiteManager().unregisterAdapter(snapshot_iterable)
75
168
    True
176
    True
76
169
77
170
177
78
=== modified file 'src/lazr/lifecycle/interfaces.py'
79
--- src/lazr/lifecycle/interfaces.py	2009-03-24 16:17:11 +0000
80
+++ src/lazr/lifecycle/interfaces.py	2009-12-03 18:31:09 +0000
81
@@ -18,6 +18,7 @@
82
18
18
83
19
__metaclass__ = type
19
__metaclass__ = type
84
20
__all__ = [
20
__all__ = [
85
21
    'IDoNotSnapshot',
86
21
    'IObjectCreatedEvent',
22
    'IObjectCreatedEvent',
87
22
    'IObjectDeletedEvent',
23
    'IObjectDeletedEvent',
88
23
    'IObjectModifiedEvent',
24
    'IObjectModifiedEvent',
89
@@ -57,3 +58,11 @@
90
57
    lookup. The snapshot value is what should be returned from the adapter
58
    lookup. The snapshot value is what should be returned from the adapter
91
58
    lookup.
59
    lookup.
92
59
    """
60
    """
93
61
94
62
95
63
class IDoNotSnapshot(Interface):
96
64
    """Marker interface for attributes to exclude from the snapshot.
97
65
98
66
    Some attributes such as collections should not be included as part of the
99
67
    snapshot as they may be huge and not intrinsic to the object.
100
68
    """
101
60
69
102
=== modified file 'src/lazr/lifecycle/snapshot.py'
103
--- src/lazr/lifecycle/snapshot.py	2009-03-24 16:17:11 +0000
104
+++ src/lazr/lifecycle/snapshot.py	2009-12-03 18:31:09 +0000
105
@@ -21,21 +21,32 @@
106
21
21
107
22
__metaclass__ = type
22
__metaclass__ = type
108
23
23
112
24
__all__ = ['SnapshotCreationError',
24
__all__ = [
113
25
           'Snapshot',
25
    'doNotSnapshot',
114
26
           ]
26
    'SnapshotCreationError',
115
27
    'Snapshot',
116
28
    ]
117
27
29
118
28
from zope.component import queryAdapter
30
from zope.component import queryAdapter
119
29
from zope.interface.interfaces import IInterface
31
from zope.interface.interfaces import IInterface
121
30
from zope.interface import directlyProvides
32
from zope.interface import alsoProvides, directlyProvides
122
31
from zope.schema.interfaces import IField
33
from zope.schema.interfaces import IField
123
34
from zope.schema import Field
124
32
from zope.security.proxy import removeSecurityProxy
35
from zope.security.proxy import removeSecurityProxy
125
33
36
127
34
from lazr.lifecycle.interfaces import ISnapshotValueFactory
37
from lazr.lifecycle.interfaces import (
128
38
    IDoNotSnapshot, ISnapshotValueFactory)
129
39
130
35
40
131
36
_marker = object()
41
_marker = object()
132
37
42
133
38
43
134
44
def doNotSnapshot(field):
135
45
    """Simple wrapper method to provide `IDoNotSnapshot`."""
136
46
    alsoProvides(field, IDoNotSnapshot)
137
47
    return field
138
48
139
49
140
39
class SnapshotCreationError(Exception):
50
class SnapshotCreationError(Exception):
141
40
    """Something went wrong while creating a snapshot."""
51
    """Something went wrong while creating a snapshot."""
142
41
52
143
@@ -66,7 +77,8 @@
144
66
            for iface in providing:
77
            for iface in providing:
145
67
                for name in iface.names(all=True):
78
                for name in iface.names(all=True):
146
68
                    field = iface[name]
79
                    field = iface[name]
148
69
                    if IField.providedBy(field):
80
                    if (IField.providedBy(field) and
149
81
                        not IDoNotSnapshot.providedBy(field)):
150
70
                        names.add(name)
82
                        names.add(name)
151
71
83
152
72
        for name in names:
84
        for name in names:
153
73
85
154
=== modified file 'src/lazr/lifecycle/version.txt'
155
--- src/lazr/lifecycle/version.txt	2009-08-29 16:09:41 +0000
156
+++ src/lazr/lifecycle/version.txt	2009-12-03 18:31:09 +0000
157
@@ -1,1 +1,1 @@
159
1
1.0
1
1.1
Reviewer	Review Type	Date Requested	Status
Gary Poster	code	2009-12-03	Approve on 2009-12-03
Review via email: mp+15612@code.launchpad.net