Mercurial Repository: p/roundup/code: roundup/hyperdb.py comparison

comparison roundup/hyperdb.py @ 2909:2fc6c508b537

Database instances must have method close() trim trailing spaces, fix vim modeline

author	Alexander Smishlajev <a1s@users.sourceforge.net>
date	Sat, 13 Nov 2004 07:11:14 +0000
parents	a8808157f892
children	4607f58a007b

comparison

equal deleted inserted replaced

-:95813789cf70
+:2fc6c508b537
 # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 # FOR A PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 #
-# $Id: hyperdb.py,v 1.105 2004-11-12 04:07:03 richard Exp $
+# $Id: hyperdb.py,v 1.106 2004-11-13 07:11:14 a1s Exp $
 """Hyperdatabase implementation, especially field types.
 """
 __docformat__ = 'restructuredtext'
 Class.set(), and Class.retire() methods are disabled.
 """
 raise NotImplementedError
 def post_init(self):
 """Called once the schema initialisation has finished.
 If 'refresh' is true, we want to rebuild the backend
 structures.
 """
 raise NotImplementedError
 '''
 raise NotImplementedError
 def storefile(self, classname, nodeid, property, content):
 '''Store the content of the file in the database.
 The property may be None, in which case the filename does not
 indicate which property is being saved.
 '''
 raise NotImplementedError
 Undo all the changes made since the database was opened or the last
 commit() or rollback() was performed.
 '''
 raise NotImplementedError
+def close(self):
+"""Close the database.
+This method must be called at the end of processing.
+"""
 #
 # The base Class class
 #
 class Class:
 """ The handle to a particular class of nodes in a hyperdatabase.
 All methods except __repr__ and getnode must be implemented by a
 concrete backend Class.
 """
 def __init__(self, db, classname, **properties):
 The keyword arguments in 'propvalues' map property names to values.
 The values of arguments must be acceptable for the types of their
 corresponding properties or a TypeError is raised.
 If this class has a key property, it must be present and its value
 must not collide with other key strings or a ValueError is raised.
 Any other properties on this class that are missing from the
 'propvalues' dictionary are set to None.
 If an id in a link or multilink property does not refer to a valid
 node, an IndexError is raised.
 """
 raise NotImplementedError
 '''
 raise NotImplementedError
 def set(self, nodeid, **propvalues):
 """Modify a property on an existing node of this class.
 'nodeid' must be the id of an existing node of this class or an
 IndexError is raised.
 Each key in 'propvalues' must be the name of a property of this
 class or a KeyError is raised.
 """
 raise NotImplementedError
 def retire(self, nodeid):
 """Retire a node.
 The properties on the node remain available from the get() method,
 and the node's id is never reused.
 Retired nodes are not returned by the find(), list(), or lookup()
 methods, and other nodes may reuse the values of their key properties.
 """
 raise NotImplementedError
 '''Restpre a retired node.
 Make node available for all operations like it was before retirement.
 '''
 raise NotImplementedError
 def is_retired(self, nodeid):
 '''Return true if the node is rerired
 '''
 raise NotImplementedError
 def destroy(self, nodeid):
 """Destroy a node.
 WARNING: this method should never be used except in extremely rare
 situations where there could never be links to the node being
 deleted
 WARNING: use retire() instead
 raise NotImplementedError
 def find(self, **propspec):
 """Get the ids of nodes in this class which link to the given nodes.
 'propspec' consists of keyword args propname={nodeid:1,}
 'propname' must be the name of a property in this class, or a
 KeyError is raised.  That property must be a Link or Multilink
 property, or a TypeError is raised.
 Any node in this class whose 'propname' property links to any of the
 for name in self.cl.getprops(protected=protected).keys():
 l.append((name, self.cl.get(self.nodeid, name)))
 return l
 def has_key(self, name):
 return self.cl.getprops().has_key(name)
 def get(self, name, default=None):
 if self.has_key(name):
 return self[name]
 else:
 return default
 def __getattr__(self, name):
 cl = Class(db, name, name=String(), order=String())
 for i in range(len(options)):
 cl.create(name=options[i], order=i)
 return hyperdb.Link(name)
-# vim: set filetype=python ts=4 sw=4 et si
+# vim: set filetype=python sts=4 sw=4 et si :

Mercurial > p > roundup > code

comparison roundup/hyperdb.py @ 2909:2fc6c508b537