mirror of
https://github.com/beetbox/beets.git
synced 2025-12-06 08:39:17 +01:00
101 lines
3.1 KiB
Python
101 lines
3.1 KiB
Python
# This file is part of beets.
|
|
# Copyright 2016, Blemjhoo Tezoulbr <baobab@heresiarch.info>.
|
|
#
|
|
# 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.
|
|
|
|
"""Moves patterns in path formats (suitable for moving articles)."""
|
|
|
|
import re
|
|
|
|
from beets.plugins import BeetsPlugin
|
|
|
|
__author__ = "baobab@heresiarch.info"
|
|
__version__ = "1.1"
|
|
|
|
PATTERN_THE = "^the\\s"
|
|
PATTERN_A = "^[a][n]?\\s"
|
|
FORMAT = "{}, {}"
|
|
|
|
|
|
class ThePlugin(BeetsPlugin):
|
|
patterns: list[str] = []
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
|
|
self.template_funcs["the"] = self.the_template_func
|
|
|
|
self.config.add(
|
|
{
|
|
"the": True,
|
|
"a": True,
|
|
"format": "{}, {}",
|
|
"strip": False,
|
|
"patterns": [],
|
|
}
|
|
)
|
|
|
|
self.patterns = self.config["patterns"].as_str_seq()
|
|
for p in self.patterns:
|
|
if p:
|
|
try:
|
|
re.compile(p)
|
|
except re.error:
|
|
self._log.error("invalid pattern: {}", p)
|
|
else:
|
|
if not (p.startswith("^") or p.endswith("$")):
|
|
self._log.warning(
|
|
'warning: "{}" will not match string start/end',
|
|
p,
|
|
)
|
|
if self.config["a"]:
|
|
self.patterns = [PATTERN_A] + self.patterns
|
|
if self.config["the"]:
|
|
self.patterns = [PATTERN_THE] + self.patterns
|
|
if not self.patterns:
|
|
self._log.warning("no patterns defined!")
|
|
|
|
def unthe(self, text, pattern):
|
|
"""Moves pattern in the path format string or strips it
|
|
|
|
text -- text to handle
|
|
pattern -- regexp pattern (case ignore is already on)
|
|
strip -- if True, pattern will be removed
|
|
"""
|
|
if text:
|
|
r = re.compile(pattern, flags=re.IGNORECASE)
|
|
try:
|
|
t = r.findall(text)[0]
|
|
except IndexError:
|
|
return text
|
|
else:
|
|
r = re.sub(r, "", text).strip()
|
|
if self.config["strip"]:
|
|
return r
|
|
else:
|
|
fmt = self.config["format"].as_str()
|
|
return fmt.format(r, t.strip()).strip()
|
|
else:
|
|
return ""
|
|
|
|
def the_template_func(self, text):
|
|
if not self.patterns:
|
|
return text
|
|
if text:
|
|
for p in self.patterns:
|
|
r = self.unthe(text, p)
|
|
if r != text:
|
|
self._log.debug('"{}" -> "{}"', text, r)
|
|
break
|
|
return r
|
|
else:
|
|
return ""
|