[Zope3-checkins] CVS: Zope3/src/zope/app/interfaces - annotation.py:1.1.2.4 dependable.py:1.1.2.2 dublincore.py:1.1.2.2 event.py:1.1.2.3 forms.py:1.1.2.3 introspector.py:1.1.2.2 rdb.py:1.1.2.4 schemagen.py:1.1.2.3 undo.py:1.1.2.2 workflow.py:1.1.2.2
Tim Peters
tim.one@comcast.net
Tue, 24 Dec 2002 21:21:35 -0500
Update of /cvs-repository/Zope3/src/zope/app/interfaces
In directory cvs.zope.org:/tmp/cvs-serv19240/src/zope/app/interfaces
Modified Files:
Tag: NameGeddon-branch
annotation.py dependable.py dublincore.py event.py forms.py
introspector.py rdb.py schemagen.py undo.py workflow.py
Log Message:
Whitespace normalization, via Python's Tools/scripts/reindent.py. The
files are fixed-points of that script now. Fixed a few cases where
code relied on significant trailing whitespace (ouch).
=== Zope3/src/zope/app/interfaces/annotation.py 1.1.2.3 => 1.1.2.4 ===
--- Zope3/src/zope/app/interfaces/annotation.py:1.1.2.3 Mon Dec 23 16:25:01 2002
+++ Zope3/src/zope/app/interfaces/annotation.py Tue Dec 24 21:20:31 2002
@@ -2,14 +2,14 @@
#
# Copyright (c) 2001, 2002 Zope Corporation and Contributors.
# All Rights Reserved.
-#
+#
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
-#
+#
##############################################################################
"""
@@ -23,10 +23,10 @@
class IAnnotatable(Interface):
"""
Marker interface for objects that support storing annotations.
-
+
This interface says "There exists an adapter to an IAnnotations
for an object that implements IAnnotatable".
-
+
Classes should not directly declare that they implement this interface.
Instead they should implement an interface derived from this one, which
details how the annotations are to be stored, such as
=== Zope3/src/zope/app/interfaces/dependable.py 1.1.2.1 => 1.1.2.2 ===
--- Zope3/src/zope/app/interfaces/dependable.py:1.1.2.1 Mon Dec 23 14:31:41 2002
+++ Zope3/src/zope/app/interfaces/dependable.py Tue Dec 24 21:20:31 2002
@@ -2,14 +2,14 @@
#
# Copyright (c) 2002 Zope Corporation and Contributors.
# All Rights Reserved.
-#
+#
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
-#
+#
##############################################################################
"""
$Id$
@@ -18,25 +18,25 @@
from zope.interface import Interface
class IDependable(Interface):
- """Objects that other objects depend on.
-
- Note that IDependable will normally be implemented by an adapter.
- """
-
- def addDependent(location):
- """Add a dependency to a dependent object by location
-
- The location is the physical path to the dependent object.
- """
- def removeDependent(location):
- """Remove a dependency with a dependent object by location.
-
- The location is the physical path to the dependent object.
- """
- def dependents():
- """Return a sequence of dependent object locations.
- """
-
+ """Objects that other objects depend on.
+
+ Note that IDependable will normally be implemented by an adapter.
+ """
+
+ def addDependent(location):
+ """Add a dependency to a dependent object by location
+
+ The location is the physical path to the dependent object.
+ """
+ def removeDependent(location):
+ """Remove a dependency with a dependent object by location.
+
+ The location is the physical path to the dependent object.
+ """
+ def dependents():
+ """Return a sequence of dependent object locations.
+ """
+
__doc__ = IDependable.__doc__ + __doc__
@@ -46,4 +46,3 @@
class DependencyError(Exception):
""" This object is dependable"""
-
=== Zope3/src/zope/app/interfaces/dublincore.py 1.1.2.1 => 1.1.2.2 ===
--- Zope3/src/zope/app/interfaces/dublincore.py:1.1.2.1 Mon Dec 23 14:31:41 2002
+++ Zope3/src/zope/app/interfaces/dublincore.py Tue Dec 24 21:20:31 2002
@@ -2,14 +2,14 @@
#
# Copyright (c) 2002 Zope Corporation and Contributors.
# All Rights Reserved.
-#
+#
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
-#
+#
##############################################################################
"""
$Id$
@@ -46,7 +46,7 @@
u"The date and time that an object is created. "
u"\nThis is normally set automatically."
)
-
+
modified = Datetime(
title = u'Modification Date',
description =
@@ -63,7 +63,7 @@
description =
u"The date and time that an object should be published. "
)
-
+
expires = Datetime(
title = u'Expiration Date',
@@ -103,7 +103,7 @@
u"The unqualified Dublin Core 'Contributor' element values",
value_types = (TextLine(),),
)
-
+
@@ -116,7 +116,7 @@
class ICMFDublinCore(Interface):
"""This interface duplicates the CMF dublinc core interface.
"""
-
+
def Title():
"""Return the resource title.
@@ -124,7 +124,7 @@
returned as a unicode string if an unqualified element is
defined, otherwise, an empty unicode string is returned.
"""
-
+
def Creator():
"""Return the resource creators.
@@ -160,27 +160,27 @@
The first unqualified Dublin Core 'Publisher' element value is
returned as a unicode string if an unqualified element is
- defined, otherwise, an empty unicode string is returned.
+ defined, otherwise, an empty unicode string is returned.
"""
def Contributors():
"""Return the resource contributors
Return any additional collaborators.
-
+
The unqualified Dublin Core 'Contributor' element values are
returned as a sequence of unicode strings.
"""
-
+
def Date():
"""Return the default date
The first unqualified Dublin Core 'Date' element value is
returned as a unicode string if an unqualified element is
defined, otherwise, an empty unicode string is returned. The
- string is formatted 'YYYY-MM-DD H24:MN:SS TZ'.
+ string is formatted 'YYYY-MM-DD H24:MN:SS TZ'.
"""
-
+
def CreationDate():
"""Return the creation date.
@@ -189,7 +189,7 @@
element is defined, otherwise, an empty unicode string is
returned. The string is formatted 'YYYY-MM-DD H24:MN:SS TZ'.
"""
-
+
def EffectiveDate():
"""Return the effective date
@@ -198,7 +198,7 @@
element is defined, otherwise, an empty unicode string is
returned. The string is formatted 'YYYY-MM-DD H24:MN:SS TZ'.
"""
-
+
def ExpirationDate():
"""Date resource expires.
@@ -207,7 +207,7 @@
element is defined, otherwise, an empty unicode string is
returned. The string is formatted 'YYYY-MM-DD H24:MN:SS TZ'.
"""
-
+
def ModificationDate():
"""Date resource last modified.
@@ -225,7 +225,7 @@
The first unqualified Dublin Core 'Type' element value is
returned as a unicode string if an unqualified element is
defined, otherwise, an empty unicode string is returned. The
- string is formatted 'YYYY-MM-DD H24:MN:SS TZ'.
+ string is formatted 'YYYY-MM-DD H24:MN:SS TZ'.
"""
def Format():
@@ -237,7 +237,7 @@
The first unqualified Dublin Core 'Format' element value is
returned as a unicode string if an unqualified element is
defined, otherwise, an empty unicode string is returned. The
- string is formatted 'YYYY-MM-DD H24:MN:SS TZ'.
+ string is formatted 'YYYY-MM-DD H24:MN:SS TZ'.
"""
def Identifier():
@@ -256,7 +256,7 @@
The first unqualified Dublin Core 'Language' element value is
returned as a unicode string if an unqualified element is
defined, otherwise, an empty unicode string is returned. The
- string is formatted 'YYYY-MM-DD H24:MN:SS TZ'.
+ string is formatted 'YYYY-MM-DD H24:MN:SS TZ'.
"""
def Rights():
@@ -268,10 +268,10 @@
The first unqualified Dublin Core 'Rights' element value is
returned as a unicode string if an unqualified element is
defined, otherwise, an empty unicode string is returned. The
- string is formatted 'YYYY-MM-DD H24:MN:SS TZ'.
+ string is formatted 'YYYY-MM-DD H24:MN:SS TZ'.
"""
-
+
__doc__ = ICMFDublinCore.__doc__ + __doc__
=== Zope3/src/zope/app/interfaces/event.py 1.1.2.2 => 1.1.2.3 ===
--- Zope3/src/zope/app/interfaces/event.py:1.1.2.2 Mon Dec 23 15:49:36 2002
+++ Zope3/src/zope/app/interfaces/event.py Tue Dec 24 21:20:31 2002
@@ -2,14 +2,14 @@
#
# Copyright (c) 2002, 2003 Zope Corporation and Contributors.
# All Rights Reserved.
-#
+#
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
-#
+#
##############################################################################
"""
=== Zope3/src/zope/app/interfaces/forms.py 1.1.2.2 => 1.1.2.3 ===
--- Zope3/src/zope/app/interfaces/forms.py:1.1.2.2 Mon Dec 23 15:49:36 2002
+++ Zope3/src/zope/app/interfaces/forms.py Tue Dec 24 21:20:31 2002
@@ -119,7 +119,7 @@
title = Attribute("The widget title")
required = Attribute("Flag indicating whether the field is required")
-
+
def setData(value):
"""Set the default data for the widget.
=== Zope3/src/zope/app/interfaces/introspector.py 1.1.2.1 => 1.1.2.2 ===
--- Zope3/src/zope/app/interfaces/introspector.py:1.1.2.1 Mon Dec 23 14:31:41 2002
+++ Zope3/src/zope/app/interfaces/introspector.py Tue Dec 24 21:20:31 2002
@@ -2,14 +2,14 @@
#
# Copyright (c) 2001, 2002 Zope Corporation and Contributors.
# All Rights Reserved.
-#
+#
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
-#
+#
##############################################################################
from zope.interface import Interface
@@ -18,28 +18,28 @@
def isInterface():
"Checks if the context is class or interface"
-
+
def setRequest(request):
"""sets the request"""
-
+
def getClass():
"""Returns the class name"""
def getBaseClassNames():
"""Returns the names of the classes"""
-
+
def getModule():
"""Returns the module name of the class"""
-
+
def getDocString():
"""Returns the description of the class"""
-
+
def getInterfaces():
"""Returns interfaces implemented by this class"""
def getInterfaceNames():
"""Returns the name of the interface"""
-
+
def getInterfaceDetails():
"""Returns the entire documentation in the interface"""
@@ -47,5 +47,4 @@
"""Returns all the class extended up to the top most level"""
def getInterfaceConfiguration():
- """Returns details for a interface configuration"""
-
+ """Returns details for a interface configuration"""
=== Zope3/src/zope/app/interfaces/rdb.py 1.1.2.3 => 1.1.2.4 ===
--- Zope3/src/zope/app/interfaces/rdb.py:1.1.2.3 Mon Dec 23 18:01:14 2002
+++ Zope3/src/zope/app/interfaces/rdb.py Tue Dec 24 21:20:31 2002
@@ -2,14 +2,14 @@
#
# Copyright (c) 2002 Zope Corporation and Contributors.
# All Rights Reserved.
-#
+#
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
-#
+#
##############################################################################
"""Relational Database Adapter interfaces.
@@ -29,7 +29,7 @@
class IDBITypeInfo(Interface):
"""Database adapter specific information"""
-
+
paramstyle = Attribute("""
String constant stating the type of parameter marker formatting
expected by the interface. Possible values are [2]:
@@ -128,13 +128,13 @@
Modules are free to implement this method using multiple calls to the
execute() method or by using array operations to have the database
process the sequence as a whole in one call.
-
+
The same comments as for execute() also apply accordingly to this
method.
- Return values are not defined.
+ Return values are not defined.
"""
-
+
def fetchone():
"""Fetch the next row of a query result set, returning a single
sequence, or None when no more data is available. [6]
@@ -172,7 +172,7 @@
An Error (or subclass) exception is raised if the previous call to
executeXXX() did not produce any result set or no call was issued yet.
"""
-
+
class IResultSet(Interface):
"""Holds results, and allows iteration."""
@@ -259,13 +259,13 @@
Modules are free to implement this method using multiple calls to the
execute() method or by using array operations to have the database
process the sequence as a whole in one call.
-
+
The same comments as for execute() also apply accordingly to this
method.
- Return values are not defined.
+ Return values are not defined.
"""
-
+
def fetchone():
"""Fetch the next row of a query result set, returning a single
sequence, or None when no more data is available. [6]
@@ -319,10 +319,10 @@
class IDBIConnection(Interface):
"""A DB-API based Interface """
-
+
def cursor():
"""Return a new ICursor Object using the connection.
-
+
If the database does not provide a direct cursor concept, the module
will have to emulate cursors using other means to the extent needed by
this specification. """
@@ -335,7 +335,7 @@
Database modules that do not support transactions should implement
this method with void functionality.
"""
-
+
def rollback():
"""In case a database does provide transactions this method causes the
database to roll back to the start of any pending transaction. Closing
@@ -352,7 +352,7 @@
class ISQLCommand(Interface):
"""Static SQL commands."""
-
+
connectionName = Attribute("""The name of the database connection
to use in getConnection """)
@@ -393,7 +393,7 @@
class IZopeConnection(IDBIConnection, IDBITypeInfoProvider):
# XXX What does the next paragraph mean?
-
+
# An implementation of this object will be exposed to the
# user. Therefore the Zope connection represents a connection in
# the Zope sense, meaning that the object might not be actually
@@ -401,7 +401,7 @@
def cursor():
"""Return an IZopeCursor object."""
-
+
def registerForTxn():
"""Join the current transaction.
=== Zope3/src/zope/app/interfaces/schemagen.py 1.1.2.2 => 1.1.2.3 ===
--- Zope3/src/zope/app/interfaces/schemagen.py:1.1.2.2 Mon Dec 23 15:49:36 2002
+++ Zope3/src/zope/app/interfaces/schemagen.py Tue Dec 24 21:20:31 2002
@@ -19,7 +19,7 @@
"""
from zope.interface import Interface, Attribute
-
+
class ITypeRepresentation(Interface):
"""Provide a textual representation of object
@@ -35,9 +35,9 @@
def getTypes():
"""Return the sequence of types this representation can represent.
"""
-
+
class ISchemaSpec(Interface):
-
+
def addField(name, field):
"""Add a field to schema.
@@ -57,11 +57,10 @@
def insertField(name, field, position):
"""Insert a field at position.
"""
-
+
def moveField(name, position):
"""Move field to position.
"""
-
+
def generateModuleSource(self):
pass
-
=== Zope3/src/zope/app/interfaces/undo.py 1.1.2.1 => 1.1.2.2 ===
--- Zope3/src/zope/app/interfaces/undo.py:1.1.2.1 Mon Dec 23 14:31:41 2002
+++ Zope3/src/zope/app/interfaces/undo.py Tue Dec 24 21:20:31 2002
@@ -2,28 +2,28 @@
#
# Copyright (c) 2001, 2002 Zope Corporation and Contributors.
# All Rights Reserved.
-#
+#
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
-#
+#
##############################################################################
from zope.interface import Interface
class IUndoManager(Interface):
" Interface for the Undo Manager "
-
+
def getUndoInfo():
- """
+ """
Gets all undo information.
Note: at the moment, doesnt care where called from
returns sequence of mapping objects by date desc
-
+
keys of mapping objects:
id -> internal id for zodb
user_name -> name of user that last accessed the file
@@ -38,4 +38,3 @@
iterate over each id in list, and undo
the transaction item.
"""
-
=== Zope3/src/zope/app/interfaces/workflow.py 1.1.2.1 => 1.1.2.2 ===
--- Zope3/src/zope/app/interfaces/workflow.py:1.1.2.1 Mon Dec 23 14:31:41 2002
+++ Zope3/src/zope/app/interfaces/workflow.py Tue Dec 24 21:20:31 2002
@@ -2,14 +2,14 @@
#
# Copyright (c) 2001, 2002 Zope Corporation and Contributors.
# All Rights Reserved.
-#
+#
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
-#
+#
##############################################################################
"""
Interfaces for workflow-related events.
@@ -154,7 +154,7 @@
"""
pass
-
+
def setActive():
"""
Change the status to Active according to the state machine
@@ -168,13 +168,13 @@
"""
pass
-
+
def listWorkitems():
"""
List all contained workitems
"""
pass
-
+
def listActiveWorkitems():
"""
@@ -189,7 +189,7 @@
"""
pass
-
+
"""
@@ -300,7 +300,7 @@
by the present engines
"""
-
+
from zope.interface import Interface
@@ -332,9 +332,3 @@
def getProcessDefinition(process_definition_id):
"""
"""
-
-
-
-
-
-