Skip to content

Explicitly state <OPTIMIZE ...> on functions does nothing #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sharktide merged 1 commit into from
Jul 10, 2025
Merged

Explicitly state <OPTIMIZE ...> on functions does nothing #109

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions docs/source/reference/Features/OPTIMIZE.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,27 @@ reStructuredPython allows you to apply runtime optimizations using special compi

.. code-block:: python

<OPTIMIZE gct=True, profile=True>
<OPTIMIZE gct=True, parallel=True, profile=True>
for i in range(10_000_000) {
temp = str(i) * 10
}


.. note::
Optimizations currently support loops and functions only.
Optimizations currently support loops only. The function implementation currently **does not** have actual optimizations, only profiling and tracing.

Arguments for `optimize_loop` and `optimize_function` include:
Arguments for <OPTIMIZE ...> on loops include:

- ``gct=True``: Enable garbage collection tracking.
- ``profile=True``: Enable execution time logging.
- ``parallel=True``: Enables multiprocessing pool

This will generate a python file that imports the optimization decorators from this ( the ``restructuredpython`` package ), so you will need to have this packag installed via pip on systems running your compiled, optimized program.
Arguments for <OPTIMIZE ...> on functions include:

- ``profile=False`` Enable execution time logging
- ``trace=False`` Enable event tracing

This will generate a python file that imports the optimization decorators from this ( the ``restructuredpython`` package ), so you will need to have this package installed via pip on systems running your compiled, optimized program.

However, as of 2.5.0, you could technically open the generated python file, remove the imports from ``restructuredpython``, and instead use ``include 'subinterpreter.optimize'``. However, this is expictily NOT recommended as it will break in future versions of reStructuredPython and will include an annoying copyright header in the generated file.

Expand Down