MetaSync: more OO structure + iTunes support #1450

tomjaspers · 2015-05-07T08:45:58Z

Adds support for syncing iTunes metadata: rating, play count, skip count, last played, last skipped

It uses plistlib, which is available for all platforms (since py26), but the behavior is completely untested on Windows system (only tested on my OS X system). The iTunes library is copied to a temporary file before reading it, to avoid corrupting it.

Want to do a few more things, but figured I'd get it up here already (since it technically works).

Make more OO (e.g., like FetchArt and ArtSources)
Add extra logging in the MetaSources
Investigate behavior on Windows
Add tests
Expose item_types from the MetaSources

Uses plistlib to read a temp copy of `iTunes Library.xml`

changelog & metasync plugin documentation

Kraymer · 2015-05-07T09:00:31Z

docs/plugins/metasync.rst

+
+The path to your iTunes library **xml** file has to be configured, e.g.::
+
+    metaysnc:


metaysnc => metasync

- allows for the logging to integrate better - renamed `get_data` to `sync_data`, to better reflect that its not returning anything, but that the item's data is being set by the function

- MetaSources get loaded from the modules automatically - The MetaSources can define their own item_types, that get loaded for the plugin - __init__ doesn't need any changes to accept new metasources - Fix the --sources option to actually accept sources (it was being interpreted as boolean flag before, crashing the plugin) - More safety w.r.t. external dependencies

tomjaspers · 2015-05-10T11:15:33Z

@pprkut Thats' a good point; I never considered reverse syncing (which definitely would need its own function).

What do you think about sync_from_source (and in the future: sync_to_source) ? That feels explicit enough to me.

pprkut · 2015-05-10T12:08:31Z

Generally fine, but I don't think 'syncing to source' would be semantically correct ;-) How about sync_from_remote and sync_to_remote?
But I guess that also kind of throws the command parameters into question :-/

tomjaspers · 2015-05-10T12:43:21Z

I'll stick to sync_from_source for now. If the plugin gets extended to sync to a player we can still refactor it, and change the command parameters too.

- `sync_data` -> `sync_from_source` - properly catch ConfigValueError - avoiding iterating through library if we couldn't instantiate any meta sources - fix create_temporary_copy to actually make a tempdir

No tests for Amarok, unfortunately

tomjaspers · 2015-05-11T20:32:51Z

I think this is done now. I tested it on a Windows machine with iTunes and all seems good. Maybe @pprkut could add some tests later on for Amarok?

There could still be future work to move the lastimport plugin to this as mentioned in #1386, but it's probably better to do that later in a separate issue. Could you have a look please, @sampsyo ?

sampsyo · 2015-05-12T04:56:50Z

beetsplug/metasync/__init__.py

+        for cls_name, _cls in classes:
+            meta_sources[cls_name.lower()] = _cls
+
+    return meta_sources


This is some very clever work to get auto-discovery in order! It could be, though, that it would be easier just to hard-code the list of modules to import and pull classes out of—this sort of pkgutil and inspect magic could make this harder to maintain in the future. (We already run into some amount of trouble with testing, for example, when it interacts with similar magic in the beets plugin loading system.)

So I'll advocate gently for the "dumb" solution here: just redundantly writing down the list of available backends rather than automatically discovering them. But if anyone thinks this is too nifty to throw away, I could be convinced. 😃

Also, I should mention I realize that you didn't invent the magic here; it's just clearer this time, so it's the first time I thought about it carefully.

I suppose you are right, considering there won't be that many sources.

Think I was just having some fun writing the auto-discovery, and sort of forgot the whole "Simple is better than complex" 😃

sampsyo · 2015-05-12T05:03:56Z

This is looking really great, @tomjaspers. This backend is one I might use myself.

I have a few lower-level comments above; please feel free to ask for clarification on anything.

In favor of simpler, hard-coded, list of sources, to avoid unneccesary magic. Also: check to see if query has results before instantiating the meta sources

- Use path as an key to find items (over artist/title/album tuples) - Sensible default library location

tomjaspers · 2015-05-13T18:18:47Z

@sampsyo I've made the changes. I'm not exactly sure why Travis is failing, though?

There were quite some quirks with iTunes' way of storing the path, but they're documented in the _norm_itunes_path method. Have tested it on my Windows VM, and modified the tests to take Windows in to account too.

Anyway, I'll be away for a few days, but can work on it some more if need be, next week.

sampsyo · 2015-05-13T21:55:38Z

Awesome. This looks really cool; nice hacks to get the paths in shape.

And yes, I don't know what's up with Travis. The failures seem unrelated to this plugin. I suspect something wrong with the Travis environment, but they haven't changed the build environments lately: http://docs.travis-ci.com/user/build-environment-updates/

Investigating.

MetaSync: more OO structure + iTunes support

lzilioli · 2024-01-07T15:38:26Z

Any plans to update this plugin for the Apple Music app?

tomjaspers added 2 commits May 6, 2015 22:01

MetaSync: add iTunes synchronization

3dc2bed

Uses plistlib to read a temp copy of `iTunes Library.xml`

MetaSync: docs for itunes synchronization

04d7c88

changelog & metasync plugin documentation

Kraymer reviewed May 7, 2015
View reviewed changes

tomjaspers added 3 commits May 8, 2015 16:43

MetaSync: update changelog & fix typo in doc

27aef76

MetaSync: sources need to subclass MetaSource

de5db70

- allows for the logging to integrate better - renamed `get_data` to `sync_data`, to better reflect that its not returning anything, but that the item's data is being set by the function

tomjaspers changed the title ~~MetaSync: iTunes support~~ MetaSync: more OO structure + iTunes support May 9, 2015

tomjaspers mentioned this pull request May 9, 2015

iTunes-beets bi-directional sync plugin #1403

Open

MetaSync: rename 'cls' variable to '_cls'

bba8647

tomjaspers added 3 commits May 10, 2015 14:44

MetaSync: small refactoring + enhancements

abd0205

- `sync_data` -> `sync_from_source` - properly catch ConfigValueError - avoiding iterating through library if we couldn't instantiate any meta sources - fix create_temporary_copy to actually make a tempdir

MetaSync: basic tests

afeedd2

No tests for Amarok, unfortunately

MetaSync: fix tests for Windows

16531b6

sampsyo reviewed May 12, 2015
View reviewed changes

tomjaspers added 2 commits May 13, 2015 11:01

MetaSync: Remove auto-discovery of sources

02bec1b

In favor of simpler, hard-coded, list of sources, to avoid unneccesary magic. Also: check to see if query has results before instantiating the meta sources

MetaSync: minor improvements for iTunes source

94edc7a

- Use path as an key to find items (over artist/title/album tuples) - Sensible default library location

sampsyo merged commit 94edc7a into beetbox:master May 13, 2015

sampsyo added a commit that referenced this pull request May 13, 2015

Merge pull request #1450 from tomjaspers/metasync-itunes

71d7c0b

MetaSync: more OO structure + iTunes support

tomjaspers deleted the metasync-itunes branch May 20, 2015 17:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MetaSync: more OO structure + iTunes support #1450

MetaSync: more OO structure + iTunes support #1450

tomjaspers commented May 7, 2015

Kraymer May 7, 2015

tomjaspers commented May 10, 2015

pprkut commented May 10, 2015

tomjaspers commented May 10, 2015

tomjaspers commented May 11, 2015

sampsyo May 12, 2015

sampsyo May 12, 2015

tomjaspers May 12, 2015

sampsyo commented May 12, 2015

tomjaspers commented May 13, 2015

sampsyo commented May 13, 2015

lzilioli commented Jan 7, 2024


		The path to your iTunes library xml file has to be configured, e.g.::

		metaysnc:

MetaSync: more OO structure + iTunes support #1450

MetaSync: more OO structure + iTunes support #1450

Conversation

tomjaspers commented May 7, 2015

Kraymer May 7, 2015

Choose a reason for hiding this comment

tomjaspers commented May 10, 2015

pprkut commented May 10, 2015

tomjaspers commented May 10, 2015

tomjaspers commented May 11, 2015

sampsyo May 12, 2015

Choose a reason for hiding this comment

sampsyo May 12, 2015

Choose a reason for hiding this comment

tomjaspers May 12, 2015

Choose a reason for hiding this comment

sampsyo commented May 12, 2015

tomjaspers commented May 13, 2015

sampsyo commented May 13, 2015

lzilioli commented Jan 7, 2024