Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (testpypi.python.org).
Help us improve Python packaging - Donate today!

Library for using callbacks to resume your code.

Project Description

A Python library for using callbacks to resume your code.

resumeback provides a utility function decorator that enables using callback-based interfaces in a single line of execution – a single function.

Full docs are available here: http://fichtefoll.github.io/resumeback/

Installation

$ pip install resumeback

Usage

resumeback.send_self’s mechanic of sending a generator function a handle to itself is what allows for better flow control using callback-based interfaces. Essentially, it enables a single line of execution.

Following is a function that uses an asynchronous callback mechanism to signal that user input has been made:

from threading import Thread

def ask_for_user_input(question, on_done):
    def watcher():
        result = input(question)
        on_done(result)

    Thread(target=watcher).start()

The traditional way of using a function like ask_for_user_input would be to define a function of some way, either as a closure or using functools.partial so that we can preserve the state we already accumulated prior to executing said function.

For example like so:

def main():
    arbitrary_value = 10

    def on_done(number):
        number = str(number)
        print("Result:", number * arbitrary_value)

    ask_for_user_input("Please enter a number", on_done)

Because Python does not have multi-line inline functions, this is rather awkward, because we are jumping from the function call of ask_for_user_input back to our previously defined function on_done – which is only ever going to be called once in this context.

However, using resumeback.send_self, we can do something to flatten our line of execution by passing a callback to resume execution in our original function:

from resumeback import send_self

@send_self
def main():
    this = yield  # "this" is now a reference to the just-created generator
    arbitrary_value = 10

    # Yield pauses execution until one of the generator methods is called,
    # such as `.send`, which we provide as the callback parameter.
    number = yield ask_for_user_input("Please enter a number", this.send)
    number = str(number)
    print("Result:", number * arbitrary_value)

Acknowledgements

Project started initially after a forum post from @Varriount on the Sublime Text forum. I just took his idea “to the next (abstraction) level” and made it more convenient to use.

Release History

Release History

This version
History Node

0.1.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
resumeback-0.1.0-py2.py3-none-any.whl (8.5 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Dec 10, 2015
resumeback-0.1.0.zip (11.5 kB) Copy SHA256 Checksum SHA256 Source Dec 10, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting