[Checkins] SVN: cipher.background/ initial upload
Adam Groszer
cvs-admin at zope.org
Thu Apr 5 13:15:48 UTC 2012
Log message for revision 124967:
initial upload
Changed:
A cipher.background/branches/
A cipher.background/tags/
A cipher.background/trunk/
A cipher.background/trunk/.gitignore
A cipher.background/trunk/CHANGES.txt
A cipher.background/trunk/COPYRIGHT.txt
A cipher.background/trunk/LICENSE.txt
A cipher.background/trunk/Makefile
A cipher.background/trunk/README.txt
A cipher.background/trunk/bootstrap.py
A cipher.background/trunk/buildout.cfg
A cipher.background/trunk/setup.py
A cipher.background/trunk/src/
A cipher.background/trunk/src/cipher/
A cipher.background/trunk/src/cipher/__init__.py
A cipher.background/trunk/src/cipher/background/
A cipher.background/trunk/src/cipher/background/__init__.py
A cipher.background/trunk/src/cipher/background/contextmanagers.py
A cipher.background/trunk/src/cipher/background/testing.py
A cipher.background/trunk/src/cipher/background/tests/
A cipher.background/trunk/src/cipher/background/tests/__init__.py
A cipher.background/trunk/src/cipher/background/tests/test_contextmanagers.py
A cipher.background/trunk/src/cipher/background/tests/test_thread.py
A cipher.background/trunk/src/cipher/background/thread.py
A cipher.background/trunk/ztk-versions-1.0.1.cfg
-=-
Property changes on: cipher.background/trunk
___________________________________________________________________
Added: svn:ignore
+ .installed.cfg
bin
develop-eggs
parts
Added: cipher.background/trunk/.gitignore
===================================================================
--- cipher.background/trunk/.gitignore (rev 0)
+++ cipher.background/trunk/.gitignore 2012-04-05 13:15:44 UTC (rev 124967)
@@ -0,0 +1,10 @@
+.installed.cfg
+bin/
+parts/
+develop-eggs/
+*.egg-info
+ID
+TAGS
+tags
+.coverage
+htmlcov/
Added: cipher.background/trunk/CHANGES.txt
===================================================================
--- cipher.background/trunk/CHANGES.txt (rev 0)
+++ cipher.background/trunk/CHANGES.txt 2012-04-05 13:15:44 UTC (rev 124967)
@@ -0,0 +1,13 @@
+=======
+CHANGES
+=======
+
+
+1.0.1 (unreleased)
+------------------
+
+
+1.0.0 (2012-02-10)
+------------------
+
+- Initial release as a separate package.
Property changes on: cipher.background/trunk/CHANGES.txt
___________________________________________________________________
Added: svn:keywords
+ Date Author Id Revision
Added: svn:eol-style
+ native
Added: cipher.background/trunk/COPYRIGHT.txt
===================================================================
--- cipher.background/trunk/COPYRIGHT.txt (rev 0)
+++ cipher.background/trunk/COPYRIGHT.txt 2012-04-05 13:15:44 UTC (rev 124967)
@@ -0,0 +1 @@
+Zope Foundation and Contributors
\ No newline at end of file
Property changes on: cipher.background/trunk/COPYRIGHT.txt
___________________________________________________________________
Added: svn:keywords
+ Date Author Id Revision
Added: svn:eol-style
+ native
Added: cipher.background/trunk/LICENSE.txt
===================================================================
--- cipher.background/trunk/LICENSE.txt (rev 0)
+++ cipher.background/trunk/LICENSE.txt 2012-04-05 13:15:44 UTC (rev 124967)
@@ -0,0 +1,44 @@
+Zope Public License (ZPL) Version 2.1
+
+A copyright notice accompanies this license document that identifies the
+copyright holders.
+
+This license has been certified as open source. It has also been designated as
+GPL compatible by the Free Software Foundation (FSF).
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions in source code must retain the accompanying copyright
+notice, this list of conditions, and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the accompanying copyright
+notice, this list of conditions, and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+3. Names of the copyright holders must not be used to endorse or promote
+products derived from this software without prior written permission from the
+copyright holders.
+
+4. The right to distribute this software or to use it for any purpose does not
+give you the right to use Servicemarks (sm) or Trademarks (tm) of the
+copyright
+holders. Use of them is covered by separate agreement with the copyright
+holders.
+
+5. If any files are modified, you must cause the modified files to carry
+prominent notices stating that you changed the files and the date of any
+change.
+
+Disclaimer
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY EXPRESSED
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Property changes on: cipher.background/trunk/LICENSE.txt
___________________________________________________________________
Added: svn:keywords
+ Date Author Id Revision
Added: svn:eol-style
+ native
Added: cipher.background/trunk/Makefile
===================================================================
--- cipher.background/trunk/Makefile (rev 0)
+++ cipher.background/trunk/Makefile 2012-04-05 13:15:44 UTC (rev 124967)
@@ -0,0 +1,56 @@
+PYTHON = python2.6
+
+scripts = bin/test bin/python bin/coverage-test bin/coverage-report bin/tags
+
+.PHONY: all
+all: $(scripts)
+
+.PHONY: help
+help:
+ @echo "make test -- run all tests"
+ @echo "make fast-coverage -- compute test coverage with coverage.py"
+ @echo "make slow-coverage -- compute test coverage with z3c.coverage"
+ @echo "make tags -- build ctags database"
+
+.PHONY: test
+test: bin/test
+ bin/test -c 2>&1 | less -RFX
+
+.PHONY: coverage
+coverage:
+ @echo "Pick one:"
+ @echo
+ @echo "make fast-coverage -- compute test coverage with coverage.py"
+ @echo "make slow-coverage -- compute test coverage with z3c.coverage"
+ @echo
+ @echo "(Why even have slow-coverage, given that coverage.py is faster"
+ @echo "and produces fancier HTML reports? Well, Stephan says he likes"
+ @echo "the old reports better.)"
+
+.PHONY: fast-coverage
+fast-coverage: bin/test
+ bin/coverage-test -c
+ bin/coverage report --include '*/cipher/background/*'
+ bin/coverage html --include '*/cipher/background/*'
+ @echo
+ @echo "Now run 'xdg-open htmlcov/index.html' to view results"
+
+.PHONY: slow-coverage
+slow-coverage: bin/test
+ bin/test --coverage `pwd`/coverage -c
+ bin/coverage-report
+ @echo
+ @echo "Now run 'xdg-open coverage/report/cipher.background.html' to view results"
+
+.PHONY:
+tags: bin/tags
+ bin/tags
+
+
+bin/buildout: bootstrap.py
+ $(PYTHON) bootstrap.py
+ touch -c bin/buildout
+
+$(scripts): bin/buildout buildout.cfg setup.py
+ bin/buildout $(BUILDOUTARGS)
+ touch -c $(scripts)
Added: cipher.background/trunk/README.txt
===================================================================
--- cipher.background/trunk/README.txt (rev 0)
+++ cipher.background/trunk/README.txt 2012-04-05 13:15:44 UTC (rev 124967)
@@ -0,0 +1,7 @@
+cipher.background
+=================
+
+A library for creating background threads that can talk to the ZODB and use
+local site components.
+
+We're probably reinventing Celery.
Property changes on: cipher.background/trunk/README.txt
___________________________________________________________________
Added: svn:keywords
+ Date Author Id Revision
Added: svn:eol-style
+ native
Added: cipher.background/trunk/bootstrap.py
===================================================================
--- cipher.background/trunk/bootstrap.py (rev 0)
+++ cipher.background/trunk/bootstrap.py 2012-04-05 13:15:44 UTC (rev 124967)
@@ -0,0 +1,262 @@
+##############################################################################
+#
+# Copyright (c) 2006 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.
+#
+##############################################################################
+"""Bootstrap a buildout-based project
+
+Simply run this script in a directory containing a buildout.cfg.
+The script accepts buildout command-line options, so you can
+use the -c option to specify an alternate configuration file.
+"""
+
+import os, shutil, sys, tempfile, urllib, urllib2, subprocess
+from optparse import OptionParser
+
+if sys.platform == 'win32':
+ def quote(c):
+ if ' ' in c:
+ return '"%s"' % c # work around spawn lamosity on windows
+ else:
+ return c
+else:
+ quote = str
+
+# See zc.buildout.easy_install._has_broken_dash_S for motivation and comments.
+stdout, stderr = subprocess.Popen(
+ [sys.executable, '-Sc',
+ 'try:\n'
+ ' import ConfigParser\n'
+ 'except ImportError:\n'
+ ' print 1\n'
+ 'else:\n'
+ ' print 0\n'],
+ stdout=subprocess.PIPE, stderr=subprocess.PIPE).communicate()
+has_broken_dash_S = bool(int(stdout.strip()))
+
+# In order to be more robust in the face of system Pythons, we want to
+# run without site-packages loaded. This is somewhat tricky, in
+# particular because Python 2.6's distutils imports site, so starting
+# with the -S flag is not sufficient. However, we'll start with that:
+if not has_broken_dash_S and 'site' in sys.modules:
+ # We will restart with python -S.
+ args = sys.argv[:]
+ args[0:0] = [sys.executable, '-S']
+ args = map(quote, args)
+ os.execv(sys.executable, args)
+# Now we are running with -S. We'll get the clean sys.path, import site
+# because distutils will do it later, and then reset the path and clean
+# out any namespace packages from site-packages that might have been
+# loaded by .pth files.
+clean_path = sys.path[:]
+import site # imported because of its side effects
+sys.path[:] = clean_path
+for k, v in sys.modules.items():
+ if k in ('setuptools', 'pkg_resources') or (
+ hasattr(v, '__path__') and
+ len(v.__path__) == 1 and
+ not os.path.exists(os.path.join(v.__path__[0], '__init__.py'))):
+ # This is a namespace package. Remove it.
+ sys.modules.pop(k)
+
+is_jython = sys.platform.startswith('java')
+
+setuptools_source = 'http://peak.telecommunity.com/dist/ez_setup.py'
+distribute_source = 'http://python-distribute.org/distribute_setup.py'
+
+
+# parsing arguments
+def normalize_to_url(option, opt_str, value, parser):
+ if value:
+ if '://' not in value: # It doesn't smell like a URL.
+ value = 'file://%s' % (
+ urllib.pathname2url(
+ os.path.abspath(os.path.expanduser(value))),)
+ if opt_str == '--download-base' and not value.endswith('/'):
+ # Download base needs a trailing slash to make the world happy.
+ value += '/'
+ else:
+ value = None
+ name = opt_str[2:].replace('-', '_')
+ setattr(parser.values, name, value)
+
+usage = '''\
+[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options]
+
+Bootstraps a buildout-based project.
+
+Simply run this script in a directory containing a buildout.cfg, using the
+Python that you want bin/buildout to use.
+
+Note that by using --setup-source and --download-base to point to
+local resources, you can keep this script from going over the network.
+'''
+
+parser = OptionParser(usage=usage)
+parser.add_option("-v", "--version", dest="version",
+ help="use a specific zc.buildout version")
+parser.add_option("-d", "--distribute",
+ action="store_true", dest="use_distribute", default=False,
+ help="Use Distribute rather than Setuptools.")
+parser.add_option("--setup-source", action="callback", dest="setup_source",
+ callback=normalize_to_url, nargs=1, type="string",
+ help=("Specify a URL or file location for the setup file. "
+ "If you use Setuptools, this will default to " +
+ setuptools_source + "; if you use Distribute, this "
+ "will default to " + distribute_source + "."))
+parser.add_option("--download-base", action="callback", dest="download_base",
+ callback=normalize_to_url, nargs=1, type="string",
+ help=("Specify a URL or directory for downloading "
+ "zc.buildout and either Setuptools or Distribute. "
+ "Defaults to PyPI."))
+parser.add_option("--eggs",
+ help=("Specify a directory for storing eggs. Defaults to "
+ "a temporary directory that is deleted when the "
+ "bootstrap script completes."))
+parser.add_option("-t", "--accept-buildout-test-releases",
+ dest='accept_buildout_test_releases',
+ action="store_true", default=False,
+ help=("Normally, if you do not specify a --version, the "
+ "bootstrap script and buildout gets the newest "
+ "*final* versions of zc.buildout and its recipes and "
+ "extensions for you. If you use this flag, "
+ "bootstrap and buildout will get the newest releases "
+ "even if they are alphas or betas."))
+parser.add_option("-c", None, action="store", dest="config_file",
+ help=("Specify the path to the buildout configuration "
+ "file to be used."))
+
+options, args = parser.parse_args()
+
+# if -c was provided, we push it back into args for buildout's main function
+if options.config_file is not None:
+ args += ['-c', options.config_file]
+
+if options.eggs:
+ eggs_dir = os.path.abspath(os.path.expanduser(options.eggs))
+else:
+ eggs_dir = tempfile.mkdtemp()
+
+if options.setup_source is None:
+ if options.use_distribute:
+ options.setup_source = distribute_source
+ else:
+ options.setup_source = setuptools_source
+
+if options.accept_buildout_test_releases:
+ args.append('buildout:accept-buildout-test-releases=true')
+args.append('bootstrap')
+
+try:
+ import pkg_resources
+ import setuptools # A flag. Sometimes pkg_resources is installed alone.
+ if not hasattr(pkg_resources, '_distribute'):
+ raise ImportError
+except ImportError:
+ ez_code = urllib2.urlopen(
+ options.setup_source).read().replace('\r\n', '\n')
+ ez = {}
+ exec ez_code in ez
+ setup_args = dict(to_dir=eggs_dir, download_delay=0)
+ if options.download_base:
+ setup_args['download_base'] = options.download_base
+ if options.use_distribute:
+ setup_args['no_fake'] = True
+ ez['use_setuptools'](**setup_args)
+ if 'pkg_resources' in sys.modules:
+ reload(sys.modules['pkg_resources'])
+ import pkg_resources
+ # This does not (always?) update the default working set. We will
+ # do it.
+ for path in sys.path:
+ if path not in pkg_resources.working_set.entries:
+ pkg_resources.working_set.add_entry(path)
+
+cmd = [quote(sys.executable),
+ '-c',
+ quote('from setuptools.command.easy_install import main; main()'),
+ '-mqNxd',
+ quote(eggs_dir)]
+
+if not has_broken_dash_S:
+ cmd.insert(1, '-S')
+
+find_links = options.download_base
+if not find_links:
+ find_links = os.environ.get('bootstrap-testing-find-links')
+if find_links:
+ cmd.extend(['-f', quote(find_links)])
+
+if options.use_distribute:
+ setup_requirement = 'distribute'
+else:
+ setup_requirement = 'setuptools'
+ws = pkg_resources.working_set
+setup_requirement_path = ws.find(
+ pkg_resources.Requirement.parse(setup_requirement)).location
+env = dict(
+ os.environ,
+ PYTHONPATH=setup_requirement_path)
+
+requirement = 'zc.buildout'
+version = options.version
+if version is None and not options.accept_buildout_test_releases:
+ # Figure out the most recent final version of zc.buildout.
+ import setuptools.package_index
+ _final_parts = '*final-', '*final'
+
+ def _final_version(parsed_version):
+ for part in parsed_version:
+ if (part[:1] == '*') and (part not in _final_parts):
+ return False
+ return True
+ index = setuptools.package_index.PackageIndex(
+ search_path=[setup_requirement_path])
+ if find_links:
+ index.add_find_links((find_links,))
+ req = pkg_resources.Requirement.parse(requirement)
+ if index.obtain(req) is not None:
+ best = []
+ bestv = None
+ for dist in index[req.project_name]:
+ distv = dist.parsed_version
+ if _final_version(distv):
+ if bestv is None or distv > bestv:
+ best = [dist]
+ bestv = distv
+ elif distv == bestv:
+ best.append(dist)
+ if best:
+ best.sort()
+ version = best[-1].version
+if version:
+ requirement = '=='.join((requirement, version))
+cmd.append(requirement)
+
+if is_jython:
+ import subprocess
+ exitcode = subprocess.Popen(cmd, env=env).wait()
+else: # Windows prefers this, apparently; otherwise we would prefer subprocess
+ exitcode = os.spawnle(*([os.P_WAIT, sys.executable] + cmd + [env]))
+if exitcode != 0:
+ sys.stdout.flush()
+ sys.stderr.flush()
+ print ("An error occurred when trying to install zc.buildout. "
+ "Look above this message for any errors that "
+ "were output by easy_install.")
+ sys.exit(exitcode)
+
+ws.add_entry(eggs_dir)
+ws.require(requirement)
+import zc.buildout.buildout
+zc.buildout.buildout.main(args)
+if not options.eggs: # clean up temporary egg directory
+ shutil.rmtree(eggs_dir)
Property changes on: cipher.background/trunk/bootstrap.py
___________________________________________________________________
Added: svn:keywords
+ Date Author Id Revision
Added: svn:eol-style
+ native
Added: cipher.background/trunk/buildout.cfg
===================================================================
--- cipher.background/trunk/buildout.cfg (rev 0)
+++ cipher.background/trunk/buildout.cfg 2012-04-05 13:15:44 UTC (rev 124967)
@@ -0,0 +1,65 @@
+[buildout]
+extends = ztk-versions-1.0.1.cfg
+develop = .
+parts = test coverage coverage-test coverage2-test coverage-report python tags
+versions = versions
+newest = false
+include-site-packages = false
+unzip = true
+
+[python]
+recipe = z3c.recipe.scripts
+eggs = cipher.background [test]
+interpreter = python
+
+[tags]
+recipe = z3c.recipe.tag
+eggs = ${python:eggs}
+
+[test]
+recipe = zc.recipe.testrunner
+eggs = ${python:eggs}
+defaults = ['--tests-pattern', '^f?tests$$', '-v']
+
+[coverage]
+recipe = z3c.recipe.scripts
+eggs = coverage
+
+[coverage-test]
+recipe = zc.recipe.testrunner
+eggs = ${python:eggs}
+ coverage
+defaults = ['--tests-pattern', '^f?tests$$', '-v']
+initialization =
+ # haaaaack because zc.testrunner 1.4.0 produces an _insane_ bin/test
+ # that cannot be run with bin/coverage run bin/test, or even
+ # bin/python bin/test
+ import coverage, atexit
+ c = coverage.coverage(data_file='${buildout:directory}/.coverage',
+ source=['cipher.background'])
+ def _when_done(c=c): c.stop(), c.save()
+ atexit.register(_when_done)
+ c.start()
+
+[coverage2-test]
+recipe = zc.recipe.testrunner
+eggs = ${python:eggs}
+defaults = ['--coverage', '${buildout:directory}/coverage']
+
+[coverage-report]
+recipe = z3c.recipe.scripts
+eggs = z3c.coverage
+scripts = coveragereport=coverage-report
+arguments =
+ ('${buildout:directory}/coverage',
+ '${buildout:directory}/coverage/report')
+
+[versions]
+# we're getting buildout 1.5.0 anyway from our bootstrap
+zc.buildout = 1.5.0
+
+# required by zc.buildout 1.5.0
+zc.recipe.egg = 1.3.0
+
+# required by zc.buildout 1.5.0 for include-site-packages=false to work
+zc.recipe.testrunner = 1.4.0
Property changes on: cipher.background/trunk/buildout.cfg
___________________________________________________________________
Added: svn:keywords
+ Date Author Id Revision
Added: svn:eol-style
+ native
Added: cipher.background/trunk/setup.py
===================================================================
--- cipher.background/trunk/setup.py (rev 0)
+++ cipher.background/trunk/setup.py 2012-04-05 13:15:44 UTC (rev 124967)
@@ -0,0 +1,61 @@
+##############################################################################
+#
+# 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.
+#
+##############################################################################
+"""Setup for package cipher.background
+"""
+import os
+from setuptools import setup, find_packages
+
+
+def read(*rnames):
+ return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
+
+setup(
+ name='cipher.background',
+ version='1.0.1dev',
+ url="http://pypi.python.org/pypi/cipher.background/",
+ author='Zope Foundation and Contributors',
+ author_email='zope-dev at zope.org',
+ description="Background thread support with ZODB support",
+ long_description=(
+ read('README.txt')
+ + '\n\n' +
+ read('CHANGES.txt')
+ ),
+ license='ZPL 2.1',
+ keywords="CipherHealth background thread ZODB",
+ classifiers=[
+ 'Development Status :: 4 - Beta',
+ 'Environment :: Web Environment',
+ 'Intended Audience :: Developers',
+ 'Programming Language :: Python',
+ 'Natural Language :: English',
+ 'Operating System :: OS Independent',
+ 'Topic :: Internet :: WWW/HTTP',
+ 'Framework :: Zope3'],
+ packages=find_packages('src'),
+ package_dir={'': 'src'},
+ extras_require=dict(
+ test=[
+ # in case we need something extra
+ ],
+ ),
+ install_requires=[
+ 'setuptools',
+ 'transaction',
+ 'zope.component',
+ 'zope.security',
+ ],
+ include_package_data=True,
+ zip_safe=False,
+)
Property changes on: cipher.background/trunk/setup.py
___________________________________________________________________
Added: svn:keywords
+ Date Author Id Revision
Added: svn:eol-style
+ native
Property changes on: cipher.background/trunk/src
___________________________________________________________________
Added: svn:ignore
+ cipher.background.egg-info
Added: cipher.background/trunk/src/cipher/__init__.py
===================================================================
--- cipher.background/trunk/src/cipher/__init__.py (rev 0)
+++ cipher.background/trunk/src/cipher/__init__.py 2012-04-05 13:15:44 UTC (rev 124967)
@@ -0,0 +1,2 @@
+import pkg_resources
+pkg_resources.declare_namespace(__name__)
Property changes on: cipher.background/trunk/src/cipher/__init__.py
___________________________________________________________________
Added: svn:keywords
+ Date Author Id Revision
Added: svn:eol-style
+ native
Added: cipher.background/trunk/src/cipher/background/__init__.py
===================================================================
--- cipher.background/trunk/src/cipher/background/__init__.py (rev 0)
+++ cipher.background/trunk/src/cipher/background/__init__.py 2012-04-05 13:15:44 UTC (rev 124967)
@@ -0,0 +1 @@
+# Make a package.
Property changes on: cipher.background/trunk/src/cipher/background/__init__.py
___________________________________________________________________
Added: svn:keywords
+ Date Author Id Revision
Added: svn:eol-style
+ native
Added: cipher.background/trunk/src/cipher/background/contextmanagers.py
===================================================================
--- cipher.background/trunk/src/cipher/background/contextmanagers.py (rev 0)
+++ cipher.background/trunk/src/cipher/background/contextmanagers.py 2012-04-05 13:15:44 UTC (rev 124967)
@@ -0,0 +1,109 @@
+##############################################################################
+#
+# 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.
+#
+##############################################################################
+"""Helpful context managers for Zope 3."""
+
+from __future__ import absolute_import
+from contextlib import contextmanager, closing
+
+import transaction
+from zope.component import hooks
+from zope.security.management import newInteraction, endInteraction
+
+
+ at contextmanager
+def ZopeInteraction(*participations):
+ """Perform work within an interaction.
+
+ Raises an error if the calling thread already has an interaction.
+
+ Example::
+
+ with ZopeInteraction():
+ doStuff()
+
+ """
+ newInteraction(*participations)
+ try:
+ yield None
+ finally:
+ endInteraction()
+
+
+ at contextmanager
+def ZodbConnection(db):
+ """Perform work with a ZODB connection.
+
+ Example::
+
+ with ZodbConnection(DB(FileStorage('Data.fs'))) as conn:
+ doStuff(conn.root())
+
+ """
+ with closing(db.open()) as conn:
+ yield conn
+
+
+ at contextmanager
+def ZopeSite(site):
+ """Perform work with a local Zope site.
+
+ Example::
+
+ with ZopeSite(site) as site:
+ doStuff()
+
+ """
+ oldsite = hooks.getSite()
+ try:
+ hooks.setSite(site)
+ yield site
+ finally:
+ hooks.setSite(oldsite)
+
+
+ at contextmanager
+def ZopeTransaction(user=None, note=None, path="/"):
+ """Perform work within a new fresh transaction.
+
+ Commits on success, aborts on exception.
+
+ Example::
+
+ with ZopeTransaction(user='root', note='system maintenance') as txn:
+ txn.setExtendedInfo('foo', 'bar')
+ doStuff()
+
+ WARNING: the "new fresh transaction" in the description above means that
+ any previous but not yet committed transaction will be aborted!
+ """
+ # XXX Note that transaction.begin() acts the same as transaction.abort(),
+ # i.e. discards the previous transaction. This is desired in some
+ # circumstances but surprising and painful in others. I think it'd be nice
+ # to have an explicit assertion verifying that the current transaction is
+ # empty -- let the users call transaction.abort() explicitly if they want
+ # that.
+ txn = transaction.begin()
+ try:
+ if user:
+ txn.setUser(user, path)
+ if note:
+ txn.note(note)
+ yield txn
+ # don't use txn -- it may have already been committed or aborted,
+ # and a new transaction started
+ transaction.commit()
+ except:
+ transaction.abort()
+ raise
+
Property changes on: cipher.background/trunk/src/cipher/background/contextmanagers.py
___________________________________________________________________
Added: svn:keywords
+ Date Author Id Revision
Added: svn:eol-style
+ native
Added: cipher.background/trunk/src/cipher/background/testing.py
===================================================================
--- cipher.background/trunk/src/cipher/background/testing.py (rev 0)
+++ cipher.background/trunk/src/cipher/background/testing.py 2012-04-05 13:15:44 UTC (rev 124967)
@@ -0,0 +1,24 @@
+from cStringIO import StringIO
+import logging
+
+
+def setUpLogging(logger, level=logging.DEBUG):
+ buf = StringIO()
+ handler = logging.StreamHandler(buf)
+ handler._added_by_tests_ = True
+ handler._old_propagate_ = logger.propagate
+ handler._old_level_ = logger.level
+ logger.propagate = False
+ logger.addHandler(handler)
+ logger.setLevel(level)
+ return buf
+
+
+def tearDownLogging(logger):
+ for handler in logger.handlers:
+ if hasattr(handler, '_added_by_tests_'):
+ logger.removeHandler(handler)
+ logger.propagate = handler._old_propagate_
+ logger.setLevel(handler._old_level_)
+ break
+
Property changes on: cipher.background/trunk/src/cipher/background/testing.py
___________________________________________________________________
Added: svn:keywords
+ Date Author Id Revision
Added: svn:eol-style
+ native
Added: cipher.background/trunk/src/cipher/background/tests/__init__.py
===================================================================
--- cipher.background/trunk/src/cipher/background/tests/__init__.py (rev 0)
+++ cipher.background/trunk/src/cipher/background/tests/__init__.py 2012-04-05 13:15:44 UTC (rev 124967)
@@ -0,0 +1 @@
+# Make a package.
Property changes on: cipher.background/trunk/src/cipher/background/tests/__init__.py
___________________________________________________________________
Added: svn:keywords
+ Date Author Id Revision
Added: svn:eol-style
+ native
Added: cipher.background/trunk/src/cipher/background/tests/test_contextmanagers.py
===================================================================
--- cipher.background/trunk/src/cipher/background/tests/test_contextmanagers.py (rev 0)
+++ cipher.background/trunk/src/cipher/background/tests/test_contextmanagers.py 2012-04-05 13:15:44 UTC (rev 124967)
@@ -0,0 +1,273 @@
+##############################################################################
+#
+# 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.
+#
+##############################################################################
+
+import doctest
+
+import transaction
+from zope.component import hooks
+from zope.security.management import endInteraction, queryInteraction
+
+from cipher.background import contextmanagers
+
+
+class ConnectionStub(object):
+ def __init__(self, db, verbose=False):
+ self._db = db
+ self._db.opened += 1
+ self._verbose = verbose
+ if self._verbose:
+ print 'Connection opened'
+ def close(self):
+ self._db.closed += 1
+ if self._verbose:
+ print 'Connection closed'
+ def __repr__(self):
+ return '<ConnectionStub>'
+
+class DbStub(object):
+ opened = closed = 0
+ def __init__(self, verbose=False):
+ self._verbose = verbose
+ self._objects = {}
+ def open(self):
+ return ConnectionStub(self, verbose=self._verbose)
+
+class SiteStub(object):
+ def __init__(self, name=''):
+ self._p_jar = ConnectionStub(DbStub())
+ self._p_oid = 42
+ self._p_jar._db._objects[self._p_oid] = self
+ self._name = name
+ def getSiteManager(self):
+ return None
+ def __repr__(self):
+ return 'SiteStub(%s)' % repr(self._name)
+
+class DataManagerStub(object):
+ def __init__(self):
+ self.log = []
+ def abort(self, t):
+ print 'aborted'
+ self.log.append('aborted')
+ def tpc_begin(self, t):
+ pass
+ def commit(self, t):
+ print 'committed'
+ self.log.append('committed')
+ def tpc_vote(self, t):
+ pass
+ def tpc_finish(self, t):
+ pass
+
+
+def doctest_ZopeInteraction():
+ """Test for ZopeInteraction
+
+ >>> print queryInteraction()
+ None
+
+ >>> with contextmanagers.ZopeInteraction():
+ ... print queryInteraction().__class__.__name__
+ ParanoidSecurityPolicy
+
+ >>> print queryInteraction()
+ None
+
+ """
+
+
+def doctest_ZodbConnection():
+ """Test the ZodbConnection context manager.
+
+ >>> with contextmanagers.ZodbConnection(DbStub(verbose=True)) as conn:
+ ... print conn
+ Connection opened
+ <ConnectionStub>
+ Connection closed
+
+ """
+
+
+def doctest_ZodbConnection_handles_exceptions():
+ """Test the ZodbConnection context manager.
+
+ >>> db = DbStub()
+ >>> with contextmanagers.ZodbConnection(db) as conn:
+ ... raise Exception()
+ Traceback (most recent call last):
+ ...
+ Exception
+
+ >>> (db.opened, db.closed)
+ (1, 1)
+
+ """
+
+
+def doctest_ZopeSite():
+ """Test the ZopeSite context manager.
+
+ Initially there's no site
+
+ >>> print hooks.getSite()
+ None
+
+ It is set inside the context manager
+
+ >>> site = SiteStub()
+ >>> with contextmanagers.ZopeSite(site) as s:
+ ... print hooks.getSite() is site
+ ... print s is site
+ True
+ True
+
+ and cleared when you're done
+
+ >>> print hooks.getSite()
+ None
+
+ """
+
+
+def doctest_ZopeSite_can_be_nested():
+ """Test the ZopeSite context manager.
+
+ ZopeSite() can be nested
+
+ >>> with contextmanagers.ZopeSite(SiteStub('outer')):
+ ... print hooks.getSite()
+ ... with contextmanagers.ZopeSite(SiteStub('inner')):
+ ... print hooks.getSite()
+ ... print hooks.getSite()
+ SiteStub('outer')
+ SiteStub('inner')
+ SiteStub('outer')
+
+ """
+
+
+def doctest_ZopeSite_handles_exceptions():
+ """Test the ZopeSite context manager.
+
+ If an exception happens, the site is reset
+
+ >>> site = SiteStub()
+ >>> with contextmanagers.ZopeSite(site):
+ ... raise Exception()
+ Traceback (most recent call last):
+ ...
+ Exception
+
+ >>> print hooks.getSite()
+ None
+
+ """
+
+
+def doctest_ZopeTransaction():
+ """Test the ZopeTransaction context manager.
+
+ >>> with contextmanagers.ZopeTransaction() as t:
+ ... print t is transaction.get()
+ True
+
+ """
+
+
+def doctest_ZopeTransaction_with_user():
+ """Test the ZopeTransaction context manager.
+
+ >>> with contextmanagers.ZopeTransaction(user='admin') as t:
+ ... print repr(t.user)
+ '/ admin'
+
+ """
+
+
+def doctest_ZopeTransaction_with_note():
+ """Test the ZopeTransaction context manager.
+
+ >>> with contextmanagers.ZopeTransaction(note='doing stuff') as t:
+ ... print repr(t.description)
+ 'doing stuff'
+
+ """
+
+
+def doctest_ZopeTransaction_with_path():
+ """Test the ZopeTransaction context manager.
+
+ >>> with contextmanagers.ZopeTransaction(user='bob', path='/url') as t:
+ ... print repr(t.user)
+ '/url bob'
+
+ """
+
+
+def doctest_ZopeTransaction_commits_on_success():
+ """Test the ZopeTransaction context manager.
+
+ >>> with contextmanagers.ZopeTransaction() as t:
+ ... t.join(DataManagerStub())
+ ... print 'okay, time to commit'
+ okay, time to commit
+ committed
+
+ """
+
+
+def doctest_ZopeTransaction_aborts_on_failure():
+ """Test the ZopeTransaction context manager.
+
+ >>> dm = DataManagerStub()
+ >>> with contextmanagers.ZopeTransaction() as t:
+ ... t.join(dm)
+ ... raise Exception
+ Traceback (most recent call last):
+ ...
+ Exception
+
+ >>> dm.log
+ ['aborted']
+
+ """
+
+
+def doctest_ZopeTransaction_starts_new_transaction():
+ """Test the ZopeTransaction context manager.
+
+ >>> transaction.get().join(DataManagerStub())
+ >>> with contextmanagers.ZopeTransaction() as t:
+ ... print 'inside new transaction'
+ aborted
+ inside new transaction
+
+ XXX: this is surprising, and therefore bad design. Consider changing
+ ZopeTransaction() to assert that transaction.get()._resources == [],
+ so that the old transaction is not quietly dropped.
+ """
+
+
+def setUp(test):
+ pass
+
+
+def tearDown(test):
+ endInteraction()
+ hooks.setSite(None)
+ transaction.abort()
+
+
+def test_suite():
+ return doctest.DocTestSuite(setUp=setUp, tearDown=tearDown)
Property changes on: cipher.background/trunk/src/cipher/background/tests/test_contextmanagers.py
___________________________________________________________________
Added: svn:keywords
+ Date Author Id Revision
Added: svn:eol-style
+ native
Added: cipher.background/trunk/src/cipher/background/tests/test_thread.py
===================================================================
--- cipher.background/trunk/src/cipher/background/tests/test_thread.py (rev 0)
+++ cipher.background/trunk/src/cipher/background/tests/test_thread.py 2012-04-05 13:15:44 UTC (rev 124967)
@@ -0,0 +1,288 @@
+##############################################################################
+#
+# 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.
+#
+##############################################################################
+
+import doctest
+
+import transaction
+from zope.component.hooks import getSite, setSite
+from zope.security.management import queryInteraction, endInteraction
+
+from cipher.background import testing
+from cipher.background.thread import BackgroundWorkerThread, log
+
+
+class SiteStub(object):
+ __name__ = 'testsite'
+ def __init__(self):
+ self._p_jar = ConnectionStub(DbStub())
+ self._p_oid = 42
+ self._p_jar._db._objects[self._p_oid] = self
+ self.patients = {}
+ def getSiteManager(self):
+ return None
+
+class ConnectionStub(object):
+ def __init__(self, db, verbose=False):
+ self._db = db
+ self._db.opened += 1
+ self._verbose = verbose
+ def db(self):
+ return self._db
+ def get(self, oid):
+ return self._db._objects[oid]
+ def close(self):
+ self._db.closed += 1
+
+class DbStub(object):
+ opened = closed = 0
+ def __init__(self, verbose=False):
+ self._verbose = verbose
+ self._objects = {}
+ def open(self):
+ return ConnectionStub(self, verbose=self._verbose)
+
+
+class BackgroundWorkerThreadForTest(BackgroundWorkerThread):
+
+ def __init__(self, *args, **kw):
+ super(BackgroundWorkerThreadForTest, self).__init__(*args, **kw)
+ self._tasks = [None] * 5
+
+ def scheduleNextWork(self):
+ if not self._tasks:
+ log.info('no tasks left to schedule')
+ return False
+ log.info('scheduling a task')
+ self._tasks.pop()
+ return True
+
+
+def doctest_BackgroundWorkerThread():
+ """Test for BackgroundWorkerThread.__init__
+
+ >>> site = SiteStub()
+ >>> thread = BackgroundWorkerThreadForTest(
+ ... site_db=site._p_jar.db(), site_oid=site._p_oid,
+ ... site_name='testsite', user_name='someuser',
+ ... )
+ >>> thread.name
+ 'background worker thread (BackgroundWorkerThreadForTest) for testsite'
+
+ """
+
+
+def doctest_BackgroundWorkerThread_forSite():
+ """Test for BackgroundWorkerThread.forSite
+
+ >>> site = SiteStub()
+ >>> thread = BackgroundWorkerThreadForTest.forSite(
+ ... site=site,
+ ... user_name='someuser',
+ ... )
+ >>> thread.name
+ 'background worker thread (BackgroundWorkerThreadForTest) for testsite'
+
+ """
+
+
+def doctest_BackgroundWorkerThread_getTransactionNote():
+ """Test for BackgroundWorkerThread.getTransactionNote
+
+ >>> site = SiteStub()
+ >>> thread = BackgroundWorkerThreadForTest.forSite(site, 'someuser')
+ >>> thread.name = 'my thread'
+
+ Default transaction note is just the thread name
+
+ >>> thread.getTransactionNote()
+ 'my thread'
+
+ You can customize it by changing the work_transaction_note attribute
+
+ >>> thread.work_transaction_note = ('work for %(site_name)s'
+ ... ' on behalf of %(user_name)s')
+ >>> thread.getTransactionNote()
+ 'work for testsite on behalf of someuser'
+
+ """
+
+
+def doctest_BackgroundWorkerThread_getCleanupNote():
+ """Test for BackgroundWorkerThread.getCleanupNote
+
+ >>> site = SiteStub()
+ >>> thread = BackgroundWorkerThreadForTest.forSite(site, 'someuser')
+ >>> thread.name = 'my thread'
+
+ Default transaction note is just the thread name with " cleanup" tacked on
+
+ >>> thread.getCleanupNote()
+ 'my thread cleanup'
+
+ You can customize it by changing the cleanup_transaction_note attribute
+
+ >>> thread.cleanup_transaction_note = ('cleanup for %(site_name)s'
+ ... ' on behalf of %(user_name)s')
+ >>> thread.getCleanupNote()
+ 'cleanup for testsite on behalf of someuser'
+
+ """
+
+
+def doctest_BackgroundWorkerThread_run():
+ """Test for BackgroundWorkerThread.run
+
+ >>> site = SiteStub()
+ >>> thread = BackgroundWorkerThreadForTest.forSite(site, 'someuser')
+
+ >>> logbuf = testing.setUpLogging(log)
+
+ The method gives us a Zope interaction, a ZODB connection (not directly
+ available), and a site (loaded from the DB connection).
+
+ >>> def doWork(self):
+ ... log.info('got interaction: %s', queryInteraction() is not None)
+ ... log.info('got site: %s', getSite() is not None)
+ ... self._tasks = [] # terminate early
+ >>> thread.doWork = doWork.__get__(thread)
+
+ >>> thread.run()
+
+ >>> print logbuf.getvalue().strip() # doctest: +ELLIPSIS
+ scheduling a task
+ got interaction: True
+ got site: True
+ no tasks left to schedule
+
+ >>> testing.tearDownLogging(log)
+
+ We can check that the database connection was closed
+
+ >>> site._p_jar.db().opened
+ 2
+ >>> site._p_jar.db().closed
+ 1
+
+ The site was reset and the interaction ended
+
+ >>> queryInteraction()
+ >>> getSite()
+
+ """
+
+
+def doctest_BackgroundWorkerThread_run_exception_handling():
+ """Test for BackgroundWorkerThread.run
+
+ >>> site = SiteStub()
+ >>> thread = BackgroundWorkerThreadForTest.forSite(site, 'someuser')
+ >>> thread.name = 'this thread'
+
+ >>> logbuf = testing.setUpLogging(log)
+
+ What if an exception happens during the background processing?
+
+ >>> def doWork(self):
+ ... self._tasks = []
+ ... raise Exception('something happened')
+ >>> thread.doWork = doWork.__get__(thread)
+
+ >>> thread.run()
+
+ The exception is mentioned in the log
+
+ >>> print logbuf.getvalue().strip() # doctest: +ELLIPSIS
+ scheduling a task
+ Exception in this thread
+ Traceback (most recent call last):
+ ...
+ Exception: something happened
+ no tasks left to schedule
+
+ >>> testing.tearDownLogging(log)
+
+ We can check that the database connection was closed
+
+ >>> site._p_jar.db().opened
+ 2
+ >>> site._p_jar.db().closed
+ 1
+
+ The site was reset and the interaction ended
+
+ >>> queryInteraction()
+ >>> getSite()
+
+ """
+
+
+def doctest_BackgroundWorkerThread_run_outer_exception_handling():
+ """Test for BackgroundWorkerThread.run
+
+ >>> site = SiteStub()
+ >>> thread = BackgroundWorkerThreadForTest.forSite(site, 'someuser')
+ >>> thread.name = 'this thread'
+
+ >>> logbuf = testing.setUpLogging(log)
+
+ What if an exception happens during the scheduling?
+
+ >>> def scheduleNextWork(self):
+ ... log.info('scheduling a task')
+ ... raise Exception('something happened')
+ >>> thread.scheduleNextWork = scheduleNextWork.__get__(thread)
+
+ >>> thread.run()
+
+ The exception is mentioned in the log and the thread is terminated
+
+ >>> print logbuf.getvalue().strip() # doctest: +ELLIPSIS
+ scheduling a task
+ Exception in this thread, thread terminated
+ Traceback (most recent call last):
+ ...
+ Exception: something happened
+
+ >>> testing.tearDownLogging(log)
+
+ """
+
+
+def doctest_BackgroundWorkerThread_scheduleNextWork():
+ """Test for BackgroundWorkerThread.scheduleNextWork
+
+ >>> site = SiteStub()
+ >>> thread = BackgroundWorkerThread.forSite(site, 'someuser')
+
+ The default implementation terminates the thread at once.
+
+ >>> thread.scheduleNextWork()
+ False
+
+ """
+
+
+def setUp(test):
+ pass
+
+
+def tearDown(test):
+ testing.tearDownLogging(log)
+ setSite(None)
+ endInteraction()
+ transaction.abort()
+
+
+def test_suite():
+ return doctest.DocTestSuite(setUp=setUp, tearDown=tearDown)
Property changes on: cipher.background/trunk/src/cipher/background/tests/test_thread.py
___________________________________________________________________
Added: svn:keywords
+ Date Author Id Revision
Added: svn:eol-style
+ native
Added: cipher.background/trunk/src/cipher/background/thread.py
===================================================================
--- cipher.background/trunk/src/cipher/background/thread.py (rev 0)
+++ cipher.background/trunk/src/cipher/background/thread.py 2012-04-05 13:15:44 UTC (rev 124967)
@@ -0,0 +1,149 @@
+##############################################################################
+#
+# 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.
+#
+##############################################################################
+import threading
+import logging
+
+from .contextmanagers import (ZopeInteraction, ZodbConnection, ZopeSite,
+ ZopeTransaction)
+
+
+log = logging.getLogger(__name__)
+
+
+class BackgroundWorkerThread(threading.Thread):
+ """A background thread that can access the ZODB and a local site.
+
+ Abstracts the plumbing away so we can focus on the important details.
+
+ Subclasses ought to override the following methods:
+
+ - scheduleNextWork -- sleep until the next job becomes available,
+ or return False if the thread should terminate
+
+ - doWork -- perform whatever work is necessary
+
+ - doCleanup -- perform whatever cleanup is necessary, called even
+ when doWork() raises an exception.
+
+ """
+
+ # Feel free to replace these with more descriptive notes in subclasses
+ description = "background worker thread (%(class_name)s) for %(site_name)s"
+ work_transaction_note = "%(thread_name)s"
+ cleanup_transaction_note = "%(thread_name)s cleanup"
+
+ log = log # let subclasses use a different logger if they want
+
+ def __init__(self, site_db, site_oid, site_name, user_name, daemon=True):
+ """Create a thread."""
+ self.site_db = site_db
+ self.site_oid = site_oid
+ self.site_name = site_name
+ self.user_name = user_name
+ super(BackgroundWorkerThread, self).__init__(
+ name=self.description % dict(class_name=self.__class__.__name__,
+ site_name=self.site_name,
+ user_name=self.user_name),
+ )
+ if daemon:
+ self.setDaemon(True)
+
+ @classmethod
+ def forSite(cls, site, user_name, daemon=True):
+ """Create a thread."""
+ return cls(site._p_jar.db(), site._p_oid, site.__name__, user_name,
+ daemon=daemon)
+
+ def getTransactionNote(self):
+ """Note for the ZODB transaction record.
+
+ Visible in tools like @@zodbbrowser.
+ """
+ return self.work_transaction_note % dict(
+ thread_name=self.name,
+ class_name=self.__class__.__name__,
+ site_name=self.site_name,
+ user_name=self.user_name)
+
+ def getCleanupNote(self):
+ """Note for the ZODB transaction record for the cleanup transaction.
+
+ Visible in tools like @@zodbbrowser.
+ """
+ return self.cleanup_transaction_note % dict(
+ thread_name=self.name,
+ class_name=self.__class__.__name__,
+ site_name=self.site_name,
+ user_name=self.user_name)
+
+ def run(self):
+ """Main loop of the thread."""
+ try:
+ while self.scheduleNextWork():
+ with ZopeInteraction():
+ with ZodbConnection(self.site_db) as conn:
+ try:
+ with ZopeSite(conn.get(self.site_oid)):
+ try:
+ with ZopeTransaction(
+ user=self.user_name,
+ note=self.getTransactionNote()):
+ self.doWork()
+ finally:
+ # Do the cleanup in a new transaction, as
+ # the current one may be doomed or
+ # something. Also do it while the site
+ # is available, since we may need to access
+ # local utilities during the cleanup
+ with ZopeTransaction(
+ user=self.user_name,
+ note=self.getCleanupNote()):
+ self.doCleanup()
+ except:
+ # Note: log the exception while the ZODB connection
+ # is still open; we may need it for repr() of
+ # objects in various __traceback_info__s.
+ self.log.exception("Exception in %s" % self.name)
+ except:
+ self.log.exception("Exception in %s, thread terminated" % self.name)
+
+ def scheduleNextWork(self):
+ """Sleep until some work is available.
+
+ Return True if there is work, and False if the thread should terminate
+ now.
+
+ Override it, otherwise there's no point!
+ """
+ return False
+
+ def doWork(self):
+ """Perform the work.
+
+ Does nothing by default. Override it, otherwise there's no point!
+
+ This method is called with a local site set and a working ZODB
+ connection.
+ """
+
+ def doCleanup(self):
+ """Clean up if necessary.
+
+ Does nothing by default. Override if you need to do some sort of
+ cleanup.
+
+ Cleanup is also called when doWork() raises an exception. It is
+ performed in a separate transaction. It can access the site.
+ """
+
Property changes on: cipher.background/trunk/src/cipher/background/thread.py
___________________________________________________________________
Added: svn:keywords
+ Date Author Id Revision
Added: svn:eol-style
+ native
Added: cipher.background/trunk/ztk-versions-1.0.1.cfg
===================================================================
--- cipher.background/trunk/ztk-versions-1.0.1.cfg (rev 0)
+++ cipher.background/trunk/ztk-versions-1.0.1.cfg 2012-04-05 13:15:44 UTC (rev 124967)
@@ -0,0 +1,110 @@
+[versions]
+# ZTK
+zope.annotation = 3.5.0
+zope.applicationcontrol = 3.5.5
+zope.authentication = 3.7.1
+zope.broken = 3.6.0
+zope.browser = 1.3
+zope.browsermenu = 3.9.1
+zope.browserpage = 3.12.2
+zope.browserresource = 3.10.3
+zope.cachedescriptors = 3.5.1
+zope.catalog = 3.8.1
+zope.component = 3.9.5
+zope.componentvocabulary = 1.0.1
+zope.configuration = 3.7.2
+zope.container = 3.11.2
+zope.contentprovider = 3.7.2
+zope.contenttype = 3.5.1
+zope.copy = 3.5.0
+zope.copypastemove = 3.6.0
+zope.datetime = 3.4.0
+zope.deferredimport = 3.5.3
+zope.deprecation = 3.4.0
+zope.dottedname = 3.4.6
+zope.dublincore = 3.7.0
+zope.error = 3.7.2
+zope.event = 3.5.0-1
+zope.exceptions = 3.6.1
+zope.filerepresentation = 3.6.0
+zope.formlib = 4.0.5
+zope.hookable = 3.4.1
+zope.i18n = 3.7.4
+zope.i18nmessageid = 3.5.3
+zope.index = 3.6.1
+zope.interface = 3.6.1
+zope.intid = 3.7.2
+zope.keyreference = 3.6.2
+zope.lifecycleevent = 3.6.2
+zope.location = 3.9.0
+zope.login = 1.0.0
+zope.mimetype = 1.3.1
+zope.minmax = 1.1.2
+zope.pagetemplate = 3.5.2
+zope.password = 3.6.1
+zope.pluggableauth = 1.0.3
+zope.principalannotation = 3.6.1
+zope.principalregistry = 3.7.1
+zope.processlifetime = 1.0
+zope.proxy = 3.6.1
+zope.ptresource = 3.9.0
+zope.publisher = 3.12.4
+zope.ramcache = 1.0
+zope.schema = 3.7.0
+zope.security = 3.7.4
+zope.securitypolicy = 3.7.0
+zope.sendmail = 3.7.4
+zope.sequencesort = 3.4.0
+zope.server = 3.6.2
+zope.session = 3.9.3
+zope.site = 3.9.2
+zope.size = 3.4.1
+zope.structuredtext = 3.5.0
+zope.tal = 3.5.2
+zope.tales = 3.5.1
+zope.testing = 3.9.5
+zope.traversing = 3.13
+zope.viewlet = 3.7.2
+
+# Deprecating
+zope.documenttemplate = 3.4.2
+
+# Dependencies
+# Needed for the mechanize 0.1.x.
+ClientForm = 0.2.10
+distribute = 0.6.14
+docutils = 0.7
+Jinja2 = 2.5.5
+# Newer versions of mechanize are not fully py24 compatible.
+mechanize = 0.1.11
+Paste = 1.7.5.1
+PasteDeploy = 1.3.4
+PasteScript = 1.7.3
+py = 1.3.4
+Pygments = 1.3.1
+python-gettext = 1.0
+pytz = 2010l
+RestrictedPython = 3.6.0
+setuptools = 0.6c11
+Sphinx = 1.0.5
+transaction = 1.1.1
+z3c.recipe.sphinxdoc = 0.0.8
+zc.buildout = 1.4.4
+zc.lockfile = 1.0.0
+ZConfig = 2.8.0
+zc.recipe.egg = 1.2.2
+zc.recipe.testrunner = 1.2.1
+zc.resourcelibrary = 1.3.1
+zdaemon = 2.0.4
+ZODB3 = 3.9.7
+zope.mkzeoinstance = 3.9.4
+
+# toolchain
+argparse = 1.1
+lxml = 2.2.8
+mr.developer = 1.16
+tl.eggdeps = 0.4
+z3c.checkversions = 0.4.1
+z3c.recipe.compattest = 0.12.2
+z3c.recipe.depgraph = 0.5
+zope.kgs = 1.2.0
Property changes on: cipher.background/trunk/ztk-versions-1.0.1.cfg
___________________________________________________________________
Added: svn:keywords
+ Date Author Id Revision
Added: svn:eol-style
+ native
More information about the checkins
mailing list