Merge pull request #223 from willkg/221-python312

add support for python 3.12 (#221)

.github/workflows/main.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
 
     name: Python ${{ matrix.python-version}}
     steps:

Makefile

@@ -14,7 +14,7 @@ test:  ## Run tests, linting, and static typechecking
 lint:  ## Lint and black reformat files
 	# NOTE(willkg): Make sure this matches what's in tox.ini.
 	black src setup.py tests docs examples
-	tox -e py37-lint
+	tox -e py38-lint
 
 .PHONY: clean
 clean:  ## Clean build artifacts

README.rst

@@ -54,13 +54,17 @@ Run::
 
 Some configuration environments require additional dependencies::
 
-
     # For INI support
     $ pip install 'everett[ini]'
 
     # for YAML support
     $ pip install 'everett[yaml]'
 
+Additionally, if you want to use the Sphinx extension to document
+your configuration, you need to add Sphinx::
+
+    # to use the Sphinx extension
+    $ pip install 'everett[sphinx]'
 
 Quick start
 ===========

pyproject.toml

@@ -50,6 +50,7 @@ envlist =
     py39
     py310
     py311
+    py312
     py38-doctest
     py38-lint
     py38-typecheck
@@ -60,6 +61,7 @@ python =
     3.9: py39
     3.10: py310
     3.11: py311
+    3.12: py312
 
 [testenv]
 deps = -rrequirements-dev.txt
@@ -73,7 +75,7 @@ commands = pytest --doctest-modules src/
 basepython = python3.8
 changedir = {toxinidir}
 commands =
-    black --check src setup.py tests docs examples
+    black --diff setup.py tests docs examples
     ruff src setup.py tests docs examples
 
 [testenv:py38-typecheck]

requirements-dev.txt

@@ -1,17 +1,17 @@
 # Requirements file for developing on Everett.
--e .[ini,yaml]
+-e .[ini,yaml,sphinx]
 
-black==23.1.00
+black==23.9.1
 check-manifest==0.49
 cogapp==3.3.0
-mypy==1.1.1
-pytest==7.2.2
-ruff==0.0.262
-tox==4.4.7
-tox-gh-actions==3.1.0
+mypy==1.5.1
+pytest==7.4.2
+ruff==0.0.292
+tox==4.11.3
+tox-gh-actions==3.1.3
 twine==4.0.2
-types-PyYAML==6.0.12.8
+types-PyYAML==6.0.12.12
 
-# These require Python 3.8+ before we can update them
-Sphinx==5.3.0
-sphinx_rtd_theme==1.0.0
+# We need to drop support for Python 3.8 before we can update this further.
+Sphinx==6.2.1
+sphinx_rtd_theme==1.3.0

setup.py

@@ -24,6 +24,7 @@ def get_file(fn):
 
 INSTALL_REQUIRES = []
 EXTRAS_REQUIRE = {
+    "sphinx": ["sphinx"],
     "ini": ["configobj"],
     "yaml": ["PyYAML"],
 }
@@ -56,6 +57,9 @@ def get_file(fn):
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: Implementation :: CPython",
+        "Topic :: Software Development :: Libraries :: Python Modules",
     ],
     project_urls={
         "Documentation": "https://everett.readthedocs.io/",

src/everett/sphinxext.py

@@ -2,7 +2,13 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-"""Sphinx extension for auto-documenting components with configuration."""
+"""Sphinx extension for auto-documenting components with configuration.
+
+To use this, you must install the optional requirements::
+
+    $ pip install 'everett[sphinx]'
+
+"""
 
 import ast
 from importlib import import_module
@@ -705,12 +711,12 @@ def extract_configuration(
                 # }
                 for key, val in zip(node.keys, node.values):
                     if (
-                        isinstance(key, ast.Str)
+                        isinstance(key, ast.Constant)
                         and isinstance(val, ast.Call)
                         and isinstance(val.func, ast.Name)
                         and val.func.id == variable_name
                     ):
-                        config_nodes.append((key.s, val))
+                        config_nodes.append((key.value, val))
 
         CONFIG_ARGS = [
             "key",