Welcome to RestrictedPython’s documentation!

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.

Supported Python versions

RestrictedPython supports CPython 3.7 up to 3.12. It does _not_ support PyPy or other alternative Python implementations.

Contents

• The idea behind RestrictedPython
• Install / Depend on RestrictedPython
• Usage of RestrictedPython
  • Basic usage
  • Necessary setup
  • Usage in frameworks and Zope
  • Policies & builtins
  • Implementing a policy
  • Examples
• API overview
  • compile_restricted methods
  • restricted builtins
  • helper modules
  • RestrictingNodeTransformer
• Upgrade from 3.x
• Roadmap
  • RestrictedPython 4.0 (finished)
  • RestrictedPython 4.1+
  • RestrictedPython 6.0+
• Contributing
  • Contributing to RestrictedPython
  • Differences between different Python versions
  • Understanding How RestrictedPython works internally
  • Todos
• Changes
  • 7.0 (unreleased)
  • 6.0 (2022-11-03)
  • 5.2 (2021-11-19)
  • 5.1 (2020-10-07)
  • 5.0 (2019-09-03)
  • 4.0 (2019-05-10)
  • 3.6.0 (2010-07-09)
  • 3.6.0a1 (2010-06-05)
  • 3.5.2 (2010-04-30)
  • 3.5.1 (2009-03-17)
  • 3.5.0 (2009-02-09)
  • 3.4.3 (2008-10-26)
  • 3.4.2 (2007-07-28)
  • 3.4.1 (2007-06-23)
  • 3.4.0 (2007-06-04)
  • 3.2.0 (2006-01-05)
  • 3.1.0 (2005-10-03)
  • 3.0.0 (2004-11-07)

Indices and tables

• Index
• Module Index
• Search Page