[Checkins] SVN: zc.objectlog/trunk/src/zc/objectlog/ normalized
whitespace
Fred L. Drake, Jr.
fdrake at gmail.com
Tue Nov 7 21:54:34 EST 2006
Log message for revision 71096:
normalized whitespace
Changed:
U zc.objectlog/trunk/src/zc/objectlog/copier.txt
U zc.objectlog/trunk/src/zc/objectlog/log.txt
-=-
Modified: zc.objectlog/trunk/src/zc/objectlog/copier.txt
===================================================================
--- zc.objectlog/trunk/src/zc/objectlog/copier.txt 2006-11-07 20:27:59 UTC (rev 71095)
+++ zc.objectlog/trunk/src/zc/objectlog/copier.txt 2006-11-08 02:54:33 UTC (rev 71096)
@@ -2,7 +2,7 @@
zc.copy.copy (and thus the replacement ObjectCopier also in the
same module) so that copies of objects with an object log get fresh logs.
-For instance, consider the following.
+For instance, consider the following.
>>> import zope.interface
>>> import zope.schema
Modified: zc.objectlog/trunk/src/zc/objectlog/log.txt
===================================================================
--- zc.objectlog/trunk/src/zc/objectlog/log.txt 2006-11-07 20:27:59 UTC (rev 71095)
+++ zc.objectlog/trunk/src/zc/objectlog/log.txt 2006-11-08 02:54:33 UTC (rev 71096)
@@ -2,19 +2,19 @@
objectlog
=========
-The objectlog package provides a customizable log for a single object. The
+The objectlog package provides a customizable log for a single object. The
system was designed to provide information for a visual log of important
-object changes and to provide analyzable information for metrics.
+object changes and to provide analyzable information for metrics.
-- It provides automatic recording for each log entry of a timestamp and the
+- It provides automatic recording for each log entry of a timestamp and the
principals in the request when the log was made.
-- Given a schema of data to collect about the object, it automatically
- calculates and stores changesets from the last log entry, primarily to
+- Given a schema of data to collect about the object, it automatically
+ calculates and stores changesets from the last log entry, primarily to
provide a quick and easy answer to the question "what changed?" and
secondarily to reduce database size.
-- It accepts optional summary and detail values that allow the system or users
+- It accepts optional summary and detail values that allow the system or users
to annotate the entries with human-readable messages.
- It allows each log entry to be annotated with zero or more marker interfaces
@@ -23,7 +23,7 @@
Moreover, the log entries can be set to occur at transition boundaries, and
to only ocur if a change was made (according to the changeset) since the last
log entry.
-
+
To show this, we need to set up a dummy interaction. We do this below, then
create an object with a log, then actually make a log.
@@ -60,7 +60,7 @@
>>> ztapi.provideUtility(
... zope.app.security.interfaces.IAuthentication, auth)
>>> import zope.publisher.interfaces
-
+
>>> import zc.objectlog
>>> import zope.location
>>> WORKING = u"Where I'm working"
@@ -74,7 +74,7 @@
... title=u"Location", required=False)
... weight = schema.Int(title=u"Weight in Pounds", required=True)
... getAge, = schema.accessors(
- ... schema.Int(title=u"Age in Years", readonly=True,
+ ... schema.Int(title=u"Age in Years", readonly=True,
... required=False))
...
>>> import persistent
@@ -112,7 +112,7 @@
True
>>> before = datetime.datetime.now(pytz.utc)
>>> entry = emily.log(
- ... u'Starting to keep track of Emily',
+ ... u'Starting to keep track of Emily',
... u'Looks like\nshe might go upstairs soon')
>>> entry is emily.log[0]
True
@@ -290,7 +290,7 @@
4
>>> success = emily.log(u"Yay, unicode")
-The following is commented out until we have more
+The following is commented out until we have more
# >>> emily.log(u"Data without an interface won't work", None, 'boo hoo')
Traceback (most recent call last):
@@ -326,7 +326,7 @@
# >>> emily.log[4].data[0].dry_food
1
-__getitem__ and __iter__ work as normal for a Python sequence, including
+__getitem__ and __iter__ work as normal for a Python sequence, including
support for extended slices.
>>> list(emily.log) == [emily.log[0], emily.log[1], emily.log[2],
@@ -412,8 +412,8 @@
>>> emily.log[0].next is emily.log[1]
True
-Objectlogs also support deferring until the end of a transaction. To show
-this, we will need a sample database, a transaction, and key reference
+Objectlogs also support deferring until the end of a transaction. To show
+this, we will need a sample database, a transaction, and key reference
adapters. We show the simplest example first.
>>> from ZODB.tests import util
@@ -451,7 +451,7 @@
>>> emily.log[6].record_changes
{}
-While this is interesting, the point is to capture changes to the object,
+While this is interesting, the point is to capture changes to the object,
whether or not they happened when the log was called. Here is a more pertinent
example, then.
@@ -485,7 +485,7 @@
>>> emily.log[9].summary
u'Two log'
-Another option is if_changed. It should not make a log unless there was a
+Another option is if_changed. It should not make a log unless there was a
change.
>>> len(emily.log)
@@ -508,7 +508,7 @@
The two options, if_changed and defer, can be used together. This makes for
a log entry that will only be made at a transition boundary if there have
been no previous changes. Note that a log entry that occurs whether or not
-changes were made (hereafter called a "required" log entry) that is also
+changes were made (hereafter called a "required" log entry) that is also
deferred will always eliminate any deferred is_changed log entry, even if the
required log entry was registered later in the transaction.
@@ -575,4 +575,3 @@
>>> # TEAR DOWN
>>> zope.security.management.endInteraction()
>>> ztapi.unprovideUtility(zope.app.security.interfaces.IAuthentication)
-
More information about the Checkins
mailing list