mirror of
https://github.com/fergalmoran/picard.git
synced 2026-02-23 08:06:46 +00:00
Refactor script module into package
This commit is contained in:
Philipp Wolfer
102
picard/script/__init__.py
Normal file
102
picard/script/__init__.py
Normal file
@@ -0,0 +1,102 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Picard, the next-generation MusicBrainz tagger
|
||||
#
|
||||
# Copyright (C) 2006-2009, 2012 Lukáš Lalinský
|
||||
# Copyright (C) 2007 Javier Kohen
|
||||
# Copyright (C) 2008-2011, 2014-2015, 2018-2020 Philipp Wolfer
|
||||
# Copyright (C) 2009 Carlin Mangar
|
||||
# Copyright (C) 2009 Nikolai Prokoschenko
|
||||
# Copyright (C) 2011-2012 Michael Wiencek
|
||||
# Copyright (C) 2012 Chad Wilson
|
||||
# Copyright (C) 2012 stephen
|
||||
# Copyright (C) 2012, 2014, 2017 Wieland Hoffmann
|
||||
# Copyright (C) 2013-2014, 2017-2020 Laurent Monin
|
||||
# Copyright (C) 2014, 2017 Sophist-UK
|
||||
# Copyright (C) 2016-2017 Sambhav Kothari
|
||||
# Copyright (C) 2016-2017 Ville Skyttä
|
||||
# Copyright (C) 2017-2018 Antonio Larrosa
|
||||
# Copyright (C) 2018 Calvin Walton
|
||||
# Copyright (C) 2018 virusMac
|
||||
# Copyright (C) 2020 Bob Swift
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or
|
||||
# modify it under the terms of the GNU General Public License
|
||||
# as published by the Free Software Foundation; either version 2
|
||||
# of the License, or (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program; if not, write to the Free Software
|
||||
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
|
||||
|
||||
from picard import config
|
||||
from picard.script.functions import ( # noqa: F401 # pylint: disable=unused-import
|
||||
register_script_function,
|
||||
script_function,
|
||||
)
|
||||
from picard.script.parser import ( # noqa: F401 # pylint: disable=unused-import
|
||||
MultiValue,
|
||||
ScriptEndOfFile,
|
||||
ScriptError,
|
||||
ScriptExpression,
|
||||
ScriptFunction,
|
||||
ScriptParseError,
|
||||
ScriptParser,
|
||||
ScriptRuntimeError,
|
||||
ScriptSyntaxError,
|
||||
ScriptText,
|
||||
ScriptUnknownFunction,
|
||||
ScriptVariable,
|
||||
)
|
||||
|
||||
|
||||
class ScriptFunctionDocError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
def script_function_documentation(name, fmt, functions=None, postprocessor=None):
|
||||
if functions is None:
|
||||
functions = dict(ScriptParser._function_registry)
|
||||
if name not in functions:
|
||||
raise ScriptFunctionDocError("no such function: %s (known functions: %r)" % (name, [name for name in functions]))
|
||||
|
||||
if fmt == 'html':
|
||||
return functions[name].htmldoc(postprocessor)
|
||||
elif fmt == 'markdown':
|
||||
return functions[name].markdowndoc(postprocessor)
|
||||
else:
|
||||
raise ScriptFunctionDocError("no such documentation format: %s (known formats: html, markdown)" % fmt)
|
||||
|
||||
|
||||
def script_function_names(functions=None):
|
||||
if functions is None:
|
||||
functions = dict(ScriptParser._function_registry)
|
||||
for name in sorted(functions):
|
||||
yield name
|
||||
|
||||
|
||||
def script_function_documentation_all(fmt='markdown', pre='',
|
||||
post='', postprocessor=None):
|
||||
functions = dict(ScriptParser._function_registry)
|
||||
doc_elements = []
|
||||
for name in script_function_names(functions):
|
||||
doc_element = script_function_documentation(name, fmt,
|
||||
functions=functions,
|
||||
postprocessor=postprocessor)
|
||||
if doc_element:
|
||||
doc_elements.append(pre + doc_element + post)
|
||||
return "\n".join(doc_elements)
|
||||
|
||||
|
||||
def enabled_tagger_scripts_texts():
|
||||
"""Returns an iterator over the enabled tagger scripts.
|
||||
For each script, you'll get a tuple consisting of the script name and text"""
|
||||
if not config.setting["enable_tagger_scripts"]:
|
||||
return []
|
||||
return [(s_name, s_text) for _s_pos, s_name, s_enabled, s_text in config.setting["list_of_scripts"] if s_enabled and s_text]
|
||||
@@ -34,23 +34,21 @@
|
||||
# along with this program; if not, write to the Free Software
|
||||
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
|
||||
|
||||
from collections import namedtuple
|
||||
from collections.abc import MutableSequence
|
||||
import datetime
|
||||
from functools import reduce
|
||||
from inspect import getfullargspec
|
||||
import operator
|
||||
from queue import LifoQueue
|
||||
import re
|
||||
import unicodedata
|
||||
|
||||
from picard import config
|
||||
from picard.metadata import (
|
||||
MULTI_VALUED_JOINER,
|
||||
Metadata,
|
||||
from picard.metadata import MULTI_VALUED_JOINER
|
||||
from picard.script.parser import (
|
||||
MultiValue,
|
||||
ScriptParser,
|
||||
ScriptRuntimeError,
|
||||
normalize_tagname,
|
||||
)
|
||||
from picard.plugin import ExtensionPoint
|
||||
from picard.util import uniqify
|
||||
|
||||
|
||||
@@ -60,95 +58,7 @@ except ImportError:
|
||||
markdown = None
|
||||
|
||||
|
||||
class ScriptError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
class ScriptParseError(ScriptError):
|
||||
def __init__(self, stackitem, message):
|
||||
super().__init__(
|
||||
"{prefix:s}: {message:s}".format(
|
||||
prefix=str(stackitem),
|
||||
message=message
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
class ScriptEndOfFile(ScriptParseError):
|
||||
def __init__(self, stackitem):
|
||||
super().__init__(
|
||||
stackitem,
|
||||
"Unexpected end of script"
|
||||
)
|
||||
|
||||
|
||||
class ScriptSyntaxError(ScriptParseError):
|
||||
pass
|
||||
|
||||
|
||||
class ScriptUnknownFunction(ScriptParseError):
|
||||
def __init__(self, stackitem):
|
||||
super().__init__(
|
||||
stackitem,
|
||||
"Unknown function '{name}'".format(name=stackitem.name)
|
||||
)
|
||||
|
||||
|
||||
class ScriptRuntimeError(ScriptError):
|
||||
def __init__(self, stackitem, message='Unknown error'):
|
||||
super().__init__(
|
||||
"{prefix:s}: {message:s}".format(
|
||||
prefix=str(stackitem),
|
||||
message=message
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
class StackItem:
|
||||
def __init__(self, line, column, name=None):
|
||||
self.line = line
|
||||
self.column = column
|
||||
if name is None:
|
||||
self.name = None
|
||||
else:
|
||||
self.name = '$' + name
|
||||
|
||||
def __str__(self):
|
||||
if self.name is None:
|
||||
return '{line:d}:{column:d}'.format(
|
||||
line=self.line,
|
||||
column=self.column
|
||||
)
|
||||
else:
|
||||
return '{line:d}:{column:d}:{name}'.format(
|
||||
line=self.line,
|
||||
column=self.column,
|
||||
name=self.name
|
||||
)
|
||||
|
||||
|
||||
class ScriptText(str):
|
||||
|
||||
def eval(self, state):
|
||||
return self
|
||||
|
||||
|
||||
def normalize_tagname(name):
|
||||
if name.startswith('_'):
|
||||
return "~" + name[1:]
|
||||
return name
|
||||
|
||||
|
||||
class ScriptVariable(object):
|
||||
|
||||
def __init__(self, name):
|
||||
self.name = name
|
||||
|
||||
def __repr__(self):
|
||||
return '<ScriptVariable %%%s%%>' % self.name
|
||||
|
||||
def eval(self, state):
|
||||
return state.context.get(normalize_tagname(self.name), "")
|
||||
Bound = namedtuple("Bound", ["lower", "upper"])
|
||||
|
||||
|
||||
class FunctionRegistryItem:
|
||||
@@ -188,320 +98,6 @@ class FunctionRegistryItem:
|
||||
return self._postprocess(ret, postprocessor)
|
||||
|
||||
|
||||
class ScriptFunctionDocError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
def script_function_documentation(name, fmt, functions=None, postprocessor=None):
|
||||
if functions is None:
|
||||
functions = dict(ScriptParser._function_registry)
|
||||
if name not in functions:
|
||||
raise ScriptFunctionDocError("no such function: %s (known functions: %r)" % (name, [name for name in functions]))
|
||||
|
||||
if fmt == 'html':
|
||||
return functions[name].htmldoc(postprocessor)
|
||||
elif fmt == 'markdown':
|
||||
return functions[name].markdowndoc(postprocessor)
|
||||
else:
|
||||
raise ScriptFunctionDocError("no such documentation format: %s (known formats: html, markdown)" % fmt)
|
||||
|
||||
|
||||
def script_function_names(functions=None):
|
||||
if functions is None:
|
||||
functions = dict(ScriptParser._function_registry)
|
||||
for name in sorted(functions):
|
||||
yield name
|
||||
|
||||
|
||||
def script_function_documentation_all(fmt='markdown', pre='',
|
||||
post='', postprocessor=None):
|
||||
functions = dict(ScriptParser._function_registry)
|
||||
doc_elements = []
|
||||
for name in script_function_names(functions):
|
||||
doc_element = script_function_documentation(name, fmt,
|
||||
functions=functions,
|
||||
postprocessor=postprocessor)
|
||||
if doc_element:
|
||||
doc_elements.append(pre + doc_element + post)
|
||||
return "\n".join(doc_elements)
|
||||
|
||||
|
||||
Bound = namedtuple("Bound", ["lower", "upper"])
|
||||
|
||||
|
||||
class ScriptFunction(object):
|
||||
|
||||
def __init__(self, name, args, parser, column=0, line=0):
|
||||
self.stackitem = StackItem(line, column, name)
|
||||
try:
|
||||
argnum_bound = parser.functions[name].argcount
|
||||
argcount = len(args)
|
||||
if argnum_bound:
|
||||
too_few_args = argcount < argnum_bound.lower
|
||||
if argnum_bound.upper is not None:
|
||||
if argnum_bound.lower == argnum_bound.upper:
|
||||
expected = "exactly %i" % argnum_bound.lower
|
||||
else:
|
||||
expected = "between %i and %i" % (argnum_bound.lower, argnum_bound.upper)
|
||||
too_many_args = argcount > argnum_bound.upper
|
||||
else:
|
||||
expected = "at least %i" % argnum_bound.lower
|
||||
too_many_args = False
|
||||
|
||||
if too_few_args or too_many_args:
|
||||
raise ScriptSyntaxError(
|
||||
self.stackitem,
|
||||
"Wrong number of arguments for $%s: Expected %s, got %i"
|
||||
% (name, expected, argcount)
|
||||
)
|
||||
except KeyError:
|
||||
raise ScriptUnknownFunction(self.stackitem)
|
||||
|
||||
self.name = name
|
||||
self.args = args
|
||||
|
||||
def __repr__(self):
|
||||
return "<ScriptFunction $%s(%r)>" % (self.name, self.args)
|
||||
|
||||
def eval(self, parser):
|
||||
try:
|
||||
function_registry_item = parser.functions[self.name]
|
||||
except KeyError:
|
||||
raise ScriptUnknownFunction(self.stackitem)
|
||||
|
||||
if function_registry_item.eval_args:
|
||||
args = [arg.eval(parser) for arg in self.args]
|
||||
else:
|
||||
args = self.args
|
||||
parser._function_stack.put(self.stackitem)
|
||||
# Save return value to allow removing function from the stack on successful completion
|
||||
return_value = function_registry_item.function(parser, *args)
|
||||
parser._function_stack.get()
|
||||
return return_value
|
||||
|
||||
|
||||
class ScriptExpression(list):
|
||||
|
||||
def eval(self, state):
|
||||
return "".join([item.eval(state) for item in self])
|
||||
|
||||
|
||||
def isidentif(ch):
|
||||
return ch.isalnum() or ch == '_'
|
||||
|
||||
|
||||
class ScriptParser(object):
|
||||
|
||||
r"""Tagger script parser.
|
||||
|
||||
Grammar:
|
||||
text ::= [^$%] | '\$' | '\%' | '\(' | '\)' | '\,'
|
||||
argtext ::= [^$%(),] | '\$' | '\%' | '\(' | '\)' | '\,'
|
||||
identifier ::= [a-zA-Z0-9_]
|
||||
variable ::= '%' identifier '%'
|
||||
function ::= '$' identifier '(' (argument (',' argument)*)? ')'
|
||||
expression ::= (variable | function | text)*
|
||||
argument ::= (variable | function | argtext)*
|
||||
"""
|
||||
|
||||
_function_registry = ExtensionPoint(label='function_registry')
|
||||
_cache = {}
|
||||
|
||||
def __init__(self):
|
||||
self._function_stack = LifoQueue()
|
||||
|
||||
def __raise_eof(self):
|
||||
raise ScriptEndOfFile(StackItem(line=self._y, column=self._x))
|
||||
|
||||
def __raise_char(self, ch):
|
||||
raise ScriptSyntaxError(StackItem(line=self._y, column=self._x), "Unexpected character '%s'" % ch)
|
||||
|
||||
def read(self):
|
||||
try:
|
||||
ch = self._text[self._pos]
|
||||
except IndexError:
|
||||
return None
|
||||
else:
|
||||
self._pos += 1
|
||||
self._px = self._x
|
||||
self._py = self._y
|
||||
if ch == '\n':
|
||||
self._line = self._pos
|
||||
self._x = 1
|
||||
self._y += 1
|
||||
else:
|
||||
self._x += 1
|
||||
return ch
|
||||
|
||||
def unread(self):
|
||||
self._pos -= 1
|
||||
self._x = self._px
|
||||
self._y = self._py
|
||||
|
||||
def parse_arguments(self):
|
||||
results = []
|
||||
while True:
|
||||
result, ch = self.parse_expression(False)
|
||||
results.append(result)
|
||||
if ch == ')':
|
||||
# Only an empty expression as first argument
|
||||
# is the same as no argument given.
|
||||
if len(results) == 1 and results[0] == []:
|
||||
return []
|
||||
return results
|
||||
|
||||
def parse_function(self):
|
||||
start = self._pos
|
||||
column = self._x - 2 # Set x position to start of function name ($)
|
||||
line = self._y
|
||||
while True:
|
||||
ch = self.read()
|
||||
if ch == '(':
|
||||
name = self._text[start:self._pos-1]
|
||||
if name not in self.functions:
|
||||
raise ScriptUnknownFunction(StackItem(line, column, name))
|
||||
return ScriptFunction(name, self.parse_arguments(), self, column, line)
|
||||
elif ch is None:
|
||||
self.__raise_eof()
|
||||
elif not isidentif(ch):
|
||||
self.__raise_char(ch)
|
||||
|
||||
def parse_variable(self):
|
||||
begin = self._pos
|
||||
while True:
|
||||
ch = self.read()
|
||||
if ch == '%':
|
||||
return ScriptVariable(self._text[begin:self._pos-1])
|
||||
elif ch is None:
|
||||
self.__raise_eof()
|
||||
elif not isidentif(ch) and ch != ':':
|
||||
self.__raise_char(ch)
|
||||
|
||||
def parse_text(self, top):
|
||||
text = []
|
||||
while True:
|
||||
ch = self.read()
|
||||
if ch == "\\":
|
||||
ch = self.read()
|
||||
if ch == 'n':
|
||||
text.append('\n')
|
||||
elif ch == 't':
|
||||
text.append('\t')
|
||||
elif ch not in "$%(),\\":
|
||||
self.__raise_char(ch)
|
||||
else:
|
||||
text.append(ch)
|
||||
elif ch is None:
|
||||
break
|
||||
elif not top and ch == '(':
|
||||
self.__raise_char(ch)
|
||||
elif ch in '$%' or (not top and ch in ',)'):
|
||||
self.unread()
|
||||
break
|
||||
else:
|
||||
text.append(ch)
|
||||
return ScriptText("".join(text))
|
||||
|
||||
def parse_expression(self, top):
|
||||
tokens = ScriptExpression()
|
||||
while True:
|
||||
ch = self.read()
|
||||
if ch is None:
|
||||
if top:
|
||||
break
|
||||
else:
|
||||
self.__raise_eof()
|
||||
elif not top and ch in ',)':
|
||||
break
|
||||
elif ch == '$':
|
||||
tokens.append(self.parse_function())
|
||||
elif ch == '%':
|
||||
tokens.append(self.parse_variable())
|
||||
else:
|
||||
self.unread()
|
||||
tokens.append(self.parse_text(top))
|
||||
return (tokens, ch)
|
||||
|
||||
def load_functions(self):
|
||||
self.functions = {}
|
||||
for name, item in ScriptParser._function_registry:
|
||||
self.functions[name] = item
|
||||
|
||||
def parse(self, script, functions=False):
|
||||
"""Parse the script."""
|
||||
self._text = script
|
||||
self._pos = 0
|
||||
self._px = self._x = 1
|
||||
self._py = self._y = 1
|
||||
self._line = 0
|
||||
if not functions:
|
||||
self.load_functions()
|
||||
return self.parse_expression(True)[0]
|
||||
|
||||
def eval(self, script, context=None, file=None):
|
||||
"""Parse and evaluate the script."""
|
||||
self.context = context if context is not None else Metadata()
|
||||
self.file = file
|
||||
self.load_functions()
|
||||
key = hash(script)
|
||||
if key not in ScriptParser._cache:
|
||||
ScriptParser._cache[key] = self.parse(script, True)
|
||||
return ScriptParser._cache[key].eval(self)
|
||||
|
||||
|
||||
class MultiValue(MutableSequence):
|
||||
def __init__(self, parser, multi, separator):
|
||||
self.parser = parser
|
||||
if isinstance(separator, ScriptExpression):
|
||||
self.separator = separator.eval(self.parser)
|
||||
else:
|
||||
self.separator = separator
|
||||
if (self.separator == MULTI_VALUED_JOINER
|
||||
and len(multi) == 1
|
||||
and isinstance(multi[0], ScriptVariable)):
|
||||
# Convert ScriptExpression containing only a single variable into variable
|
||||
self._multi = self.parser.context.getall(normalize_tagname(multi[0].name))
|
||||
else:
|
||||
# Fall-back to converting to a string and splitting if haystack is an expression
|
||||
# or user has overridden the separator character.
|
||||
evaluated_multi = multi.eval(self.parser)
|
||||
if not evaluated_multi:
|
||||
self._multi = []
|
||||
elif self.separator:
|
||||
self._multi = evaluated_multi.split(self.separator)
|
||||
else:
|
||||
self._multi = [evaluated_multi]
|
||||
|
||||
def __len__(self):
|
||||
return len(self._multi)
|
||||
|
||||
def __getitem__(self, key):
|
||||
return self._multi[key]
|
||||
|
||||
def __setitem__(self, key, value):
|
||||
self._multi[key] = value
|
||||
|
||||
def __delitem__(self, key):
|
||||
del self._multi[key]
|
||||
|
||||
def insert(self, index, value):
|
||||
return self._multi.insert(index, value)
|
||||
|
||||
def __repr__(self):
|
||||
return '%s(%r, %r, %r)' % (self.__class__.__name__, self.parser, self._multi, self.separator)
|
||||
|
||||
def __str__(self):
|
||||
return self.separator.join(self)
|
||||
|
||||
|
||||
def enabled_tagger_scripts_texts():
|
||||
"""Returns an iterator over the enabled tagger scripts.
|
||||
For each script, you'll get a tuple consisting of the script name and text"""
|
||||
if not config.setting["enable_tagger_scripts"]:
|
||||
return []
|
||||
return [(s_name, s_text) for _s_pos, s_name, s_enabled, s_text in config.setting["list_of_scripts"] if s_enabled and s_text]
|
||||
|
||||
|
||||
def register_script_function(function, name=None, eval_args=True,
|
||||
check_argcount=True, documentation=None):
|
||||
"""Registers a script function. If ``name`` is ``None``,
|
||||
400
picard/script/parser.py
Normal file
400
picard/script/parser.py
Normal file
@@ -0,0 +1,400 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Picard, the next-generation MusicBrainz tagger
|
||||
#
|
||||
# Copyright (C) 2006-2009, 2012 Lukáš Lalinský
|
||||
# Copyright (C) 2007 Javier Kohen
|
||||
# Copyright (C) 2008-2011, 2014-2015, 2018-2020 Philipp Wolfer
|
||||
# Copyright (C) 2009 Carlin Mangar
|
||||
# Copyright (C) 2009 Nikolai Prokoschenko
|
||||
# Copyright (C) 2011-2012 Michael Wiencek
|
||||
# Copyright (C) 2012 Chad Wilson
|
||||
# Copyright (C) 2012 stephen
|
||||
# Copyright (C) 2012, 2014, 2017 Wieland Hoffmann
|
||||
# Copyright (C) 2013-2014, 2017-2020 Laurent Monin
|
||||
# Copyright (C) 2014, 2017 Sophist-UK
|
||||
# Copyright (C) 2016-2017 Sambhav Kothari
|
||||
# Copyright (C) 2016-2017 Ville Skyttä
|
||||
# Copyright (C) 2017-2018 Antonio Larrosa
|
||||
# Copyright (C) 2018 Calvin Walton
|
||||
# Copyright (C) 2018 virusMac
|
||||
# Copyright (C) 2020 Bob Swift
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or
|
||||
# modify it under the terms of the GNU General Public License
|
||||
# as published by the Free Software Foundation; either version 2
|
||||
# of the License, or (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program; if not, write to the Free Software
|
||||
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
|
||||
from collections.abc import MutableSequence
|
||||
from queue import LifoQueue
|
||||
|
||||
from picard.metadata import (
|
||||
MULTI_VALUED_JOINER,
|
||||
Metadata,
|
||||
)
|
||||
from picard.plugin import ExtensionPoint
|
||||
|
||||
|
||||
class ScriptError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
class ScriptParseError(ScriptError):
|
||||
def __init__(self, stackitem, message):
|
||||
super().__init__(
|
||||
"{prefix:s}: {message:s}".format(
|
||||
prefix=str(stackitem),
|
||||
message=message
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
class ScriptEndOfFile(ScriptParseError):
|
||||
def __init__(self, stackitem):
|
||||
super().__init__(
|
||||
stackitem,
|
||||
"Unexpected end of script"
|
||||
)
|
||||
|
||||
|
||||
class ScriptSyntaxError(ScriptParseError):
|
||||
pass
|
||||
|
||||
|
||||
class ScriptUnknownFunction(ScriptParseError):
|
||||
def __init__(self, stackitem):
|
||||
super().__init__(
|
||||
stackitem,
|
||||
"Unknown function '{name}'".format(name=stackitem.name)
|
||||
)
|
||||
|
||||
|
||||
class ScriptRuntimeError(ScriptError):
|
||||
def __init__(self, stackitem, message='Unknown error'):
|
||||
super().__init__(
|
||||
"{prefix:s}: {message:s}".format(
|
||||
prefix=str(stackitem),
|
||||
message=message
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
class StackItem:
|
||||
def __init__(self, line, column, name=None):
|
||||
self.line = line
|
||||
self.column = column
|
||||
if name is None:
|
||||
self.name = None
|
||||
else:
|
||||
self.name = '$' + name
|
||||
|
||||
def __str__(self):
|
||||
if self.name is None:
|
||||
return '{line:d}:{column:d}'.format(
|
||||
line=self.line,
|
||||
column=self.column
|
||||
)
|
||||
else:
|
||||
return '{line:d}:{column:d}:{name}'.format(
|
||||
line=self.line,
|
||||
column=self.column,
|
||||
name=self.name
|
||||
)
|
||||
|
||||
|
||||
class ScriptText(str):
|
||||
|
||||
def eval(self, state):
|
||||
return self
|
||||
|
||||
|
||||
def normalize_tagname(name):
|
||||
if name.startswith('_'):
|
||||
return "~" + name[1:]
|
||||
return name
|
||||
|
||||
|
||||
class ScriptVariable(object):
|
||||
|
||||
def __init__(self, name):
|
||||
self.name = name
|
||||
|
||||
def __repr__(self):
|
||||
return '<ScriptVariable %%%s%%>' % self.name
|
||||
|
||||
def eval(self, state):
|
||||
return state.context.get(normalize_tagname(self.name), "")
|
||||
|
||||
|
||||
class ScriptFunction(object):
|
||||
|
||||
def __init__(self, name, args, parser, column=0, line=0):
|
||||
self.stackitem = StackItem(line, column, name)
|
||||
try:
|
||||
argnum_bound = parser.functions[name].argcount
|
||||
argcount = len(args)
|
||||
if argnum_bound:
|
||||
too_few_args = argcount < argnum_bound.lower
|
||||
if argnum_bound.upper is not None:
|
||||
if argnum_bound.lower == argnum_bound.upper:
|
||||
expected = "exactly %i" % argnum_bound.lower
|
||||
else:
|
||||
expected = "between %i and %i" % (argnum_bound.lower, argnum_bound.upper)
|
||||
too_many_args = argcount > argnum_bound.upper
|
||||
else:
|
||||
expected = "at least %i" % argnum_bound.lower
|
||||
too_many_args = False
|
||||
|
||||
if too_few_args or too_many_args:
|
||||
raise ScriptSyntaxError(
|
||||
self.stackitem,
|
||||
"Wrong number of arguments for $%s: Expected %s, got %i"
|
||||
% (name, expected, argcount)
|
||||
)
|
||||
except KeyError:
|
||||
raise ScriptUnknownFunction(self.stackitem)
|
||||
|
||||
self.name = name
|
||||
self.args = args
|
||||
|
||||
def __repr__(self):
|
||||
return "<ScriptFunction $%s(%r)>" % (self.name, self.args)
|
||||
|
||||
def eval(self, parser):
|
||||
try:
|
||||
function_registry_item = parser.functions[self.name]
|
||||
except KeyError:
|
||||
raise ScriptUnknownFunction(self.stackitem)
|
||||
|
||||
if function_registry_item.eval_args:
|
||||
args = [arg.eval(parser) for arg in self.args]
|
||||
else:
|
||||
args = self.args
|
||||
parser._function_stack.put(self.stackitem)
|
||||
# Save return value to allow removing function from the stack on successful completion
|
||||
return_value = function_registry_item.function(parser, *args)
|
||||
parser._function_stack.get()
|
||||
return return_value
|
||||
|
||||
|
||||
class ScriptExpression(list):
|
||||
|
||||
def eval(self, state):
|
||||
return "".join([item.eval(state) for item in self])
|
||||
|
||||
|
||||
def isidentif(ch):
|
||||
return ch.isalnum() or ch == '_'
|
||||
|
||||
|
||||
class ScriptParser(object):
|
||||
|
||||
r"""Tagger script parser.
|
||||
|
||||
Grammar:
|
||||
text ::= [^$%] | '\$' | '\%' | '\(' | '\)' | '\,'
|
||||
argtext ::= [^$%(),] | '\$' | '\%' | '\(' | '\)' | '\,'
|
||||
identifier ::= [a-zA-Z0-9_]
|
||||
variable ::= '%' identifier '%'
|
||||
function ::= '$' identifier '(' (argument (',' argument)*)? ')'
|
||||
expression ::= (variable | function | text)*
|
||||
argument ::= (variable | function | argtext)*
|
||||
"""
|
||||
|
||||
_function_registry = ExtensionPoint(label='function_registry')
|
||||
_cache = {}
|
||||
|
||||
def __init__(self):
|
||||
self._function_stack = LifoQueue()
|
||||
|
||||
def __raise_eof(self):
|
||||
raise ScriptEndOfFile(StackItem(line=self._y, column=self._x))
|
||||
|
||||
def __raise_char(self, ch):
|
||||
raise ScriptSyntaxError(StackItem(line=self._y, column=self._x), "Unexpected character '%s'" % ch)
|
||||
|
||||
def read(self):
|
||||
try:
|
||||
ch = self._text[self._pos]
|
||||
except IndexError:
|
||||
return None
|
||||
else:
|
||||
self._pos += 1
|
||||
self._px = self._x
|
||||
self._py = self._y
|
||||
if ch == '\n':
|
||||
self._line = self._pos
|
||||
self._x = 1
|
||||
self._y += 1
|
||||
else:
|
||||
self._x += 1
|
||||
return ch
|
||||
|
||||
def unread(self):
|
||||
self._pos -= 1
|
||||
self._x = self._px
|
||||
self._y = self._py
|
||||
|
||||
def parse_arguments(self):
|
||||
results = []
|
||||
while True:
|
||||
result, ch = self.parse_expression(False)
|
||||
results.append(result)
|
||||
if ch == ')':
|
||||
# Only an empty expression as first argument
|
||||
# is the same as no argument given.
|
||||
if len(results) == 1 and results[0] == []:
|
||||
return []
|
||||
return results
|
||||
|
||||
def parse_function(self):
|
||||
start = self._pos
|
||||
column = self._x - 2 # Set x position to start of function name ($)
|
||||
line = self._y
|
||||
while True:
|
||||
ch = self.read()
|
||||
if ch == '(':
|
||||
name = self._text[start:self._pos-1]
|
||||
if name not in self.functions:
|
||||
raise ScriptUnknownFunction(StackItem(line, column, name))
|
||||
return ScriptFunction(name, self.parse_arguments(), self, column, line)
|
||||
elif ch is None:
|
||||
self.__raise_eof()
|
||||
elif not isidentif(ch):
|
||||
self.__raise_char(ch)
|
||||
|
||||
def parse_variable(self):
|
||||
begin = self._pos
|
||||
while True:
|
||||
ch = self.read()
|
||||
if ch == '%':
|
||||
return ScriptVariable(self._text[begin:self._pos-1])
|
||||
elif ch is None:
|
||||
self.__raise_eof()
|
||||
elif not isidentif(ch) and ch != ':':
|
||||
self.__raise_char(ch)
|
||||
|
||||
def parse_text(self, top):
|
||||
text = []
|
||||
while True:
|
||||
ch = self.read()
|
||||
if ch == "\\":
|
||||
ch = self.read()
|
||||
if ch == 'n':
|
||||
text.append('\n')
|
||||
elif ch == 't':
|
||||
text.append('\t')
|
||||
elif ch not in "$%(),\\":
|
||||
self.__raise_char(ch)
|
||||
else:
|
||||
text.append(ch)
|
||||
elif ch is None:
|
||||
break
|
||||
elif not top and ch == '(':
|
||||
self.__raise_char(ch)
|
||||
elif ch in '$%' or (not top and ch in ',)'):
|
||||
self.unread()
|
||||
break
|
||||
else:
|
||||
text.append(ch)
|
||||
return ScriptText("".join(text))
|
||||
|
||||
def parse_expression(self, top):
|
||||
tokens = ScriptExpression()
|
||||
while True:
|
||||
ch = self.read()
|
||||
if ch is None:
|
||||
if top:
|
||||
break
|
||||
else:
|
||||
self.__raise_eof()
|
||||
elif not top and ch in ',)':
|
||||
break
|
||||
elif ch == '$':
|
||||
tokens.append(self.parse_function())
|
||||
elif ch == '%':
|
||||
tokens.append(self.parse_variable())
|
||||
else:
|
||||
self.unread()
|
||||
tokens.append(self.parse_text(top))
|
||||
return (tokens, ch)
|
||||
|
||||
def load_functions(self):
|
||||
self.functions = {}
|
||||
for name, item in ScriptParser._function_registry:
|
||||
self.functions[name] = item
|
||||
|
||||
def parse(self, script, functions=False):
|
||||
"""Parse the script."""
|
||||
self._text = script
|
||||
self._pos = 0
|
||||
self._px = self._x = 1
|
||||
self._py = self._y = 1
|
||||
self._line = 0
|
||||
if not functions:
|
||||
self.load_functions()
|
||||
return self.parse_expression(True)[0]
|
||||
|
||||
def eval(self, script, context=None, file=None):
|
||||
"""Parse and evaluate the script."""
|
||||
self.context = context if context is not None else Metadata()
|
||||
self.file = file
|
||||
self.load_functions()
|
||||
key = hash(script)
|
||||
if key not in ScriptParser._cache:
|
||||
ScriptParser._cache[key] = self.parse(script, True)
|
||||
return ScriptParser._cache[key].eval(self)
|
||||
|
||||
|
||||
class MultiValue(MutableSequence):
|
||||
def __init__(self, parser, multi, separator):
|
||||
self.parser = parser
|
||||
if isinstance(separator, ScriptExpression):
|
||||
self.separator = separator.eval(self.parser)
|
||||
else:
|
||||
self.separator = separator
|
||||
if (self.separator == MULTI_VALUED_JOINER
|
||||
and len(multi) == 1
|
||||
and isinstance(multi[0], ScriptVariable)):
|
||||
# Convert ScriptExpression containing only a single variable into variable
|
||||
self._multi = self.parser.context.getall(normalize_tagname(multi[0].name))
|
||||
else:
|
||||
# Fall-back to converting to a string and splitting if haystack is an expression
|
||||
# or user has overridden the separator character.
|
||||
evaluated_multi = multi.eval(self.parser)
|
||||
if not evaluated_multi:
|
||||
self._multi = []
|
||||
elif self.separator:
|
||||
self._multi = evaluated_multi.split(self.separator)
|
||||
else:
|
||||
self._multi = [evaluated_multi]
|
||||
|
||||
def __len__(self):
|
||||
return len(self._multi)
|
||||
|
||||
def __getitem__(self, key):
|
||||
return self._multi[key]
|
||||
|
||||
def __setitem__(self, key, value):
|
||||
self._multi[key] = value
|
||||
|
||||
def __delitem__(self, key):
|
||||
del self._multi[key]
|
||||
|
||||
def insert(self, index, value):
|
||||
return self._multi.insert(index, value)
|
||||
|
||||
def __repr__(self):
|
||||
return '%s(%r, %r, %r)' % (self.__class__.__name__, self.parser, self._multi, self.separator)
|
||||
|
||||
def __str__(self):
|
||||
return self.separator.join(self)
|
||||
@@ -40,11 +40,12 @@ from test.picardtestcase import PicardTestCase
|
||||
from picard import config
|
||||
from picard.cluster import Cluster
|
||||
from picard.const import DEFAULT_FILE_NAMING_FORMAT
|
||||
from picard.metadata import Metadata
|
||||
from picard.metadata import (
|
||||
MULTI_VALUED_JOINER,
|
||||
Metadata,
|
||||
)
|
||||
from picard.plugin import ExtensionPoint
|
||||
from picard.script import (
|
||||
MULTI_VALUED_JOINER,
|
||||
FunctionRegistryItem,
|
||||
MultiValue,
|
||||
ScriptEndOfFile,
|
||||
ScriptError,
|
||||
@@ -60,6 +61,7 @@ from picard.script import (
|
||||
script_function_documentation,
|
||||
script_function_documentation_all,
|
||||
)
|
||||
from picard.script.functions import FunctionRegistryItem
|
||||
|
||||
|
||||
try:
|
||||
|
||||
Reference in New Issue
Block a user