Skip to main content
https://github.com/zopefoundation/RestrictedPython/actions/workflows/tests.yml/badge.svg https://coveralls.io/repos/github/zopefoundation/RestrictedPython/badge.svg?branch=master Documentation Status Current version on PyPI Supported Python versions https://github.com/zopefoundation/RestrictedPython/raw/master/docs/logo.jpg

RestrictedPython

RestrictedPython is a tool that helps to define a subset of the Python language which allows to provide a program input into a trusted environment. RestrictedPython is not a sandbox system or a secured environment, but it helps to define a trusted environment and execute untrusted code inside of it.

For full documentation please see http://restrictedpython.readthedocs.io/.

Example

To give a basic understanding what RestrictedPython does here two examples:

An unproblematic code example

Python allows you to execute a large set of commands. This would not harm any system.

>>> from RestrictedPython import compile_restricted
>>> from RestrictedPython import safe_globals
>>>
>>> source_code = """
... def example():
...     return 'Hello World!'
... """
>>>
>>> loc = {}
>>> byte_code = compile_restricted(source_code, '<inline>', 'exec')
>>> exec(byte_code, safe_globals, loc)
>>>
>>> loc['example']()
'Hello World!'

Problematic code example

This example directly executed in Python could harm your system.

>>> from RestrictedPython import compile_restricted
>>> from RestrictedPython import safe_globals
>>>
>>> source_code = """
... import os
...
... os.listdir('/')
... """
>>> byte_code = compile_restricted(source_code, '<inline>', 'exec')
>>> exec(byte_code, safe_globals, {})
Traceback (most recent call last):
ImportError: __import__ not found

Contributing to RestrictedPython

If you want to help maintain RestrictedPython and contribute, please refer to the documentation Contributing page.

Changes

8.5 (2026-08-19)

  • Officially support Python 3.15 after performing a security audit of its changes:

    • Disallow lazy import statements (PEP 810) as they bypass a guarded __import__.

    • Disallow unpacking in comprehensions (PEP 798) as it bypasses the _getiter_ guard.

  • Add the attributes of asynchronous generator objects (ag_await, ag_frame, ag_code) to the restricted names in INSPECT_ATTRIBUTES as they were missing there.

  • Fix the combined coverage report: the coverage tox environment now combines the coverage data of all supported Python versions instead of measuring a single one, and enforces 100 % coverage. The broken combined-coverage environment has been removed, as it erased the data it was supposed to combine.

8.4 (2026-07-10)

  • Add type annotations to the package code. For clarification, restricted Python code does not support type annotations.

  • Allow ast.Module, ast.Expression and ast.Interactive as body in compile_restricted_function

  • Disallow mode="function" in compile_restricted (it never worked).

  • Prevent access to string.Formatter and its unsafe traversal methods via safer_getattr.

8.3 (2026-06-16)

  • Switch to PyPI Trusted Publishing for the package release process

  • Also validate positional-only argument names (parameters before /) so they cannot start with an underscore, closing a sandbox escape where a positional-only parameter could shadow an injected protected name such as _getattr_, _getitem_, _write_ or _print_.

8.3a1.dev0 (2026-05-29)

  • Allow to use the package with Python 3.15 – Caution: No security audit has been done so far.

8.2 (2026-05-29)

  • Remove documentation that appears to promote unsupported direct guards usage.

  • Move package metadata from setup.py to pyproject.toml.

  • Drop support for Python 3.9.

  • Allow the ... (Ellipsis) statement.

8.1 (2025-10-19)

  • Allow to use the package with Python 3.14 including t-string support.

8.0 (2025-01-23)

Backwards incompatible changes
  • Disallow try/except* clauses due to a possible sandbox escape and probable uselessness of this feature in the context of RestrictedPython. In addition, remove ExceptionGroup from safe_builtins (as useful only with try/except*). - This feature was introduced into RestrictedPython in version 6.0 for Python 3.11+. (CVE-2025-22153)

  • Drop support for Python 3.8.

Features
  • Update setuptools version pin. (#292)

7.4 (2024-10-09)

  • Allow to use the package with Python 3.13.

  • Drop support for Python 3.7.

  • Provide new function RestrictedPython.Guards.safer_getattr_raise. It is similar to safer_getattr but handles its parameter default like getattr, i.e. it raises AttributeError if the attribute lookup fails and this parameter is not provided, fixes #287.

7.3 (2024-09-30)

  • Increase the safety level of safer_getattr allowing applications to use it as getattr implementation. Such use should now follow the same policy and give the same level of protection as direct attribute access in an environment based on RestrictedPython’s safe_builtints.

  • Prevent information leakage via AttributeError.obj and the string module. (CVE-2024-47532)

7.2 (2024-08-02)

  • Remove unneeded setuptools fossils that may cause installation problems with recent setuptools versions.

  • Add support for single mode statements / execution.

  • Fix a potential breakout capability in the provided safer_getattr method that is part of the safer_builtins.

7.1 (2024-03-14)

  • Add support for the matmul (@) operator.

7.0 (2023-11-17)

Backwards incompatible changes
  • Drop support for Python 3.6.

Features
  • Officially support Python 3.12.

Fixes
  • Prevent DeprecationWarnings from ast.Str and ast.Num on Python 3.12

  • Forbid using some attributes providing access to restricted Python internals. (CVE-2023-37271)

  • Fix information disclosure problems through Python’s “format” functionality (format and format_map methods on str and its instances, string.Formatter). (CVE-2023-41039)

6.0 (2022-11-03)

Backwards incompatible changes
  • Drop support for Python 2.7 and 3.5.

Features
  • Officially support Python 3.11.

  • Allow to use the Python 3.11 feature of exception groups and except* (PEP 654).

5.2 (2021-11-19)

  • Document that __name__ is needed to define classes.

  • Add support for Python 3.10. Auditing the Python 3.10 change log did not reveal any changes which require actions in RestrictedPython.

  • Avoid deprecation warnings when using Python 3.8+. (#192)

5.1 (2020-10-07)

Features
  • Add support for (Python 3.8+) assignment expressions (i.e. the := operator)

  • Add support for Python 3.9 after checking the security implications of the syntax changes made in that version.

  • Add support for the bytes and sorted builtins (#186)

Documentation
  • Document parameter mode for the compile_restricted functions (#157)

  • Fix documentation for compile_restricted_function (#158)

Fixes
  • Fix compile_restricted_function with SyntaxErrors that have no text (#181)

  • Drop install dependency on setuptools. (#189)

5.0 (2019-09-03)

Breaking changes
  • Revert the allowance of the ... (Ellipsis) statement, as of 4.0. It is not needed to support Python 3.8. The security implications of the Ellipsis Statement is not 100 % clear and is not checked. ... (Ellipsis) is disallowed again.

Features
  • Add support for f-strings in Python 3.6+. (#123)

4.0 (2019-05-10)

Changes since 3.6.0:

Breaking changes
  • The compile_restricted* functions now return a namedtuple CompileResult instead of a simple tuple.

  • Drop the old implementation of version 3.x: RCompile.py, SelectCompiler.py, MutatingWorker.py, RestrictionMutator.py and tests/verify.py.

  • Drop support for long-deprecated sets module.

Features
  • Mostly complete rewrite based on Python AST module. [loechel (Alexander Loechel), icemac (Michael Howitz), stephan-hof (Stephan Hofmockel), tlotze (Thomas Lotze)]

  • Add support for Python 3.5, 3.6, 3.7.

  • Add preliminary support for Python 3.8. as of 3.8.0a3 is released.

  • Warn when using another Python implementation than CPython as it is not safe to use RestrictedPython with other versions than CPyton. See https://bitbucket.org/pypy/pypy/issues/2653 for PyPy.

  • Allow the ... (Ellipsis) statement. It is needed to support Python 3.8.

  • Allow yield and yield from statements. Generator functions would now work in RestrictedPython.

  • Allow the following magic methods to be defined on classes. (#104) They cannot be called directly but by the built-in way to use them (e. g. class instantiation, or comparison):

    • __init__

    • __contains__

    • __lt__

    • __le__

    • __eq__

    • __ne__

    • __gt__

    • __ge__

  • Imports like from a import * (so called star imports) are now forbidden as they allow to import names starting with an underscore which could override protected build-ins. (#102)

  • Allow to use list comprehensions in the default implementation of RestrictionCapableEval.eval().

  • Switch to pytest as test runner.

  • Bring test coverage to 100 %.

Bug fixes
  • Improve .Guards.safer_getattr to prevent accessing names starting with underscore. (#142)

3.6.0 (2010-07-09)

  • Add name check for names assigned during imports using the from x import y format.

  • Add test for name check when assigning an alias using multiple-context with statements in Python 2.7.

  • Add tests for protection of the iterators for dict and set comprehensions in Python 2.7.

3.6.0a1 (2010-06-05)

  • Remove support for DocumentTemplate.sequence - this is handled in the DocumentTemplate package itself.

3.5.2 (2010-04-30)

  • Remove a testing dependency on zope.testing.

3.5.1 (2009-03-17)

  • Add tests for Utilities module.

  • Filter DeprecationWarnings when importing Python’s sets module.

3.5.0 (2009-02-09)

  • Drop legacy support for Python 2.1 / 2.2 (__future__ imports of nested_scopes / generators.).

3.4.3 (2008-10-26)

  • Fix deprecation warning: with is now a reserved keyword on Python 2.6. That means RestrictedPython should run on Python 2.6 now. Thanks to Ranjith Kannikara, GSoC Student for the patch.

  • Add tests for ternary if expression and for with keyword and context managers.

3.4.2 (2007-07-28)

  • Changed homepage URL to the PyPI site

  • Improve README.txt.

3.4.1 (2007-06-23)

3.4.0 (2007-06-04)

  • RestrictedPython now has its own release cycle as a separate project.

  • Synchronized with RestrictedPython from Zope 2 tree.

3.2.0 (2006-01-05)

  • Corresponds to the verison of the RestrictedPython package shipped as part of the Zope 3.2.0 release.

  • No changes from 3.1.0.

3.1.0 (2005-10-03)

  • Corresponds to the verison of the RestrictedPython package shipped as part of the Zope 3.1.0 release.

  • Remove unused fossil module, SafeMapping.

  • Replaced use of deprecated whrandom module with random (aliased to whrandom for backward compatibility).

3.0.0 (2004-11-07)

  • Corresponds to the verison of the RestrictedPython package shipped as part of the Zope X3.0.0 release.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

restrictedpython-8.5.tar.gz (455.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

restrictedpython-8.5-py3-none-any.whl (31.0 kB view details)

Uploaded Python 3

File details

Details for the file restrictedpython-8.5.tar.gz.

File metadata

  • Download URL: restrictedpython-8.5.tar.gz
  • Upload date:
  • Size: 455.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for restrictedpython-8.5.tar.gz
Algorithm Hash digest
SHA256 4ed1269dbe3caa88db650d1af325198a952aeb1451eca05df0cfa65db4466215
MD5 6f904e41c56c887d820cb1e79e047f61
BLAKE2b-256 7c3b8e41f7cfabbb30b1013ebc7484303d6c87da2906ec432d69dea11d2f7d75

See more details on using hashes here.

Provenance

The following attestation bundles were made for restrictedpython-8.5.tar.gz:

Publisher: tests.yml on zopefoundation/RestrictedPython

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file restrictedpython-8.5-py3-none-any.whl.

File metadata

  • Download URL: restrictedpython-8.5-py3-none-any.whl
  • Upload date:
  • Size: 31.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for restrictedpython-8.5-py3-none-any.whl
Algorithm Hash digest
SHA256 6c70e0a3af13e830d37225788cdc8ab5804a8df4b500c135086eaef34b5c01e0
MD5 2339cc09a0b94de41af61c0121fa0b95
BLAKE2b-256 585716ce3c721f5a33317e4110575d5c9976c0c45f7fd96ca2e0adeab06e6026

See more details on using hashes here.

Provenance

The following attestation bundles were made for restrictedpython-8.5-py3-none-any.whl:

Publisher: tests.yml on zopefoundation/RestrictedPython

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

8.5 This release

2 files

8.4

2 files

8.3

2 files

8.2

2 files

8.1

2 files

8.1a1.dev0

2 files

8.0

2 files

7.4

2 files

7.3

2 files

7.2

2 files

7.2a1.dev0

2 files

7.1

2 files

7.0

2 files

7.0a2.dev0

2 files

7.0a1.dev1

2 files

7.0a1.dev0

2 files

6.2

2 files

6.1

2 files

6.0

2 files

6.0a1.dev0

2 files

5.4

2 files

5.3

2 files

5.3a1.dev0

2 files

5.2

2 files

5.2a1.dev0

2 files

5.1

2 files

5.0

2 files

4.0

2 files

4.0a1

1 file

3.6.0

1 file

3.6.0a1

1 file

3.5.2

1 file

3.5.1

1 file

3.5.0

1 file

3.4.3

1 file

3.4.2

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page