mirror of
https://github.com/beetbox/beets.git
synced 2025-12-07 09:04:33 +01:00
887d1c1287
I'm transitioning to using exclusively instance-level fields instead of class-level fields in plugin objects, but I neglected to bring inline and rewrite into the future. This manifested as silent inaction on the part of these plugins. This change restores the old behavior (for compatibility) but also updates the plugins to use the new behavior.
70 lines
2.6 KiB
Python
70 lines
2.6 KiB
Python
# This file is part of beets.
|
|
# Copyright 2013, Adrian Sampson.
|
|
#
|
|
# 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.
|
|
|
|
"""Uses user-specified rewriting rules to canonicalize names for path
|
|
formats.
|
|
"""
|
|
import re
|
|
import logging
|
|
from collections import defaultdict
|
|
|
|
from beets.plugins import BeetsPlugin
|
|
from beets import ui
|
|
from beets import library
|
|
from beets import config
|
|
|
|
log = logging.getLogger('beets')
|
|
|
|
def rewriter(field, rules):
|
|
"""Create a template field function that rewrites the given field
|
|
with the given rewriting rules. ``rules`` must be a list of
|
|
(pattern, replacement) pairs.
|
|
"""
|
|
def fieldfunc(item):
|
|
value = getattr(item, field)
|
|
for pattern, replacement in rules:
|
|
if pattern.match(value.lower()):
|
|
# Rewrite activated.
|
|
return replacement
|
|
# Not activated; return original value.
|
|
return value
|
|
return fieldfunc
|
|
|
|
class RewritePlugin(BeetsPlugin):
|
|
def __init__(self):
|
|
super(RewritePlugin, self).__init__()
|
|
|
|
self.config.add({})
|
|
|
|
# Gather all the rewrite rules for each field.
|
|
rules = defaultdict(list)
|
|
for key, value in self.config.items():
|
|
try:
|
|
fieldname, pattern = key.split(None, 1)
|
|
except ValueError:
|
|
raise ui.UserError("invalid rewrite specification")
|
|
if fieldname not in library.ITEM_KEYS:
|
|
raise ui.UserError("invalid field name (%s) in rewriter" %
|
|
fieldname)
|
|
log.debug(u'adding template field %s' % key)
|
|
pattern = re.compile(pattern.lower())
|
|
rules[fieldname].append((pattern, value))
|
|
if fieldname == 'artist':
|
|
# Special case for the artist field: apply the same
|
|
# rewrite for "albumartist" as well.
|
|
rules['albumartist'].append((pattern, value))
|
|
|
|
# Replace each template field with the new rewriter function.
|
|
for fieldname, fieldrules in rules.iteritems():
|
|
self.template_fields[fieldname] = rewriter(fieldname, fieldrules)
|