-
-
Notifications
You must be signed in to change notification settings - Fork 34.5k
gh-134939: Add the interpreters Module #133958
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.
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
Changes from 12 commits
e3aa50b
88e47fb
ce3505b
0a5d0e4
fe86353
382cff2
5b6eb17
226e75c
eb7f7eb
491a642
fb3e215
cdfa1e7
fe1c1ae
399042f
907bb8c
e4cbc66
c0b637e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,198 @@ | ||
| :mod:`concurrent.!interpreters` --- Multiple Interpreters in the Same Process | ||
| ============================================================================= | ||
|
|
||
| .. module:: concurrent.interpreters | ||
| :synopsis: Multiple Interpreters in the Same Process | ||
|
|
||
| .. moduleauthor:: Eric Snow <ericsnowcurrently@gmail.com> | ||
| .. sectionauthor:: Eric Snow <ericsnowcurrently@gmail.com> | ||
|
|
||
| .. versionadded:: 3.14 | ||
|
|
||
| **Source code:** :source:`Lib/concurrent/interpreters.py` | ||
|
|
||
| -------------- | ||
|
|
||
|
|
||
| Introduction | ||
| ------------ | ||
|
|
||
| The :mod:`!concurrent.interpreters` module constructs higher-level | ||
| interfaces on top of the lower level :mod:`!_interpreters` module. | ||
|
|
||
| .. XXX Add references to the upcoming HOWTO docs in the seealso block. | ||
|
|
||
| .. seealso:: | ||
|
|
||
| :ref:`isolating-extensions-howto` | ||
| how to update an extension module to support multiple interpreters | ||
|
|
||
| :pep:`554` | ||
|
|
||
| :pep:`734` | ||
|
|
||
| :pep:`684` | ||
|
|
||
| .. XXX Why do we disallow multiple interpreters on WASM? | ||
|
|
||
| .. include:: ../includes/wasm-notavail.rst | ||
|
|
||
|
|
||
| Key Details | ||
| ----------- | ||
|
ericsnowcurrently marked this conversation as resolved.
Outdated
|
||
|
|
||
| Before we dive into examples, there are a small number of details | ||
| to keep in mind about using multiple interpreters: | ||
|
|
||
| * isolated, by default | ||
| * no implicit threads | ||
| * not all PyPI packages support use in multiple interpreters yet | ||
|
|
||
| .. XXX Are there other relevant details to list? | ||
|
|
||
| In the context of multiple interpreters, "isolated" means each | ||
| interpreter shares no state between them. In practice, there is some | ||
|
ericsnowcurrently marked this conversation as resolved.
Outdated
|
||
| process-global data they all share, but that is managed by the runtime. | ||
|
|
||
|
|
||
| Reference | ||
| --------- | ||
|
|
||
| This module defines the following functions: | ||
|
|
||
| .. function:: list_all() | ||
|
|
||
| Return a :class:`list` of :class:`Interpreter` objects, | ||
| one for each existing interpreter. | ||
|
|
||
| .. function:: get_current() | ||
|
|
||
| Return an :class:`Interpreter` object for the currently running | ||
| interpreter. | ||
|
|
||
| .. function:: get_main() | ||
|
|
||
| Return an :class:`Interpreter` object for the main interpreter. | ||
|
|
||
| .. function:: create() | ||
|
|
||
| Initialize a new (idle) Python interpreter | ||
| and return a :class:`Interpreter` object for it. | ||
|
|
||
|
|
||
| Interpreter objects | ||
| ^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| .. class:: Interpreter(id) | ||
|
|
||
| A single interpreter in the current process. | ||
|
|
||
| Generally, :class:`Interpreter` shouldn't be called directly. | ||
| Instead, use :func:`create` or one of the other module functions. | ||
|
|
||
| .. attribute:: id | ||
|
|
||
| (read-only) | ||
|
|
||
| The interpreter's ID. | ||
|
|
||
| .. attribute:: whence | ||
|
|
||
| (read-only) | ||
|
|
||
| A string describing where the interpreter came from. | ||
|
|
||
| .. method:: is_running() | ||
|
|
||
| Return ``True`` if the interpreter is currently executing code | ||
| in its :mod:`!__main__` module and ``False`` otherwise. | ||
|
|
||
| .. method:: close() | ||
|
|
||
| Finalize and destroy the interpreter. | ||
|
|
||
| .. method:: prepare_main(ns=None, **kwargs) | ||
|
|
||
| Bind "shareable" objects in the interpreter's | ||
| :mod:`!__main__` module. | ||
|
|
||
| .. method:: exec(code, /, dedent=True) | ||
|
|
||
| Run the given source code in the interpreter (in the current thread). | ||
|
|
||
| .. method:: call(callable, /, *args, **kwargs) | ||
|
|
||
| Return the result of calling running the given function in the | ||
| interpreter (in the current thread). | ||
|
|
||
| .. method:: call_in_thread(callable, /, *args, **kwargs) | ||
|
|
||
| Run the given function in the interpreter (in a new thread). | ||
|
|
||
| Exceptions | ||
| ^^^^^^^^^^ | ||
|
|
||
| .. exception:: InterpreterError | ||
|
|
||
| This exception, a subclass of :exc:`Exception`, is raised when | ||
| an interpreter-related error happens. | ||
|
|
||
| .. exception:: InterpreterNotFoundError | ||
|
|
||
| This exception, a subclass of :exc:`InterpreterError`, is raised when | ||
| the targeted interpreter no longer exists. | ||
|
|
||
| .. exception:: ExecutionFailed | ||
|
|
||
| This exception, a subclass of :exc:`InterpreterError`, is raised when | ||
| the running code raised an uncaught exception. | ||
|
|
||
| .. attribute:: excinfo | ||
|
|
||
| A basic snapshot of the exception raised in the other interpreter. | ||
|
|
||
| .. XXX Document the excinfoattrs? | ||
|
|
||
| .. exception:: NotShareableError | ||
|
|
||
| This exception, a subclass of :exc:`TypeError`, is raised when | ||
| an object cannot be sent to another interpreter. | ||
|
|
||
|
|
||
| .. XXX Add functions for communicating between interpreters. | ||
|
|
||
|
|
||
| Basic Usage | ||
|
ericsnowcurrently marked this conversation as resolved.
Outdated
|
||
| ----------- | ||
|
|
||
| Creating an interpreter and running code in it:: | ||
|
|
||
| from concurrent import interpreters | ||
|
|
||
| interp = interpreters.create() | ||
|
|
||
| # Run in the current OS thread. | ||
|
|
||
| interp.exec('print("spam!")') | ||
|
|
||
| interp.exec("""if True: | ||
| print('spam!') | ||
| """) | ||
|
|
||
| from textwrap import dedent | ||
| interp.exec(dedent(""" | ||
| print('spam!') | ||
| """)) | ||
|
|
||
| def run(): | ||
| print('spam!') | ||
|
|
||
| interp.call(run) | ||
|
|
||
| # Run in new OS thread. | ||
|
|
||
| t = interp.call_in_thread(run) | ||
| t.join() | ||
|
|
||
|
|
||
| .. XXX Explain about object "sharing". | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| The :mod:`!concurrent` package | ||
| ============================== | ||
|
|
||
| Currently, there is only one module in this package: | ||
| Currently, there are only two modules in this package: | ||
|
AA-Turner marked this conversation as resolved.
Outdated
ericsnowcurrently marked this conversation as resolved.
Outdated
|
||
|
|
||
| * :mod:`concurrent.futures` -- Launching parallel tasks | ||
| * :mod:`concurrent.interpreters` -- Multiple interpreters in the same process | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,7 +26,7 @@ def __getattr__(name): | |
| if name in ('Queue', 'QueueEmpty', 'QueueFull', 'create_queue'): | ||
| global create_queue, Queue, QueueEmpty, QueueFull | ||
| ns = globals() | ||
| from .queues import ( | ||
| from ._queues import ( | ||
| create as create_queue, | ||
| Queue, QueueEmpty, QueueFull, | ||
| ) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is importing the If not though, I'd suggest just simplifying all of this into a regular import.
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah, it might not matter so much. I'll take a look at dropping the module
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. done |
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.