mirror of
https://github.com/xonsh/xonsh.git
synced 2025-03-04 16:34:47 +01:00
2abb24f4f6
A number of common spelling typos found within various docstrings and comments found within source code files have been identified and resolved.
94 lines
3.2 KiB
Python
94 lines
3.2 KiB
Python
""" This will release the lock on the current directory whenever the
|
|
prompt is shown. Enabling this will allow the other programs or
|
|
Windows Explorer to delete or rename the current or parent
|
|
directories. Internally, it is accomplished by temporarily resetting
|
|
CWD to the root drive folder while waiting at the prompt. This only
|
|
works with the prompt_toolkit backend and can cause cause issues
|
|
if any extensions are enabled that hook the prompt and relies on
|
|
``os.getcwd()``.
|
|
"""
|
|
import os
|
|
import builtins
|
|
import functools
|
|
from xonsh.tools import print_exception
|
|
|
|
|
|
def _chdir_up(path):
|
|
""" Change directory to path or if path does not exist
|
|
the first valid parent.
|
|
"""
|
|
try:
|
|
os.chdir(path)
|
|
return path
|
|
except (FileNotFoundError, NotADirectoryError):
|
|
parent = os.path.dirname(path)
|
|
if parent != path:
|
|
return _chdir_up(parent)
|
|
else:
|
|
raise
|
|
|
|
|
|
def _cwd_release_wrapper(func):
|
|
""" Decorator for Windows to the wrap the prompt function and release
|
|
the process lock on the current directory while the prompt is
|
|
displayed. This works by temporarily setting
|
|
the workdir to the users home directory.
|
|
"""
|
|
env = builtins.__xonsh_env__
|
|
if env.get('UPDATE_PROMPT_ON_KEYPRESS'):
|
|
return func if not hasattr(func, '_orgfunc') else func._orgfunc
|
|
|
|
if hasattr(func, '_orgfunc'):
|
|
# Already wrapped
|
|
return func
|
|
else:
|
|
@functools.wraps(func)
|
|
def wrapper(*args, **kwargs):
|
|
rootdir = os.path.splitdrive(os.getcwd())[0] + '\\'
|
|
os.chdir(rootdir)
|
|
try:
|
|
out = func(*args, **kwargs)
|
|
finally:
|
|
try:
|
|
pwd = env.get('PWD', rootdir)
|
|
os.chdir(pwd)
|
|
except (FileNotFoundError, NotADirectoryError):
|
|
print_exception()
|
|
newpath = _chdir_up(pwd)
|
|
builtins.__xonsh_env__['PWD'] = newpath
|
|
raise KeyboardInterrupt
|
|
return out
|
|
wrapper._orgfunc = func
|
|
return wrapper
|
|
|
|
|
|
def _cwd_restore_wrapper(func):
|
|
""" Decorator for Windows which will temporary restore the true working
|
|
directory. Designed to wrap completer callbacks from the
|
|
prompt_toolkit or readline.
|
|
"""
|
|
env = builtins.__xonsh_env__
|
|
if env.get('UPDATE_PROMPT_ON_KEYPRESS'):
|
|
return func if not hasattr(func, '_orgfunc') else func._orgfunc
|
|
|
|
if hasattr(func, '_orgfunc'):
|
|
# Already wrapped
|
|
return func
|
|
else:
|
|
@functools.wraps(func)
|
|
def wrapper(*args, **kwargs):
|
|
workdir = os.getcwd()
|
|
_chdir_up(env.get('PWD', workdir))
|
|
out = func(*args, **kwargs)
|
|
_chdir_up(workdir)
|
|
return out
|
|
wrapper._orgfunc = func
|
|
return wrapper
|
|
|
|
|
|
@events.on_ptk_create
|
|
def setup_release_cwd_hook(prompter, history, completer, bindings, **kw):
|
|
prompter.prompt = _cwd_release_wrapper(prompter.prompt)
|
|
if completer.completer:
|
|
# Temporarily restore cwd for callbacks to the completer
|
|
completer.completer.complete = _cwd_restore_wrapper(completer.completer.complete)
|