Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2026-01-08 08:56:56 +01:00
Code Issues Projects Releases Wiki Activity

drop flexattr namespaces

Browse source 
Namespaces were a worthy idea, but they added a lot of complexity to both the
library code itself and every client of the flexattrs interfaces. Getting rid
of them, and having one flat namespace of both traditional fields and
flexattrs, has one huge benefit: we can "promote" flexattrs to real attributes
(and vice versa) without code changes in every client.

This frees us to have a somewhat less efficient implementation of flexattrs
because we have a smooth upgrade path for making attributes more efficient via
promotion.
This commit is contained in:
Adrian Sampson 2013-08-16 11:18:05 -07:00
parent 3b9b39e5c9
commit 1a0d9c507d
2 changed files with 71 additions and 68 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

126
beets/library.py
View file

@ -229,12 +229,9 @@ def format_for_path(value, key=None, pathmod=None):
def get_flexattrs(rows):
"""Given a list of SQLite result rows, construct a dictionary
hierarchy reflecting the contained flexible attribute values.
reflecting the contained flexible attribute values.
"""
out = defaultdict(dict)
for row in rows:
out[row['namespace']][row['key']] = row['value']
return dict(out)
return {row['key']: row['value'] for row in rows}
# Exceptions.
@ -246,9 +243,15 @@ class InvalidFieldError(Exception):
# Library items (songs).
class Item(object):
def __init__(self, values, flexattrs=None):
def __init__(self, values=None, flexattrs=None):
self.dirty = {}
self._fill_record(values, flexattrs)
self.record = {k: None for k in ITEM_KEYS}
self.flexattrs = {}
if values:
self.update(values)
if flexattrs:
self.update(flexattrs)
self._clear_dirty()
@classmethod
@ -263,50 +266,32 @@ class Item(object):
i.mtime = i.current_mtime() # Initial mtime.
return i
def _fill_record(self, values, flexattrs=None):
self.record = {}
for key in ITEM_KEYS:
try:
setattr(self, key, values[key])
except KeyError:
setattr(self, key, None)
self.flexattrs = defaultdict(dict)
if flexattrs:
self.flexattrs.update(flexattrs)
def _clear_dirty(self):
self.dirty = {}
for key in ITEM_KEYS:
self.dirty[key] = False
def __repr__(self):
return 'Item(' + repr(self.record) + ')'
return 'Item({0!r}, {1!r})'.format(self.record, self.flexattrs)
# Item field accessors.
def __getattr__(self, key):
"""If key is an item attribute (i.e., a column in the database),
returns the record entry for that key.
def __getitem__(self, key):
"""Get the item's value for a standard field or a flexattr.
"""
if key in ITEM_KEYS:
return self.record.get(key)
elif '-' in key:
namespace, key = key.split('-', 1)
if namespace in self.flexattrs:
return self.flexattrs[namespace].get(key)
return None
elif key in self.flexattrs:
return self.flexattrs[key]
else:
raise AttributeError(key + ' is not a valid item field')
raise KeyError('item does not have the key {0}'.format(key))
def __setattr__(self, key, value):
"""If key is an item attribute (i.e., a column in the database),
sets the record entry for that key to value. Note that to change
the attribute in the database or in the file's tags, one must
call store() or write().
def __contains__(self, key):
return key in ITEM_KEYS or key in self.flexattrs
Otherwise, performs an ordinary setattr.
def __setitem__(self, key, value):
"""Set the item's value for a standard field or a flexattr.
"""
# Encode unicode paths and read buffers.
if key == 'path':
@ -323,12 +308,39 @@ class Item(object):
if key in ITEM_KEYS_WRITABLE:
self.mtime = 0 # Reset mtime on dirty.
elif '-' in key:
namespace, key = key.split('-', 1)
self.flexattrs[namespace][key] = value
else:
self.flexattrs[key] = value
def update(self, values):
for key, value in values.items():
self[key] = value
def get(self, key, default=None):
if key in self:
return self[key]
else:
return default
def __getattr__(self, key):
"""If key is an item attribute (i.e., a column in the database),
returns the record entry for that key.
"""
try:
return super(Item, self).__getattr__(key)
except AttributeError:
if key in self:
return self[key]
else:
raise AttributeError(key + ' is not an item field')
def __setattr__(self, key, value):
"""Set the item's value for a standard field or a flexattr.
"""
# FIXME hack to allow self.x = y in __init__
if key in ('record', 'flexattrs', 'dirty'):
super(Item, self).__setattr__(key, value)
else:
self[key] = value
# Interaction with file metadata.
@ -450,11 +462,10 @@ class Item(object):
mapping['albumartist'] = mapping['artist']
# Flexible attributes.
for namespace, attrs in self.flexattrs.items():
for key, value in attrs.items():
if sanitize:
value = format_for_path(value, None, pathmod)
mapping['{}-{}'.format(namespace, key)] = value
for key, value in self.flexattrs.items():
if sanitize:
value = format_for_path(value, None, pathmod)
mapping[key] = value
# Get values from plugins.
for key, value in plugins.template_values(self).items():
@ -836,7 +847,7 @@ class ResultIterator(object):
'SELECT * FROM item_attributes WHERE entity_id=?',
(row['id'],)
)
return Item(row, get_flexattrs(flex_rows))
return Item(dict(row), get_flexattrs(flex_rows))
# Regular expression for parse_query_part, below.
PARSE_QUERY_PART_REGEX = re.compile(
@ -1152,7 +1163,6 @@ class Transaction(object):
"""Execute an SQL statement with substitution values and return
the row ID of the last affected row.
"""
print statement, subvals
cursor = self.lib._connection().execute(statement, subvals)
plugins.send('database_change', lib=self.lib)
return cursor.lastrowid
@ -1261,10 +1271,9 @@ class Library(BaseLibrary):
CREATE TABLE IF NOT EXISTS {0}_attributes (
id INTEGER PRIMARY KEY,
entity_id INTEGER,
namespace TEXT,
key TEXT,
value TEXT,
UNIQUE(entity_id, namespace, key) ON CONFLICT REPLACE);
UNIQUE(entity_id, key) ON CONFLICT REPLACE);
CREATE INDEX IF NOT EXISTS {0}_id_attribute
ON {0}_attributes (entity_id);
""".format(entity))
@ -1410,12 +1419,11 @@ class Library(BaseLibrary):
# Flexible attributes.
flexins = 'INSERT INTO item_attributes ' \
' (entity_id, namespace, key, value)' \
' (entity_id, key, value)' \
' VALUES (?, ?, ?, ?)'
for namespace, attrs in item.flexattrs.items():
for key, value in attrs.items():
if value is not None:
tx.mutate(flexins, (new_id, key, value))
for key, value in item.flexattrs.items():
if value is not None:
tx.mutate(flexins, (new_id, key, value))
item._clear_dirty()
item.id = new_id
@ -1426,7 +1434,8 @@ class Library(BaseLibrary):
if load_id is None:
load_id = item.id
stored_item = self.get_item(load_id)
item._fill_record(stored_item.record, stored_item.flexattrs)
item.update(stored_item.record)
item.update(stored_item.flexattrs)
item._clear_dirty()
def store(self, item, store_id=None, store_all=False):
@ -1456,11 +1465,10 @@ class Library(BaseLibrary):
# Flexible attributes.
flexins = 'INSERT INTO item_attributes ' \
' (entity_id, namespace, key, value)' \
' VALUES (?, ?, ?, ?)'
for namespace, attrs in item.flexattrs.items():
for key, value in attrs.items():
tx.mutate(flexins, (store_id, namespace, key, value))
' (entity_id, key, value)' \
' VALUES (?, ?, ?)'
for key, value in item.flexattrs.items():
tx.mutate(flexins, (store_id, key, value))
item._clear_dirty()
self._memotable = {}

13
beets/ui/commands.py
View file

@ -1099,6 +1099,8 @@ def _convert_type(key, value, album=False):
`album` indicates whether to use album or item field definitions.
"""
fields = library.ALBUM_FIELDS if album else library.ITEM_FIELDS
if key not in fields:
return value
typ = [f[1] for f in fields if f[0] == key][0]
if typ is bool:
@ -1120,15 +1122,9 @@ def _convert_type(key, value, album=False):
def modify_items(lib, mods, query, write, move, album, confirm):
"""Modifies matching items according to key=value assignments."""
# Parse key=value specifications into a dictionary.
if album:
allowed_keys = library.ALBUM_KEYS
else:
allowed_keys = library.ITEM_KEYS_WRITABLE + ['added']
fsets = {}
for mod in mods:
key, value = mod.split('=', 1)
if key not in allowed_keys and '-' not in key:
raise ui.UserError('"%s" is not a valid field' % key)
fsets[key] = _convert_type(key, value, album)
# Get the items to modify.
@ -1143,8 +1139,7 @@ def modify_items(lib, mods, query, write, move, album, confirm):
# Show each change.
for field, value in fsets.iteritems():
curval = getattr(obj, field)
_showdiff(field, curval, value)
_showdiff(field, obj.get(field), value)
# Confirm.
if confirm:
@ -1156,7 +1151,7 @@ def modify_items(lib, mods, query, write, move, album, confirm):
with lib.transaction():
for obj in objs:
for field, value in fsets.iteritems():
setattr(obj, field, value)
obj[field] = value
if move:
cur_path = obj.item_dir() if album else obj.path