Update supported Python versions, be sure tests run in newer versions of Sphinx.

.github/dependabot.yml

@@ -0,0 +1,13 @@
+# Keep GitHub Actions up to date with GitHub's Dependabot...
+# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#package-ecosystem
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    groups:
+      github-actions:
+        patterns:
+          - "*"  # Group all Actions updates into a single larger pull request
+    schedule:
+      interval: monthly

.github/workflows/tests.yml

@@ -5,41 +5,45 @@ on: [push, pull_request]
 env:
   PYTHONHASHSEED: 1042466059
   ZOPE_INTERFACE_STRICT_IRO: 1
-  PYTHONWARNINGS: "ignore:'U' mode is deprecated:DeprecationWarning::"
+
 
 
 jobs:
   test:
     strategy:
       matrix:
-        python-version: [2.7, pypy2, pypy3, 3.6, 3.7, 3.8, 3.9]
+        python-version:
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
 
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Pip cache
-      uses: actions/cache@v2
-      with:
-        path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('setup.*') }}
-        restore-keys: |
-          ${{ runner.os }}-pip-
+        cache: 'pip'
+        cache-dependency-path: 'setup.py'
     - name: Install dependencies
       run: |
         python -m pip install -U pip setuptools wheel
-        python -m pip install -U coverage pylint
+        python -m pip install -U coverage zope.testrunner
         python -m pip install -U -e ".[test]"
     - name: Test
       run: |
-        pylint -r no src/sphinxcontrib
-        coverage run -m unittest discover -s src
+        coverage run -m zope.testrunner --test-path=src
+    - name: Lint
+      if: matrix.python-version == '3.12'
+      run: |
+        python -m pip install -U pylint
+        pylint src
     - name: Submit to Coveralls
-      # This is a container action, which only runs on Linux.
-      uses: AndreMiras/coveralls-python-action@develop
+      uses: coverallsapp/github-action@v2
       with:
         parallel: true
 
@@ -48,6 +52,4 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Coveralls Finished
-      uses: AndreMiras/coveralls-python-action@develop
-      with:
-        parallel-finished: true
+      uses: coverallsapp/github-action@v2

.pylintrc

@@ -1,3 +1,72 @@
+[MASTER]
+load-plugins=pylint.extensions.bad_builtin,
+   pylint.extensions.check_elif,
+   pylint.extensions.code_style,
+   pylint.extensions.dict_init_mutate,
+   pylint.extensions.docstyle,
+   pylint.extensions.dunder,
+   pylint.extensions.comparison_placement,
+   pylint.extensions.confusing_elif,
+   pylint.extensions.for_any_all,
+   pylint.extensions.consider_refactoring_into_while_condition,
+   pylint.extensions.mccabe,
+   pylint.extensions.eq_without_hash,
+   pylint.extensions.redefined_variable_type,
+   pylint.extensions.overlapping_exceptions,
+   pylint.extensions.docparams,
+   pylint.extensions.private_import,
+   pylint.extensions.set_membership,
+   pylint.extensions.typing,
+
+# magic_value wants you to not use arbitrary strings and numbers
+# inline in the code. But it's overzealous and has way too many false
+# positives. Trust people to do the most readable thing.
+#   pylint.extensions.magic_value
+
+# Empty comment would be good, except it detects blank lines within
+# a single comment block.
+#
+# Those are often used to separate paragraphs, like here.
+#   pylint.extensions.empty_comment,
+
+# consider_ternary_expression is a nice check, but is also overzealous.
+# Trust the human to do the readable thing.
+#    pylint.extensions.consider_ternary_expression,
+
+# redefined_loop_name tends to catch us with things like
+# for name in (a, b, c): name = name + '_column' ...
+#    pylint.extensions.redefined_loop_name,
+
+# This wants you to turn ``x in (1, 2)`` into ``x in {1, 2}``.
+# They both result in the LOAD_CONST bytecode, one a tuple one a
+# frozenset. In theory a set lookup using hashing is faster than
+# a linear scan of a tuple; but if the tuple is small, it can often
+# actually be faster to scan the tuple.
+#   pylint.extensions.set_membership,
+
+# Fix zope.cachedescriptors.property.Lazy; the property-classes doesn't seem to
+# do anything.
+# https://stackoverflow.com/questions/51160955/pylint-how-to-specify-a-self-defined-property-decorator-with-property-classes
+# For releases prior to 2.14.2, this needs to be a one-line, quoted string. After that,
+# a multi-line string.
+# - Make zope.cachedescriptors.property.Lazy look like a property;
+#   fixes pylint thinking it is a method.
+# - Run in Pure Python mode (ignore C extensions that respect this);
+#   fixes some issues with zope.interface, like IFoo.providedby(ob)
+#   claiming not to have the right number of parameters...except no, it does not.
+init-hook =
+    import astroid.bases
+    astroid.bases.POSSIBLE_PROPERTIES.add('Lazy')
+    astroid.bases.POSSIBLE_PROPERTIES.add('LazyOnClass')
+    astroid.bases.POSSIBLE_PROPERTIES.add('readproperty')
+    astroid.bases.POSSIBLE_PROPERTIES.add('non_overridable')
+    import os
+    os.environ['PURE_PYTHON'] = ("1")
+    # Ending on a quoted string
+    # breaks pylint 2.14.5 (it strips the trailing quote. This is
+    # probably because it tries to handle one-line quoted strings as well as multi-blocks).
+    # The parens around it fix the issue.
+
 
 [MESSAGES CONTROL]
 
@@ -10,7 +79,8 @@
 # comments at the end of the line does the same thing (though Py3 supports
 # mixing)
 
-# invalid-name, ; Things like loadBlob get flagged
+
+# invalid-name, ; We get lots of these, especially in scripts. should fix many of them
 # protected-access, ; We have many cases of this; legit ones need to be examinid and commented, then this removed
 # no-self-use, ; common in superclasses with extension points
 # too-few-public-methods, ; Exception and marker classes get tagged with this
@@ -27,58 +97,124 @@
 #   see https://github.com/PyCQA/pylint/issues/846
 # useless-suppression: the only way to avoid repeating it for specific statements everywhere that we
 #   do Py2/Py3 stuff is to put it here. Sadly this means that we might get better but not realize it.
-# bad-option-value: Pylint on Python 3 understands and checks for somethings Pylint on Python 2
-#   does not.
-disable=missing-docstring,
-    invalid-name,
+# duplicate-code: Yeah, the compatibility ssl modules are much the same
+# In pylint 1.8.0, inconsistent-return-statements are created for the wrong reasons.
+# This code raises it, even though there is only one return (the implicit ``return None`` is presumably
+# what triggers it):
+#  def foo():
+#    if baz:
+#      return 1
+# In Pylint 2dev1, needed for Python 3.7, we get spurious "useless return" errors:
+# @property
+# def foo(self):
+#   return None # generates useless-return
+# Pylint 2.4 adds import-outside-toplevel. But we do that a lot to defer imports because of patching.
+# Pylint 2.4 adds self-assigning-variable. But we do *that* to avoid unused-import when we
+# "export" the variable and dont have a __all__.
+# Pylint 2.6+ adds some python-3-only things that dont apply: raise-missing-from, super-with-arguments, consider-using-f-string, redundant-u-string-prefix
+# cyclic import is added because it pylint is spuriously detecting that
+# consider-using-assignment-expr wants you to transform things like:
+#   foo = get_foo()
+#   if foo: ...
+#
+# Into ``if (foo := get_foo()):``
+# But there are a *lot* of those. Trust people to do the right, most
+# readable, thing
+#
+# docstring-first-line-empty: That's actually our standard, based on Django.
+# XXX: unclear on the docstring warnings, missing-type-doc, missing-param-doc,
+# differing-param-doc, differing-type-doc (are the last two replacements for the first two?)
+#
+# They should be addressed, in general they are a good thing, but sometimes they are
+# unnecessary.
+disable=wrong-import-position,
     wrong-import-order,
+    missing-docstring,
+    ungrouped-imports,
+    invalid-name,
+    too-few-public-methods,
+    global-statement,
     locally-disabled,
-    no-self-use,
-    bad-option-value,
+    too-many-arguments,
+    useless-suppression,
+    duplicate-code,
+    useless-object-inheritance,
+    import-outside-toplevel,
+    self-assigning-variable,
+    consider-using-f-string,
+    consider-using-assignment-expr,
+    use-dict-literal,
+    missing-type-doc,
+    missing-param-doc,
+    differing-param-doc,
+    differing-type-doc,
+    compare-to-zero,
+    docstring-first-line-empty,
 
+enable=consider-using-augmented-assign
 
 [FORMAT]
-# duplicated from setup.cfg
 max-line-length=100
+max-module-lines=1100
 
 [MISCELLANEOUS]
 # List of note tags to take in consideration, separated by a comma.
 #notes=FIXME,XXX,TODO
-# Disable that, we don't want them in the report (???)
+# Disable that, we don't want them to fail the lint CI job.
 notes=
 
 [VARIABLES]
 
 dummy-variables-rgx=_.*
+init-import=true
 
 [TYPECHECK]
 
 # List of members which are set dynamically and missed by pylint inference
-# system, and so shouldn't trigger E1101 when accessed. Python regular
+# system, and so shouldnt trigger E1101 when accessed. Python regular
 # expressions are accepted.
-# gevent: this is helpful for py3/py2 code.
-generated-members=env,build
+generated-members=REQUEST,acl_users,aq_parent,providedBy
+
+
+# Tells whether missing members accessed in mixin class should be ignored. A
+# mixin class is detected if its name ends with "mixin" (case insensitive).
+# XXX: deprecated in 2.14; replaced with ignored-checks-for-mixins.
+# The defaults for that value seem to be what we want
+#ignore-mixin-members=yes
 
 # List of classes names for which member attributes should not be checked
-# (useful for classes with attributes dynamically set). This supports can work
+# (useful for classes with attributes dynamically set). This can work
 # with qualified names.
+#ignored-classes=SSLContext, SSLSocket, greenlet, Greenlet, parent, dead
 
-ignored-classes=Sphinx,doctree
 
 # List of module names for which member attributes should not be checked
 # (useful for modules/projects where namespaces are manipulated during runtime
 # and thus existing member attributes cannot be deduced by static analysis. It
 # supports qualified module names, as well as Unix pattern matching.
-#ignored-modules=gevent._corecffi
+#ignored-modules=gevent._corecffi,gevent.os,os,greenlet,threading,gevent.libev.corecffi,gevent.socket,gevent.core,gevent.testing.support
+ignored-modules=psycopg2.errors
 
 [DESIGN]
 max-attributes=12
-max-locals=16
-max-public-methods=40
+max-parents=10
+# Bump complexity up one.
+max-complexity=11
 
 [BASIC]
-bad-functions=input
 # Prospector turns ot unsafe-load-any-extension by default, but
 # pylint leaves it off. This is the proximal cause of the
 # undefined-all-variable crash.
-#unsafe-load-any-extension = no
+unsafe-load-any-extension = yes
+# This does not seem to work, hence the init-hook
+property-classes=zope.cachedescriptors.property.Lazy,zope.cachedescriptors.property.Cached
+
+[CLASSES]
+# List of interface methods to ignore, separated by a comma. This is used for
+# instance to not check methods defines in Zope's Interface base class.
+
+
+
+# Local Variables:
+# mode: conf
+# End:

CHANGES.rst

@@ -5,7 +5,12 @@
 0.18 (unreleased)
 =================
 
-- Nothing changed yet.
+- Drop support for Python < 3.8. This means Python 2 is no longer
+  supported.
+- Drop setuptools dependency. Instead, use a native ``pkgutil``
+  namespace package.
+- Now requires docutils >= 0.18.1. This effectively requires Sphinx
+  versions newer than 5.0.
 
 
 0.17 (2021-03-31)

pyproject.toml

@@ -0,0 +1,5 @@
+[build-system]
+requires = [
+   "wheel",
+   "setuptools",
+]

setup.cfg

@@ -1,11 +1,2 @@
-[aliases]
-release = egg_info -RDb ''
-
-[upload_docs]
-upload_dir = build/sphinx/html
-
-[bdist_wheel]
-universal = 1
-
 [zest.releaser]
 python-file-with-version = src/sphinxcontrib/programoutput/__init__.py