Skip to main content

Emulating Python's interactive interpreter in asynchronous contexts

Project description

asyncode

PyPI PyPI - Python Version PyPI - Wheel Read the Docs Travis CI

Python package for emulating Python's interactive interpreter in asynchronous contexts.

Installation

Use the package manager pip to install asyncode:

pip install asyncode

Dependencies

  • Python ≥ 3.5 (no CI for Python < 3.8)

Usage

This package's external API consists in two classes, AsyncInteractiveInterpreter and AsyncInteractiveConsole, which subclass respectively code.InteractiveInterpreter and code.InteractiveConsole.

These classes are meant to be used in already running asynchronous contexts. Minimal useful code will need to subclass provided classes to implement specific functions:

import asyncode

class MyAsyncConsole(asyncode.AsyncInteractiveConsole):
    """AsyncInteractiveConsole adapted to running environment"""

    async def write(self, data):
        """Use specific function"""
        await some_output_coroutine(data)

    async def raw_input(self, prompt=""):
        """Use specific functions"""
        if prompt:
            await some_output_coroutine(prompt)

        data = await some_input_coroutine()
        return data


async def run_interpreter():
    """Run an interactive Python interpreter"""
    console = MyAsyncConsole()
    try:
        await console.interact()
    except SystemExit:
        # Do not exit the whole program when sending "exit()" or "quit()"
        await some_output_coroutine("Bye!")

Read the docs for more informations.

Contributing

Pull requests are welcome. Do not hesitate to get in touch with me (see below) for any question or suggestion about this project!

License

This work is shared under the MIT license.

© 2020 Loïc Simon (loic.simon@espci.org)

Project details


Download files

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

Source Distribution

asyncode-1.0.0.tar.gz (7.4 kB view hashes)

Uploaded Source

Built Distribution

asyncode-1.0.0-py3-none-any.whl (6.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page