From c64826652cbba4a4665b6d588ea0285a812dae5a Mon Sep 17 00:00:00 2001 From: Michael Howitz Date: Thu, 1 Dec 2022 08:44:06 +0100 Subject: [PATCH 1/2] Configuring for pure-python --- .editorconfig | 39 ++++++++ .github/workflows/tests.yml | 65 +++++++++++++ .gitignore | 40 ++++++-- .meta.toml | 22 +++++ .travis.yml | 33 ------- CONTRIBUTING.md | 23 +++++ MANIFEST.in | 9 +- bootstrap.py | 189 ------------------------------------ setup.cfg | 28 ++++-- tox.ini | 82 ++++++++++++++-- 10 files changed, 275 insertions(+), 255 deletions(-) create mode 100644 .editorconfig create mode 100644 .github/workflows/tests.yml create mode 100644 .meta.toml delete mode 100644 .travis.yml create mode 100644 CONTRIBUTING.md delete mode 100644 bootstrap.py diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..c5508b9 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,39 @@ +# Generated from: +# https://github.com/zopefoundation/meta/tree/master/config/pure-python +# +# EditorConfig Configuration file, for more details see: +# http://EditorConfig.org +# EditorConfig is a convention description, that could be interpreted +# by multiple editors to enforce common coding conventions for specific +# file types + +# top-most EditorConfig file: +# Will ignore other EditorConfig files in Home directory or upper tree level. +root = true + + +[*] # For All Files +# Unix-style newlines with a newline ending every file +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true +# Set default charset +charset = utf-8 +# Indent style default +indent_style = space +# Max Line Length - a hard line wrap, should be disabled +max_line_length = off + +[*.{py,cfg,ini}] +# 4 space indentation +indent_size = 4 + +[*.{yml,zpt,pt,dtml,zcml}] +# 2 space indentation +indent_size = 2 + +[{Makefile,.gitmodules}] +# Tab indentation (no size specified, but view as 4 spaces) +indent_style = tab +indent_size = unset +tab_width = unset diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 0000000..073fe30 --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,65 @@ +# Generated from: +# https://github.com/zopefoundation/meta/tree/master/config/pure-python +name: tests + +on: + push: + pull_request: + schedule: + - cron: '0 12 * * 0' # run once a week on Sunday + # Allow to run this workflow manually from the Actions tab + workflow_dispatch: + +jobs: + build: + strategy: + # We want to see all failures: + fail-fast: false + matrix: + os: + - ubuntu + config: + # [Python version, tox env] + - ["3.9", "lint"] + - ["2.7", "py27"] + - ["3.5", "py35"] + - ["3.6", "py36"] + - ["3.7", "py37"] + - ["3.8", "py38"] + - ["3.9", "py39"] + - ["3.10", "py310"] + - ["3.11", "py311"] + - ["pypy-2.7", "pypy"] + - ["pypy-3.7", "pypy3"] + - ["3.9", "coverage"] + + runs-on: ${{ matrix.os }}-latest + if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name + name: ${{ matrix.config[1] }} + steps: + - uses: actions/checkout@v3 + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.config[0] }} + - name: Pip cache + uses: actions/cache@v3 + with: + path: ~/.cache/pip + key: ${{ runner.os }}-pip-${{ matrix.config[0] }}-${{ hashFiles('setup.*', 'tox.ini') }} + restore-keys: | + ${{ runner.os }}-pip-${{ matrix.config[0] }}- + ${{ runner.os }}-pip- + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install tox + - name: Test + run: tox -e ${{ matrix.config[1] }} + - name: Coverage + if: matrix.config[1] == 'coverage' + run: | + pip install coveralls coverage-python-version + coveralls --service=github + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore index defd3bd..1f321f5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,12 +1,32 @@ -bin -build -dist -lib -parts - -.coverage -.tox +# Generated from: +# https://github.com/zopefoundation/meta/tree/master/config/pure-python +*.dll +*.egg-info/ +*.profraw *.pyc *.pyo -*.egg-info -nosetests.xml +*.so +.coverage +.coverage.* +.eggs/ +.installed.cfg +.mr.developer.cfg +.tox/ +.vscode/ +__pycache__/ +bin/ +build/ +coverage.xml +develop-eggs/ +develop/ +dist/ +docs/_build +eggs/ +etc/ +lib/ +lib64 +log/ +parts/ +pyvenv.cfg +testing.log +var/ diff --git a/.meta.toml b/.meta.toml new file mode 100644 index 0000000..bf5ed6d --- /dev/null +++ b/.meta.toml @@ -0,0 +1,22 @@ +# Generated from: +# https://github.com/zopefoundation/meta/tree/master/config/pure-python +[meta] +template = "pure-python" +commit-id = "d8ee00613a60c98a8d2227b0564403d0e447741a" + +[python] +with-macos = false +with-windows = false +with-pypy = true +with-future-python = false +with-legacy-python = true +with-sphinx-doctests = false + +[tox] +use-flake8 = true +testenv-deps = [ + "zope.testrunner", + ] + +[coverage] +fail-under = 100 diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 88a7b01..0000000 --- a/.travis.yml +++ /dev/null @@ -1,33 +0,0 @@ -language: python - -dist: focal - -python: - - "2.7" - - "3.6" - - "3.7" - - "3.8" - - "3.9" - - pypy2 - - pypy3 - -install: - - pip install -U setuptools - - pip install zc.buildout - - pip install coveralls coverage - - buildout bootstrap - - buildout - -script: - - coverage run bin/test -v1 - -notifications: - email: false - -after_success: - - coveralls - -cache: - pip: true - directories: - - eggs/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..31d95f0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ + +# 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. diff --git a/MANIFEST.in b/MANIFEST.in index 672fdbd..dc6ad98 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,10 +1,9 @@ -include *.py +# 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 src * - -global-exclude *.pyc -global-exclude *.pyo +recursive-include src *.py diff --git a/bootstrap.py b/bootstrap.py deleted file mode 100644 index a629566..0000000 --- a/bootstrap.py +++ /dev/null @@ -1,189 +0,0 @@ -############################################################################## -# -# 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) diff --git a/setup.cfg b/setup.cfg index deacf9c..b7ce758 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,13 +1,23 @@ +# Generated from: +# https://github.com/zopefoundation/meta/tree/master/config/pure-python [bdist_wheel] universal = 1 -[coverage:run] -branch = True -source = src -omit = +[flake8] +doctests = 1 -[coverage:report] -ignore_errors = True -precision = 2 -show_missing = True -sort = Name +[check-manifest] +ignore = + .editorconfig + .meta.toml + +[isort] +force_single_line = True +combine_as_imports = True +sections = FUTURE,STDLIB,THIRDPARTY,ZOPE,FIRSTPARTY,LOCALFOLDER +known_third_party = six, docutils, pkg_resources +known_zope = +known_first_party = +default_section = ZOPE +line_length = 79 +lines_after_imports = 2 diff --git a/tox.ini b/tox.ini index 60015ad..d4d056f 100644 --- a/tox.ini +++ b/tox.ini @@ -1,18 +1,82 @@ +# Generated from: +# https://github.com/zopefoundation/meta/tree/master/config/pure-python [tox] -envlist = py27,py36,py37,py38,py39,pypy,pypy3,coverage +minversion = 3.18 +envlist = + lint + py27 + py35 + py36 + py37 + py38 + py39 + py310 + py311 + pypy + pypy3 + coverage [testenv] -commands = - zope-testrunner --test-path={envsitepackagesdir} -s ZopeUndo +usedevelop = true deps = zope.testrunner +commands = + zope-testrunner --test-path=src {posargs:-vc} +extras = + test -[testenv:coverage] -basepython = - python2.7 +[testenv:lint] +basepython = python3 +skip_install = true commands = - nosetests --with-xunit --with-xcoverage --where={envsitepackagesdir}/ZopeUndo --cover-package=ZopeUndo + isort --check-only --diff {toxinidir}/src {toxinidir}/setup.py + flake8 src setup.py + check-manifest + check-python-versions +deps = + check-manifest + check-python-versions >= 0.19.1 + wheel + flake8 + isort + +[testenv:isort-apply] +basepython = python3 +commands_pre = +deps = + isort +commands = + isort {toxinidir}/src {toxinidir}/setup.py [] + +[testenv:coverage] +basepython = python3 +allowlist_externals = + mkdir deps = - nose coverage - nosexcover + coverage-python-version + zope.testrunner +commands = + mkdir -p {toxinidir}/parts/htmlcov + coverage run -m zope.testrunner --test-path=src {posargs:-vc} + coverage html --ignore-errors + coverage report --ignore-errors --show-missing --fail-under=100 + +[coverage:run] +branch = True +plugins = coverage_python_version +source = ZopeUndo + +[coverage:report] +precision = 2 +exclude_lines = + pragma: no cover + pragma: nocover + except ImportError: + raise NotImplementedError + if __name__ == '__main__': + self.fail + raise AssertionError + +[coverage:html] +directory = parts/htmlcov From 1f4f871094ee2b77a8ce25e0ac5ef48b6c0265a0 Mon Sep 17 00:00:00 2001 From: Michael Howitz Date: Thu, 1 Dec 2022 08:45:42 +0100 Subject: [PATCH 2/2] Add support for Python 3.5, 3.10, 3.11. - isort imports - bring coverage to 100 %. --- CHANGES.rst | 6 +++--- setup.py | 14 +++++++++++--- src/ZopeUndo/tests/test_prefix.py | 4 ++++ 3 files changed, 18 insertions(+), 6 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index f4f010b..8df0d76 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -4,11 +4,11 @@ Changelog 5.0 (unreleased) ---------------- -- Update PyPy version for Travis. +- Add support for Python 3.7, 3.8, 3.9, 3.10, 3.11. -- Add support for Python 3.7, 3.8 and 3.9. +- Update PyPy version for Travis. -- Drop support for Python 3.4 and 3.5. +- Drop support for Python 3.4. 4.3 (2017-09-08) diff --git a/setup.py b/setup.py index 8e6574a..86b56ba 100644 --- a/setup.py +++ b/setup.py @@ -13,7 +13,10 @@ ############################################################################## import os -from setuptools import setup, find_packages + +from setuptools import find_packages +from setuptools import setup + version = '5.0.dev0' @@ -38,21 +41,26 @@ classifiers=[ "Development Status :: 6 - Mature", "Environment :: Web Environment", - "Framework :: Zope2", + "Framework :: Zope :: 2", + "Framework :: Zope :: 4", + "Framework :: Zope :: 5", "License :: OSI Approved :: Zope Public License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy", ], - python_requires='>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*', + python_requires='>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*', keywords="zope zope4 undo", install_requires=[ 'setuptools', diff --git a/src/ZopeUndo/tests/test_prefix.py b/src/ZopeUndo/tests/test_prefix.py index 9dbd2e7..e5798ba 100644 --- a/src/ZopeUndo/tests/test_prefix.py +++ b/src/ZopeUndo/tests/test_prefix.py @@ -50,3 +50,7 @@ def test_username_info(self): for equal in (" eggs", "/ eggs", "/def eggs", "/a/b eggs", "/a/b/c eggs", "/a/b/c/d eggs"): self.assertEqual(p2, equal) + + def test__repr__(self): + p1 = Prefix('/a/b') + self.assertEqual(repr(p1), "Prefix('/a/b')")