add test for except star (#237)

* add test for except star

* fixed test with decorator skipif and standardize .gitignore file

* add some comments

* more clear syntax

* removed typo

* impreve test for except*

* Update tests/transformer/test_try.py

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

* updated CHANGES + decreased percentage of fail-under limit to 98.5

* updated CHANGES

* add python 3.11 in setup.py

* - reinstate accidentally removed change log entry [ci skip]

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

Author: 3 people

.meta.toml

@@ -57,7 +57,7 @@ coverage-setenv = [
     ]
 
 [coverage]
-fail-under = 98.8
+fail-under = 98.5
 
 [isort]
 additional-sources = "{toxinidir}/tests"

CHANGES.rst

@@ -14,6 +14,8 @@ Features
 
 - Officially support Python 3.11.
 
+- Add test for trystar syntax.
+
 
 5.2 (2021-11-19)
 ----------------

src/RestrictedPython/Guards.py

@@ -17,6 +17,8 @@
 
 import builtins
 
+from RestrictedPython._compat import IS_PY311_OR_GREATER
+
 
 safe_builtins = {}
 
@@ -103,6 +105,9 @@
     'ZeroDivisionError',
 ]
 
+if IS_PY311_OR_GREATER:
+    _safe_exceptions.append("ExceptionGroup")
+
 for name in _safe_names:
     safe_builtins[name] = getattr(builtins, name)
 

src/RestrictedPython/_compat.py

@@ -6,5 +6,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
+IS_PY311_OR_GREATER = _version.major == 3 and _version.minor >= 11
 
 IS_CPYTHON = platform.python_implementation() == 'CPython'

src/RestrictedPython/transformer.py

@@ -1127,6 +1127,10 @@ def visit_Try(self, node):
         """Allow `try` without restrictions."""
         return self.node_contents_visit(node)
 
+    def visit_TryStar(self, node):
+        """Allow `ExceptionGroup` without restrictions."""
+        return self.node_contents_visit(node)
+
     def visit_ExceptHandler(self, node):
         """Protect exception handlers."""
         node = self.node_contents_visit(node)

tests/transformer/test_try.py

@@ -1,4 +1,7 @@
+import pytest
+
 from RestrictedPython import compile_restricted_exec
+from RestrictedPython._compat import IS_PY311_OR_GREATER
 from tests.helper import restricted_exec
 
 
@@ -47,6 +50,39 @@ def test_RestrictingNodeTransformer__visit_Try__2(
     ])
 
 
+TRY_EXCEPT_STAR = """
+def try_except_star(m):
+    try:
+        m('try')
+        raise ExceptionGroup("group", [IndentationError('f1'), ValueError(65)])
+    except* IndentationError:
+        m('IndentationError')
+    except* ValueError:
+        m('ValueError')
+    except* RuntimeError:
+        m('RuntimeError')
+"""
+
+
+@pytest.mark.skipif(
+    not IS_PY311_OR_GREATER,
+    reason="ExceptionGroup class was added in Python 3.11.",
+)
+def test_RestrictingNodeTransformer__visit_TryStar__1(mocker):
+    """It allows try-except* PEP 654 statements."""
+    trace = mocker.stub()
+    restricted_exec(TRY_EXCEPT_STAR)['try_except_star'](trace)
+
+    trace.assert_has_calls([
+        mocker.call('try'),
+        mocker.call('IndentationError'),
+        mocker.call('ValueError')
+    ])
+
+    with pytest.raises(AssertionError):
+        trace.assert_has_calls([mocker.call('RuntimeError')])
+
+
 TRY_FINALLY = """
 def try_finally(m):
     try:

tox.ini

@@ -96,7 +96,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=98.8
+    coverage report -m --fail-under=98.5
 
 [coverage:run]
 branch = True