Add feature to vote on tags (#240)

musicbrainzngs/mbxml.py

@@ -775,10 +775,20 @@ def make_tag_request(**kwargs):
  e_xml = ET.SubElement(e_list, "{%s}%s" % (NS, entity_type.replace('_', '-')))
  e_xml.set("{%s}id" % NS, e)
  taglist = ET.SubElement(e_xml, "{%s}user-tag-list" % NS)
- for tag in tags:
- usertag_xml = ET.SubElement(taglist, "{%s}user-tag" % NS)
- name_xml = ET.SubElement(usertag_xml, "{%s}name" % NS)
- name_xml.text = tag
+ if isinstance(tags, dict):
+ for tag, vote in tags.items():
+ if vote not in ('upvote', 'downvote', 'withdraw'):
+ raise ValueError("invalid vote: %s" % vote)
+
+ usertag_xml = ET.SubElement(taglist, "{%s}user-tag" % NS)
+ usertag_xml.set('vote', vote)
+ name_xml = ET.SubElement(usertag_xml, "{%s}name" % NS)
+ name_xml.text = tag
+ else:
+ for tag in tags:
+ usertag_xml = ET.SubElement(taglist, "{%s}user-tag" % NS)
+ name_xml = ET.SubElement(usertag_xml, "{%s}name" % NS)
+ name_xml.text = tag
  if kwargs.keys():
  raise TypeError("make_tag_request() got an unexpected keyword argument '%s'" % kwargs.popitem()[0])
 

musicbrainzngs/musicbrainz.py

@@ -1275,17 +1275,23 @@ def submit_tags(**kwargs):
  """Submit user tags.
  Takes parameters named e.g. 'artist_tags', 'recording_tags', etc.,
  and of the form:
+ {entity_id1: {tag1: vote, ...}, ...}
+
+ The value of _vote_ can be "upvote", "downvote", or "withdraw".
+
+ If you only want to set the tags, you can use a list:
  {entity_id1: [tag1, ...], ...}
- If you only have one tag for an entity you can use a string instead
- of a list.
+
+ If you only want to submit one tag, you can use a string:
+ {entity_id1: tag, ...}
 
  The user's tags for each entity will be set to that list, adding or
  removing tags as necessary. Submitting an empty list for an entity
  will remove all tags for that entity by the user.
  """
  for k, v in kwargs.items():
  for id, tags in v.items():
- kwargs[k][id] = tags if isinstance(tags, list) else [tags]
+ kwargs[k][id] = tags if isinstance(tags, (list, dict)) else [tags]
 
  query = mbxml.make_tag_request(**kwargs)
  return _do_mb_post("tag", query)

test/test_mbxml.py

@@ -22,6 +22,18 @@ def test_make_tag_request(self):
  xml = mbxml.make_tag_request(artist_tags={"mbid": ["one", "two"]})
  self.assertEqual(expected, xml)
 
+ def test_make_tag_request_with_votes(self):
+ expected = (b'<ns0:metadata xmlns:ns0="http://musicbrainz.org/ns/mmd-2.0#">'
+ b'<ns0:artist-list><ns0:artist ns0:id="mbid">'
+ b"<ns0:user-tag-list>"
+ b'<ns0:user-tag vote="upvote"><ns0:name>one</ns0:name></ns0:user-tag>'
+ b'<ns0:user-tag vote="downvote"><ns0:name>two</ns0:name></ns0:user-tag>'
+ b'<ns0:user-tag vote="withdraw"><ns0:name>three</ns0:name></ns0:user-tag>'
+ b"</ns0:user-tag-list></ns0:artist>"
+ b"</ns0:artist-list></ns0:metadata>")
+ xml = mbxml.make_tag_request(artist_tags={"mbid": {"one": "upvote", "two": "downvote", "three": "withdraw"}})
+ self.assertEqual(expected, xml)
+
  def test_read_error(self):
  error = '<?xml version="1.0" encoding="UTF-8"?><error><text>Invalid mbid.</text><text>For usage, please see: http://musicbrainz.org/development/mmd</text></error>'
  parts = mbxml.get_error_message(error)

test/test_submit.py

@@ -31,6 +31,17 @@ def make_xml(**kwargs):
  musicbrainz.submit_tags(artist_tags={"mbid": ["one", "two"]})
  musicbrainz.mbxml.make_tag_request = oldmake_tag_request
 
+ def test_submit_tags_with_votes(self):
+ self.opener = _common.FakeOpener("<response/>")
+ musicbrainzngs.compat.build_opener = lambda *args: self.opener
+ def make_xml(**kwargs):
+ self.assertEqual({'artist_tags': {'mbid': {"one": "upvote", "two": "downvote", "three": "withdraw"}}}, kwargs)
+ oldmake_tag_request = musicbrainz.mbxml.make_tag_request
+ musicbrainz.mbxml.make_tag_request = make_xml
+
+ musicbrainz.submit_tags(artist_tags={"mbid": {"one": "upvote", "two": "downvote", "three": "withdraw"}})
+ musicbrainz.mbxml.make_tag_request = oldmake_tag_request
+
  def test_submit_single_tag(self):
  self.opener = _common.FakeOpener("<response/>")
  musicbrainzngs.compat.build_opener = lambda *args: self.opener