Merge tseaver-persistent_as_egg branch.

buildout.cfg

 [buildout]
 develop = .
-parts = test scripts
-
+parts =
+    test
+    scripts
 versions = versions
 
 [versions]
 zc.recipe.testrunner = 1.3.0
+persistent = 4.0.0
 
 [test]
 recipe = zc.recipe.testrunner
-eggs = ZODB3 [test]
+eggs =
+    persistent
+    ZODB3 [test]
 initialization = 
   import os, tempfile
   try: os.mkdir('tmp')
@@ -19,5 +23,7 @@ defaults = ['--all']
 
 [scripts]
 recipe = zc.recipe.egg
-eggs = ZODB3 [test]
+eggs =
+    persistent
+    ZODB3 [test]
 interpreter = py

setup.py

@@ -35,6 +35,7 @@ if sys.version_info < (2, 5):
     sys.exit(0)
 
 
+
 if sys.version_info < (2, 6):
     transaction_version = 'transaction == 1.1.1'
     manuel_version = 'manuel < 1.6dev'
@@ -59,7 +60,26 @@ Framework :: ZODB
 """
 
 # Include directories for C extensions
-include = ['src']
+# Sniff the location of the headers in 'persistent'.
+
+class ModuleHeaderDir(object):
+
+    def __init__(self, require_spec, where='..'):
+        # By default, assume top-level pkg has the same name as the dist.
+        # Also assume that headers are located in the package dir, and
+        # are meant to be included as follows:
+        #    #include "module/header_name.h"
+        self._require_spec = require_spec
+        self._where = where
+
+    def __str__(self):
+        from pkg_resources import require
+        from pkg_resources import resource_filename
+        require(self._require_spec)
+        return os.path.abspath(
+                    resource_filename(self._require_spec, self._where))
+
+include = [ModuleHeaderDir('persistent'), 'src']
 
 # Set up dependencies for the BTrees package
 base_btrees_depends = [
@@ -72,7 +92,6 @@ base_btrees_depends = [
     "src/BTrees/SetTemplate.c",
     "src/BTrees/TreeSetTemplate.c",
     "src/BTrees/sorters.c",
-    "src/persistent/cPersistence.h",
     ]
 
 _flavors = {"O": "object", "I": "int", "F": "float", 'L': 'int'}
@@ -80,6 +99,7 @@ _flavors = {"O": "object", "I": "int", "F": "float", 'L': 'int'}
 KEY_H = "src/BTrees/%skeymacros.h"
 VALUE_H = "src/BTrees/%svaluemacros.h"
 
+
 def BTreeExtension(flavor):
     key = flavor[0]
     value = flavor[1]
@@ -100,35 +120,6 @@ exts = [BTreeExtension(flavor)
                        "fs", "LO", "OL", "LL", "LF",
                        )]
 
-cPersistence = Extension(name = 'persistent.cPersistence',
-                         include_dirs = include,
-                         sources= ['src/persistent/cPersistence.c',
-                                   'src/persistent/ring.c'],
-                         depends = ['src/persistent/cPersistence.h',
-                                    'src/persistent/ring.h',
-                                    'src/persistent/ring.c']
-                         )
-
-cPickleCache = Extension(name = 'persistent.cPickleCache',
-                         include_dirs = include,
-                         sources= ['src/persistent/cPickleCache.c',
-                                   'src/persistent/ring.c'],
-                         depends = ['src/persistent/cPersistence.h',
-                                    'src/persistent/ring.h',
-                                    'src/persistent/ring.c']
-                         )
-
-TimeStamp = Extension(name = 'persistent.TimeStamp',
-                      include_dirs = include,
-                      sources= ['src/persistent/TimeStamp.c']
-                      )
-
-
-exts += [cPersistence,
-         cPickleCache,
-         TimeStamp,
-        ]
-
 def _modname(path, base, name=''):
     if path == base:
         return name
@@ -184,14 +175,12 @@ long_description = str(
 
 setup(name="ZODB3",
       version=VERSION,
+      setup_requires=['persistent'],
       maintainer="Zope Foundation and Contributors",
       maintainer_email="zodb-dev@zope.org",
       packages = find_packages('src'),
       package_dir = {'': 'src'},
       ext_modules = exts,
-      headers = ['src/persistent/cPersistence.h',
-                 'src/persistent/py24compat.h',
-                 'src/persistent/ring.h'],
       license = "ZPL 2.1",
       platforms = ["any"],
       description = doclines[0],
@@ -200,8 +189,13 @@ setup(name="ZODB3",
       test_suite="__main__.alltests", # to support "setup.py test"
       tests_require = ['zope.testing', manuel_version],
       extras_require = dict(test=['zope.testing', manuel_version]),
+      # XXX: We don't really want to install these headers;  we would
+      #      prefer just including them so that folks can build from an sdist.
+      headers = ['include/persistent/cPersistence.h',
+                 'include/persistent/ring.h'],
       install_requires = [
         transaction_version,
+        'persistent',
         'zc.lockfile',
         'ZConfig',
         'zdaemon',

src/persistent/README.txt

-===================
-Persistence support
-===================
-
-(This document is under construction. More basic documentation will eventually
-appear here.)
-
-
-Overriding `__getattr__`, `__getattribute__`, `__setattr__`, and `__delattr__`
-------------------------------------------------------------------------------
-
-Subclasses can override the attribute-management methods.  For the
-`__getattr__` method, the behavior is like that for regular Python
-classes and for earlier versions of ZODB 3.
-
-For `__getattribute__`, __setattr__`, and `__delattr__`, it is necessary
-to call certain methods defined by `persistent.Persistent`.  Detailed
-examples and documentation is provided in the test module,
-`persistent.tests.test_overriding_attrs`.

src/persistent/__init__.py

-##############################################################################
-#
-# Copyright (c) 2001, 2002 Zope Foundation and Contributors.
-# All Rights Reserved.
-#
-# This software is subject to the provisions of the Zope Public License,
-# Version 2.1 (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
-#
-##############################################################################
-"""Provide access to Persistent and PersistentMapping.
-
-$Id$
-"""
-
-from cPersistence import Persistent, GHOST, UPTODATE, CHANGED, STICKY
-from cPickleCache import PickleCache
-
-from cPersistence import simple_new
-import copy_reg
-copy_reg.constructor(simple_new)
-
-# Make an interface declaration for Persistent,
-# if zope.interface is available.
-try:
-    from zope.interface import classImplements
-except ImportError:
-    pass
-else:
-    from persistent.interfaces import IPersistent
-    classImplements(Persistent, IPersistent)

src/persistent/cPersistence.h

-/*****************************************************************************
-
-  Copyright (c) 2001, 2002 Zope Foundation and Contributors.
-  All Rights Reserved.
-
-  This software is subject to the provisions of the Zope Public License,
-  Version 2.1 (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
-
- ****************************************************************************/
-
-#ifndef CPERSISTENCE_H
-#define CPERSISTENCE_H
-
-#include "Python.h"
-#include "py24compat.h"
-
-#include "ring.h"
-
-#define CACHE_HEAD \
-    PyObject_HEAD \
-    CPersistentRing ring_home; \
-    int non_ghost_count; \
-    PY_LONG_LONG total_estimated_size;
-
-struct ccobject_head_struct;
-
-typedef struct ccobject_head_struct PerCache;    
-
-/* How big is a persistent object?
-
-   12  PyGC_Head is two pointers and an int
-    8  PyObject_HEAD is an int and a pointer
- 
-   12  jar, oid, cache pointers
-    8  ring struct
-    8  serialno
-    4  state + extra
-    4  size info
-
-  (56) so far
-
-    4  dict ptr
-    4  weaklist ptr
-  -------------------------
-   68  only need 62, but obmalloc rounds up to multiple of eight
-
-  Even a ghost requires 64 bytes.  It's possible to make a persistent
-  instance with slots and no dict, which changes the storage needed.
-
-*/
-
-#define cPersistent_HEAD \
-    PyObject_HEAD \
-    PyObject *jar; \
-    PyObject *oid; \
-    PerCache *cache; \
-    CPersistentRing ring; \
-    char serial[8]; \
-    signed state:8;                              \
-    unsigned estimated_size:24;
-
-/* We recently added estimated_size.  We originally added it as a new
-   unsigned long field after a signed char state field and a
-   3-character reserved field.  This didn't work because there
-   are packages in the wild that have their own copies of cPersistence.h
-   that didn't see the update.  
-
-   To get around this, we used the reserved space by making
-   estimated_size a 24-bit bit field in the space occupied by the old
-   3-character reserved field.  To fit in 24 bits, we made the units
-   of estimated_size 64-character blocks.  This allows is to handle up
-   to a GB.  We should never see that, but to be paranoid, we also
-   truncate sizes greater than 1GB.  We also set the minimum size to
-   64 bytes.
-
-   We use the _estimated_size_in_24_bits and _estimated_size_in_bytes
-   macros both to avoid repetition and to make intent a little clearer.
-*/
-#define _estimated_size_in_24_bits(I) ((I) > 1073741696 ? 16777215 : (I)/64+1)
-#define _estimated_size_in_bytes(I) ((I)*64)
-
-#define cPersistent_GHOST_STATE -1
-#define cPersistent_UPTODATE_STATE 0
-#define cPersistent_CHANGED_STATE 1
-#define cPersistent_STICKY_STATE 2
-
-typedef struct {
-    cPersistent_HEAD
-} cPersistentObject;
-
-typedef void (*percachedelfunc)(PerCache *, PyObject *);
-
-typedef struct {
-    PyTypeObject *pertype;
-    getattrofunc getattro;
-    setattrofunc setattro;
-    int (*changed)(cPersistentObject*);
-    void (*accessed)(cPersistentObject*);
-    void (*ghostify)(cPersistentObject*);
-    int (*setstate)(PyObject*);
-    percachedelfunc percachedel;
-    int (*readCurrent)(cPersistentObject*);
-} cPersistenceCAPIstruct;
-
-#define cPersistenceType cPersistenceCAPI->pertype
-
-#ifndef DONT_USE_CPERSISTENCECAPI
-static cPersistenceCAPIstruct *cPersistenceCAPI;
-#endif
-
-#define cPersistanceModuleName "cPersistence"
-
-#define PER_TypeCheck(O) PyObject_TypeCheck((O), cPersistenceCAPI->pertype)
-
-#define PER_USE_OR_RETURN(O,R) {if((O)->state==cPersistent_GHOST_STATE && cPersistenceCAPI->setstate((PyObject*)(O)) < 0) return (R); else if ((O)->state==cPersistent_UPTODATE_STATE) (O)->state=cPersistent_STICKY_STATE;}
-
-#define PER_CHANGED(O) (cPersistenceCAPI->changed((cPersistentObject*)(O)))
-
-#define PER_READCURRENT(O, E)                                     \
-  if (cPersistenceCAPI->readCurrent((cPersistentObject*)(O)) < 0) { E; }
-
-#define PER_GHOSTIFY(O) (cPersistenceCAPI->ghostify((cPersistentObject*)(O)))
-
-/* If the object is sticky, make it non-sticky, so that it can be ghostified.
-   The value is not meaningful
- */
-#define PER_ALLOW_DEACTIVATION(O) ((O)->state==cPersistent_STICKY_STATE && ((O)->state=cPersistent_UPTODATE_STATE))
-
-#define PER_PREVENT_DEACTIVATION(O)  ((O)->state==cPersistent_UPTODATE_STATE && ((O)->state=cPersistent_STICKY_STATE))
-
-/* 
-   Make a persistent object usable from C by:
-
-   - Making sure it is not a ghost
-
-   - Making it sticky.
-
-   IMPORTANT: If you call this and don't call PER_ALLOW_DEACTIVATION, 
-              your object will not be ghostified.
-
-   PER_USE returns a 1 on success and 0 failure, where failure means
-   error.
- */
-#define PER_USE(O) \
-(((O)->state != cPersistent_GHOST_STATE \
-  || (cPersistenceCAPI->setstate((PyObject*)(O)) >= 0)) \
- ? (((O)->state==cPersistent_UPTODATE_STATE) \
-    ? ((O)->state=cPersistent_STICKY_STATE) : 1) : 0)
-
-#define PER_ACCESSED(O)  (cPersistenceCAPI->accessed((cPersistentObject*)(O)))
-
-#endif

src/persistent/dict.py

-##############################################################################
-#
-# Copyright Zope Foundation and Contributors.
-# All Rights Reserved.
-#
-# This software is subject to the provisions of the Zope Public License,
-# Version 2.1 (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.
-#
-##############################################################################
-
-# persistent.dict is deprecated. Use persistent.mapping
-from persistent.mapping import PersistentMapping as PersistentDict

src/persistent/list.py

-##############################################################################
-#
-# Copyright (c) 2001, 2002 Zope Foundation and Contributors.
-# All Rights Reserved.
-#
-# This software is subject to the provisions of the Zope Public License,
-# Version 2.1 (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
-#
-##############################################################################
-
-"""Python implementation of persistent list.
-
-$Id$"""
-
-import persistent
-from UserList import UserList
-
-class PersistentList(UserList, persistent.Persistent):
-    __super_setitem = UserList.__setitem__
-    __super_delitem = UserList.__delitem__
-    __super_setslice = UserList.__setslice__
-    __super_delslice = UserList.__delslice__
-    __super_iadd = UserList.__iadd__
-    __super_imul = UserList.__imul__
-    __super_append = UserList.append
-    __super_insert = UserList.insert
-    __super_pop = UserList.pop
-    __super_remove = UserList.remove
-    __super_reverse = UserList.reverse
-    __super_sort = UserList.sort
-    __super_extend = UserList.extend
-
-    def __setitem__(self, i, item):
-        self.__super_setitem(i, item)
-        self._p_changed = 1
-
-    def __delitem__(self, i):
-        self.__super_delitem(i)
-        self._p_changed = 1
-
-    def __setslice__(self, i, j, other):
-        self.__super_setslice(i, j, other)
-        self._p_changed = 1
-
-    def __delslice__(self, i, j):
-        self.__super_delslice(i, j)
-        self._p_changed = 1
-
-    def __iadd__(self, other):
-        L = self.__super_iadd(other)
-        self._p_changed = 1
-        return L
-
-    def __imul__(self, n):
-        L = self.__super_imul(n)
-        self._p_changed = 1
-        return L
-
-    def append(self, item):
-        self.__super_append(item)
-        self._p_changed = 1
-
-    def insert(self, i, item):
-        self.__super_insert(i, item)
-        self._p_changed = 1
-
-    def pop(self, i=-1):
-        rtn = self.__super_pop(i)
-        self._p_changed = 1
-        return rtn
-
-    def remove(self, item):
-        self.__super_remove(item)
-        self._p_changed = 1
-
-    def reverse(self):
-        self.__super_reverse()
-        self._p_changed = 1
-
-    def sort(self, *args, **kwargs):
-        self.__super_sort(*args, **kwargs)
-        self._p_changed = 1
-
-    def extend(self, other):
-        self.__super_extend(other)
-        self._p_changed = 1
-
-    # This works around a bug in Python 2.1.x (up to 2.1.2 at least) where the
-    # __cmp__ bogusly raises a RuntimeError, and because this is an extension
-    # class, none of the rich comparison stuff works anyway.
-    def __cmp__(self, other):
-        return cmp(self.data, self._UserList__cast(other))

src/persistent/mapping.py

-##############################################################################
-#
-# Copyright (c) 2001, 2002 Zope Foundation and Contributors.
-# All Rights Reserved.
-#
-# This software is subject to the provisions of the Zope Public License,
-# Version 2.1 (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
-#
-##############################################################################
-
-"""Python implementation of persistent base types
-
-$Id$"""
-
-import persistent
-import UserDict
-
-class default(object):
-
-    def __init__(self, func):
-        self.func = func
-
-    def __get__(self, inst, class_):
-        if inst is None:
-            return self
-        return self.func(inst)
-
-
-class PersistentMapping(UserDict.IterableUserDict, persistent.Persistent):
-    """A persistent wrapper for mapping objects.
-
-    This class allows wrapping of mapping objects so that object
-    changes are registered.  As a side effect, mapping objects may be
-    subclassed.
-
-    A subclass of PersistentMapping or any code that adds new
-    attributes should not create an attribute named _container.  This
-    is reserved for backwards compatibility reasons.
-    """
-
-    # UserDict provides all of the mapping behavior.  The
-    # PersistentMapping class is responsible marking the persistent
-    # state as changed when a method actually changes the state.  At
-    # the mapping API evolves, we may need to add more methods here.
-
-    __super_delitem = UserDict.IterableUserDict.__delitem__
-    __super_setitem = UserDict.IterableUserDict.__setitem__
-    __super_clear = UserDict.IterableUserDict.clear
-    __super_update = UserDict.IterableUserDict.update
-    __super_setdefault = UserDict.IterableUserDict.setdefault
-    __super_pop = UserDict.IterableUserDict.pop
-    __super_popitem = UserDict.IterableUserDict.popitem
-
-    def __delitem__(self, key):
-        self.__super_delitem(key)
-        self._p_changed = 1
-
-    def __setitem__(self, key, v):
-        self.__super_setitem(key, v)
-        self._p_changed = 1
-
-    def clear(self):
-        self.__super_clear()
-        self._p_changed = 1
-
-    def update(self, b):
-        self.__super_update(b)
-        self._p_changed = 1
-
-    def setdefault(self, key, failobj=None):
-        # We could inline all of UserDict's implementation into the
-        # method here, but I'd rather not depend at all on the
-        # implementation in UserDict (simple as it is).
-        if not self.has_key(key):
-            self._p_changed = 1
-        return self.__super_setdefault(key, failobj)
-
-    def pop(self, key, *args):
-        self._p_changed = 1
-        return self.__super_pop(key, *args)
-
-    def popitem(self):
-        self._p_changed = 1
-        return self.__super_popitem()
-
-    # Old implementations used _container rather than data.
-    # Use a descriptor to provide data when we have _container instead
-
-    @default
-    def data(self):
-        # We don't want to cause a write on read, so wer're careful not to
-        # do anything that would cause us to become marked as changed, however,
-        # if we're modified, then the saved record will have data, not
-        # _container.
-        data = self.__dict__.pop('_container')
-        self.__dict__['data'] = data
-
-        return data

src/persistent/py24compat.h

-/* Backport type definitions from Python 2.5's object.h */
-#ifndef PERSISTENT_PY24COMPAT_H
-#define PERSISTENT_PY24COMPAT_H
-#if PY_VERSION_HEX < 0x02050000
-typedef int Py_ssize_t;
-#define PY_SSIZE_T_MAX INT_MAX
-#define PY_SSIZE_T_MIN INT_MIN
-#endif /* PY_VERSION_HEX */
-#endif /* PERSISTENT_PY24COMPAT_H */

src/persistent/ring.c

-/*****************************************************************************
-
-  Copyright (c) 2003 Zope Foundation and Contributors.
-  All Rights Reserved.
-
-  This software is subject to the provisions of the Zope Public License,
-  Version 2.1 (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
-
- ****************************************************************************/
-
-#define RING_C "$Id$\n"
-
-/* Support routines for the doubly-linked list of cached objects.
-
-The cache stores a doubly-linked list of persistent objects, with
-space for the pointers allocated in the objects themselves.  The cache
-stores the distinguished head of the list, which is not a valid
-persistent object.
-
-The next pointers traverse the ring in order starting with the least
-recently used object.  The prev pointers traverse the ring in order
-starting with the most recently used object.
-
-*/
-
-#include "Python.h"
-#include "ring.h"
-
-void
-ring_add(CPersistentRing *ring, CPersistentRing *elt)
-{
-    assert(!elt->r_next);
-    elt->r_next = ring;
-    elt->r_prev = ring->r_prev;
-    ring->r_prev->r_next = elt;
-    ring->r_prev = elt;
-}
-
-void
-ring_del(CPersistentRing *elt)
-{
-    elt->r_next->r_prev = elt->r_prev;
-    elt->r_prev->r_next = elt->r_next;
-    elt->r_next = NULL;
-    elt->r_prev = NULL;
-}
-
-void
-ring_move_to_head(CPersistentRing *ring, CPersistentRing *elt)
-{
-    elt->r_prev->r_next = elt->r_next;
-    elt->r_next->r_prev = elt->r_prev;
-    elt->r_next = ring;
-    elt->r_prev = ring->r_prev;
-    ring->r_prev->r_next = elt;
-    ring->r_prev = elt;
-}

src/persistent/ring.h

-/*****************************************************************************
-
-  Copyright (c) 2003 Zope Foundation and Contributors.
-  All Rights Reserved.
-
-  This software is subject to the provisions of the Zope Public License,
-  Version 2.1 (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
-
- ****************************************************************************/
-
-/* Support routines for the doubly-linked list of cached objects.
-
-The cache stores a headed, doubly-linked, circular list of persistent
-objects, with space for the pointers allocated in the objects themselves.
-The cache stores the distinguished head of the list, which is not a valid
-persistent object.  The other list members are non-ghost persistent
-objects, linked in LRU (least-recently used) order.
-
-The r_next pointers traverse the ring starting with the least recently used
-object.  The r_prev pointers traverse the ring starting with the most
-recently used object.
-
-Obscure:  While each object is pointed at twice by list pointers (once by
-its predecessor's r_next, again by its successor's r_prev), the refcount
-on the object is bumped only by 1.  This leads to some possibly surprising
-sequences of incref and decref code.  Note that since the refcount is
-bumped at least once, the list does hold a strong reference to each
-object in it.
-*/
-
-typedef struct CPersistentRing_struct
-{
-    struct CPersistentRing_struct *r_prev;
-    struct CPersistentRing_struct *r_next;
-} CPersistentRing;
-
-/* The list operations here take constant time independent of the
- * number of objects in the list:
- */
-
-/* Add elt as the most recently used object.  elt must not already be
- * in the list, although this isn't checked.
- */
-void ring_add(CPersistentRing *ring, CPersistentRing *elt);
-
-/* Remove elt from the list.  elt must already be in the list, although
- * this isn't checked.
- */
-void ring_del(CPersistentRing *elt);
-
-/* elt must already be in the list, although this isn't checked.  It's
- * unlinked from its current position, and relinked into the list as the
- * most recently used object (which is arguably the tail of the list
- * instead of the head -- but the name of this function could be argued
- * either way).  This is equivalent to
- *
- *     ring_del(elt);
- *     ring_add(ring, elt);
- *
- * but may be a little quicker.
- */
-void ring_move_to_head(CPersistentRing *ring, CPersistentRing *elt);

src/persistent/tests/__init__.py

-# package

src/persistent/tests/testPersistent.py

-#############################################################################
-#
-# Copyright (c) 2003 Zope Foundation and Contributors.
-# All Rights Reserved.
-#
-# This software is subject to the provisions of the Zope Public License,
-# Version 2.1 (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.
-#
-##############################################################################
-import unittest
-
-Picklable = None # avoid global import of Persistent;  updated later
-
-class PersistenceTest(unittest.TestCase):
-
-    def _makeOne(self):
-        from persistent import Persistent
-
-        class P(Persistent):
-            pass
-
-        return P()
-
-    def _makeJar(self):
-        from persistent.tests.utils import ResettingJar
-        return ResettingJar()
-
-    def test_oid_initial_value(self):
-        obj = self._makeOne()
-        self.assertEqual(obj._p_oid, None)
-
-    def test_oid_mutable_and_deletable_when_no_jar(self):
-        obj = self._makeOne()
-        obj._p_oid = 12
-        self.assertEqual(obj._p_oid, 12)
-        del obj._p_oid
-
-    def test_oid_immutable_when_in_jar(self):
-        obj = self._makeOne()
-        jar = self._makeJar()
-        jar.add(obj)
-
-        # Can't change oid of cache object.
-        def deloid():
-            del obj._p_oid
-        self.assertRaises(ValueError, deloid)
-
-        def setoid():
-            obj._p_oid = 12
-        self.assertRaises(ValueError, setoid)
-
-    # The value returned for _p_changed can be one of:
-    # 0 -- it is not changed
-    # 1 -- it is changed
-    # None -- it is a ghost
-
-    def test_change_via_setattr(self):
-        from persistent import CHANGED
-        obj = self._makeOne()
-        jar = self._makeJar()
-        jar.add(obj)
-
-        obj.x = 1
-
-        self.assertEqual(obj._p_changed, 1)
-        self.assertEqual(obj._p_state, CHANGED)
-        self.assert_(obj in jar.registered)
-
-    def test_setattr_then_mark_uptodate(self):
-        from persistent import UPTODATE
-        obj = self._makeOne()
-        jar = self._makeJar()
-        jar.add(obj)
-
-        obj.x = 1
-        obj._p_changed = 0
-
-        self.assertEqual(obj._p_changed, 0)
-        self.assertEqual(obj._p_state, UPTODATE)
-
-    def test_set_changed_directly(self):
-        from persistent import CHANGED
-        obj = self._makeOne()
-        jar = self._makeJar()
-        jar.add(obj)
-
-        obj._p_changed = 1
-
-        self.assertEqual(obj._p_changed, 1)
-        self.assertEqual(obj._p_state, CHANGED)
-        self.assert_(obj in jar.registered)
-
-    def test_cant_ghostify_if_changed(self):
-        from persistent import CHANGED
-        obj = self._makeOne()
-        jar = self._makeJar()
-        jar.add(obj)
-
-        # setting obj._p_changed to None ghostifies if the
-        # object is in the up-to-date state, but not otherwise.
-        obj.x = 1
-        obj._p_changed = None
-
-        self.assertEqual(obj._p_changed, 1)
-        self.assertEqual(obj._p_state, CHANGED)
-
-    def test_can_ghostify_if_uptodate(self):
-        from persistent import GHOST
-        obj = self._makeOne()
-        jar = self._makeJar()
-        jar.add(obj)
-
-        obj.x = 1
-        obj._p_changed = 0
-        obj._p_changed = None
-
-        self.assertEqual(obj._p_changed, None)
-        self.assertEqual(obj._p_state, GHOST)
-
-    def test_can_ghostify_if_changed_but_del__p_changed(self):
-        from persistent import GHOST
-        obj = self._makeOne()
-        jar = self._makeJar()
-        jar.add(obj)
-
-        # You can transition directly from modified to ghost if
-        # you delete the _p_changed attribute.
-        obj.x = 1
-        del obj._p_changed
-
-        self.assertEqual(obj._p_changed, None)
-        self.assertEqual(obj._p_state, GHOST)
-
-    def test__p_state_immutable(self):
-        from persistent import CHANGED
-        from persistent import GHOST
-        from persistent import STICKY
-        from persistent import UPTODATE
-        # make sure we can't write to _p_state; we don't want yet
-        # another way to change state!
-        obj = self._makeOne()
-        def setstate(value):
-            obj._p_state = value
-
-        self.assertRaises(Exception, setstate, GHOST)
-        self.assertRaises(Exception, setstate, UPTODATE)
-        self.assertRaises(Exception, setstate, CHANGED)
-        self.assertRaises(Exception, setstate, STICKY)
-
-    def test_invalidate(self):
-        from persistent import GHOST
-        from persistent import UPTODATE
-        obj = self._makeOne()
-        jar = self._makeJar()
-        jar.add(obj)
-
-        self.assertEqual(obj._p_changed, 0)
-        self.assertEqual(obj._p_state, UPTODATE)
-
-        obj._p_invalidate()
-
-        self.assertEqual(obj._p_changed, None)
-        self.assertEqual(obj._p_state, GHOST)
-
-    def test_invalidate_activate_invalidate(self):
-        from persistent import GHOST
-        obj = self._makeOne()
-        jar = self._makeJar()
-        jar.add(obj)
-
-        obj._p_invalidate()
-        obj._p_activate()
-        obj.x = 1
-        obj._p_invalidate()
-
-        self.assertEqual(obj._p_changed, None)
-        self.assertEqual(obj._p_state, GHOST)
-
-    def test_initial_serial(self):
-        NOSERIAL = "\000" * 8
-        obj = self._makeOne()
-        self.assertEqual(obj._p_serial, NOSERIAL)
-
-    def test_setting_serial_w_invalid_types_raises(self):
-        # Serial must be an 8-digit string
-        obj = self._makeOne()
-
-        def set(val):
-            obj._p_serial = val
-
-        self.assertRaises(ValueError, set, 1)
-        self.assertRaises(ValueError, set, "0123")
-        self.assertRaises(ValueError, set, "012345678")
-        self.assertRaises(ValueError, set, u"01234567")
-
-    def test_del_serial_returns_to_initial(self):
-        NOSERIAL = "\000" * 8
-        obj = self._makeOne()
-        obj._p_serial = "01234567"
-        del obj._p_serial
-        self.assertEqual(obj._p_serial, NOSERIAL)
-
-    def test_initial_mtime(self):
-        obj = self._makeOne()
-        self.assertEqual(obj._p_mtime, None)
-
-    def test_setting_serial_sets_mtime_to_now(self):
-        import time
-        from persistent.TimeStamp import TimeStamp
-
-        obj = self._makeOne()
-        t = int(time.time())
-        ts = TimeStamp(*time.gmtime(t)[:6]) # XXX: race?
-
-        obj._p_serial = repr(ts) # why repr it?
-
-        self.assertEqual(obj._p_mtime, t)
-        self.assert_(isinstance(obj._p_mtime, float))
-
-    def test_pickle_unpickle(self):
-        import pickle
-        from persistent import Persistent
-
-        # see above:  class must be at module scope to be pickled.
-        global Picklable
-        class Picklable(Persistent):
-            pass
-
-        obj = Picklable()
-        obj.attr = "test"
-
-        s = pickle.dumps(obj)
-        obj2 = pickle.loads(s)
-
-        self.assertEqual(obj.attr, obj2.attr)
-
-    def test___getattr__(self):
-        from persistent import CHANGED
-        from persistent import Persistent
-
-        class H1(Persistent):
-
-            def __init__(self):
-                self.n = 0
-
-            def __getattr__(self, attr):
-                self.n += 1
-                return self.n
-
-        obj = H1()
-        self.assertEqual(obj.larry, 1)
-        self.assertEqual(obj.curly, 2)
-        self.assertEqual(obj.moe, 3)
-
-        jar = self._makeJar()
-        jar.add(obj)
-        obj._p_deactivate()
-
-        # The simple Jar used for testing re-initializes the object.
-        self.assertEqual(obj.larry, 1)
-
-        # The getattr hook modified the object, so it should now be
-        # in the changed state.
-        self.assertEqual(obj._p_changed, 1)
-        self.assertEqual(obj._p_state, CHANGED)
-        self.assertEqual(obj.curly, 2)
-        self.assertEqual(obj.moe, 3)
-
-    def test___getattribute__(self):
-        from persistent import CHANGED
-        from persistent import Persistent
-
-        class H2(Persistent):
-
-            def __init__(self):
-                self.n = 0
-
-            def __getattribute__(self, attr):
-                supergetattr = super(H2, self).__getattribute__
-                try:
-                    return supergetattr(attr)
-                except AttributeError:
-                    n = supergetattr("n")
-                    self.n = n + 1
-                    return n + 1
-
-        obj = H2()
-        self.assertEqual(obj.larry, 1)
-        self.assertEqual(obj.curly, 2)
-        self.assertEqual(obj.moe, 3)
-
-        jar = self._makeJar()
-        jar.add(obj)
-        obj._p_deactivate()
-
-        # The simple Jar used for testing re-initializes the object.
-        self.assertEqual(obj.larry, 1)
-
-        # The getattr hook modified the object, so it should now be
-        # in the changed state.
-        self.assertEqual(obj._p_changed, 1)
-        self.assertEqual(obj._p_state, CHANGED)
-        self.assertEqual(obj.curly, 2)
-        self.assertEqual(obj.moe, 3)
-
-    # TODO:  Need to decide how __setattr__ and __delattr__ should work,
-    # then write tests.
-
-
-def test_suite():
-    return unittest.makeSuite(PersistenceTest)

src/persistent/tests/test_persistent.py

-##############################################################################
-#
-# Copyright (c) Zope Foundation and Contributors.
-# All Rights Reserved.
-#
-# This software is subject to the provisions of the Zope Public License,
-# Version 2.1 (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 persistent import Persistent, simple_new
-import os
-if os.environ.get('USE_ZOPE_TESTING_DOCTEST'):
-    from zope.testing import doctest
-else:
-    import doctest
-
-import unittest
-
-class P(Persistent):
-    def __init__(self):
-        self.x = 0
-    def inc(self):
-        self.x += 1
-
-def cpersistent_setstate_pointer_sanity():
-    """
-    >>> Persistent().__setstate__({})
-    Traceback (most recent call last):
-    ...
-    TypeError: this object has no instance dictionary
-
-    >>> class C(Persistent): __slots__ = 'x', 'y'
-    >>> C().__setstate__(({}, {}))
-    Traceback (most recent call last):
-    ...
-    TypeError: this object has no instance dictionary
-    """
-
-def cpersistent_simple_new_invalid_argument():
-    """
-    >>> simple_new('')
-    Traceback (most recent call last):
-    ...
-    TypeError: simple_new argument must be a type object.
-    """
-
-def test_suite():
-    return unittest.TestSuite((
-        doctest.DocFileSuite("persistent.txt", globs={"P": P}),
-        doctest.DocTestSuite(),
-        ))