Update to Python 3.10 (#215)

* Configuring for pure-python
* Fix tests on Python 3.10.

Author: Michael Howitz

.github/workflows/tests.yml

@@ -28,6 +28,7 @@ jobs:
         - ["3.7",   "py37"]
         - ["3.8",   "py38"]
         - ["3.9",   "py39"]
+        - ["3.10.0-rc.2",  "py310"]
         - ["3.8",   "docs"]
         - ["3.8",   "coverage"]
         - ["3.8",   "py38-datetime"]

.meta.toml

@@ -2,15 +2,15 @@
 # https://github.com/zopefoundation/meta/tree/master/config/pure-python
 [meta]
 template = "pure-python"
-commit-id = "81a3fca06e30c8fba7256352591a7a298d676a41"
+commit-id = "3329f708f7922fcee2608b4057a3976ee4ed6d72"
 
 [python]
 with-pypy = false
 with-legacy-python = true
 with-docs = true
 with-sphinx-doctests = true
 with-windows = true
-with-future-python = false
+with-future-python = true
 
 [tox]
 use-flake8 = true
@@ -60,7 +60,7 @@ coverage-setenv = [
     ]
 
 [coverage]
-fail-under = 99.2
+fail-under = 98.9
 
 [manifest]
 additional-rules = [

CHANGES.rst

@@ -6,6 +6,9 @@ Changes
 
 - Document that ``__name__`` is needed to define classes.
 
+- Allow to use the package with Python 3.10 -- Caution: No security audit has
+  been done so far.
+
 
 5.1 (2020-10-07)
 ----------------

setup.py

@@ -54,6 +54,7 @@ def read(*rnames):
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
         'Programming Language :: Python :: Implementation :: CPython',
         'Topic :: Security',
     ],
@@ -69,7 +70,7 @@ def read(*rnames):
     package_dir={'': 'src'},
     install_requires=[
     ],
-    python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, <3.10",  # NOQA: E501
+    python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, <3.11",  # NOQA: E501
     tests_require=tests_require,
     extras_require={
         'test': tests_require,

src/RestrictedPython/_compat.py

@@ -10,6 +10,7 @@
 IS_PY36_OR_GREATER = _version.major == 3 and _version.minor >= 6
 IS_PY37_OR_GREATER = _version.major == 3 and _version.minor >= 7
 IS_PY38_OR_GREATER = _version.major == 3 and _version.minor >= 8
+IS_PY310_OR_GREATER = _version.major == 3 and _version.minor >= 10
 
 if IS_PY2:  # pragma: PY2
     basestring = basestring  # NOQA: F821  # Python 2 only built-in function

tests/test_compile.py

@@ -6,6 +6,7 @@
 from RestrictedPython._compat import IS_PY2
 from RestrictedPython._compat import IS_PY3
 from RestrictedPython._compat import IS_PY38_OR_GREATER
+from RestrictedPython._compat import IS_PY310_OR_GREATER
 from tests.helper import restricted_eval
 
 import platform
@@ -40,7 +41,9 @@ def test_compile__compile_restricted_invalid_mode_input():
 def test_compile__invalid_syntax():
     with pytest.raises(SyntaxError) as err:
         compile_restricted(INVALID_ASSINGMENT, '<string>', 'exec')
-    if IS_PY38_OR_GREATER:
+    if IS_PY310_OR_GREATER:
+        assert "SyntaxError: cannot assign to literal here." in str(err.value)
+    elif IS_PY38_OR_GREATER:
         assert "cannot assign to literal at statement:" in str(err.value)
     else:
         assert "can't assign to literal at statement:" in str(err.value)
@@ -120,9 +123,15 @@ def no_exec():
 def test_compile__compile_restricted_exec__10():  # pragma: PY3
     """It is a SyntaxError to use the `exec` statement. (Python 3 only)"""
     result = compile_restricted_exec(EXEC_STATEMENT)
-    assert (
-        'Line 2: SyntaxError: Missing parentheses in call to \'exec\' at '
-        'statement: "exec \'q = 1\'"',) == result.errors
+    if IS_PY310_OR_GREATER:
+        assert (
+            'Line 2: SyntaxError: Missing parentheses in call to \'exec\'. Did'
+            ' you mean exec(...)? at statement: "exec \'q = 1\'"',
+        ) == result.errors
+    else:
+        assert (
+            'Line 2: SyntaxError: Missing parentheses in call to \'exec\' at'
+            ' statement: "exec \'q = 1\'"',) == result.errors
 
 
 FUNCTION_DEF = """\

tests/test_compile_restricted_function.py

@@ -2,6 +2,7 @@
 from RestrictedPython import PrintCollector
 from RestrictedPython import safe_builtins
 from RestrictedPython._compat import IS_PY38_OR_GREATER
+from RestrictedPython._compat import IS_PY310_OR_GREATER
 from types import FunctionType
 
 
@@ -210,9 +211,15 @@ def test_compile_restricted_function_handle_SyntaxError():
     )
 
     assert result.code is None
-    assert result.errors == (
-        "Line 1: SyntaxError: unexpected EOF while parsing at statement: 'a('",
-    )
+    if IS_PY310_OR_GREATER:
+        assert result.errors == (
+            "Line 1: SyntaxError: '(' was never closed at statement: 'a('",
+        )
+    else:
+        assert result.errors == (
+            "Line 1: SyntaxError: unexpected EOF while parsing at statement:"
+            " 'a('",
+        )
 
 
 def test_compile_restricted_function_invalid_syntax():
@@ -230,7 +237,11 @@ def test_compile_restricted_function_invalid_syntax():
     assert len(result.errors) == 1
     error_msg = result.errors[0]
 
-    if IS_PY38_OR_GREATER:
+    if IS_PY310_OR_GREATER:
+        assert error_msg.startswith(
+            "Line 1: SyntaxError: cannot assign to literal here. Maybe "
+        )
+    elif IS_PY38_OR_GREATER:
         assert error_msg.startswith(
             "Line 1: SyntaxError: cannot assign to literal at statement:"
         )

tox.ini

@@ -10,6 +10,7 @@ envlist =
     py37
     py38
     py39
+    py310
     docs
     coverage
     py38-datetime
@@ -22,8 +23,6 @@ deps =
     -cconstraints.txt
     pytest-cov
     coverage-python-version
-    # Until repoze.sphinx.autointerface supports Sphinx 4.x we cannot use it:
-    Sphinx < 4
 setenv =
     COVERAGE_FILE=.coverage.{envname}
 commands =
@@ -61,6 +60,7 @@ deps =
     flake8
     check-manifest
     check-python-versions
+    wheel
 commands =
     flake8 src setup.py
     check-manifest
@@ -69,8 +69,6 @@ commands =
 [testenv:docs]
 basepython = python3
 skip_install = false
-# Until repoze.sphinx.autointerface supports Sphinx 4.x we cannot use it:
-deps = Sphinx < 4
 commands_pre =
 commands =
     sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html
@@ -83,8 +81,6 @@ allowlist_externals =
 deps =
     coverage
     coverage-python-version
-    # Until repoze.sphinx.autointerface supports Sphinx 4.x we cannot use it:
-    Sphinx < 4
     datetime: DateTime
     -cconstraints.txt
     pytest-cov
@@ -96,7 +92,7 @@ commands =
     pytest --cov=src --cov=tests --cov-report= {posargs}
     coverage run -a -m sphinx -b doctest -d {envdir}/.cache/doctrees docs {envdir}/.cache/doctest
     coverage html
-    coverage report -m --fail-under=99.2
+    coverage report -m --fail-under=98.9
 
 [coverage:run]
 branch = True