Add support for Python 3.12 (#263)

Co-authored-by: Michael Howitz <[email protected]>

Author: loechel

.github/workflows/tests.yml

@@ -28,7 +28,6 @@ jobs:
         - ["3.10",  "py310"]
         - ["3.11",  "py311"]
         - ["3.12",  "py312"]
-        - ["3.13.0-alpha - 3.13.0",  "py313"]
         - ["3.9",   "docs"]
         - ["3.9",   "coverage"]
         - ["3.9",   "py39-datetime"]

.meta.toml

@@ -47,7 +47,7 @@ testenv-additional = [
     "    coverage combine",
     "    coverage html",
     "    coverage report -m --fail-under=100",
-    "depends = py37,py38,py39,py39-datetime,py310,py311,py312coverage",
+    "depends = py37,py38,py39,py39-datetime,py310,py311,py312,coverage",
     ]
 coverage-basepython = "python3.8"
 coverage-command = "pytest --cov=src --cov=tests --cov-report= {posargs}"

CHANGES.rst

@@ -12,8 +12,7 @@ Backwards incompatible changes
 Features
 ++++++++
 
-- Allow to use the package with Python 3.12 and 3.13 -- Caution: No security
-  audit has been done so far.
+- Officially support Python 3.12.
 
 Fixes
 +++++
@@ -23,8 +22,7 @@ Fixes
 - Forbid using some attributes providing access to restricted Python internals.
   (CVE-2023-37271)
 
-- Fix information disclosure problems through
-  Python's "format" functionality
+- Fix information disclosure problems through Python's "format" functionality
   (``format`` and ``format_map`` methods on ``str`` and its instances,
   ``string.Formatter``). (CVE-2023-41039)
 

docs/conf.py

@@ -47,17 +47,17 @@
 
 # General information about the project.
 project = 'RestrictedPython'
-copyright = '2017-2022, Zope Foundation and Contributors'
+copyright = '2017-2023, Zope Foundation and Contributors'
 author = 'The Zope & Plone developer community'
 
 # 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 = '5.0'
+version = '7.0'
 # The full version, including alpha/beta/rc tags.
-release = '5.0'
+release = '7.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -217,7 +217,7 @@
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'RestrictedPythondoc'
+htmlhelp_basename = 'RestrictedPython_doc'
 
 # -- Options for LaTeX output ---------------------------------------------
 

docs/contributing/ast/python3_12.ast

@@ -14,23 +14,27 @@ module Python version "3.12"
                        stmt* body,
                        expr* decorator_list,
                        expr? returns,
-                       string? type_comment)
+                       string? type_comment,
+                       type_param* type_params)
          | AsyncFunctionDef(identifier name,
                             arguments args,
                             stmt* body,
                             expr* decorator_list,
                             expr? returns,
-                            string? type_comment)
+                            string? type_comment,
+                            type_param* type_params)
 
          | ClassDef(identifier name,
                     expr* bases,
                     keyword* keywords,
                     stmt* body,
-                    expr* decorator_list)
+                    expr* decorator_list,
+                    type_param* type_params)
          | Return(expr? value)
 
          | Delete(expr* targets)
          | Assign(expr* targets, expr value, string? type_comment)
+         | TypeAlias(expr name, type_param* type_params, expr value)
          | AugAssign(expr target, operator op, expr value)
          -- 'simple' indicates that we annotate simple name without parens
          | AnnAssign(expr target, expr annotation, expr? value, int simple)
@@ -182,4 +186,9 @@ module Python version "3.12"
              attributes (int lineno, int col_offset, int end_lineno, int end_col_offset)
 
     type_ignore = TypeIgnore(int lineno, string tag)
+
+    type_param = TypeVar(identifier name, expr? bound)
+               | ParamSpec(identifier name)
+               | TypeVarTuple(identifier name)
+               attributes (int lineno, int col_offset, int end_lineno, int end_col_offset)
 }

docs/contributing/index.rst

@@ -91,8 +91,8 @@ To enable a certain functionality in RestrictedPython, do the following:
   * icemac
   * loechel
 
-Differences between different Python versions
----------------------------------------------
+Differences between Python versions
+-----------------------------------
 
 A (modified style) Copy of all Abstract Grammar Definitions for the Python versions does live in this Documentation (ast Subfolder) to help finding difference quicker by comparing files.
 
@@ -152,14 +152,14 @@ The ``ast`` module consists of four areas:
 A ``NodeVisitor`` is a class of a node / AST consumer, it reads the data by stepping through the tree without modifying it.
 In contrast, a ``NodeTransformer`` (which inherits from a ``NodeVisitor``) is allowed to modify the tree and nodes.
 
-Technical decissions on how to implement / maintain RestrictedPython (Design, Structure, Tools, ...)
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+Technical decisions on how to implement / maintain RestrictedPython (Design, Structure, Tools, ...)
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 RestrictedPython is a core Package of the Zope & Plone Stack.
 Until Version 3.6 RestrictedPython was Python 2 only, and a critical blocker for Zope & Plone.
-With RestrictedPython 4.0 an API compatible rewrite has happend, which supports modern Python Versions.
+With RestrictedPython 4.0 an API compatible rewrite has happened, which supports modern Python Versions.
 
-* Use modern python tool stack for maintainance and tests
+* Use modern python tool stack for maintenance and tests
 
   * tox
   * pytest
@@ -179,15 +179,15 @@ With RestrictedPython 4.0 an API compatible rewrite has happend, which supports
   Resolve discussion about how RestrictedPython should be treat new expressions / ``ast.Nodes``.
   This belongs to :ref:`new_python_version`.
 
-  **Option 1 - reduce maintainance burden (prefered by icemac)**
+  **Option 1 - reduce maintenance burden (preferred by icemac)**
 
 
   All AST Nodes without an explicit ``visit_<AST Node>`` method, are denied by default.
   So the usage of this expression and functionality is not allowed.
 
   *This is currently the promoted version.*
 
-  **Option 2 - be as explicite as possible (prefered by loechel)**
+  **Option 2 - be as explicit as possible (preferred by loechel)**
 
   If the new AST Node should be disabled by default, add a ``visit_<AST Node>`` method such as the following:
 
@@ -237,12 +237,12 @@ Technical Backgrounds - Links to External Documentation
 
   * AST Grammar of Python (`Status of Python Versions`_)
 
-    * `Python 3.12 AST`_ (development branch - EOL 2028-10)
-    * `Python 3.11 AST`_ (in bugfix phase - EOL 2027-10)
-    * `Python 3.10 AST`_ (in bugfix phase - EOL 2026-10)
-    * `Python 3.9 AST`_ (in security phase - EOL 2025-10)
-    * `Python 3.8 AST`_ (in security phase - EOL 2024-10)
-    * `Python 3.7 AST`_ (in security phase - EOL 2023-06-27)
+    * `Python 3.12 AST`_ (EOL 2028-10)
+    * `Python 3.11 AST`_ (EOL 2027-10)
+    * `Python 3.10 AST`_ (EOL 2026-10)
+    * `Python 3.9 AST`_ (EOL 2025-10)
+    * `Python 3.8 AST`_ (EOL 2024-10)
+    * `Python 3.7 AST`_ (EOL 2023-06-27)
 
   * `AST NodeVistiors Class`_
   * `AST NodeTransformer Class`_

docs/roadmap/index.rst

@@ -26,11 +26,6 @@ Full code coverage tests.
 
     stephan-hof did propose a solution, should be discussed and if approved implemented.
 
-RestrictedPython 4.1+
----------------------
-
-Enhance RestrictedPython, declare  deprecations and possible new restrictions.
-
 RestrictedPython 6.0+
 ---------------------
 

setup.py

@@ -52,6 +52,7 @@ def read(*rnames):
         '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 :: Security',
     ],