zope.exceptions-4.0.8/0000775000175100017510000000000012563163734014212 5ustar adiadi00000000000000zope.exceptions-4.0.8/setup.cfg0000664000175100017510000000041412563163734016032 0ustar adiadi00000000000000[nosetests] nocapture = 1 cover-package = zope.exceptions cover-erase = 1 with-doctest = 0 where = src [aliases] dev = develop easy_install zope.exceptions[testing] docs = easy_install zope.exceptions[docs] [egg_info] tag_build = tag_date = 0 tag_svn_revision = 0 zope.exceptions-4.0.8/PKG-INFO0000664000175100017510000001707712563163734015323 0ustar adiadi00000000000000Metadata-Version: 1.1 Name: zope.exceptions Version: 4.0.8 Summary: Zope Exceptions Home-page: http://cheeseshop.python.org/pypi/zope.exceptions Author: Zope Foundation and Contributors Author-email: zope-dev@zope.org License: ZPL 2.1 Description: ``zope.exceptions`` =================== .. image:: https://pypip.in/version/zope.exceptions/badge.svg?style=flat :target: https://pypi.python.org/pypi/zope.exceptions/ :alt: Latest Version .. image:: https://travis-ci.org/zopefoundation/zope.exceptions.png?branch=master :target: https://travis-ci.org/zopefoundation/zope.exceptions .. image:: https://readthedocs.org/projects/zopeexceptions/badge/?version=latest :target: http://zopeexceptions.readthedocs.org/en/latest/ :alt: Documentation Status This package contains exception exceptions and implementations which are so general purpose that they don't belong in Zope application-specific packages. Please see http://docs.zope.org/zope.exceptions/ for the documentation. ``zope.exceptions`` Changelog ============================= 4.0.8 (2015-08-13) ------------------ - Fixes around ``TextExceptionFormatter`` ``limit``: ``formatException`` and ``extractStack`` was cutting the traceback at the bottom, at the most interesting point. Now it will cut from the middle. Some text about the missing entries will be inserted. - Maybe fix for ``extractStack``, it did not detect recursions in the frames. 4.0.7 (2014-03-19) ------------------ - Added explicit support for Python 3.4. - Updated ``boostrap.py`` to version 2.2. 4.0.6 (2013-02-28) ------------------ - Make sure that ``setup.py`` finds all tests. Now tox runs them all as well. - Fix failing test under Python 3. - Made buildout work under Python 3 and Buildout 2. 4.0.5 (2012-12-31) ------------------ - Fleshed out PyPI Trove classifiers. - Fixed a test failure under Python 2.6. 4.0.4 (2012-12-13) ------------------ - Release with a fixed MANIFEST.in (without ``docs/``) 4.0.3 (2012-12-10) ------------------ - Fixed format_exception(..., as_html=True) not to HTML-escape the '
' it adds to the exception value. 4.0.2 (2012-11-21) ------------------ - Test Python 3.3 support under tox. 4.0.1 (2012-08-20) ------------------ - Fixed optional dependency code for `zope.security` to work under Python 3.3. 4.0.0.1 (2012-05-16) -------------------- - Fixed rendering of package docs on PyPI. 4.0.0 (2012-05-16) ------------------ - Automated build of Sphinx HTML docs and running doctest snippets via tox. - Added Sphinx documentation. - Added support for continuous integration using ``tox`` and ``jenkins``. - Removed use of '2to3' and associated fixers when installing under Py3k. The code is now in a "compatible subset" which supports Python 2.6, 2.7, and 3.2, including PyPy 1.8 (the version compatible with the 2.7 language spec). - 100% unit test coverage. - Dropped explicit support for Python 2.4 / 2.5 / 3.1. - Added 'setup.py dev' alias (runs ``setup.py develop`` plus installs ``nose`` and ``coverage``). - Added 'setup.py docs' alias (installs ``Sphinx`` and dependencies). 3.7.1 (2012-03-28) ------------------ - Fix: missed to reverse extractStack entries 3.7.0 (2012-03-28) ------------------ - Added TextExceptionFormatter.extractStack and extract_stack 3.6.2 (2012-03-28) ------------------ - Fallback to traceback.format_tb when the formatter is called recursively. i.e. Don't let errors in the formatter pass silently. - Fix deprecated unittest functions: ``assert_`` and ``assertEquals``. 3.6.1 (2010-07-06) ------------------ - Fixed tests to work under Python 2.7. - PEP8 cleanup and removed obsolete build infrastructure files. 3.6.0 (2010-05-02) ------------------ - Added support to bootstrap on Jython. - Added Python 3 support. - The dependency on zope.testing seemed spurious, possibly a rest of a real dependency that is gone now. I removed it. 3.5.2 (2008-04-30) ------------------ - Updated CHANGES.txt. 3.5.1 (2008-04-28) ------------------ - Reverted changes in 3.5.0. 3.5.0 ----- - Added the capability for exceptions to be formatted line-by-line. Unfortunately, also introduced a bug cause each line of the exception to be its own log message. 3.4.0 (2007-10-02) ------------------ - Updated package meta-data. 3.4.0b2 (2007-08-14) -------------------- - Removed superfluous dependency on ``zope.deprecation``. 3.4.0b1 (2007-07-09) -------------------- - Corresponds to the version of the ``zope.exceptions`` package shipped as part of the Zope 3.4.0b1 release. 3.2.0 (2006-01-05) ------------------ - Corresponds to the version of the ``zope.exceptions`` package shipped as part of the Zope 3.2.0 release. - Deprecated the ``INotFoundError`` interface and the corresponding ``NotFoundError`` exception class, in favor of "standard" exceptions ``AttributeError``, ``KeyError``). The deprecated items will be removed in Zope 3.3. 3.0.0 (2004-11-07) ------------------ - Corresponds to the version of the zope.exceptions package shipped as part of the Zope X3.0.0 release. Keywords: zope exceptions Platform: UNKNOWN Classifier: Development Status :: 5 - Production/Stable Classifier: Environment :: Web Environment Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: Zope Public License Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 2 Classifier: Programming Language :: Python :: 2.6 Classifier: Programming Language :: Python :: 2.7 Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.2 Classifier: Programming Language :: Python :: 3.3 Classifier: Programming Language :: Python :: 3.4 Classifier: Programming Language :: Python :: Implementation :: CPython Classifier: Programming Language :: Python :: Implementation :: PyPy Classifier: Natural Language :: English Classifier: Operating System :: OS Independent Classifier: Topic :: Internet :: WWW/HTTP Classifier: Framework :: Zope3 zope.exceptions-4.0.8/tox.ini0000664000175100017510000000115112563163712015517 0ustar adiadi00000000000000[tox] envlist = py26,py27,py32,py33,py34,pypy,coverage,docs [testenv] commands = python setup.py -q test -q deps = zope.interface zope.testrunner [testenv:coverage] usedevelop = true basepython = python2.7 commands = nosetests --with-xunit --with-xcoverage deps = zope.interface nose coverage nosexcover [testenv:docs] basepython = python2.7 commands = sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html sphinx-build -b doctest -d docs/_build/doctrees docs docs/_build/doctest deps = zope.interface Sphinx repoze.sphinx.autointerface zope.exceptions-4.0.8/setup.py0000664000175100017510000000671212563163712015726 0ustar adiadi00000000000000############################################################################## # # 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. # ############################################################################## # This package is developed by the Zope Toolkit project, documented here: # http://docs.zope.org/zopetoolkit # When developing and releasing this package, please follow the documented # Zope Toolkit policies as described by this documentation. ############################################################################## """Setup for zope.exceptions package """ import os from setuptools import setup, find_packages def read(*rnames): return open(os.path.join(os.path.dirname(__file__), *rnames)).read() def alltests(): import os import sys import unittest # use the zope.testrunner machinery to find all the # test suites we've put under ourselves import zope.testrunner.find import zope.testrunner.options here = os.path.abspath(os.path.join(os.path.dirname(__file__), 'src')) args = sys.argv[:] defaults = ["--test-path", here] options = zope.testrunner.options.get_options(args, defaults) suites = list(zope.testrunner.find.find_suites(options)) return unittest.TestSuite(suites) setup(name='zope.exceptions', version='4.0.8', author='Zope Foundation and Contributors', author_email='zope-dev@zope.org', description='Zope Exceptions', long_description=(read('README.rst') + '\n\n' + read('CHANGES.rst')), keywords = 'zope exceptions', classifiers = [ 'Development Status :: 5 - Production/Stable', 'Environment :: Web Environment', 'Intended Audience :: Developers', 'License :: OSI Approved :: Zope Public License', 'Programming Language :: Python', 'Programming Language :: Python :: 2', 'Programming Language :: Python :: 2.6', 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.2', 'Programming Language :: Python :: 3.3', 'Programming Language :: Python :: 3.4', "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy", 'Natural Language :: English', 'Operating System :: OS Independent', 'Topic :: Internet :: WWW/HTTP', 'Framework :: Zope3'], url='http://cheeseshop.python.org/pypi/zope.exceptions', license='ZPL 2.1', packages=find_packages('src'), package_dir = {'': 'src'}, namespace_packages=['zope'], install_requires=['setuptools', 'zope.interface', ], tests_require = [ 'zope.testrunner', ], test_suite = '__main__.alltests', include_package_data = True, zip_safe = False, extras_require = { 'docs': ['Sphinx', 'repoze.sphinx.autointerface'], 'testing': ['nose', 'coverage'], }, ) zope.exceptions-4.0.8/rtd.txt0000664000175100017510000000005312563163712015536 0ustar adiadi00000000000000repoze.sphinx.autointerface zope.interface zope.exceptions-4.0.8/buildout.cfg0000664000175100017510000000014112563163712016512 0ustar adiadi00000000000000[buildout] develop = . parts = test [test] recipe = zc.recipe.testrunner eggs = zope.exceptions zope.exceptions-4.0.8/bootstrap.py0000664000175100017510000001454512563163712016606 0ustar adiadi00000000000000############################################################################## # # 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 import shutil import sys import tempfile from optparse import OptionParser tmpeggs = tempfile.mkdtemp() 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 --find-links to point to local resources, you can keep this script from going over the network. ''' parser = OptionParser(usage=usage) parser.add_option("-v", "--version", help="use a specific zc.buildout version") 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", "--config-file", help=("Specify the path to the buildout configuration " "file to be used.")) parser.add_option("-f", "--find-links", help=("Specify a URL to search for buildout releases")) parser.add_option("--allow-site-packages", action="store_true", default=False, help=("Let bootstrap.py use existing site packages")) parser.add_option("--setuptools-version", help="use a specific setuptools version") options, args = parser.parse_args() ###################################################################### # load/install setuptools try: if options.allow_site_packages: import setuptools import pkg_resources from urllib.request import urlopen except ImportError: from urllib2 import urlopen ez = {} exec(urlopen('https://bootstrap.pypa.io/ez_setup.py').read(), ez) if not options.allow_site_packages: # ez_setup imports site, which adds site packages # this will remove them from the path to ensure that incompatible versions # of setuptools are not in the path import site # inside a virtualenv, there is no 'getsitepackages'. # We can't remove these reliably if hasattr(site, 'getsitepackages'): for sitepackage_path in site.getsitepackages(): sys.path[:] = [x for x in sys.path if sitepackage_path not in x] setup_args = dict(to_dir=tmpeggs, download_delay=0) if options.setuptools_version is not None: setup_args['version'] = options.setuptools_version ez['use_setuptools'](**setup_args) import setuptools 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) ###################################################################### # Install buildout ws = pkg_resources.working_set cmd = [sys.executable, '-c', 'from setuptools.command.easy_install import main; main()', '-mZqNxd', tmpeggs] find_links = os.environ.get( 'bootstrap-testing-find-links', options.find_links or ('http://downloads.buildout.org/' if options.accept_buildout_test_releases else None) ) if find_links: cmd.extend(['-f', find_links]) setuptools_path = ws.find( pkg_resources.Requirement.parse('setuptools')).location 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): try: return not parsed_version.is_prerelease except AttributeError: # Older setuptools 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=[setuptools_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) import subprocess if subprocess.call(cmd, env=dict(os.environ, PYTHONPATH=setuptools_path)) != 0: raise Exception( "Failed to execute command:\n%s" % repr(cmd)[1:-1]) ###################################################################### # Import and run buildout ws.add_entry(tmpeggs) ws.require(requirement) import zc.buildout.buildout if not [a for a in args if '=' not in a]: args.append('bootstrap') # if -c was provided, we push it back into args for buildout' main function if options.config_file is not None: args[0:0] = ['-c', options.config_file] zc.buildout.buildout.main(args) shutil.rmtree(tmpeggs) zope.exceptions-4.0.8/README.rst0000664000175100017510000000137212563163712015700 0ustar adiadi00000000000000``zope.exceptions`` =================== .. image:: https://pypip.in/version/zope.exceptions/badge.svg?style=flat :target: https://pypi.python.org/pypi/zope.exceptions/ :alt: Latest Version .. image:: https://travis-ci.org/zopefoundation/zope.exceptions.png?branch=master :target: https://travis-ci.org/zopefoundation/zope.exceptions .. image:: https://readthedocs.org/projects/zopeexceptions/badge/?version=latest :target: http://zopeexceptions.readthedocs.org/en/latest/ :alt: Documentation Status This package contains exception exceptions and implementations which are so general purpose that they don't belong in Zope application-specific packages. Please see http://docs.zope.org/zope.exceptions/ for the documentation. zope.exceptions-4.0.8/MANIFEST.in0000664000175100017510000000031012563163712015736 0ustar adiadi00000000000000include *.rst include *.txt recursive-include docs * recursive-include src * global-exclude *.pyc # added by check_manifest.py include *.py include .travis.yml include buildout.cfg include tox.ini zope.exceptions-4.0.8/LICENSE.txt0000664000175100017510000000402612563163712016033 0ustar adiadi00000000000000Zope 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. zope.exceptions-4.0.8/COPYRIGHT.txt0000664000175100017510000000004012563163712016311 0ustar adiadi00000000000000Zope Foundation and Contributorszope.exceptions-4.0.8/CHANGES.rst0000664000175100017510000001003212563163712016004 0ustar adiadi00000000000000``zope.exceptions`` Changelog ============================= 4.0.8 (2015-08-13) ------------------ - Fixes around ``TextExceptionFormatter`` ``limit``: ``formatException`` and ``extractStack`` was cutting the traceback at the bottom, at the most interesting point. Now it will cut from the middle. Some text about the missing entries will be inserted. - Maybe fix for ``extractStack``, it did not detect recursions in the frames. 4.0.7 (2014-03-19) ------------------ - Added explicit support for Python 3.4. - Updated ``boostrap.py`` to version 2.2. 4.0.6 (2013-02-28) ------------------ - Make sure that ``setup.py`` finds all tests. Now tox runs them all as well. - Fix failing test under Python 3. - Made buildout work under Python 3 and Buildout 2. 4.0.5 (2012-12-31) ------------------ - Fleshed out PyPI Trove classifiers. - Fixed a test failure under Python 2.6. 4.0.4 (2012-12-13) ------------------ - Release with a fixed MANIFEST.in (without ``docs/``) 4.0.3 (2012-12-10) ------------------ - Fixed format_exception(..., as_html=True) not to HTML-escape the '
' it adds to the exception value. 4.0.2 (2012-11-21) ------------------ - Test Python 3.3 support under tox. 4.0.1 (2012-08-20) ------------------ - Fixed optional dependency code for `zope.security` to work under Python 3.3. 4.0.0.1 (2012-05-16) -------------------- - Fixed rendering of package docs on PyPI. 4.0.0 (2012-05-16) ------------------ - Automated build of Sphinx HTML docs and running doctest snippets via tox. - Added Sphinx documentation. - Added support for continuous integration using ``tox`` and ``jenkins``. - Removed use of '2to3' and associated fixers when installing under Py3k. The code is now in a "compatible subset" which supports Python 2.6, 2.7, and 3.2, including PyPy 1.8 (the version compatible with the 2.7 language spec). - 100% unit test coverage. - Dropped explicit support for Python 2.4 / 2.5 / 3.1. - Added 'setup.py dev' alias (runs ``setup.py develop`` plus installs ``nose`` and ``coverage``). - Added 'setup.py docs' alias (installs ``Sphinx`` and dependencies). 3.7.1 (2012-03-28) ------------------ - Fix: missed to reverse extractStack entries 3.7.0 (2012-03-28) ------------------ - Added TextExceptionFormatter.extractStack and extract_stack 3.6.2 (2012-03-28) ------------------ - Fallback to traceback.format_tb when the formatter is called recursively. i.e. Don't let errors in the formatter pass silently. - Fix deprecated unittest functions: ``assert_`` and ``assertEquals``. 3.6.1 (2010-07-06) ------------------ - Fixed tests to work under Python 2.7. - PEP8 cleanup and removed obsolete build infrastructure files. 3.6.0 (2010-05-02) ------------------ - Added support to bootstrap on Jython. - Added Python 3 support. - The dependency on zope.testing seemed spurious, possibly a rest of a real dependency that is gone now. I removed it. 3.5.2 (2008-04-30) ------------------ - Updated CHANGES.txt. 3.5.1 (2008-04-28) ------------------ - Reverted changes in 3.5.0. 3.5.0 ----- - Added the capability for exceptions to be formatted line-by-line. Unfortunately, also introduced a bug cause each line of the exception to be its own log message. 3.4.0 (2007-10-02) ------------------ - Updated package meta-data. 3.4.0b2 (2007-08-14) -------------------- - Removed superfluous dependency on ``zope.deprecation``. 3.4.0b1 (2007-07-09) -------------------- - Corresponds to the version of the ``zope.exceptions`` package shipped as part of the Zope 3.4.0b1 release. 3.2.0 (2006-01-05) ------------------ - Corresponds to the version of the ``zope.exceptions`` package shipped as part of the Zope 3.2.0 release. - Deprecated the ``INotFoundError`` interface and the corresponding ``NotFoundError`` exception class, in favor of "standard" exceptions ``AttributeError``, ``KeyError``). The deprecated items will be removed in Zope 3.3. 3.0.0 (2004-11-07) ------------------ - Corresponds to the version of the zope.exceptions package shipped as part of the Zope X3.0.0 release. zope.exceptions-4.0.8/.travis.yml0000664000175100017510000000031012563163712016311 0ustar adiadi00000000000000language: python sudo: false python: - 2.6 - 2.7 - 3.2 - 3.3 - 3.4 - pypy install: - pip install . script: - python setup.py -q test -q notifications: email: false zope.exceptions-4.0.8/src/0000775000175100017510000000000012563163734015001 5ustar adiadi00000000000000zope.exceptions-4.0.8/src/zope.exceptions.egg-info/0000775000175100017510000000000012563163734021630 5ustar adiadi00000000000000zope.exceptions-4.0.8/src/zope.exceptions.egg-info/top_level.txt0000664000175100017510000000000512563163727024357 0ustar adiadi00000000000000zope zope.exceptions-4.0.8/src/zope.exceptions.egg-info/requires.txt0000664000175100017510000000013512563163727024231 0ustar adiadi00000000000000setuptools zope.interface [docs] Sphinx repoze.sphinx.autointerface [testing] nose coveragezope.exceptions-4.0.8/src/zope.exceptions.egg-info/not-zip-safe0000664000175100017510000000000112563163712024052 0ustar adiadi00000000000000 zope.exceptions-4.0.8/src/zope.exceptions.egg-info/namespace_packages.txt0000664000175100017510000000000512563163727026160 0ustar adiadi00000000000000zope zope.exceptions-4.0.8/src/zope.exceptions.egg-info/dependency_links.txt0000664000175100017510000000000112563163727025700 0ustar adiadi00000000000000 zope.exceptions-4.0.8/src/zope.exceptions.egg-info/SOURCES.txt0000664000175100017510000000152212563163727023516 0ustar adiadi00000000000000.travis.yml CHANGES.rst COPYRIGHT.txt LICENSE.txt MANIFEST.in README.rst bootstrap.py buildout.cfg rtd.txt setup.cfg setup.py tox.ini docs/Makefile docs/api.rst docs/conf.py docs/hacking.rst docs/index.rst docs/make.bat docs/narr.rst docs/_static/.gitignore src/zope/__init__.py src/zope.exceptions.egg-info/PKG-INFO src/zope.exceptions.egg-info/SOURCES.txt src/zope.exceptions.egg-info/dependency_links.txt src/zope.exceptions.egg-info/namespace_packages.txt src/zope.exceptions.egg-info/not-zip-safe src/zope.exceptions.egg-info/requires.txt src/zope.exceptions.egg-info/top_level.txt src/zope/exceptions/__init__.py src/zope/exceptions/exceptionformatter.py src/zope/exceptions/interfaces.py src/zope/exceptions/log.py src/zope/exceptions/tests/__init__.py src/zope/exceptions/tests/test_exceptionformatter.py src/zope/exceptions/tests/test_log.pyzope.exceptions-4.0.8/src/zope.exceptions.egg-info/PKG-INFO0000664000175100017510000001707712563163727022743 0ustar adiadi00000000000000Metadata-Version: 1.1 Name: zope.exceptions Version: 4.0.8 Summary: Zope Exceptions Home-page: http://cheeseshop.python.org/pypi/zope.exceptions Author: Zope Foundation and Contributors Author-email: zope-dev@zope.org License: ZPL 2.1 Description: ``zope.exceptions`` =================== .. image:: https://pypip.in/version/zope.exceptions/badge.svg?style=flat :target: https://pypi.python.org/pypi/zope.exceptions/ :alt: Latest Version .. image:: https://travis-ci.org/zopefoundation/zope.exceptions.png?branch=master :target: https://travis-ci.org/zopefoundation/zope.exceptions .. image:: https://readthedocs.org/projects/zopeexceptions/badge/?version=latest :target: http://zopeexceptions.readthedocs.org/en/latest/ :alt: Documentation Status This package contains exception exceptions and implementations which are so general purpose that they don't belong in Zope application-specific packages. Please see http://docs.zope.org/zope.exceptions/ for the documentation. ``zope.exceptions`` Changelog ============================= 4.0.8 (2015-08-13) ------------------ - Fixes around ``TextExceptionFormatter`` ``limit``: ``formatException`` and ``extractStack`` was cutting the traceback at the bottom, at the most interesting point. Now it will cut from the middle. Some text about the missing entries will be inserted. - Maybe fix for ``extractStack``, it did not detect recursions in the frames. 4.0.7 (2014-03-19) ------------------ - Added explicit support for Python 3.4. - Updated ``boostrap.py`` to version 2.2. 4.0.6 (2013-02-28) ------------------ - Make sure that ``setup.py`` finds all tests. Now tox runs them all as well. - Fix failing test under Python 3. - Made buildout work under Python 3 and Buildout 2. 4.0.5 (2012-12-31) ------------------ - Fleshed out PyPI Trove classifiers. - Fixed a test failure under Python 2.6. 4.0.4 (2012-12-13) ------------------ - Release with a fixed MANIFEST.in (without ``docs/``) 4.0.3 (2012-12-10) ------------------ - Fixed format_exception(..., as_html=True) not to HTML-escape the '
' it adds to the exception value. 4.0.2 (2012-11-21) ------------------ - Test Python 3.3 support under tox. 4.0.1 (2012-08-20) ------------------ - Fixed optional dependency code for `zope.security` to work under Python 3.3. 4.0.0.1 (2012-05-16) -------------------- - Fixed rendering of package docs on PyPI. 4.0.0 (2012-05-16) ------------------ - Automated build of Sphinx HTML docs and running doctest snippets via tox. - Added Sphinx documentation. - Added support for continuous integration using ``tox`` and ``jenkins``. - Removed use of '2to3' and associated fixers when installing under Py3k. The code is now in a "compatible subset" which supports Python 2.6, 2.7, and 3.2, including PyPy 1.8 (the version compatible with the 2.7 language spec). - 100% unit test coverage. - Dropped explicit support for Python 2.4 / 2.5 / 3.1. - Added 'setup.py dev' alias (runs ``setup.py develop`` plus installs ``nose`` and ``coverage``). - Added 'setup.py docs' alias (installs ``Sphinx`` and dependencies). 3.7.1 (2012-03-28) ------------------ - Fix: missed to reverse extractStack entries 3.7.0 (2012-03-28) ------------------ - Added TextExceptionFormatter.extractStack and extract_stack 3.6.2 (2012-03-28) ------------------ - Fallback to traceback.format_tb when the formatter is called recursively. i.e. Don't let errors in the formatter pass silently. - Fix deprecated unittest functions: ``assert_`` and ``assertEquals``. 3.6.1 (2010-07-06) ------------------ - Fixed tests to work under Python 2.7. - PEP8 cleanup and removed obsolete build infrastructure files. 3.6.0 (2010-05-02) ------------------ - Added support to bootstrap on Jython. - Added Python 3 support. - The dependency on zope.testing seemed spurious, possibly a rest of a real dependency that is gone now. I removed it. 3.5.2 (2008-04-30) ------------------ - Updated CHANGES.txt. 3.5.1 (2008-04-28) ------------------ - Reverted changes in 3.5.0. 3.5.0 ----- - Added the capability for exceptions to be formatted line-by-line. Unfortunately, also introduced a bug cause each line of the exception to be its own log message. 3.4.0 (2007-10-02) ------------------ - Updated package meta-data. 3.4.0b2 (2007-08-14) -------------------- - Removed superfluous dependency on ``zope.deprecation``. 3.4.0b1 (2007-07-09) -------------------- - Corresponds to the version of the ``zope.exceptions`` package shipped as part of the Zope 3.4.0b1 release. 3.2.0 (2006-01-05) ------------------ - Corresponds to the version of the ``zope.exceptions`` package shipped as part of the Zope 3.2.0 release. - Deprecated the ``INotFoundError`` interface and the corresponding ``NotFoundError`` exception class, in favor of "standard" exceptions ``AttributeError``, ``KeyError``). The deprecated items will be removed in Zope 3.3. 3.0.0 (2004-11-07) ------------------ - Corresponds to the version of the zope.exceptions package shipped as part of the Zope X3.0.0 release. Keywords: zope exceptions Platform: UNKNOWN Classifier: Development Status :: 5 - Production/Stable Classifier: Environment :: Web Environment Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: Zope Public License Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 2 Classifier: Programming Language :: Python :: 2.6 Classifier: Programming Language :: Python :: 2.7 Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.2 Classifier: Programming Language :: Python :: 3.3 Classifier: Programming Language :: Python :: 3.4 Classifier: Programming Language :: Python :: Implementation :: CPython Classifier: Programming Language :: Python :: Implementation :: PyPy Classifier: Natural Language :: English Classifier: Operating System :: OS Independent Classifier: Topic :: Internet :: WWW/HTTP Classifier: Framework :: Zope3 zope.exceptions-4.0.8/src/zope/0000775000175100017510000000000012563163734015756 5ustar adiadi00000000000000zope.exceptions-4.0.8/src/zope/__init__.py0000664000175100017510000000007012563163712020060 0ustar adiadi00000000000000__import__('pkg_resources').declare_namespace(__name__) zope.exceptions-4.0.8/src/zope/exceptions/0000775000175100017510000000000012563163734020137 5ustar adiadi00000000000000zope.exceptions-4.0.8/src/zope/exceptions/log.py0000664000175100017510000000247512563163712021276 0ustar adiadi00000000000000############################################################################## # # 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. # ############################################################################## """Log formatter that enhances tracebacks with extra information. """ import logging try: from StringIO import StringIO except ImportError: #pragma NO COVER Python3 from io import StringIO from zope.exceptions.exceptionformatter import print_exception class Formatter(logging.Formatter): def formatException(self, ei): """Format and return the specified exception information as a string. Uses zope.exceptions.exceptionformatter to generate the traceback. """ sio = StringIO() print_exception(ei[0], ei[1], ei[2], file=sio, with_filenames=True) s = sio.getvalue() if s.endswith("\n"): s = s[:-1] return s zope.exceptions-4.0.8/src/zope/exceptions/interfaces.py0000664000175100017510000000655712563163712022645 0ustar adiadi00000000000000############################################################################## # # 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. # ############################################################################## """ITracebackSupplement interface definition. When zope.exceptionformatter generates a traceback, it looks for local variables named __traceback_info__ or __traceback_supplement__. It includes the information provided by those local variables in the traceback. __traceback_info__ is for arbitrary information. repr(__traceback_info__) gets dumped to the traceback. __traceback_supplement__ is more structured. It should be a tuple. The first item of the tuple is a callable that produces an object that implements ITracebackSupplement, and the rest of the tuple contains arguments to pass to the factory. The traceback formatter makes an effort to clearly present the information provided by the ITracebackSupplement. """ from zope.interface import Interface from zope.interface import Attribute from zope.interface import implementer class IDuplicationError(Interface): pass @implementer(IDuplicationError) class DuplicationError(Exception): """A duplicate registration was attempted""" class IUserError(Interface): """User error exceptions """ @implementer(IUserError) class UserError(Exception): """User errors These exceptions should generally be displayed to users unless they are handled. """ class ITracebackSupplement(Interface): """Provides valuable information to supplement an exception traceback. The interface is geared toward providing meaningful feedback when exceptions occur in user code written in mini-languages like Zope page templates and restricted Python scripts. """ source_url = Attribute( 'source_url', """Optional. Set to URL of the script where the exception occurred. Normally this generates a URL in the traceback that the user can visit to manage the object. Set to None if unknown or not available. """) line = Attribute( 'line', """Optional. Set to the line number (>=1) where the exception occurred. Set to 0 or None if the line number is unknown. """) column = Attribute( 'column', """Optional. Set to the column offset (>=0) where the exception occurred. Set to None if the column number is unknown. """) expression = Attribute( 'expression', """Optional. Set to the expression that was being evaluated. Set to None if not available or not applicable. """) warnings = Attribute( 'warnings', """Optional. Set to a sequence of warning messages. Set to None if not available, not applicable, or if the exception itself provides enough information. """) def getInfo(): """Optional. Returns a string containing any other useful info. """ zope.exceptions-4.0.8/src/zope/exceptions/exceptionformatter.py0000664000175100017510000002466512563163712024444 0ustar adiadi00000000000000############################################################################## # # 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. # ############################################################################## """An exception formatter that shows traceback supplements and traceback info, optionally in HTML. """ import sys try: from html import escape except ImportError: from cgi import escape import linecache import traceback DEBUG_EXCEPTION_FORMATTER = 1 class TextExceptionFormatter(object): line_sep = '\n' def __init__(self, limit=None, with_filenames=False): self.limit = limit self.with_filenames = with_filenames def escape(self, s): return s def getPrefix(self): return 'Traceback (most recent call last):' def getLimit(self): limit = self.limit if limit is None: limit = getattr(sys, 'tracebacklimit', 200) return limit def formatSupplementLine(self, line): return ' - %s' % line def formatSourceURL(self, url): return [self.formatSupplementLine(url)] def formatSupplement(self, supplement, tb): result = [] fmtLine = self.formatSupplementLine url = getattr(supplement, 'source_url', None) if url is not None: result.extend(self.formatSourceURL(url)) line = getattr(supplement, 'line', 0) if line == -1: line = tb.tb_lineno col = getattr(supplement, 'column', -1) if line: if col is not None and col >= 0: result.append(fmtLine('Line %s, Column %s' % ( line, col))) else: result.append(fmtLine('Line %s' % line)) elif col is not None and col >= 0: result.append(fmtLine('Column %s' % col)) expr = getattr(supplement, 'expression', None) if expr: result.append(fmtLine('Expression: %s' % expr)) warnings = getattr(supplement, 'warnings', None) if warnings: for warning in warnings: result.append(fmtLine('Warning: %s' % warning)) getInfo = getattr(supplement, 'getInfo', None) if getInfo is not None: try: extra = getInfo() if extra: result.append(self.formatSupplementInfo(extra)) except: #pragma NO COVER if DEBUG_EXCEPTION_FORMATTER: traceback.print_exc() # else just swallow the exception. return result def formatSupplementInfo(self, info): return self.escape(info) def formatTracebackInfo(self, tbi): return self.formatSupplementLine('__traceback_info__: %s' % (tbi, )) def formatLine(self, tb=None, f=None): if tb and not f: f = tb.tb_frame lineno = tb.tb_lineno elif not tb and f: lineno = f.f_lineno else: raise ValueError("Pass exactly one of tb or f") co = f.f_code filename = co.co_filename name = co.co_name locals = f.f_locals # XXX shadowing normal builtins deliberately? globals = f.f_globals # XXX shadowing normal builtins deliberately? if self.with_filenames: s = ' File "%s", line %d' % (filename, lineno) else: modname = globals.get('__name__', filename) s = ' Module %s, line %d' % (modname, lineno) s = s + ', in %s' % name result = [] result.append(self.escape(s)) # Append the source line, if available line = linecache.getline(filename, lineno) if line: result.append(" " + self.escape(line.strip())) # Output a traceback supplement, if any. if '__traceback_supplement__' in locals: # Use the supplement defined in the function. tbs = locals['__traceback_supplement__'] elif '__traceback_supplement__' in globals: # Use the supplement defined in the module. # This is used by Scripts (Python). tbs = globals['__traceback_supplement__'] else: tbs = None if tbs is not None: factory = tbs[0] args = tbs[1:] try: supp = factory(*args) result.extend(self.formatSupplement(supp, tb)) except: #pragma NO COVER if DEBUG_EXCEPTION_FORMATTER: traceback.print_exc() # else just swallow the exception. try: tbi = locals.get('__traceback_info__', None) if tbi is not None: result.append(self.formatTracebackInfo(tbi)) except: #pragma NO COVER if DEBUG_EXCEPTION_FORMATTER: traceback.print_exc() # else just swallow the exception. return self.line_sep.join(result) def formatExceptionOnly(self, etype, value): result = ''.join(traceback.format_exception_only(etype, value)) return result def formatLastLine(self, exc_line): return self.escape(exc_line) def formatException(self, etype, value, tb): # The next line provides a way to detect recursion. __exception_formatter__ = 1 result = [] while tb is not None: if tb.tb_frame.f_locals.get('__exception_formatter__'): # Stop recursion. result.append('(Recursive formatException() stopped, ' 'trying traceback.format_tb)\n') result.extend(traceback.format_tb(tb)) break line = self.formatLine(tb=tb) result.append(line + '\n') tb = tb.tb_next template = ( '...\n' '{omitted} entries omitted, because limit is {limit}.\n' 'Set sys.tracebacklimit or {klass}.limit to a higher' ' value to see omitted entries\n' '...') self._obeyLimit(result, template) result = [self.getPrefix() + '\n'] + result exc_line = self.formatExceptionOnly(etype, value) result.append(self.formatLastLine(exc_line)) return result def extractStack(self, f=None): if f is None: try: raise ZeroDivisionError except ZeroDivisionError: f = sys.exc_info()[2].tb_frame.f_back # The next line provides a way to detect recursion. __exception_formatter__ = 1 result = [] while f is not None: if f.f_locals.get('__exception_formatter__'): # Stop recursion. result.append('(Recursive extractStack() stopped, ' 'trying traceback.format_stack)\n') res = traceback.format_stack(f) res.reverse() result.extend(res) break line = self.formatLine(f=f) result.append(line + '\n') f = f.f_back self._obeyLimit( result, '...{omitted} entries omitted, because limit is {limit}...\n') result.reverse() return result def _obeyLimit(self, result, template): limit = self.getLimit() if limit is not None and len(result) > limit: # cut out the middle part of the TB tocut = len(result) - limit middle = len(result) // 2 lower = middle - tocut // 2 msg = template.format( omitted=tocut, limit=limit, klass=self.__class__.__name__) result[lower:lower + tocut] = [msg] class HTMLExceptionFormatter(TextExceptionFormatter): line_sep = '
\r\n' def escape(self, s): return escape(s, quote=False) def getPrefix(self): return '

Traceback (most recent call last):

\r\n

%s

' % self.escape(exc_line) return line.replace('\n', self.line_sep) def format_exception(t, v, tb, limit=None, as_html=False, with_filenames=False): """Format a stack trace and the exception information. Similar to 'traceback.format_exception', but adds supplemental information to the traceback and accepts two options, 'as_html' and 'with_filenames'. """ if as_html: fmt = HTMLExceptionFormatter(limit, with_filenames) else: fmt = TextExceptionFormatter(limit, with_filenames) return fmt.formatException(t, v, tb) def print_exception(t, v, tb, limit=None, file=None, as_html=False, with_filenames=True): """Print exception up to 'limit' stack trace entries from 'tb' to 'file'. Similar to 'traceback.print_exception', but adds supplemental information to the traceback and accepts two options, 'as_html' and 'with_filenames'. """ if file is None: #pragma NO COVER file = sys.stderr lines = format_exception(t, v, tb, limit, as_html, with_filenames) for line in lines: file.write(line) def extract_stack(f, limit=None, as_html=False, with_filenames=True): """Format a stack trace and the exception information. Similar to 'traceback.format_exception', but adds supplemental information to the traceback and accepts two options, 'as_html' and 'with_filenames'. """ if as_html: fmt = HTMLExceptionFormatter(limit, with_filenames) else: fmt = TextExceptionFormatter(limit, with_filenames) return fmt.extractStack(f) zope.exceptions-4.0.8/src/zope/exceptions/__init__.py0000664000175100017510000000335312563163712022250 0ustar adiadi00000000000000############################################################################## # # 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. # ############################################################################## """General exceptions that wish they were standard exceptions These exceptions are so general purpose that they don't belong in Zope application-specific packages. """ from zope.exceptions.interfaces import DuplicationError from zope.exceptions.interfaces import IDuplicationError from zope.exceptions.interfaces import UserError from zope.exceptions.interfaces import IUserError from zope.exceptions.exceptionformatter import format_exception from zope.exceptions.exceptionformatter import print_exception from zope.exceptions.exceptionformatter import extract_stack # avoid dependency on zope.security: try: import zope.security except ImportError as v: #pragma NO COVER # "ImportError: No module named security" if 'security' not in str(v): raise else: #pragma NO COVER from zope.security.interfaces import IUnauthorized from zope.security.interfaces import Unauthorized from zope.security.interfaces import IForbidden from zope.security.interfaces import IForbiddenAttribute from zope.security.interfaces import Forbidden from zope.security.interfaces import ForbiddenAttribute zope.exceptions-4.0.8/src/zope/exceptions/tests/0000775000175100017510000000000012563163734021301 5ustar adiadi00000000000000zope.exceptions-4.0.8/src/zope/exceptions/tests/test_log.py0000664000175100017510000000364112563163712023473 0ustar adiadi00000000000000############################################################################## # # Copyright (c) 2012 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. # ############################################################################## """log.Formatter tests. """ import unittest class FormatterTests(unittest.TestCase): def _getTargetClass(self): from zope.exceptions.log import Formatter return Formatter def _makeOne(self, *args, **kw): return self._getTargetClass()(*args, **kw) def test_simple_exception(self): import traceback tb = DummyTB() tb.tb_frame = DummyFrame() exc = ValueError('testing') fmt = self._makeOne() result = fmt.formatException((ValueError, exc, tb)) lines = result.splitlines() self.assertEqual(len(lines), 3) self.assertEqual(lines[0], 'Traceback (most recent call last):') self.assertEqual(lines[1], ' File "dummy/filename.py", line 14, ' 'in dummy_function') self.assertEqual(lines[2], traceback.format_exception_only( ValueError, exc)[0][:-1]) #trailing \n class DummyTB(object): tb_lineno = 14 tb_next = None class DummyFrame(object): f_lineno = 137 f_back = None def __init__(self): self.f_locals = {} self.f_globals = {} self.f_code = DummyCode() class DummyCode(object): co_filename = 'dummy/filename.py' co_name = 'dummy_function' zope.exceptions-4.0.8/src/zope/exceptions/tests/test_exceptionformatter.py0000664000175100017510000007727412563163712026651 0ustar adiadi00000000000000############################################################################## # # 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. # ############################################################################## """ExceptionFormatter tests. """ import unittest import doctest import sys class TextExceptionFormatterTests(unittest.TestCase): def _getTargetClass(self): from zope.exceptions.exceptionformatter import TextExceptionFormatter return TextExceptionFormatter def _makeOne(self, *args, **kw): return self._getTargetClass()(*args, **kw) def test_ctor_defaults(self): fmt = self._makeOne() self.assertEqual(fmt.line_sep, '\n') self.assertEqual(fmt.limit, None) self.assertEqual(fmt.with_filenames, False) def test_ctor_explicit(self): fmt = self._makeOne(limit=20, with_filenames=True) self.assertEqual(fmt.line_sep, '\n') self.assertEqual(fmt.limit, 20) self.assertEqual(fmt.with_filenames, True) def test_escape(self): fmt = self._makeOne() self.assertEqual(fmt.escape('XXX'), 'XXX') def test_getPrefix(self): fmt = self._makeOne() self.assertEqual(fmt.getPrefix(), 'Traceback (most recent call last):') def test_getLimit_default(self): fmt = self._makeOne() self.assertEqual(fmt.getLimit(), 200) def test_getLimit_sys_has_limit(self): import sys fmt = self._makeOne() with _Monkey(sys, tracebacklimit=15): self.assertEqual(fmt.getLimit(), 15) def test_getLimit_explicit(self): fmt = self._makeOne(limit=10) self.assertEqual(fmt.getLimit(), 10) def test_formatSupplementLine(self): fmt = self._makeOne() self.assertEqual(fmt.formatSupplementLine('XXX'), ' - XXX') def test_formatSourceURL(self): fmt = self._makeOne() self.assertEqual(fmt.formatSourceURL('http://example.com/'), [' - http://example.com/']) def test_formatSupplement_no_info(self): fmt = self._makeOne() supplement = DummySupplement() self.assertEqual(fmt.formatSupplement(supplement, tb=None), []) def test_formatSupplement_w_source_url(self): fmt = self._makeOne() supplement = DummySupplement() supplement.source_url = 'http://example.com/' self.assertEqual(fmt.formatSupplement(supplement, tb=None), [' - http://example.com/']) def test_formatSupplement_w_line_as_marker(self): fmt = self._makeOne() supplement = DummySupplement() supplement.line = -1 tb = DummyTB() self.assertEqual(fmt.formatSupplement(supplement, tb=tb), [' - Line 14']) def test_formatSupplement_w_line_no_column(self): fmt = self._makeOne() supplement = DummySupplement() supplement.line = 23 self.assertEqual(fmt.formatSupplement(supplement, tb=None), [' - Line 23']) def test_formatSupplement_w_column_no_line(self): fmt = self._makeOne() supplement = DummySupplement() supplement.column = 47 self.assertEqual(fmt.formatSupplement(supplement, tb=None), [' - Column 47']) def test_formatSupplement_w_line_and_column(self): fmt = self._makeOne() supplement = DummySupplement() supplement.line = 23 supplement.column = 47 self.assertEqual(fmt.formatSupplement(supplement, tb=None), [' - Line 23, Column 47']) def test_formatSupplement_w_expression(self): fmt = self._makeOne() supplement = DummySupplement() supplement.expression = 'a*x^2 + b*x + c' self.assertEqual(fmt.formatSupplement(supplement, tb=None), [' - Expression: a*x^2 + b*x + c']) def test_formatSupplement_w_warnings(self): fmt = self._makeOne() supplement = DummySupplement() supplement.warnings = ['Beware the ides of March!', 'You\'re gonna get wasted.', ] self.assertEqual(fmt.formatSupplement(supplement, tb=None), [' - Warning: Beware the ides of March!', ' - Warning: You\'re gonna get wasted.', ]) def test_formatSupplement_w_getInfo_empty(self): fmt = self._makeOne() supplement = DummySupplement() self.assertEqual(fmt.formatSupplement(supplement, tb=None), []) def test_formatSupplement_w_getInfo_text(self): INFO = 'Some days\nI wish I had stayed in bed.' fmt = self._makeOne() supplement = DummySupplement(INFO) self.assertEqual(fmt.formatSupplement(supplement, tb=None), [INFO]) def test_formatSupplementInfo(self): INFO = 'Some days\nI wish I had stayed in bed.' fmt = self._makeOne() self.assertEqual(fmt.formatSupplementInfo(INFO), INFO) def test_formatTracebackInfo(self): fmt = self._makeOne() self.assertEqual(fmt.formatTracebackInfo('XYZZY'), ' - __traceback_info__: XYZZY') def test_formatLine_no_tb_no_f(self): fmt = self._makeOne() self.assertRaises(ValueError, fmt.formatLine, None, None) def test_formatLine_w_tb_and_f(self): fmt = self._makeOne() tb = DummyTB() f = DummyFrame() self.assertRaises(ValueError, fmt.formatLine, tb, f) def test_formatLine_w_tb_bogus_linecache_w_filenames(self): fmt = self._makeOne(with_filenames=True) tb = DummyTB() tb.tb_frame = f = DummyFrame() lines = fmt.formatLine(tb).splitlines() self.assertEqual(len(lines), 1) self.assertEqual(lines[0], ' File "%s", line %d, in %s' % (f.f_code.co_filename, tb.tb_lineno, f.f_code.co_name, )) def test_formatLine_w_f_bogus_linecache_w_filenames(self): fmt = self._makeOne(with_filenames=True) f = DummyFrame() lines = fmt.formatLine(f=f).splitlines() self.assertEqual(len(lines), 1) self.assertEqual(lines[0], ' File "%s", line %d, in %s' % (f.f_code.co_filename, f.f_lineno, f.f_code.co_name, )) def test_formatLine_w_tb_bogus_linecache_wo_filenames(self): fmt = self._makeOne(with_filenames=False) tb = DummyTB() tb.tb_frame = f = DummyFrame() f.f_globals['__name__'] = 'dummy.filename' lines = fmt.formatLine(tb).splitlines() self.assertEqual(len(lines), 1) self.assertEqual(lines[0], ' Module dummy.filename, line %d, in %s' % (tb.tb_lineno, f.f_code.co_name, )) def test_formatLine_w_f_real_linecache_w_filenames(self): import sys fmt = self._makeOne(with_filenames=True) f = sys._getframe(); lineno = f.f_lineno result = fmt.formatLine(f=f) lines = result.splitlines() self.assertEqual(len(lines), 2) self.assertEqual(lines[0], ' File "%s", line %d, in %s' % (f.f_code.co_filename, lineno + 1, f.f_code.co_name, )) self.assertEqual(lines[1], ' result = fmt.formatLine(f=f)') def test_formatLine_w_supplement_in_locals(self): INFO_L = 'I wish I had stayed in bed.' INFO_G = 'I would rather soak my head.' fmt = self._makeOne(with_filenames=False) tb = DummyTB() tb.tb_frame = f = DummyFrame() f.f_globals['__name__'] = 'dummy.filename' f.f_locals['__traceback_supplement__'] = (DummySupplement, INFO_L) f.f_globals['__traceback_supplement__'] = (DummySupplement, INFO_G) lines = fmt.formatLine(tb).splitlines() self.assertEqual(len(lines), 2) self.assertEqual(lines[1], INFO_L) def test_formatLine_w_supplement_in_globals(self): INFO_G = 'I would rather soak my head.' fmt = self._makeOne(with_filenames=False) tb = DummyTB() tb.tb_frame = f = DummyFrame() f.f_globals['__name__'] = 'dummy.filename' f.f_globals['__traceback_supplement__'] = (DummySupplement, INFO_G) lines = fmt.formatLine(tb).splitlines() self.assertEqual(len(lines), 2) self.assertEqual(lines[1], INFO_G) def test_formatLine_w_traceback_info(self): INFO_T = 'I would rather soak my head.' fmt = self._makeOne(with_filenames=False) tb = DummyTB() tb.tb_frame = f = DummyFrame() f.f_globals['__name__'] = 'dummy.filename' f.f_locals['__traceback_info__'] = INFO_T lines = fmt.formatLine(tb).splitlines() self.assertEqual(len(lines), 2) self.assertEqual(lines[1], ' - __traceback_info__: %s' % INFO_T) def test_formatExceptionOnly(self): import traceback fmt = self._makeOne() err = ValueError('testing') self.assertEqual(fmt.formatExceptionOnly(ValueError, err), ''.join( traceback.format_exception_only(ValueError, err))) def test_formatLastLine(self): fmt = self._makeOne() self.assertEqual(fmt.formatLastLine('XXX'), 'XXX') def test_formatException_empty_tb_stack(self): import traceback fmt = self._makeOne() err = ValueError('testing') lines = fmt.formatException(ValueError, err, None) self.assertEqual(len(lines), 2) self.assertEqual(lines[0], 'Traceback (most recent call last):\n') self.assertEqual(lines[1], ''.join( traceback.format_exception_only(ValueError, err))) def test_formatException_non_empty_tb_stack(self): import traceback fmt = self._makeOne() err = ValueError('testing') tb = DummyTB() tb.tb_frame = DummyFrame() lines = fmt.formatException(ValueError, err, tb) self.assertEqual(len(lines), 3) self.assertEqual(lines[0], 'Traceback (most recent call last):\n') self.assertEqual(lines[1], ' Module dummy/filename.py, line 14, ' 'in dummy_function\n') self.assertEqual(lines[2], ''.join( traceback.format_exception_only(ValueError, err))) def test_formatException_deep_tb_stack_with_limit(self): import traceback fmt = self._makeOne(limit=4) err = ValueError('testing') tb = self._makeTBs(10) lines = fmt.formatException(ValueError, err, tb) self.assertEqual(len(lines), 7) expected = [ 'Traceback (most recent call last):\n', ' Module dummy/filename.py, line 4345, in dummy_function\n', ' Module dummy/filename.py, line 2287, in dummy_function\n', ('...\n' '6 entries omitted, because limit is 4.\n' 'Set sys.tracebacklimit or TextExceptionFormatter.limit to' ' a higher value to see omitted entries\n' '...'), ' Module dummy/filename.py, line 26, in dummy_function\n', ' Module dummy/filename.py, line 14, in dummy_function\n', ''.join(traceback.format_exception_only(ValueError, err)) ] self.assertEqual(lines, expected) def test_formatException_recursion_in_tb_stack(self): import traceback fmt = self._makeOne() err = ValueError('testing') tb_recurse = DummyTB() tb_recurse.tb_lineno = 27 r_f = tb_recurse.tb_frame = DummyFrame() r_f.f_lineno = 27 r_f.f_locals['__exception_formatter__'] = 1 tb = DummyTB() tb.tb_frame = DummyFrame() tb.tb_next = tb_recurse lines = fmt.formatException(ValueError, err, tb) self.assertEqual(len(lines), 5) self.assertEqual(lines[0], 'Traceback (most recent call last):\n') self.assertEqual(lines[1], ' Module dummy/filename.py, line 14, ' 'in dummy_function\n') self.assertEqual(lines[2], '(Recursive formatException() stopped, ' 'trying traceback.format_tb)\n') self.assertEqual(lines[3], ' File "dummy/filename.py", line 27, ' 'in dummy_function\n') self.assertEqual(lines[4], ''.join( traceback.format_exception_only(ValueError, err))) def test_extractStack_wo_frame(self): import sys fmt = self._makeOne() f = sys._getframe(); lineno = f.f_lineno lines = fmt.extractStack() # rather don't assert this here # self.assertEqual(len(lines), 10) self.assertEqual(lines[-1], ' Module ' 'zope.exceptions.tests.test_exceptionformatter, ' 'line %d, in test_extractStack_wo_frame\n' ' lines = fmt.extractStack()\n' % (lineno + 1)) def test_extractStack_wo_frame_w_limit(self): import sys fmt = self._makeOne(limit=2) f = sys._getframe(); lineno = f.f_lineno lines = fmt.extractStack() self.assertEqual(len(lines), 3) self.assertEqual(lines[-1], ' Module ' 'zope.exceptions.tests.test_exceptionformatter, ' 'line %d, in test_extractStack_wo_frame_w_limit\n' ' lines = fmt.extractStack()\n' % (lineno + 1)) def test_extractStack_w_single_frame(self): fmt = self._makeOne() f = DummyFrame() lines = fmt.extractStack(f) self.assertEqual(len(lines), 1) self.assertEqual(lines[0], ' Module dummy/filename.py, line 137, ' 'in dummy_function\n') def test_extractStack_w_multiple_frames_and_limit(self): fmt = self._makeOne(limit=2) f = self._makeFrames(10) lines = fmt.extractStack(f) self.assertEqual(len(lines), 3) expected = [ ' Module dummy/filename.py, line 17, in dummy_function\n', '...8 entries omitted, because limit is 2...\n', ' Module dummy/filename.py, line 1126, in dummy_function\n', ] self.assertEqual(expected, lines) def test_extractStack_w_recursive_frames(self): fmt = self._makeOne() f = self._makeFrames(3) f.f_back.f_locals['__exception_formatter__'] = 1 lines = fmt.extractStack(f) self.assertEqual(len(lines), 4) expected = [ ' File "dummy/filename.py", line 17, in dummy_function\n', ' File "dummy/filename.py", line 27, in dummy_function\n', '(Recursive extractStack() stopped, trying traceback.format_stack)\n', ' Module dummy/filename.py, line 43, in dummy_function\n', ] self.assertEqual(expected, lines) def test_extractStack_w_recursive_frames_and_limit(self): fmt = self._makeOne(limit=2) f = self._makeFrames(3) f.f_back.f_locals['__exception_formatter__'] = 1 lines = fmt.extractStack(f) self.assertEqual(len(lines), 3) expected = [ ' File "dummy/filename.py", line 17, in dummy_function\n', '...2 entries omitted, because limit is 2...\n', ' Module dummy/filename.py, line 43, in dummy_function\n', ] self.assertEqual(expected, lines) def _makeTBs(self, count): prev = None for i in range(count): tb = DummyTB() tb.tb_lineno = 14 tb.tb_frame = DummyFrame() if prev is not None: tb.tb_lineno = int(prev.tb_lineno * 1.9) tb.tb_next = prev prev = tb return tb def _makeFrames(self, count): prev = None for i in range(count): f = DummyFrame() f.f_lineno = 17 if prev is not None: f.f_lineno = int(prev.f_lineno * 1.6) f.f_back = prev prev = f return f class HTMLExceptionFormatterTests(unittest.TestCase): def _getTargetClass(self): from zope.exceptions.exceptionformatter import HTMLExceptionFormatter return HTMLExceptionFormatter def _makeOne(self, *args, **kw): return self._getTargetClass()(*args, **kw) def test_ctor_defaults(self): fmt = self._makeOne() self.assertEqual(fmt.line_sep, '
\r\n') self.assertEqual(fmt.limit, None) self.assertEqual(fmt.with_filenames, False) def test_ctor_explicit(self): fmt = self._makeOne(limit=20, with_filenames=True) self.assertEqual(fmt.line_sep, '
\r\n') self.assertEqual(fmt.limit, 20) self.assertEqual(fmt.with_filenames, True) def test_escape_simple(self): fmt = self._makeOne() self.assertEqual(fmt.escape('XXX'), 'XXX') def test_escape_w_markup(self): fmt = self._makeOne() self.assertEqual(fmt.escape('XXX & YYY'), '<span>XXX & YYY<span>') def test_getPrefix(self): fmt = self._makeOne() self.assertEqual(fmt.getPrefix(), '

Traceback (most recent call last):

\r\n

XXX

') class Test_format_exception(unittest.TestCase): def _callFUT(self, as_html=False): import sys from zope.exceptions.exceptionformatter import format_exception t, v, b = sys.exc_info() try: return ''.join(format_exception(t, v, b, as_html=as_html)) finally: del b def test_basic_names_text(self): try: raise ExceptionForTesting except ExceptionForTesting: s = self._callFUT(False) # The traceback should include the name of this function. self.assertTrue(s.find('test_basic_names_text') >= 0) # The traceback should include the name of the exception. self.assertTrue(s.find('ExceptionForTesting') >= 0) def test_basic_names_html(self): try: raise ExceptionForTesting except ExceptionForTesting: s = self._callFUT(True) # The traceback should include the name of this function. self.assertTrue(s.find('test_basic_names_html') >= 0) # The traceback should include the name of the exception. self.assertTrue(s.find('ExceptionForTesting') >= 0) def test_traceback_info_text(self): try: __traceback_info__ = "Adam & Eve" raise ExceptionForTesting except ExceptionForTesting: s = self._callFUT(False) self.assertTrue(s.find('Adam & Eve') >= 0, s) def test_traceback_info_html(self): try: __traceback_info__ = "Adam & Eve" raise ExceptionForTesting except ExceptionForTesting: s = self._callFUT(True) # Be sure quoting is happening. self.assertTrue(s.find('Adam & Eve') >= 0, s) def test_traceback_info_is_tuple(self): try: __traceback_info__ = ("Adam", "Eve") raise ExceptionForTesting except ExceptionForTesting: s = self._callFUT(False) self.assertTrue(s.find('Adam') >= 0, s) self.assertTrue(s.find('Eve') >= 0, s) def test_supplement_text(self, as_html=0): try: __traceback_supplement__ = (TestingTracebackSupplement, "You're one in a million") raise ExceptionForTesting except ExceptionForTesting: s = self._callFUT(as_html) # The source URL self.assertTrue(s.find('/somepath') >= 0, s) # The line number self.assertTrue(s.find('634') >= 0, s) # The column number self.assertTrue(s.find('57') >= 0, s) # The expression self.assertTrue(s.find("You're one in a million") >= 0, s) # The warning self.assertTrue(s.find("Repent, for the end is nigh") >= 0, s) def test_supplement_html(self): try: __traceback_supplement__ = (TestingTracebackSupplement, "You're one in a million") raise ExceptionForTesting except ExceptionForTesting: s = self._callFUT(True) # The source URL self.assertTrue(s.find('/somepath') >= 0, s) # The line number self.assertTrue(s.find('634') >= 0, s) # The column number self.assertTrue(s.find('57') >= 0, s) # The expression self.assertTrue(s.find("You're one in a million") >= 0, s) # The warning self.assertTrue(s.find("Repent, for the end is nigh") >= 0, s) def test_multiple_levels(self): # Ensure many levels are shown in a traceback. HOW_MANY = 10 def f(n): """Produces a (n + 1)-level traceback.""" __traceback_info__ = 'level%d' % n if n > 0: f(n - 1) else: raise ExceptionForTesting try: f(HOW_MANY) except ExceptionForTesting: s = self._callFUT(False) for n in range(HOW_MANY+1): self.assertTrue(s.find('level%d' % n) >= 0, s) def test_quote_last_line(self): class C(object): pass try: raise TypeError(C()) except: s = self._callFUT(True) self.assertTrue(s.find('<') >= 0, s) self.assertTrue(s.find('>') >= 0, s) def test_multiline_exception(self): try: exec('syntax error\n') except Exception: s = self._callFUT(False) lines = s.splitlines()[-3:] self.assertEqual(lines[0], ' syntax error') self.assertTrue(lines[1].endswith(' ^')) #PyPy has a shorter prefix self.assertEqual(lines[2], 'SyntaxError: invalid syntax') def test_recursion_failure(self): import sys from zope.exceptions.exceptionformatter import TextExceptionFormatter class FormatterException(Exception): pass class FailingFormatter(TextExceptionFormatter): def formatLine(self, tb=None, f=None): raise FormatterException("Formatter failed") fmt = FailingFormatter() try: raise ExceptionForTesting except ExceptionForTesting: try: fmt.formatException(*sys.exc_info()) except FormatterException: s = self._callFUT(False) # Recursion was detected self.assertTrue('(Recursive formatException() stopped, ' 'trying traceback.format_tb)' in s, s) # and we fellback to the stdlib rather than hid the real error self.assertEqual(s.splitlines()[-2], ' raise FormatterException("Formatter failed")') self.assertTrue('FormatterException: Formatter failed' in s.splitlines()[-1]) class Test_print_exception(unittest.TestCase): def _callFUT(self, as_html=False): try: from StringIO import StringIO except ImportError: from io import StringIO buf = StringIO() import sys from zope.exceptions.exceptionformatter import print_exception t, v, b = sys.exc_info() try: print_exception(t, v, b, file=buf, as_html=as_html) return buf.getvalue() finally: del b def test_basic_names_text(self): try: raise ExceptionForTesting except ExceptionForTesting: s = self._callFUT(False) # The traceback should include the name of this function. self.assertTrue(s.find('test_basic_names_text') >= 0) # The traceback should include the name of the exception. self.assertTrue(s.find('ExceptionForTesting') >= 0) def test_basic_names_html(self): try: raise ExceptionForTesting except ExceptionForTesting: s = self._callFUT(True) # The traceback should include the name of this function. self.assertTrue(s.find('test_basic_names_html') >= 0) # The traceback should include the name of the exception. self.assertTrue(s.find('ExceptionForTesting') >= 0) class Test_extract_stack(unittest.TestCase): def _callFUT(self, as_html=False): import sys from zope.exceptions.exceptionformatter import extract_stack f = sys.exc_info()[2].tb_frame try: return ''.join(extract_stack(f, as_html=as_html)) finally: del f def test_basic_names_as_text(self, as_html=0): try: raise ExceptionForTesting except ExceptionForTesting: s = self._callFUT(False) # The stack trace should include the name of this function. self.assertTrue(s.find('test_basic_names_as_text') >= 0) def test_basic_names_as_html(self): try: raise ExceptionForTesting except ExceptionForTesting: s = self._callFUT(True) # The stack trace should include the name of this function. self.assertTrue(s.find('test_basic_names_as_html') >= 0) def test_traceback_info_text(self): try: __traceback_info__ = "Adam & Eve" raise ExceptionForTesting except ExceptionForTesting: s = self._callFUT(False) self.assertTrue(s.find('Adam & Eve') >= 0, s) def test_traceback_info_html(self): try: __traceback_info__ = "Adam & Eve" raise ExceptionForTesting except ExceptionForTesting: s = self._callFUT(True) self.assertTrue(s.find('Adam & Eve') >= 0, s) def test_traceback_supplement_text(self): try: __traceback_supplement__ = (TestingTracebackSupplement, "You're one in a million") raise ExceptionForTesting except ExceptionForTesting: s = self._callFUT(False) # The source URL self.assertTrue(s.find('/somepath') >= 0, s) # The line number self.assertTrue(s.find('634') >= 0, s) # The column number self.assertTrue(s.find('57') >= 0, s) # The expression self.assertTrue(s.find("You're one in a million") >= 0, s) # The warning self.assertTrue(s.find("Repent, for the end is nigh") >= 0, s) def test_traceback_supplement_html(self): try: __traceback_supplement__ = (TestingTracebackSupplement, "You're one in a million") raise ExceptionForTesting except ExceptionForTesting: s = self._callFUT(True) # The source URL self.assertTrue(s.find('/somepath') >= 0, s) # The line number self.assertTrue(s.find('634') >= 0, s) # The column number self.assertTrue(s.find('57') >= 0, s) # The expression self.assertTrue(s.find("You're one in a million") >= 0, s) # The warning self.assertTrue(s.find("Repent, for the end is nigh") >= 0, s) class ExceptionForTesting (Exception): pass class TestingTracebackSupplement(object): source_url = '/somepath' line = 634 column = 57 warnings = ['Repent, for the end is nigh'] def __init__(self, expression): self.expression = expression class DummySupplement(object): def __init__(self, info=''): self._info = info def getInfo(self): return self._info class DummyTB(object): tb_lineno = 14 tb_next = None class DummyFrame(object): f_lineno = 137 f_back = None def __init__(self): self.f_locals = {} self.f_globals = {} self.f_code = DummyCode() class DummyCode(object): co_filename = 'dummy/filename.py' co_name = 'dummy_function' class _Monkey(object): # context-manager for replacing module names in the scope of a test. def __init__(self, module, **kw): self.module = module self.to_restore = dict([(key, getattr(module, key, self)) for key in kw]) for key, value in kw.items(): setattr(module, key, value) def __enter__(self): return self def __exit__(self, exc_type, exc_val, exc_tb): for key, value in self.to_restore.items(): if value is not self: setattr(self.module, key, value) else: delattr(self.module, key) def doctest_format_exception_as_html(): """Test for format_exception (as_html=True) >>> from zope.exceptions.exceptionformatter import format_exception >>> try: ... exec('import 2 + 2') ... except: ... print(''.join(format_exception(*sys.exc_info(), as_html=True)))

Traceback (most recent call last):

File "<string>", line 1
import 2 + 2
^
SyntaxError: invalid syntax

""" def test_suite(): return unittest.TestSuite([ unittest.defaultTestLoader.loadTestsFromName(__name__), doctest.DocTestSuite( optionflags=doctest.NORMALIZE_WHITESPACE), ]) zope.exceptions-4.0.8/src/zope/exceptions/tests/__init__.py0000664000175100017510000000000112563163712023375 0ustar adiadi00000000000000#zope.exceptions-4.0.8/docs/0000775000175100017510000000000012563163734015142 5ustar adiadi00000000000000zope.exceptions-4.0.8/docs/narr.rst0000664000175100017510000000654112563163712016640 0ustar adiadi00000000000000Using :mod:`zope.exceptions` ============================ This module extends the standard library's :mod:`traceback` module, allowing application code to add additional information to the formatted tracebacks using specially-named variables in the scope of a given frame. Annotating Application Code --------------------------- :py:data:`__traceback_supplement__` +++++++++++++++++++++++++++++++++++ This variable can be defined either at either local or global scope. The formatting functions treat objects with this name as though they support the :py:class:`~zope.exceptions.interfaces.ITracebackSupplement` interface. The various attributes (all optional) of that interface will be used to add structured information to the formatted traceback. For example, assuming your code renders a template: .. doctest:: >>> import os >>> class Supplement(object): ... def __init__(self, template_file, source): ... self.source_url = 'file://%s' % os.path.abspath(template_file) ... self.source = source ... def getInfo(self): ... return self.source >>> def render_w_supplement(template_file, options): ... source = open(template_file).read() ... __traceback_supplement__ = Supplement(template_file, source) Here, the filename and source of the template will be rendered as part of the traceback. :py:data:`__traceback_info__` +++++++++++++++++++++++++++++ This variable can only be defined at local scope. It will be converted to a string when added to the formatted traceback. .. doctest:: >>> def render_w_info(template_file, options): ... source = open(template_file).read() ... __traceback_info__ = '%s\n\n%s' % (template_file, source) API Functions ------------- Three API functions support these features when formatting Python exceptions and their associated tracebacks: :py:func:`~zope.exceptions.exceptionformatter.format_exception` +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Use this API to format an exception and traceback as a string, using the special annotations. E.g.: .. doctest:: >>> import sys >>> from zope.exceptions import format_exception >>> try: ... raise ValueError('demo') ... except: ... t, v, tb = sys.exc_info() ... report = format_exception(t, v, tb) ... del tb # avoid a leak ... # Now do something with report, e.g., send e-mail. :py:func:`~zope.exceptions.exceptionformatter.print_exception` ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Use this API to write the formated exception and traceback to a file-like object, using the special annotations. E.g.: .. doctest:: >>> from zope.exceptions import print_exception >>> try: ... raise ValueError('demo') ... except: ... t, v, tb = sys.exc_info() ... print_exception(t, v, tb, file=sys.stderr) ... del tb # avoid a leak :py:func:`~zope.exceptions.exceptionformatter.extract_stack` ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Use this API to format just the traceback as a list of string,s using the special annotations. E.g.: .. doctest:: >>> import sys >>> from zope.exceptions import extract_stack >>> try: ... raise ValueError('demo') ... except: ... for line in extract_stack(sys.exc_info()[2].tb_frame): ... pass # do something with each line zope.exceptions-4.0.8/docs/make.bat0000664000175100017510000001177012563163712016551 0ustar adiadi00000000000000@ECHO OFF REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) set BUILDDIR=_build set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . set I18NSPHINXOPTS=%SPHINXOPTS% . if NOT "%PAPER%" == "" ( set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% ) if "%1" == "" goto help if "%1" == "help" ( :help echo.Please use `make ^` where ^ is one of echo. html to make standalone HTML files echo. dirhtml to make HTML files named index.html in directories echo. singlehtml to make a single large HTML file echo. pickle to make pickle files echo. json to make JSON files echo. htmlhelp to make HTML files and a HTML help project echo. qthelp to make HTML files and a qthelp project echo. devhelp to make HTML files and a Devhelp project echo. epub to make an epub echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter echo. text to make text files echo. man to make manual pages echo. texinfo to make Texinfo files echo. gettext to make PO message catalogs echo. changes to make an overview over all changed/added/deprecated items echo. linkcheck to check all external links for integrity echo. doctest to run all doctests embedded in the documentation if enabled goto end ) if "%1" == "clean" ( for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i del /q /s %BUILDDIR%\* goto end ) if "%1" == "html" ( %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/html. goto end ) if "%1" == "dirhtml" ( %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. goto end ) if "%1" == "singlehtml" ( %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. goto end ) if "%1" == "pickle" ( %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the pickle files. goto end ) if "%1" == "json" ( %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the JSON files. goto end ) if "%1" == "htmlhelp" ( %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run HTML Help Workshop with the ^ .hhp project file in %BUILDDIR%/htmlhelp. goto end ) if "%1" == "qthelp" ( %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: echo.^> qcollectiongenerator %BUILDDIR%\qthelp\zopeexceptions.qhcp echo.To view the help file: echo.^> assistant -collectionFile %BUILDDIR%\qthelp\zopeexceptions.ghc goto end ) if "%1" == "devhelp" ( %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp if errorlevel 1 exit /b 1 echo. echo.Build finished. goto end ) if "%1" == "epub" ( %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub if errorlevel 1 exit /b 1 echo. echo.Build finished. The epub file is in %BUILDDIR%/epub. goto end ) if "%1" == "latex" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex if errorlevel 1 exit /b 1 echo. echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. goto end ) if "%1" == "text" ( %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text if errorlevel 1 exit /b 1 echo. echo.Build finished. The text files are in %BUILDDIR%/text. goto end ) if "%1" == "man" ( %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man if errorlevel 1 exit /b 1 echo. echo.Build finished. The manual pages are in %BUILDDIR%/man. goto end ) if "%1" == "texinfo" ( %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo if errorlevel 1 exit /b 1 echo. echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. goto end ) if "%1" == "gettext" ( %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale if errorlevel 1 exit /b 1 echo. echo.Build finished. The message catalogs are in %BUILDDIR%/locale. goto end ) if "%1" == "changes" ( %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes if errorlevel 1 exit /b 1 echo. echo.The overview file is in %BUILDDIR%/changes. goto end ) if "%1" == "linkcheck" ( %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck if errorlevel 1 exit /b 1 echo. echo.Link check complete; look for any errors in the above output ^ or in %BUILDDIR%/linkcheck/output.txt. goto end ) if "%1" == "doctest" ( %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest if errorlevel 1 exit /b 1 echo. echo.Testing of doctests in the sources finished, look at the ^ results in %BUILDDIR%/doctest/output.txt. goto end ) :end zope.exceptions-4.0.8/docs/index.rst0000664000175100017510000000035412563163712017001 0ustar adiadi00000000000000:mod:`zope.exceptions` documentation ==================================== Contents: .. toctree:: :maxdepth: 2 narr api hacking Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` zope.exceptions-4.0.8/docs/hacking.rst0000664000175100017510000002170012563163712017274 0ustar adiadi00000000000000Hacking on :mod:`zope.exceptions` ================================= Getting the Code ################ The main repository for :mod:`zope.exceptions` is in the Zope Foundation Github repository: https://github.com/zopefoundation/zope.exceptions You can get a read-only checkout from there: .. code-block:: sh $ git clone https://github.com/zopefoundation/zope.exceptions.git or fork it and get a writeable checkout of your fork: .. code-block:: sh $ git clone git@github.com/jrandom/zope.exceptions.git The project also mirrors the trunk from the Github repository as a Bazaar branch on Launchpad: https://code.launchpad.net/zope.exceptions You can branch the trunk from there using Bazaar: .. code-block:: sh $ bzr branch lp:zope.exceptions Working in a ``virtualenv`` ########################### Installing ---------- If you use the ``virtualenv`` package to create lightweight Python development environments, you can run the tests using nothing more than the ``python`` binary in a virtualenv. First, create a scratch environment: .. code-block:: sh $ /path/to/virtualenv --no-site-packages /tmp/hack-zope.exceptions Next, get this package registered as a "development egg" in the environment: .. code-block:: sh $ /tmp/hack-zope.exceptions/bin/python setup.py develop Running the tests ----------------- Run the tests using the build-in ``setuptools`` testrunner: .. code-block:: sh $ /tmp/hack-zope.exceptions/bin/python setup.py test -q running test ...--------------------------------------------------------------------- ---------------------------------------------------------------------- Ran 72 tests in 0.017s OK If you have the :mod:`nose` package installed in the virtualenv, you can use its testrunner too: .. code-block:: sh $ /tmp/hack-zope.exceptions/bin/easy_install nose ... $ /tmp/hack-zope.exceptions/bin/python setup.py nosetests running nosetests ........................................................................ ---------------------------------------------------------------------- Ran 73 tests in 0.010s OK or: .. code-block:: sh $ /tmp/hack-zope.exceptions/bin/nosetests ........................................................................ ---------------------------------------------------------------------- Ran 73 tests in 0.011s OK If you have the :mod:`coverage` pacakge installed in the virtualenv, you can see how well the tests cover the code: .. code-block:: sh $ /tmp/hack-zope.exceptions/bin/easy_install nose coverage ... $ /tmp/hack-zope.exceptions/bin/python setup.py nosetests \ --with coverage --cover-package=zope.exceptions running nosetests ... ......................................................................... Name Stmts Miss Cover Missing ------------------------------------------------------------------ zope.exceptions 10 0 100% zope.exceptions.exceptionformatter 171 0 100% zope.exceptions.interfaces 18 0 100% zope.exceptions.log 13 0 100% ------------------------------------------------------------------ TOTAL 212 0 100% ---------------------------------------------------------------------- OK Building the documentation -------------------------- :mod:`zope.exceptions` uses the nifty :mod:`Sphinx` documentation system for building its docs. Using the same virtualenv you set up to run the tests, you can build the docs: .. code-block:: sh $ /tmp/hack-zope.exceptions/bin/easy_install Sphinx ... $ cd docs $ PATH=/tmp/hack-zope.exceptions/bin:$PATH make html sphinx-build -b html -d _build/doctrees . _build/html ... build succeeded. Build finished. The HTML pages are in _build/html. You can also test the code snippets in the documentation: .. code-block:: sh $ bin/sphinx-build -b docs/doctest -d docs/_build/doctrees docs docs/_build/doctest ... 12 tests in 1 items. 12 passed and 0 failed. Test passed. Doctest summary =============== 12 tests 0 failures in tests 0 failures in setup code build succeeded. Testing of doctests in the sources finished, look at the \ results in _build/doctest/output.txt. Using :mod:`zc.buildout` ######################## Setting up the buildout ----------------------- :mod:`zope.exceptions` ships with its own :file:`buildout.cfg` file and :file:`bootstrap.py` for setting up a development buildout: .. code-block:: sh $ /path/to/python2.6 bootstrap.py ... Generated script '.../bin/buildout' $ bin/buildout Develop: '/home/jrandom/projects/Zope/BTK/exceptions/.' ... Generated script '.../bin/sphinx-quickstart'. Generated script '.../bin/sphinx-build'. Running the tests ----------------- Run the tests: .. code-block:: sh $ bin/test --all Running zope.testing.testrunner.layer.UnitTests tests: Set up zope.testing.testrunner.layer.UnitTests in 0.000 seconds. Ran 2 tests with 0 failures and 0 errors in 0.000 seconds. Tearing down left over layers: Tear down zope.testing.testrunner.layer.UnitTests in 0.000 seconds. Using :mod:`tox` ################ Running Tests on Multiple Python Versions ----------------------------------------- `tox `_ is a Python-based test automation tool designed to run tests against multiple Python versions. It creates a ``virtualenv`` for each configured version, installs the current package and configured dependencies into each ``virtualenv``, and then runs the configured commands. :mod:`zope.exceptions` configures the following :mod:`tox` environments via its ``tox.ini`` file: - The ``py26``, ``py27``, ``py33``, ``py34``, and ``pypy`` environments builds a ``virtualenv`` with ``pypy``, installs :mod:`zope.exceptions` and dependencies, and runs the tests via ``python setup.py test -q``. - The ``coverage`` environment builds a ``virtualenv`` with ``python2.6``, installs :mod:`zope.exceptions`, installs :mod:`nose` and :mod:`coverage`, and runs ``nosetests`` with statement coverage. - The ``docs`` environment builds a virtualenv with ``python2.6``, installs :mod:`zope.exceptions`, installs ``Sphinx`` and dependencies, and then builds the docs and exercises the doctest snippets. This example requires that you have a working ``python2.6`` on your path, as well as installing ``tox``: .. code-block:: sh $ tox -e py26 GLOB sdist-make: .../zope.interface/setup.py py26 sdist-reinst: .../zope.interface/.tox/dist/zope.interface-4.0.2dev.zip py26 runtests: commands[0] ...--------------------------------------------------------------------- ---------------------------------------------------------------------- Ran 72 tests in 0.000s OK ___________________________________ summary ____________________________________ py26: commands succeeded congratulations :) Running ``tox`` with no arguments runs all the configured environments, including building the docs and testing their snippets: .. code-block:: sh $ tox GLOB sdist-make: .../zope.interface/setup.py py26 sdist-reinst: .../zope.interface/.tox/dist/zope.interface-4.0.2dev.zip py26 runtests: commands[0] ... Doctest summary =============== 12 tests 0 failures in tests 0 failures in setup code 0 failures in cleanup code build succeeded. ___________________________________ summary ____________________________________ py26: commands succeeded py27: commands succeeded py32: commands succeeded pypy: commands succeeded coverage: commands succeeded docs: commands succeeded congratulations :) Contributing to :mod:`zope.exceptions` ###################################### Submitting a Bug Report ----------------------- :mod:`zope.exceptions` tracks its bugs on Github: https://github.com/zopefoundation/zope.exceptions/issues Please submit bug reports and feature requests there. Sharing Your Changes -------------------- .. note:: Please ensure that all tests are passing before you submit your code. If possible, your submission should include new tests for new features or bug fixes, although it is possible that you may have tested your new code by updating existing tests. If have made a change you would like to share, the best route is to fork the Githb repository, check out your fork, make your changes on a branch in your fork, and push it. You can then submit a pull request from your branch: https://github.com/zopefoundation/zope.exceptions/pulls If you branched the code from Launchpad using Bazaar, you have another option: you can "push" your branch to Launchpad: .. code-block:: sh $ bzr push lp:~jrandom/zope.exceptions/cool_feature After pushing your branch, you can link it to a bug report on Launchpad, or request that the maintainers merge your branch using the Launchpad "merge request" feature. zope.exceptions-4.0.8/docs/conf.py0000664000175100017510000002000512563163712016432 0ustar adiadi00000000000000# -*- coding: utf-8 -*- # # zope.exceptions documentation build configuration file, created by # sphinx-quickstart on Fri Apr 6 16:11:13 2012. # # This file is execfile()d with the current directory set to its containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys, os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('.')) # -- General configuration ----------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'repoze.sphinx.autointerface', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = u'zope.exceptions' copyright = u'2012, Zope Foundation contributors.' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = '4.0' # The full version, including alpha/beta/rc tags. release = '4.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build'] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # -- Options for HTML output --------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_domain_indices = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'zopeexceptionsdoc' # -- Options for LaTeX output -------------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'zopeexceptions.tex', u'zope.exceptions Documentation', u'Zope Foundation contributors.', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output -------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'zopeexceptions', u'zope.exceptions Documentation', [u'Zope Foundation contributors.'], 1) ] # If true, show URL addresses after external links. #man_show_urls = False # -- Options for Texinfo output ------------------------------------------------ # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', 'zopeexceptions', u'zope.exceptions Documentation', u'Zope Foundation contributors.', 'zopeexceptions', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'http://docs.python.org/': None} zope.exceptions-4.0.8/docs/api.rst0000664000175100017510000000221612563163712016442 0ustar adiadi00000000000000:mod:`zope.exceptions` API documentation ======================================== :py:mod:`zope.exceptions.interfaces` ------------------------------------ .. automodule:: zope.exceptions.interfaces :py:class:`~zope.exceptions.interfaces.ITracebackSupplement` ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. autointerface:: zope.exceptions.interfaces.ITracebackSupplement :members: :member-order: source :py:mod:`zope.exceptions.exceptionformatter` -------------------------------------------- .. automodule:: zope.exceptions.exceptionformatter :py:func:`~zope.exceptions.exceptionformatter.format_exception` +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. autofunction:: zope.exceptions.exceptionformatter.format_exception :py:func:`~zope.exceptions.exceptionformatter.print_exception` ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. autofunction:: zope.exceptions.exceptionformatter.print_exception :py:func:`~zope.exceptions.exceptionformatter.extract_stack` ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. autofunction:: zope.exceptions.exceptionformatter.extract_stack zope.exceptions-4.0.8/docs/Makefile0000664000175100017510000001273412563163712016605 0ustar adiadi00000000000000# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " devhelp to make HTML files and a Devhelp project" @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " latexpdf to make LaTeX files and run them through pdflatex" @echo " text to make text files" @echo " man to make manual pages" @echo " texinfo to make Texinfo files" @echo " info to make Texinfo files and run them through makeinfo" @echo " gettext to make PO message catalogs" @echo " changes to make an overview of all changed/added/deprecated items" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: -rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." singlehtml: $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/zopeexceptions.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/zopeexceptions.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" @echo "# mkdir -p $$HOME/.local/share/devhelp/zopeexceptions" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/zopeexceptions" @echo "# devhelp" epub: $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." texinfo: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." @echo "Run \`make' in that directory to run these through makeinfo" \ "(use \`make info' here to do that automatically)." info: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." make -C $(BUILDDIR)/texinfo info @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." gettext: $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale @echo @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." zope.exceptions-4.0.8/docs/_static/0000775000175100017510000000000012563163734016570 5ustar adiadi00000000000000zope.exceptions-4.0.8/docs/_static/.gitignore0000664000175100017510000000000012563163712020542 0ustar adiadi00000000000000