zope.pytestlayer 8.2__tar.gz

zope.pytestlayer-8.2/.pre-commit-config.yaml

@@ -0,0 +1,46 @@
+---
+repos:
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v4.5.0
+      hooks:
+          - id: trailing-whitespace
+          - id: end-of-file-fixer
+          - id: fix-encoding-pragma
+            args: [--remove]
+          - id: check-yaml
+          - id: debug-statements
+            language_version: python3
+    - repo: https://github.com/PyCQA/flake8
+      rev: 6.1.0
+      hooks:
+          - id: flake8
+            language_version: python3
+            additional_dependencies: [flake8-typing-imports==1.14.0]
+            args: ["--per-file-ignores=src/zope/pytestlayer/tests/test_integration.py:E501"]
+    - repo: https://github.com/hhatto/autopep8
+      rev: v2.0.4
+      hooks:
+          - id: autopep8
+    - repo: https://github.com/PyCQA/isort
+      rev: 5.12.0
+      hooks:
+      - id: isort
+        args: [--filter-files]
+        files: \.py$
+    - repo: local
+      hooks:
+          - id: rst
+            name: rst
+            entry: rst-lint --encoding utf-8
+            exclude: ./doc/*
+            # We have Sphinx directives in the docs. This cannot be validated
+            # here. We therefore include two rst-linter. They complement each
+            # other. This regex matches all *.rst not in the doc/ folder.
+            files: ^[^(doc)].*rst
+            language: python
+            additional_dependencies: [pygments, restructuredtext_lint]
+    - repo: https://github.com/rstcheck/rstcheck
+      rev: 'v6.2.0'
+      hooks:
+        - id: rstcheck
+          args: ["--ignore-messages", 'No directive entry for "autosummary"|No role entry for "ref"|Unknown interpreted text role "ref"|Unknown directive type "(autosummary|literalinclude|toctree)"']

zope.pytestlayer-8.2/.readthedocs.yaml

@@ -0,0 +1,25 @@
+# Generated from:
+# https://github.com/zopefoundation/meta/tree/master/config/pure-python
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: docs/requirements.txt
+  - method: pip
+    path: .

zope.pytestlayer-8.2/CHANGES.rst

@@ -0,0 +1,154 @@
+=================================
+Change log for zope.pytestlayer
+=================================
+
+8.2 (2024-05-15)
+================
+
+- Make tests compatible with pytest >= 7.3. (Caution: We do not yet support
+  pytest >= 8)
+
+- Add support for Python 3.11.
+
+- Add support for Python 3.12.
+
+- Rename from ``gocept.pytestlayer`` to ``zope.pytestlayer``.
+
+
+8.1 (2022-09-05)
+================
+
+- Ensure compatibility with pytest >= 7.1.3.
+  ``.layered.LayeredTestCaseInstance`` now has to inherit from
+  ``_pytest.unittest.UnitTestCase``.
+
+
+8.0 (2021-12-13)
+================
+
+- Use GitHub actions as CI.
+
+- Add support for Python 3.9 and 3.10.
+
+- Drop support for Python 3.6.
+
+- Add a workaround for
+  `#4 <https://github.com/gocept/gocept.pytestlayer/issues/4>`_: Use
+  ``gcoept.pytestlayer.doctest.DocTestSuite`` instead of
+  ``doctest.DocTestSuite`` to circumvent the issue.
+
+
+7.0 (2020-08-03)
+================
+
+Backwards imcompatible changes
+------------------------------
+
+- Drop support for Python 2.7 and 3.5 and ``pytest < 5.0``. (#8)
+
+Features
+--------
+
+- Support ``pytest >= 6.0``. (#8)
+
+
+6.3 (2020-05-15)
+================
+
+- Ensure compatibility with pytest > 5.4.2. We need a
+  ``_explicit_tearDown`` on our ``LayeredTestCaseFunction`` now.
+
+
+6.2 (2020-03-20)
+================
+
+- Ensure compatibility with pytest > 5.4. We need a
+  ``_needs_explicit_tearDown`` on our ``LayeredTestCaseFunction`` now.
+
+
+6.1 (2020-02-20)
+================
+
+- Fix tests to run with `pytest >= 4.2.0`.
+
+- Migrate to Github.
+
+- Do not break when rerunning a doctest using `pytest-rerunfailures`.
+
+- Add support for Python 3.8.
+
+
+6.0 (2018-10-24)
+================
+
+- Add support for Python 3.6, 3.7 and PyPy3.
+
+- Drop support for Python 3.4.
+
+- Fix tests to run with `pytest >= 3.9.1`.
+
+- Release also as universal wheel.
+
+- Update to new pytest fixture API to avoid DeprecationWarnings. (#10)
+
+
+5.1 (2016-12-02)
+================
+
+- Make installation process compatible with `setuptools >= 30.0`.
+
+
+5.0 (2016-08-23)
+================
+
+- Fix tests to pass if `pytest >= 3.0` is used for testing.
+
+
+4.0 (2016-04-27)
+================
+
+- Support Python 3.4, 3.5 and PyPy.
+
+- Use tox as testrunner.
+
+
+3.0 (2016-04-14)
+================
+
+- Claim compatibility with py.test 2.9.x.
+
+- Drop Python 2.6 support.
+
+2.1 (2014-10-22)
+================
+
+- Update handling of keywords and doctest testnames for py.test-2.5.
+  [wosc]
+
+- Re-introduce ``gocept.pytestlayer.fixture.create()`` method, to allow giving
+  created fixtures a non-random name, so other fixtures can depend on them.
+  [tlotze, wosc]
+
+- Generate session-scoped fixtures from layers in addition to class-scoped
+  ones, if a session-scoped one is required somewhere, the class-scoped ones
+  are simply ignored. [tlotze, wosc]
+
+
+2.0 (2013-09-19)
+================
+
+- Remove need to explicitely create fixtures.
+  [gotcha]
+
+- Add ``plone.testing.layered`` test suites support.
+  [gotcha]
+
+- Made tests a bit more robust.
+  [icemac]
+
+
+1.0 (2013-08-28)
+================
+
+- Initial release.
+  [tlotze, icemac, gotcha]

zope.pytestlayer-8.2/CONTRIBUTING.md

@@ -0,0 +1,23 @@
+<!--
+Generated from:
+https://github.com/zopefoundation/meta/tree/master/config/pure-python
+-->
+# Contributing to zopefoundation projects
+
+The projects under the zopefoundation GitHub organization are open source and
+welcome contributions in different forms:
+
+* bug reports
+* code improvements and bug fixes
+* documentation improvements
+* pull request reviews
+
+For any changes in the repository besides trivial typo fixes you are required
+to sign the contributor agreement. See
+https://www.zope.dev/developer/becoming-a-committer.html for details.
+
+Please visit our [Developer
+Guidelines](https://www.zope.dev/developer/guidelines.html) if you'd like to
+contribute code changes and our [guidelines for reporting
+bugs](https://www.zope.dev/developer/reporting-bugs.html) if you want to file a
+bug report.

zope.pytestlayer-8.2/COPYRIGHT.txt

@@ -0,0 +1,10 @@
+Copyright (c) 2013-2016, 2021 gocept gmbh & co. kg
+Copyright (c) 2024 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.

zope.pytestlayer-8.2/HACKING.rst

@@ -0,0 +1,19 @@
+===========================
+Developing zope.pytestlayer
+===========================
+
+:Author:
+    gocept,
+    Godefroid Chapelle <gotcha@bubblenet.be>
+
+:PyPI page:
+    https://pypi.org/project/zope.pytestlayer/
+
+:Issues:
+    https://github.com/zopefoundation/zope.pytestlayer/issues
+
+:Source code:
+    https://github.com/zopefoundation/zope.pytestlayer
+
+:Current change log:
+    https://raw.githubusercontent.com/zopefoundation/zope.pytestlayer/master/CHANGES.rst

zope.pytestlayer-8.2/LICENSE.txt

@@ -0,0 +1,43 @@
+Zope Public License (ZPL) Version 2.1
+
+A copyright notice accompanies this license document that identifies the
+copyright holders.
+
+This license has been certified as open source. It has also been designated as
+GPL compatible by the Free Software Foundation (FSF).
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions in source code must retain the accompanying copyright
+notice, this list of conditions, and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the accompanying copyright
+notice, this list of conditions, and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+3. Names of the copyright holders must not be used to endorse or promote
+products derived from this software without prior written permission from the
+copyright holders.
+
+4. The right to distribute this software or to use it for any purpose does not
+give you the right to use Servicemarks (sm) or Trademarks (tm) of the copyright
+holders. Use of them is covered by separate agreement with the copyright
+holders.
+
+5. If any files are modified, you must cause the modified files to carry
+prominent notices stating that you changed the files and the date of any
+change.
+
+Disclaimer
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY EXPRESSED
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

zope.pytestlayer-8.2/MANIFEST.in

@@ -0,0 +1,17 @@
+# Generated from:
+# https://github.com/zopefoundation/meta/tree/master/config/pure-python
+include *.md
+include *.rst
+include *.txt
+include buildout.cfg
+include tox.ini
+
+recursive-include docs *.py
+recursive-include docs *.rst
+recursive-include docs *.txt
+recursive-include docs Makefile
+
+recursive-include src *.py
+include *.yaml
+include pytest.ini
+recursive-include src *.txt

zope.pytestlayer-8.2/PKG-INFO

@@ -0,0 +1,318 @@
+Metadata-Version: 2.1
+Name: zope.pytestlayer
+Version: 8.2
+Summary: Integration of zope.testrunner-style test layers into pytest framework
+Home-page: https://github.com/zopefoundation/zope.pytestlayer/
+Author: gocept
+Author-email: zope-dev@zope.dev
+License: ZPL 2.1
+Keywords: pytest zope.testrunner layer fixture
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Framework :: Pytest
+Classifier: Framework :: Plone
+Classifier: Framework :: Zope :: 3
+Classifier: Framework :: Zope :: 5
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Zope Public License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.7
+License-File: LICENSE.txt
+Requires-Dist: pytest<8,>=6
+Requires-Dist: setuptools
+Requires-Dist: zope.dottedname
+Provides-Extra: test
+Requires-Dist: plone.testing; extra == "test"
+Provides-Extra: docs
+Requires-Dist: Sphinx; extra == "docs"
+Requires-Dist: gocept.package; extra == "docs"
+
+=================================
+The zope.pytestlayer distribution
+=================================
+
+.. image:: https://img.shields.io/pypi/v/zope.pytestlayer.svg
+    :target: https://pypi.org/project/zope.pytestlayer/
+
+.. image:: https://img.shields.io/pypi/pyversions/zope.pytestlayer.svg
+    :target: https://pypi.org/project/zope.pytestlayer/
+
+.. image:: https://github.com/zopefoundation/zope.pytestlayer/actions/workflows/tests.yml/badge.svg
+    :target: https://github.com/zopefoundation/zope.pytestlayer/actions?query=tests
+
+.. image:: https://coveralls.io/repos/github/zope/zope.pytestlayer/badge.svg?branch=master
+    :target: https://coveralls.io/github/zope/zope.pytestlayer?branch=master
+
+
+Integration of zope.testrunner-style test layers into the `pytest`_
+framework
+
+This package is compatible with Python versions 3.7 - 3.12 including
+PyPy3.
+
+It was formerly known as ``gocept.pytestlayer``.
+
+.. _`pytest` : http://pytest.org
+
+Quick start
+===========
+
+* Make sure your test files follow the `conventions of pytest's test
+  discovery`_
+
+  .. _`conventions of pytest's test discovery`:
+     http://pytest.org/latest/goodpractises.html#python-test-discovery
+
+  In particular, a file named ``tests.py`` will not be recognized.
+
+* Add a buildout section to create the `pytest` runner::
+
+    [buildout]
+    parts += pytest
+
+    [pytest]
+    recipe = zc.recipe.egg
+    eggs = zope.pytestlayer
+           pytest
+           <YOUR PACKAGE HERE>
+
+``zope.pytestlayer`` registers itself as a ``pytest`` plugin. This way, nothing
+more is needed to run an existing Zope or Plone test suite.
+
+Advanced usage
+==============
+
+Version 2.1 reintroduced `fixture.create()` to be able to define the name of
+the generated to pytest fixtures. So it is possible to use them in function
+style tests.
+
+Example (Code has to be in `contest.py`!)::
+
+    from .testing import FUNCTIONAL_LAYER
+    import zope.pytestlayer.fixture
+
+    globals().update(zope.pytestlayer.fixture.create(
+        FUNCTIONAL_LAYER,
+        session_fixture_name='functional_session',
+        class_fixture_name='functional_class',
+        function_fixture_name='functional'))
+
+This creates three fixtures with the given names and the scopes in the argument
+name. The session and class fixtures run `setUp()` and `tearDown()` of the
+layer if it has not been run before while the function fixture runs
+`testSetUp()` and `testTearDown()` of the layer. The function fixture depends
+on the session one. The fixtures return the instance of the layer. So you can
+use the `functional` fixture like this::
+
+    def test_mymodule__my_function__1(functional):
+        assert functional['app'] is not None
+
+Not supported use cases
+=======================
+
+* Inheriting from a base class while changing the layer. See commit `f879f9e
+  <https://github.com/zope/zope.pytestlayer/commit/f879f9eb21cbd41a843b5021bc1264e9462fb505>`_.
+
+* Mixing classes inheriting ``unittest.TestCase`` and a ``test_suite()``
+  function (e. g. to create a ``DocTestSuite`` or a ``DocFileSuite``) in a
+  single module (aka file).
+
+  * This is a limitation of the `pytest` test discovery which ignores the
+    doctests in this case.
+
+  * Solution: Put the classes and ``test_suite()`` into different modules.
+
+* A ``doctest.DocFileSuite`` which does not have a ``layer`` is silently
+  skipped. Use the built-in doctest abilities of pytest to run those tests.
+
+
+===========================
+Developing zope.pytestlayer
+===========================
+
+:Author:
+    gocept,
+    Godefroid Chapelle <gotcha@bubblenet.be>
+
+:PyPI page:
+    https://pypi.org/project/zope.pytestlayer/
+
+:Issues:
+    https://github.com/zopefoundation/zope.pytestlayer/issues
+
+:Source code:
+    https://github.com/zopefoundation/zope.pytestlayer
+
+:Current change log:
+    https://raw.githubusercontent.com/zopefoundation/zope.pytestlayer/master/CHANGES.rst
+
+
+=================================
+Change log for zope.pytestlayer
+=================================
+
+8.2 (2024-05-15)
+================
+
+- Make tests compatible with pytest >= 7.3. (Caution: We do not yet support
+  pytest >= 8)
+
+- Add support for Python 3.11.
+
+- Add support for Python 3.12.
+
+- Rename from ``gocept.pytestlayer`` to ``zope.pytestlayer``.
+
+
+8.1 (2022-09-05)
+================
+
+- Ensure compatibility with pytest >= 7.1.3.
+  ``.layered.LayeredTestCaseInstance`` now has to inherit from
+  ``_pytest.unittest.UnitTestCase``.
+
+
+8.0 (2021-12-13)
+================
+
+- Use GitHub actions as CI.
+
+- Add support for Python 3.9 and 3.10.
+
+- Drop support for Python 3.6.
+
+- Add a workaround for
+  `#4 <https://github.com/gocept/gocept.pytestlayer/issues/4>`_: Use
+  ``gcoept.pytestlayer.doctest.DocTestSuite`` instead of
+  ``doctest.DocTestSuite`` to circumvent the issue.
+
+
+7.0 (2020-08-03)
+================
+
+Backwards imcompatible changes
+------------------------------
+
+- Drop support for Python 2.7 and 3.5 and ``pytest < 5.0``. (#8)
+
+Features
+--------
+
+- Support ``pytest >= 6.0``. (#8)
+
+
+6.3 (2020-05-15)
+================
+
+- Ensure compatibility with pytest > 5.4.2. We need a
+  ``_explicit_tearDown`` on our ``LayeredTestCaseFunction`` now.
+
+
+6.2 (2020-03-20)
+================
+
+- Ensure compatibility with pytest > 5.4. We need a
+  ``_needs_explicit_tearDown`` on our ``LayeredTestCaseFunction`` now.
+
+
+6.1 (2020-02-20)
+================
+
+- Fix tests to run with `pytest >= 4.2.0`.
+
+- Migrate to Github.
+
+- Do not break when rerunning a doctest using `pytest-rerunfailures`.
+
+- Add support for Python 3.8.
+
+
+6.0 (2018-10-24)
+================
+
+- Add support for Python 3.6, 3.7 and PyPy3.
+
+- Drop support for Python 3.4.
+
+- Fix tests to run with `pytest >= 3.9.1`.
+
+- Release also as universal wheel.
+
+- Update to new pytest fixture API to avoid DeprecationWarnings. (#10)
+
+
+5.1 (2016-12-02)
+================
+
+- Make installation process compatible with `setuptools >= 30.0`.
+
+
+5.0 (2016-08-23)
+================
+
+- Fix tests to pass if `pytest >= 3.0` is used for testing.
+
+
+4.0 (2016-04-27)
+================
+
+- Support Python 3.4, 3.5 and PyPy.
+
+- Use tox as testrunner.
+
+
+3.0 (2016-04-14)
+================
+
+- Claim compatibility with py.test 2.9.x.
+
+- Drop Python 2.6 support.
+
+2.1 (2014-10-22)
+================
+
+- Update handling of keywords and doctest testnames for py.test-2.5.
+  [wosc]
+
+- Re-introduce ``gocept.pytestlayer.fixture.create()`` method, to allow giving
+  created fixtures a non-random name, so other fixtures can depend on them.
+  [tlotze, wosc]
+
+- Generate session-scoped fixtures from layers in addition to class-scoped
+  ones, if a session-scoped one is required somewhere, the class-scoped ones
+  are simply ignored. [tlotze, wosc]
+
+
+2.0 (2013-09-19)
+================
+
+- Remove need to explicitely create fixtures.
+  [gotcha]
+
+- Add ``plone.testing.layered`` test suites support.
+  [gotcha]
+
+- Made tests a bit more robust.
+  [icemac]
+
+
+1.0 (2013-08-28)
+================
+
+- Initial release.
+  [tlotze, icemac, gotcha]