From f58d4e838a22f46a300098887edf95a34c81b5a3 Mon Sep 17 00:00:00 2001 From: Guilherme Danno Date: Sat, 16 Apr 2016 21:25:49 -0300 Subject: [PATCH 1/9] Query data from items and export the json Based on the ``info`` plugin --- beetsplug/export.py | 145 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 145 insertions(+) create mode 100644 beetsplug/export.py diff --git a/beetsplug/export.py b/beetsplug/export.py new file mode 100644 index 000000000..a92e57265 --- /dev/null +++ b/beetsplug/export.py @@ -0,0 +1,145 @@ +# -*- coding: utf-8 -*- +# This file is part of beets. +# +# 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. + +"""Exports data from beets +""" + +from __future__ import division, absolute_import, print_function + +import json +import codecs + +from datetime import datetime, date +from beets.plugins import BeetsPlugin +from beets import ui +from beets import mediafile +from beetsplug.info import make_key_filter, library_data, tag_data + +json.JSONEncoder.default = lambda self, obj: \ + (obj.isoformat() if isinstance(obj, datetime) or isinstance(obj, date) + else None) + + +class ExportPlugin(BeetsPlugin): + + def __init__(self): + super(ExportPlugin, self).__init__() + + self.config.add({ + 'default_format': 'json', + 'json': { + # json module formatting options + 'formatting': { + 'ensure_ascii': False, + 'indent': 4, + 'separators': (',', ': '), + } + }, + # TODO: Use something like the edit plugin + # 'item_fields': [] + }) + + def commands(self): + # TODO: Add option to use albums + + cmd = ui.Subcommand('export', help=u'export data from beets') + cmd.func = self.run + cmd.parser.add_option( + u'-l', u'--library', action='store_true', + help=u'show library fields instead of tags', + ) + cmd.parser.add_option( + u'--append', action='store_true', default=False, + help=u'if should append data to the file', + ) + cmd.parser.add_option( + u'-i', u'--include-keys', default=[], + action='append', dest='included_keys', + help=u'comma separated list of keys to show', + ) + cmd.parser.add_option( + u'-p', u'--path', + help=u'path for the output file. If not given, will print the data' + ) + return [cmd] + + def run(self, lib, opts, args): + + file_path = opts.path + file_format = self.config['default_format'].get(str) + file_mode = 'a' if opts.append else 'w' + format_options = self.config[file_format]['formatting'].get(dict) + + export_format = ExportFormat.factory( + file_format, **{ + 'file_path': file_path, + 'file_mode': file_mode + } + ) + + items = [] + data_collector = library_data if opts.library else tag_data + + included_keys = [] + for keys in opts.included_keys: + included_keys.extend(keys.split(',')) + key_filter = make_key_filter(included_keys) + + for data_emitter in data_collector(lib, ui.decargs(args)): + try: + data, item = data_emitter() + except (mediafile.UnreadableFileError, IOError) as ex: + self._log.error(u'cannot read file: {0}', ex) + continue + + data = key_filter(data) + items += [data] + + export_format.export(items, **format_options) + + +class ExportFormat(object): + """The output format type""" + + @classmethod + def factory(self, type, **kwargs): + if type == "json": + if kwargs['file_path']: + return JsonFileFormat(**kwargs) + else: + return JsonPrintFormat() + raise NotImplemented("") + + def export(self, data, **kwargs): + raise NotImplemented("") + + +class JsonPrintFormat(ExportFormat): + """Outputs to the console""" + + def export(self, data, **kwargs): + ui.print_(json.dumps(data, **kwargs)) + + +class JsonFileFormat(ExportFormat): + """Saves in a json file""" + + def __init__(self, file_path, file_mode=u'w', encoding=u'utf-8'): + self.path = file_path + self.mode = file_mode + self.encoding = encoding + + def export(self, data, **kwargs): + with codecs.open(self.path, self.mode, self.encoding) as f: + json.dump(data, f, **kwargs) From c211aabd72b63cfd049808a90b8791630255d7ac Mon Sep 17 00:00:00 2001 From: Guilherme Danno Date: Sun, 17 Apr 2016 21:39:53 -0300 Subject: [PATCH 2/9] simplify json printing --- beetsplug/export.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/beetsplug/export.py b/beetsplug/export.py index a92e57265..ec90332b4 100644 --- a/beetsplug/export.py +++ b/beetsplug/export.py @@ -17,6 +17,7 @@ from __future__ import division, absolute_import, print_function +import sys import json import codecs @@ -129,7 +130,7 @@ class JsonPrintFormat(ExportFormat): """Outputs to the console""" def export(self, data, **kwargs): - ui.print_(json.dumps(data, **kwargs)) + json.dump(data, sys.stdout, **kwargs) class JsonFileFormat(ExportFormat): From 1e3704a27e11d1e5caae4ea6cf89edc25f28cb91 Mon Sep 17 00:00:00 2001 From: Guilherme Danno Date: Sun, 17 Apr 2016 21:52:09 -0300 Subject: [PATCH 3/9] fix NotImplementedError() --- beetsplug/export.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/beetsplug/export.py b/beetsplug/export.py index ec90332b4..46776354f 100644 --- a/beetsplug/export.py +++ b/beetsplug/export.py @@ -120,10 +120,10 @@ class ExportFormat(object): return JsonFileFormat(**kwargs) else: return JsonPrintFormat() - raise NotImplemented("") + raise NotImplementedError() def export(self, data, **kwargs): - raise NotImplemented("") + raise NotImplementedError() class JsonPrintFormat(ExportFormat): From 10acea4efd7b3a4b36ebab407eb799fcb6374ac9 Mon Sep 17 00:00:00 2001 From: Guilherme Danno Date: Sun, 17 Apr 2016 22:17:56 -0300 Subject: [PATCH 4/9] Remove json monkey-patching and use encoder subclassing --- beetsplug/export.py | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/beetsplug/export.py b/beetsplug/export.py index 46776354f..379bb708e 100644 --- a/beetsplug/export.py +++ b/beetsplug/export.py @@ -27,9 +27,13 @@ from beets import ui from beets import mediafile from beetsplug.info import make_key_filter, library_data, tag_data -json.JSONEncoder.default = lambda self, obj: \ - (obj.isoformat() if isinstance(obj, datetime) or isinstance(obj, date) - else None) + +class ExportEncoder(json.JSONEncoder): + """Deals with dates because JSON doesn't have a standard""" + def default(self, o): + if isinstance(o, datetime) or isinstance(o, date): + return o.isoformat() + return json.JSONEncoder.default(self, o) class ExportPlugin(BeetsPlugin): @@ -130,7 +134,7 @@ class JsonPrintFormat(ExportFormat): """Outputs to the console""" def export(self, data, **kwargs): - json.dump(data, sys.stdout, **kwargs) + json.dump(data, sys.stdout, cls=ExportEncoder, **kwargs) class JsonFileFormat(ExportFormat): @@ -143,4 +147,4 @@ class JsonFileFormat(ExportFormat): def export(self, data, **kwargs): with codecs.open(self.path, self.mode, self.encoding) as f: - json.dump(data, f, **kwargs) + json.dump(data, f, cls=ExportEncoder, **kwargs) From 5e3c65d32e36c91f70ec2534f7035098c3072eb1 Mon Sep 17 00:00:00 2001 From: Guilherme Danno Date: Sun, 17 Apr 2016 23:37:51 -0300 Subject: [PATCH 5/9] change option letter --- beetsplug/export.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/beetsplug/export.py b/beetsplug/export.py index 379bb708e..b66b549c7 100644 --- a/beetsplug/export.py +++ b/beetsplug/export.py @@ -74,14 +74,14 @@ class ExportPlugin(BeetsPlugin): help=u'comma separated list of keys to show', ) cmd.parser.add_option( - u'-p', u'--path', + u'-o', u'--output', help=u'path for the output file. If not given, will print the data' ) return [cmd] def run(self, lib, opts, args): - file_path = opts.path + file_path = opts.output file_format = self.config['default_format'].get(str) file_mode = 'a' if opts.append else 'w' format_options = self.config[file_format]['formatting'].get(dict) From 228ffc91beb1ae78f2d27c757a34d017bb373e81 Mon Sep 17 00:00:00 2001 From: Guilherme Danno Date: Sun, 17 Apr 2016 23:47:12 -0300 Subject: [PATCH 6/9] use `sort_keys` to make the data more "predictable" --- beetsplug/export.py | 1 + 1 file changed, 1 insertion(+) diff --git a/beetsplug/export.py b/beetsplug/export.py index b66b549c7..93362550f 100644 --- a/beetsplug/export.py +++ b/beetsplug/export.py @@ -49,6 +49,7 @@ class ExportPlugin(BeetsPlugin): 'ensure_ascii': False, 'indent': 4, 'separators': (',', ': '), + 'sort_keys': True } }, # TODO: Use something like the edit plugin From 1644f7117a5f7cd29154a091b6bea017eeb0a06b Mon Sep 17 00:00:00 2001 From: Guilherme Danno Date: Mon, 18 Apr 2016 11:54:22 -0300 Subject: [PATCH 7/9] documentation for export plugin --- docs/plugins/export.rst | 70 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 docs/plugins/export.rst diff --git a/docs/plugins/export.rst b/docs/plugins/export.rst new file mode 100644 index 000000000..abf56c29c --- /dev/null +++ b/docs/plugins/export.rst @@ -0,0 +1,70 @@ +Export Plugin +============= + +The ``export`` plugin lets you get data from the items and export the content to +a ``json`` file. + +Configuration +------------- +To configure the plugin, make a ``export:`` section in your configuration +file. The default options are:: + + export: + default_format: json + json: + formatting: + ensure_ascii: False + indent: 4 + separators: [',' , ': '] + sort_keys: true + +- **default_format**: Choose the format of the exported content. + Supports json only for now. + +Each format have their own options. + +The ``json`` formatting uses the `json`_ standard library options. +Using custom options overwrites all options at the same level. +The default options used here are: + +- **ensure_ascii**: All non-ASCII characters are escaped with `\uXXXX`, if true. + +- **indent**: The number of spaces for indentation. + +- **separators**: A ``(item_separator, dict_separator)`` tuple + +- **sort_keys**: Sorts the keys of the json + +.. _json: https://docs.python.org/2/library/json.html#basic-usage + +Using +----- + +Enable the ``export`` plugin (see :ref:`using-plugins` for help) and then add a +``export`` section to your :doc:`configuration file ` + +To use, you can enter a :doc:`query ` to get the data from +your library:: + + $ beet export beatles + +If you just want to see specific properties you can use the +``--include-keys`` option to filter them. The argument is a +comma-separated list of simple glob patterns where ``*`` matches any +string. For example:: + + $ beet export -i 'title,mb*' beatles + +Will only show the ``title`` property and all properties starting with +``mb``. You can add the ``-i`` option multiple times to the command +line. + +Additional command-line options include: + +* ``--library`` or ``-l``: Show data from the library database instead of the + files' tags. + +* ``--output`` or ``-o``: Path for an output file. If not informed, will print + the data in the console. + +* ``--append``: Appends the data to the file instead of writing. From 806f4908613f3227e6e3f15ff50b0f87c96d8bee Mon Sep 17 00:00:00 2001 From: Guilherme Danno Date: Mon, 18 Apr 2016 11:59:48 -0300 Subject: [PATCH 8/9] add export plugin to index.rst --- docs/plugins/index.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index 7d6313d7f..260eb7d49 100644 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -44,6 +44,7 @@ Each plugin has its own set of options that can be defined in a section bearing edit embedart embyupdate + export fetchart fromfilename ftintitle @@ -161,6 +162,7 @@ Miscellaneous * :doc:`convert`: Transcode music and embed album art while exporting to a different directory. * :doc:`duplicates`: List duplicate tracks or albums. +* :doc:`export`: Export data from queries to a format. * :doc:`fuzzy`: Search albums and tracks with fuzzy string matching. * :doc:`ihate`: Automatically skip albums and tracks during the import process. * :doc:`info`: Print music files' tags to the console. From 5817c6578ab17e25eb539d41ba7517c2713a8ee7 Mon Sep 17 00:00:00 2001 From: Guilherme Danno Date: Mon, 18 Apr 2016 12:05:16 -0300 Subject: [PATCH 9/9] Add changelog --- docs/changelog.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/changelog.rst b/docs/changelog.rst index 600bc4cb7..5e9fa21e6 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -15,6 +15,8 @@ New features: for a Microsoft Azure Marketplace free account. Thanks to :user:`Kraymer`. * :doc:`/plugins/fetchart`: Album art can now be fetched from `fanart.tv`_. Albums are matched using the ``mb_releasegroupid`` tag. +* :doc:`/plugins/export`: A new plugin to export the data from queries to a + json format. Thanks to :user:`GuilhermeHideki`. .. _fanart.tv: https://fanart.tv/