Last active
August 29, 2015 14:21
-
-
Save Varriount/4a0eec1a06c711f9f516 to your computer and use it in GitHub Desktop.
A python snippet which instantiates and sends a generator a (weakly referenced proxied) instance of itself, to itself.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
""" | |
The MIT License (MIT) | |
Copyright (c) 2015 Clay Sweetser | |
Permission is hereby granted, free of charge, to any person obtaining a copy | |
of this software and associated documentation files (the "Software"), to deal | |
in the Software without restriction, including without limitation the rights | |
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
copies of the Software, and to permit persons to whom the Software is | |
furnished to do so, subject to the following conditions: | |
The above copyright notice and this permission notice shall be included in | |
all copies or substantial portions of the Software. | |
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
THE SOFTWARE. | |
""" | |
from weakref import proxy, WeakKeyDictionary | |
from sys import version_info | |
from functools import wraps | |
import sublime | |
def get_next_method(generator_instance): | |
if version_info[0] >= 3: | |
return generator_instance.__next__ | |
else: | |
return generator_instance.next | |
def send_self(use_proxy): | |
""" A decorator which sends a generator a reference to itself via the first | |
'yield' used. | |
Useful for creating generators that can leverage callback-based functions | |
in a linear style, by passing their 'send' method as callbacks. | |
Note that by default, the generator instance reference sent is a weakly | |
referenced proxy. To override this behavior, pass `False` or | |
`use_proxy=False` as the first argument to the decorator. | |
""" | |
_use_proxy = True | |
# We either directly call this, or return it, to be called by python's | |
# decorator mechanism. | |
def _send_self(func): | |
@wraps(func) | |
def send_self_wrapper(*args, **kwargs): | |
generator = func(*args, **kwargs) | |
generator.send(None) | |
if _use_proxy: | |
generator.send(proxy(generator)) | |
else: | |
generator.send(generator) | |
return send_self_wrapper | |
# If the argument is a callable, we've been used without being directly | |
# passed an arguement by the user, and thus should call _send_self directly | |
if callable(use_proxy): | |
# No arguments, this is the decorator | |
return _send_self(use_proxy) | |
else: | |
# Someone has used @send_self(bool), and thus we need to return | |
# _send_self to be called indirectly. | |
_use_proxy = use_proxy | |
return _send_self |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
""" | |
The MIT License (MIT) | |
Copyright (c) 2015 Clay Sweetser | |
Permission is hereby granted, free of charge, to any person obtaining a copy | |
of this software and associated documentation files (the "Software"), to deal | |
in the Software without restriction, including without limitation the rights | |
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
copies of the Software, and to permit persons to whom the Software is | |
furnished to do so, subject to the following conditions: | |
The above copyright notice and this permission notice shall be included in | |
all copies or substantial portions of the Software. | |
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
THE SOFTWARE. | |
""" | |
def loop_status_msg(frames, speed, view=None, key=''): | |
""" Creates and runs a generator which continually sets the status | |
text to a series of strings. Returns a function which, when called, | |
stops the generator. | |
Useful for creating 'animations' in the status bar. | |
Parameters: | |
`frames`: A sequence of strings displayed in order on the status bar | |
`speed`: Delay between frame shifts, in seconds | |
`view`: View to set the status on. If not provided, then | |
sublime.status_message is used. | |
`key`: Key used when setting the status on a view. Ignored if no | |
view is given. | |
To stop the loop, the returned function must be called with no arguments, | |
or a single argument for which `bool(arg) == true`. As a special condition, | |
if the first argument is a callable for which `bool(arg) == True`, then | |
the argument will be called after the last animation loop has finished. | |
If for the the given argument, `bool(arg) == False`, nothing will | |
happen. | |
""" | |
flag = _FlagObject() | |
flag.flag = False | |
@send_self | |
def loop_status_generator(): | |
self = yield | |
# Get the correct status function | |
set_timeout = sublime.set_timeout | |
if view is None: | |
set_status = sublime.status_message | |
else: | |
set_status = lambda f: view.set_status(key, f) | |
# Main loop | |
while not flag.flag: | |
for frame in frames: | |
set_status(frame) | |
yield set_timeout(get_next_method(self), int(speed * 1000)) | |
if callable(flag.flag): | |
flag.flag() | |
yield | |
def stop_status_loop(callback=True): | |
flag.flag = callback | |
sublime.set_timeout(loop_status_generator, 0) | |
return stop_status_loop | |
def static_status_msg(frame, speed=1): | |
""" Creates and runs a generator which displays an updatable message in | |
the current window. | |
Parameters: | |
`frame`: Initial message text | |
`speed`: Update speed, in seconds. Faster speed means faster message | |
update, but more CPU usage. Slower update speed means less | |
CPU usage, but slower message update. | |
To update the loop, call the returned function with the new message. | |
To stop displaying the message, call the returned function with 'true' or | |
a callable as the second parameter. | |
""" | |
flag = _FlagObject() | |
flag.flag = False | |
flag.frame = frame | |
@send_self | |
def static_status_generator(): | |
self = yield | |
# Get the correct status function | |
set_timeout = sublime.set_timeout | |
set_status = sublime.status_message | |
# Main loop | |
while not flag.flag: | |
set_status(flag.frame) | |
yield set_timeout(get_next_method(self), int(speed * 1000)) | |
if callable(flag.flag): | |
flag.flag() | |
yield | |
def update_status_loop(message, stop=False): | |
flag.flag = stop | |
flag.frame = message | |
sublime.set_timeout(static_status_generator, 0) | |
return update_status_loop | |
class _FlagObject(object): | |
""" | |
Used with loop_status_msg to signal when a status message loop should end. | |
""" | |
__slots__ = ['flag', 'frame'] | |
def __init__(self): | |
self.flag = False | |
self.frame = None |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment