rnhmjoj/qutebrowser
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

reorganize and document

Browse Source
This commit is contained in:
Daniel Karbach 2016-09-29 14:37:40 +02:00
parent 8eb12c6cb9
commit cbbfbabfc4
1 changed files with 34 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
qutebrowser/commands/userscripts.py
View File

@ -325,12 +325,14 @@ class NotFoundError(Exception):
message: descriptive message string of the error message: descriptive message string of the error
""" """
def __init__(self, script_name, paths=[]): def __init__(self, script_name, paths=None):
super().__init__()
self.script_name = script_name self.script_name = script_name
self.paths = paths self.paths = paths
self.message = "Userscript '" + script_name + "' not found" self.message = "Userscript '" + script_name + "' not found"
if paths: if paths:
self.message += " in userscript directory '" + ("' or '".join(paths)) + "'" self.message += " in userscript directory '" + \
("' or '".join(paths)) + "'"
def __str__(self): def __str__(self):
return self.message return self.message
@ -344,12 +346,41 @@ class UnsupportedError(Exception):
return "Userscripts are not supported on this platform!" return "Userscripts are not supported on this platform!"
def _lookup_path(cmd):
"""Search userscript directories for given command.
Raises:
NotFoundError if the command could not be found.
Args:
cmd: The command to look for.
Returns:
A path to the userscript.
"""
cmd_path = os.path.join(standarddir.data(), "userscripts", cmd)
if os.path.exists(cmd_path):
return cmd_path
directories = [
os.path.join(standarddir.data(), "userscripts"),
os.path.join(standarddir.system_data(), "userscripts"),
]
for directory in directories:
cmd_path = os.path.join(directory, cmd)
if os.path.exists(cmd_path):
return cmd_path
raise NotFoundError(cmd, directories)
def run_async(tab, cmd, *args, win_id, env, verbose=False): def run_async(tab, cmd, *args, win_id, env, verbose=False):
"""Run a userscript after dumping page html/source. """Run a userscript after dumping page html/source.
Raises: Raises:
UnsupportedError if userscripts are not supported on the current UnsupportedError if userscripts are not supported on the current
platform. platform.
NotFoundError if the command could not be found.
Args: Args:
tab: The WebKitTab/WebEngineTab to get the source from. tab: The WebKitTab/WebEngineTab to get the source from.
@ -392,15 +423,7 @@ def run_async(tab, cmd, *args, win_id, env, verbose=False):
# ~/.local/share/qutebrowser/userscripts (or $XDG_DATA_DIR) # ~/.local/share/qutebrowser/userscripts (or $XDG_DATA_DIR)
if not os.path.isabs(cmd_path): if not os.path.isabs(cmd_path):
log.misc.debug("{} is no absolute path".format(cmd_path)) log.misc.debug("{} is no absolute path".format(cmd_path))
cmd_path = os.path.join(standarddir.data(), "userscripts", cmd) cmd_path = _lookup_path(cmd)
if not os.path.exists(cmd_path):
cmd_path = os.path.join(standarddir.system_data(),
"userscripts", cmd)
if not os.path.exists(cmd_path):
raise NotFoundError(cmd, [
os.path.join(standarddir.data(), "userscripts"),
os.path.join(standarddir.system_data(), "userscripts"),
])
elif not os.path.exists(cmd_path): elif not os.path.exists(cmd_path):
raise NotFoundError(cmd_path) raise NotFoundError(cmd_path)
log.misc.debug("Userscript to run: {}".format(cmd_path)) log.misc.debug("Userscript to run: {}".format(cmd_path))