Skip to content

Commit

Permalink
Garden docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
icemac committed Nov 17, 2023
1 parent c2764e7 commit 07ef751
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 24 deletions.
6 changes: 2 additions & 4 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ Backwards incompatible changes
Features
++++++++

- Allow to use the package with Python 3.12 -- Caution: No security audit has
been done so far.
- Officially support Python 3.12.

Fixes
+++++
Expand All @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
# The short X.Y version.
version = '7.0'
# The full version, including alpha/beta/rc tags.
release = '7.0a1.dev2'
release = '7.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
28 changes: 14 additions & 14 deletions docs/contributing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand All @@ -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:

Expand Down Expand Up @@ -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`_
Expand Down
5 changes: 0 additions & 5 deletions docs/roadmap/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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+
---------------------

Expand Down

0 comments on commit 07ef751

Please sign in to comment.