/usr/share/doc/python-musicbrainz2-doc/html/musicbrainz2.webservice-pysrc.html is in python-musicbrainz2-doc 0.7.4-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 | <?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>musicbrainz2.webservice</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="musicbrainz2-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="musicbrainz2-module.html">Package musicbrainz2</a> ::
Module webservice
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="musicbrainz2.webservice-pysrc.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="musicbrainz2.webservice-module.html">Module musicbrainz2.webservice</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-docstring">"""Classes for interacting with the MusicBrainz XML web service.</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-docstring">The L{WebService} class talks to a server implementing the MusicBrainz XML</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-docstring">web service. It mainly handles URL generation and network I/O. Use this</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-docstring">if maximum control is needed.</tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-docstring">The L{Query} class provides a convenient interface to the most commonly</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-docstring">used features of the web service. By default it uses L{WebService} to</tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-docstring">retrieve data and the L{XML parser <musicbrainz2.wsxml>} to parse the</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-docstring">responses. The results are object trees using the L{MusicBrainz domain</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-docstring">model <musicbrainz2.model>}.</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-docstring">@author: Matthias Friedrich <matt@mafr.de></tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt id="link-0" class="py-name" targets="Variable musicbrainz2.__revision__=musicbrainz2-module.html#__revision__,Variable musicbrainz2.data.__revision__=musicbrainz2.data-module.html#__revision__,Variable musicbrainz2.data.countrynames.__revision__=musicbrainz2.data.countrynames-module.html#__revision__,Variable musicbrainz2.data.languagenames.__revision__=musicbrainz2.data.languagenames-module.html#__revision__,Variable musicbrainz2.data.releasetypenames.__revision__=musicbrainz2.data.releasetypenames-module.html#__revision__,Variable musicbrainz2.data.scriptnames.__revision__=musicbrainz2.data.scriptnames-module.html#__revision__,Variable musicbrainz2.disc.__revision__=musicbrainz2.disc-module.html#__revision__,Variable musicbrainz2.model.__revision__=musicbrainz2.model-module.html#__revision__,Variable musicbrainz2.utils.__revision__=musicbrainz2.utils-module.html#__revision__,Variable musicbrainz2.webservice.__revision__=musicbrainz2.webservice-module.html#__revision__,Variable musicbrainz2.wsxml.__revision__=musicbrainz2.wsxml-module.html#__revision__"><a title="musicbrainz2.__revision__
musicbrainz2.data.__revision__
musicbrainz2.data.countrynames.__revision__
musicbrainz2.data.languagenames.__revision__
musicbrainz2.data.releasetypenames.__revision__
musicbrainz2.data.scriptnames.__revision__
musicbrainz2.disc.__revision__
musicbrainz2.model.__revision__
musicbrainz2.utils.__revision__
musicbrainz2.webservice.__revision__
musicbrainz2.wsxml.__revision__" class="py-name" href="#" onclick="return doclink('link-0', '__revision__', 'link-0');">__revision__</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'$Id: webservice.py 13325 2011-11-03 13:39:40Z luks $'</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">urllib</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">urllib2</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">urlparse</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">logging</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-1" class="py-name" targets="Package musicbrainz2=musicbrainz2-module.html"><a title="musicbrainz2" class="py-name" href="#" onclick="return doclink('link-1', 'musicbrainz2', 'link-1');">musicbrainz2</a></tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-2" class="py-name"><a title="musicbrainz2" class="py-name" href="#" onclick="return doclink('link-2', 'musicbrainz2', 'link-1');">musicbrainz2</a></tt><tt class="py-op">.</tt><tt id="link-3" class="py-name" targets="Module musicbrainz2.model=musicbrainz2.model-module.html"><a title="musicbrainz2.model" class="py-name" href="#" onclick="return doclink('link-3', 'model', 'link-3');">model</a></tt> <tt class="py-keyword">import</tt> <tt id="link-4" class="py-name" targets="Class musicbrainz2.model.Release=musicbrainz2.model.Release-class.html"><a title="musicbrainz2.model.Release" class="py-name" href="#" onclick="return doclink('link-4', 'Release', 'link-4');">Release</a></tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-5" class="py-name"><a title="musicbrainz2" class="py-name" href="#" onclick="return doclink('link-5', 'musicbrainz2', 'link-1');">musicbrainz2</a></tt><tt class="py-op">.</tt><tt id="link-6" class="py-name" targets="Module musicbrainz2.wsxml=musicbrainz2.wsxml-module.html"><a title="musicbrainz2.wsxml" class="py-name" href="#" onclick="return doclink('link-6', 'wsxml', 'link-6');">wsxml</a></tt> <tt class="py-keyword">import</tt> <tt id="link-7" class="py-name" targets="Class musicbrainz2.wsxml.MbXmlParser=musicbrainz2.wsxml.MbXmlParser-class.html"><a title="musicbrainz2.wsxml.MbXmlParser" class="py-name" href="#" onclick="return doclink('link-7', 'MbXmlParser', 'link-7');">MbXmlParser</a></tt><tt class="py-op">,</tt> <tt id="link-8" class="py-name" targets="Class musicbrainz2.wsxml.ParseError=musicbrainz2.wsxml.ParseError-class.html"><a title="musicbrainz2.wsxml.ParseError" class="py-name" href="#" onclick="return doclink('link-8', 'ParseError', 'link-8');">ParseError</a></tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-9" class="py-name"><a title="musicbrainz2" class="py-name" href="#" onclick="return doclink('link-9', 'musicbrainz2', 'link-1');">musicbrainz2</a></tt><tt class="py-op">.</tt><tt id="link-10" class="py-name" targets="Module musicbrainz2.utils=musicbrainz2.utils-module.html"><a title="musicbrainz2.utils" class="py-name" href="#" onclick="return doclink('link-10', 'utils', 'link-10');">utils</a></tt> <tt class="py-keyword">as</tt> <tt class="py-name">mbutils</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-name">__all__</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"> <tt class="py-string">'WebServiceError'</tt><tt class="py-op">,</tt> <tt class="py-string">'AuthenticationError'</tt><tt class="py-op">,</tt> <tt class="py-string">'ConnectionError'</tt><tt class="py-op">,</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"> <tt class="py-string">'RequestError'</tt><tt class="py-op">,</tt> <tt class="py-string">'ResourceNotFoundError'</tt><tt class="py-op">,</tt> <tt class="py-string">'ResponseError'</tt><tt class="py-op">,</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"> <tt class="py-string">'IIncludes'</tt><tt class="py-op">,</tt> <tt class="py-string">'ArtistIncludes'</tt><tt class="py-op">,</tt> <tt class="py-string">'ReleaseIncludes'</tt><tt class="py-op">,</tt> <tt class="py-string">'TrackIncludes'</tt><tt class="py-op">,</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"> <tt class="py-string">'LabelIncludes'</tt><tt class="py-op">,</tt> <tt class="py-string">'ReleaseGroupIncludes'</tt><tt class="py-op">,</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"> <tt class="py-string">'IFilter'</tt><tt class="py-op">,</tt> <tt class="py-string">'ArtistFilter'</tt><tt class="py-op">,</tt> <tt class="py-string">'ReleaseFilter'</tt><tt class="py-op">,</tt> <tt class="py-string">'TrackFilter'</tt><tt class="py-op">,</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"> <tt class="py-string">'UserFilter'</tt><tt class="py-op">,</tt> <tt class="py-string">'LabelFilter'</tt><tt class="py-op">,</tt> <tt class="py-string">'ReleaseGroupFilter'</tt><tt class="py-op">,</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"> <tt class="py-string">'IWebService'</tt><tt class="py-op">,</tt> <tt class="py-string">'WebService'</tt><tt class="py-op">,</tt> <tt class="py-string">'Query'</tt><tt class="py-op">,</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-op">]</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"> </tt>
<a name="IWebService"></a><div id="IWebService-def"><a name="L37"></a><tt class="py-lineno"> 37</tt> <a class="py-toggle" href="#" id="IWebService-toggle" onclick="return toggle('IWebService');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.IWebService-class.html">IWebService</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IWebService-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="IWebService-expanded"><a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"> <tt class="py-docstring">"""An interface all concrete web service classes have to implement.</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-docstring"> All web service classes have to implement this and follow the</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-docstring"> method specifications.</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"> </tt>
<a name="IWebService.get"></a><div id="IWebService.get-def"><a name="L44"></a><tt class="py-lineno"> 44</tt> <a class="py-toggle" href="#" id="IWebService.get-toggle" onclick="return toggle('IWebService.get');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.IWebService-class.html#get">get</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">entity</tt><tt class="py-op">,</tt> <tt class="py-param">id_</tt><tt class="py-op">,</tt> <tt class="py-param">include</tt><tt class="py-op">,</tt> <tt class="py-param">filter</tt><tt class="py-op">,</tt> <tt class="py-param">version</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IWebService.get-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="IWebService.get-expanded"><a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"> <tt class="py-docstring">"""Query the web service.</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-docstring"> Using this method, you can either get a resource by id (using</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class="py-docstring"> the C{id_} parameter, or perform a query on all resources of</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-docstring"> a type.</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-docstring"> The C{filter} and the C{id_} parameter exclude each other. If</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-docstring"> you are using a filter, you may not set C{id_} and vice versa.</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"><tt class="py-docstring"> Returns a file-like object containing the result or raises a</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-docstring"> L{WebServiceError} or one of its subclasses in case of an</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"><tt class="py-docstring"> error. Which one is used depends on the implementing class.</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-docstring"> @param entity: a string containing the entity's name</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-docstring"> @param id_: a string containing a UUID, or the empty string</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-docstring"> @param include: a tuple containing values for the 'inc' parameter</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt class="py-docstring"> @param filter: parameters, depending on the entity</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-docstring"> @param version: a string containing the web service version to use</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-docstring"> @return: a file-like object</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-docstring"> @raise WebServiceError: in case of errors</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"> </tt>
<a name="IWebService.post"></a><div id="IWebService.post-def"><a name="L71"></a><tt class="py-lineno"> 71</tt> <a class="py-toggle" href="#" id="IWebService.post-toggle" onclick="return toggle('IWebService.post');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.IWebService-class.html#post">post</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">entity</tt><tt class="py-op">,</tt> <tt class="py-param">id_</tt><tt class="py-op">,</tt> <tt class="py-param">data</tt><tt class="py-op">,</tt> <tt class="py-param">version</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IWebService.post-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="IWebService.post-expanded"><a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"> <tt class="py-docstring">"""Submit data to the web service.</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"><tt class="py-docstring"> @param entity: a string containing the entity's name</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"><tt class="py-docstring"> @param id_: a string containing a UUID, or the empty string</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-docstring"> @param data: A string containing the data to post</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"> @param version: a string containing the web service version to use</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"><tt class="py-docstring"> @return: a file-like object</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"><tt class="py-docstring"> @raise WebServiceError: in case of errors</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> </tt>
<a name="WebServiceError"></a><div id="WebServiceError-def"><a name="L86"></a><tt class="py-lineno"> 86</tt> <a class="py-toggle" href="#" id="WebServiceError-toggle" onclick="return toggle('WebServiceError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.WebServiceError-class.html">WebServiceError</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="WebServiceError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="WebServiceError-expanded"><a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> <tt class="py-docstring">"""A web service error has occurred.</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt class="py-docstring"> This is the base class for several other web service related</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt class="py-docstring"> exceptions.</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> </tt>
<a name="WebServiceError.__init__"></a><div id="WebServiceError.__init__-def"><a name="L93"></a><tt class="py-lineno"> 93</tt> <a class="py-toggle" href="#" id="WebServiceError.__init__-toggle" onclick="return toggle('WebServiceError.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.WebServiceError-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">msg</tt><tt class="py-op">=</tt><tt class="py-string">'Webservice Error'</tt><tt class="py-op">,</tt> <tt class="py-param">reason</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="WebServiceError.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="WebServiceError.__init__-expanded"><a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-docstring"> Set C{msg} to an error message which explains why this</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-docstring"> exception was raised. The C{reason} parameter should be the</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt class="py-docstring"> original exception which caused this L{WebService} exception</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt class="py-docstring"> to be raised. If given, it has to be an instance of</tt> </tt>
<a name="L100"></a><tt class="py-lineno"> 100</tt> <tt class="py-line"><tt class="py-docstring"> C{Exception} or one of its child classes.</tt> </tt>
<a name="L101"></a><tt class="py-lineno"> 101</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L102"></a><tt class="py-lineno"> 102</tt> <tt class="py-line"><tt class="py-docstring"> @param msg: a string containing an error message</tt> </tt>
<a name="L103"></a><tt class="py-lineno"> 103</tt> <tt class="py-line"><tt class="py-docstring"> @param reason: another exception instance, or None</tt> </tt>
<a name="L104"></a><tt class="py-lineno"> 104</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L105"></a><tt class="py-lineno"> 105</tt> <tt class="py-line"> <tt class="py-name">Exception</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name" targets="Method musicbrainz2.model.AbstractAlias.__init__()=musicbrainz2.model.AbstractAlias-class.html#__init__,Method musicbrainz2.model.Artist.__init__()=musicbrainz2.model.Artist-class.html#__init__,Method musicbrainz2.model.Disc.__init__()=musicbrainz2.model.Disc-class.html#__init__,Method musicbrainz2.model.Entity.__init__()=musicbrainz2.model.Entity-class.html#__init__,Method musicbrainz2.model.Label.__init__()=musicbrainz2.model.Label-class.html#__init__,Method musicbrainz2.model.Rating.__init__()=musicbrainz2.model.Rating-class.html#__init__,Method musicbrainz2.model.Relation.__init__()=musicbrainz2.model.Relation-class.html#__init__,Method musicbrainz2.model.Release.__init__()=musicbrainz2.model.Release-class.html#__init__,Method musicbrainz2.model.ReleaseEvent.__init__()=musicbrainz2.model.ReleaseEvent-class.html#__init__,Method musicbrainz2.model.ReleaseGroup.__init__()=musicbrainz2.model.ReleaseGroup-class.html#__init__,Method musicbrainz2.model.Tag.__init__()=musicbrainz2.model.Tag-class.html#__init__,Method musicbrainz2.model.Track.__init__()=musicbrainz2.model.Track-class.html#__init__,Method musicbrainz2.model.User.__init__()=musicbrainz2.model.User-class.html#__init__,Method musicbrainz2.webservice.ArtistFilter.__init__()=musicbrainz2.webservice.ArtistFilter-class.html#__init__,Method musicbrainz2.webservice.ArtistIncludes.__init__()=musicbrainz2.webservice.ArtistIncludes-class.html#__init__,Method musicbrainz2.webservice.LabelFilter.__init__()=musicbrainz2.webservice.LabelFilter-class.html#__init__,Method musicbrainz2.webservice.LabelIncludes.__init__()=musicbrainz2.webservice.LabelIncludes-class.html#__init__,Method musicbrainz2.webservice.Query.__init__()=musicbrainz2.webservice.Query-class.html#__init__,Method musicbrainz2.webservice.ReleaseFilter.__init__()=musicbrainz2.webservice.ReleaseFilter-class.html#__init__,Method musicbrainz2.webservice.ReleaseGroupFilter.__init__()=musicbrainz2.webservice.ReleaseGroupFilter-class.html#__init__,Method musicbrainz2.webservice.ReleaseGroupIncludes.__init__()=musicbrainz2.webservice.ReleaseGroupIncludes-class.html#__init__,Method musicbrainz2.webservice.ReleaseIncludes.__init__()=musicbrainz2.webservice.ReleaseIncludes-class.html#__init__,Method musicbrainz2.webservice.TrackFilter.__init__()=musicbrainz2.webservice.TrackFilter-class.html#__init__,Method musicbrainz2.webservice.TrackIncludes.__init__()=musicbrainz2.webservice.TrackIncludes-class.html#__init__,Method musicbrainz2.webservice.UserFilter.__init__()=musicbrainz2.webservice.UserFilter-class.html#__init__,Method musicbrainz2.webservice.WebService.__init__()=musicbrainz2.webservice.WebService-class.html#__init__,Method musicbrainz2.webservice.WebServiceError.__init__()=musicbrainz2.webservice.WebServiceError-class.html#__init__,Method musicbrainz2.wsxml.AbstractResult.__init__()=musicbrainz2.wsxml.AbstractResult-class.html#__init__,Method musicbrainz2.wsxml.ArtistResult.__init__()=musicbrainz2.wsxml.ArtistResult-class.html#__init__,Method musicbrainz2.wsxml.LabelResult.__init__()=musicbrainz2.wsxml.LabelResult-class.html#__init__,Method musicbrainz2.wsxml.MbXmlParser.__init__()=musicbrainz2.wsxml.MbXmlParser-class.html#__init__,Method musicbrainz2.wsxml.MbXmlWriter.__init__()=musicbrainz2.wsxml.MbXmlWriter-class.html#__init__,Method musicbrainz2.wsxml.Metadata.__init__()=musicbrainz2.wsxml.Metadata-class.html#__init__,Method musicbrainz2.wsxml.ParseError.__init__()=musicbrainz2.wsxml.ParseError-class.html#__init__,Method musicbrainz2.wsxml.ReleaseGroupResult.__init__()=musicbrainz2.wsxml.ReleaseGroupResult-class.html#__init__,Method musicbrainz2.wsxml.ReleaseResult.__init__()=musicbrainz2.wsxml.ReleaseResult-class.html#__init__,Method musicbrainz2.wsxml.TrackResult.__init__()=musicbrainz2.wsxml.TrackResult-class.html#__init__"><a title="musicbrainz2.model.AbstractAlias.__init__
musicbrainz2.model.Artist.__init__
musicbrainz2.model.Disc.__init__
musicbrainz2.model.Entity.__init__
musicbrainz2.model.Label.__init__
musicbrainz2.model.Rating.__init__
musicbrainz2.model.Relation.__init__
musicbrainz2.model.Release.__init__
musicbrainz2.model.ReleaseEvent.__init__
musicbrainz2.model.ReleaseGroup.__init__
musicbrainz2.model.Tag.__init__
musicbrainz2.model.Track.__init__
musicbrainz2.model.User.__init__
musicbrainz2.webservice.ArtistFilter.__init__
musicbrainz2.webservice.ArtistIncludes.__init__
musicbrainz2.webservice.LabelFilter.__init__
musicbrainz2.webservice.LabelIncludes.__init__
musicbrainz2.webservice.Query.__init__
musicbrainz2.webservice.ReleaseFilter.__init__
musicbrainz2.webservice.ReleaseGroupFilter.__init__
musicbrainz2.webservice.ReleaseGroupIncludes.__init__
musicbrainz2.webservice.ReleaseIncludes.__init__
musicbrainz2.webservice.TrackFilter.__init__
musicbrainz2.webservice.TrackIncludes.__init__
musicbrainz2.webservice.UserFilter.__init__
musicbrainz2.webservice.WebService.__init__
musicbrainz2.webservice.WebServiceError.__init__
musicbrainz2.wsxml.AbstractResult.__init__
musicbrainz2.wsxml.ArtistResult.__init__
musicbrainz2.wsxml.LabelResult.__init__
musicbrainz2.wsxml.MbXmlParser.__init__
musicbrainz2.wsxml.MbXmlWriter.__init__
musicbrainz2.wsxml.Metadata.__init__
musicbrainz2.wsxml.ParseError.__init__
musicbrainz2.wsxml.ReleaseGroupResult.__init__
musicbrainz2.wsxml.ReleaseResult.__init__
musicbrainz2.wsxml.TrackResult.__init__" class="py-name" href="#" onclick="return doclink('link-11', '__init__', 'link-11');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
<a name="L106"></a><tt class="py-lineno"> 106</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">msg</tt> <tt class="py-op">=</tt> <tt class="py-name">msg</tt> </tt>
<a name="L107"></a><tt class="py-lineno"> 107</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">reason</tt> <tt class="py-op">=</tt> <tt class="py-name">reason</tt> </tt>
</div><a name="L108"></a><tt class="py-lineno"> 108</tt> <tt class="py-line"> </tt>
<a name="WebServiceError.__str__"></a><div id="WebServiceError.__str__-def"><a name="L109"></a><tt class="py-lineno"> 109</tt> <a class="py-toggle" href="#" id="WebServiceError.__str__-toggle" onclick="return toggle('WebServiceError.__str__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.WebServiceError-class.html#__str__">__str__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="WebServiceError.__str__-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="WebServiceError.__str__-expanded"><a name="L110"></a><tt class="py-lineno"> 110</tt> <tt class="py-line"> <tt class="py-docstring">"""Makes this class printable.</tt> </tt>
<a name="L111"></a><tt class="py-lineno"> 111</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L112"></a><tt class="py-lineno"> 112</tt> <tt class="py-line"><tt class="py-docstring"> @return: a string containing an error message</tt> </tt>
<a name="L113"></a><tt class="py-lineno"> 113</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L114"></a><tt class="py-lineno"> 114</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">msg</tt> </tt>
</div></div><a name="L115"></a><tt class="py-lineno"> 115</tt> <tt class="py-line"> </tt>
<a name="L116"></a><tt class="py-lineno"> 116</tt> <tt class="py-line"> </tt>
<a name="ConnectionError"></a><div id="ConnectionError-def"><a name="L117"></a><tt class="py-lineno"> 117</tt> <a class="py-toggle" href="#" id="ConnectionError-toggle" onclick="return toggle('ConnectionError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.ConnectionError-class.html">ConnectionError</a><tt class="py-op">(</tt><tt class="py-base-class">WebServiceError</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ConnectionError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ConnectionError-expanded"><a name="L118"></a><tt class="py-lineno"> 118</tt> <tt class="py-line"> <tt class="py-docstring">"""Getting a server connection failed.</tt> </tt>
<a name="L119"></a><tt class="py-lineno"> 119</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L120"></a><tt class="py-lineno"> 120</tt> <tt class="py-line"><tt class="py-docstring"> This exception is mostly used if the client couldn't connect to</tt> </tt>
<a name="L121"></a><tt class="py-lineno"> 121</tt> <tt class="py-line"><tt class="py-docstring"> the server because of an invalid host name or port. It doesn't</tt> </tt>
<a name="L122"></a><tt class="py-lineno"> 122</tt> <tt class="py-line"><tt class="py-docstring"> make sense if the web service in question doesn't use the network.</tt> </tt>
<a name="L123"></a><tt class="py-lineno"> 123</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L124"></a><tt class="py-lineno"> 124</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
</div><a name="L125"></a><tt class="py-lineno"> 125</tt> <tt class="py-line"> </tt>
<a name="L126"></a><tt class="py-lineno"> 126</tt> <tt class="py-line"> </tt>
<a name="RequestError"></a><div id="RequestError-def"><a name="L127"></a><tt class="py-lineno"> 127</tt> <a class="py-toggle" href="#" id="RequestError-toggle" onclick="return toggle('RequestError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.RequestError-class.html">RequestError</a><tt class="py-op">(</tt><tt class="py-base-class">WebServiceError</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RequestError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="RequestError-expanded"><a name="L128"></a><tt class="py-lineno"> 128</tt> <tt class="py-line"> <tt class="py-docstring">"""An invalid request was made.</tt> </tt>
<a name="L129"></a><tt class="py-lineno"> 129</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L130"></a><tt class="py-lineno"> 130</tt> <tt class="py-line"><tt class="py-docstring"> This exception is raised if the client made an invalid request.</tt> </tt>
<a name="L131"></a><tt class="py-lineno"> 131</tt> <tt class="py-line"><tt class="py-docstring"> That could be syntactically invalid identifiers or unknown or</tt> </tt>
<a name="L132"></a><tt class="py-lineno"> 132</tt> <tt class="py-line"><tt class="py-docstring"> invalid parameter values.</tt> </tt>
<a name="L133"></a><tt class="py-lineno"> 133</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L134"></a><tt class="py-lineno"> 134</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
</div><a name="L135"></a><tt class="py-lineno"> 135</tt> <tt class="py-line"> </tt>
<a name="L136"></a><tt class="py-lineno"> 136</tt> <tt class="py-line"> </tt>
<a name="ResourceNotFoundError"></a><div id="ResourceNotFoundError-def"><a name="L137"></a><tt class="py-lineno"> 137</tt> <a class="py-toggle" href="#" id="ResourceNotFoundError-toggle" onclick="return toggle('ResourceNotFoundError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.ResourceNotFoundError-class.html">ResourceNotFoundError</a><tt class="py-op">(</tt><tt class="py-base-class">WebServiceError</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ResourceNotFoundError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ResourceNotFoundError-expanded"><a name="L138"></a><tt class="py-lineno"> 138</tt> <tt class="py-line"> <tt class="py-docstring">"""No resource with the given ID exists.</tt> </tt>
<a name="L139"></a><tt class="py-lineno"> 139</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L140"></a><tt class="py-lineno"> 140</tt> <tt class="py-line"><tt class="py-docstring"> This is usually a wrapper around IOError (which is superclass of</tt> </tt>
<a name="L141"></a><tt class="py-lineno"> 141</tt> <tt class="py-line"><tt class="py-docstring"> HTTPError).</tt> </tt>
<a name="L142"></a><tt class="py-lineno"> 142</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L143"></a><tt class="py-lineno"> 143</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
</div><a name="L144"></a><tt class="py-lineno"> 144</tt> <tt class="py-line"> </tt>
<a name="L145"></a><tt class="py-lineno"> 145</tt> <tt class="py-line"> </tt>
<a name="AuthenticationError"></a><div id="AuthenticationError-def"><a name="L146"></a><tt class="py-lineno"> 146</tt> <a class="py-toggle" href="#" id="AuthenticationError-toggle" onclick="return toggle('AuthenticationError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.AuthenticationError-class.html">AuthenticationError</a><tt class="py-op">(</tt><tt class="py-base-class">WebServiceError</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="AuthenticationError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="AuthenticationError-expanded"><a name="L147"></a><tt class="py-lineno"> 147</tt> <tt class="py-line"> <tt class="py-docstring">"""Authentication failed.</tt> </tt>
<a name="L148"></a><tt class="py-lineno"> 148</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L149"></a><tt class="py-lineno"> 149</tt> <tt class="py-line"><tt class="py-docstring"> This is thrown if user name, password or realm were invalid while</tt> </tt>
<a name="L150"></a><tt class="py-lineno"> 150</tt> <tt class="py-line"><tt class="py-docstring"> trying to access a protected resource.</tt> </tt>
<a name="L151"></a><tt class="py-lineno"> 151</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L152"></a><tt class="py-lineno"> 152</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
</div><a name="L153"></a><tt class="py-lineno"> 153</tt> <tt class="py-line"> </tt>
<a name="L154"></a><tt class="py-lineno"> 154</tt> <tt class="py-line"> </tt>
<a name="ResponseError"></a><div id="ResponseError-def"><a name="L155"></a><tt class="py-lineno"> 155</tt> <a class="py-toggle" href="#" id="ResponseError-toggle" onclick="return toggle('ResponseError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.ResponseError-class.html">ResponseError</a><tt class="py-op">(</tt><tt class="py-base-class">WebServiceError</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ResponseError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ResponseError-expanded"><a name="L156"></a><tt class="py-lineno"> 156</tt> <tt class="py-line"> <tt class="py-docstring">"""The returned resource was invalid.</tt> </tt>
<a name="L157"></a><tt class="py-lineno"> 157</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L158"></a><tt class="py-lineno"> 158</tt> <tt class="py-line"><tt class="py-docstring"> This may be due to a malformed XML document or if the requested</tt> </tt>
<a name="L159"></a><tt class="py-lineno"> 159</tt> <tt class="py-line"><tt class="py-docstring"> data wasn't part of the response. It can only occur in case of</tt> </tt>
<a name="L160"></a><tt class="py-lineno"> 160</tt> <tt class="py-line"><tt class="py-docstring"> bugs in the web service itself.</tt> </tt>
<a name="L161"></a><tt class="py-lineno"> 161</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L162"></a><tt class="py-lineno"> 162</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
</div><a name="L163"></a><tt class="py-lineno"> 163</tt> <tt class="py-line"> </tt>
<a name="DigestAuthHandler"></a><div id="DigestAuthHandler-def"><a name="L164"></a><tt class="py-lineno"> 164</tt> <a class="py-toggle" href="#" id="DigestAuthHandler-toggle" onclick="return toggle('DigestAuthHandler');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.DigestAuthHandler-class.html">DigestAuthHandler</a><tt class="py-op">(</tt><tt class="py-base-class">urllib2</tt><tt class="py-op">.</tt><tt class="py-base-class">HTTPDigestAuthHandler</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DigestAuthHandler-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="DigestAuthHandler-expanded"><a name="L165"></a><tt class="py-lineno"> 165</tt> <tt class="py-line"> <tt class="py-docstring">"""Patched DigestAuthHandler to correctly handle Digest Auth according to RFC 2617.</tt> </tt>
<a name="L166"></a><tt class="py-lineno"> 166</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L167"></a><tt class="py-lineno"> 167</tt> <tt class="py-line"><tt class="py-docstring"> This will allow multiple qop values in the WWW-Authenticate header (e.g. "auth,auth-int").</tt> </tt>
<a name="L168"></a><tt class="py-lineno"> 168</tt> <tt class="py-line"><tt class="py-docstring"> The only supported qop value is still auth, though.</tt> </tt>
<a name="L169"></a><tt class="py-lineno"> 169</tt> <tt class="py-line"><tt class="py-docstring"> See http://bugs.python.org/issue9714</tt> </tt>
<a name="L170"></a><tt class="py-lineno"> 170</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L171"></a><tt class="py-lineno"> 171</tt> <tt class="py-line"><tt class="py-docstring"> @author: Kuno Woudt</tt> </tt>
<a name="L172"></a><tt class="py-lineno"> 172</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="DigestAuthHandler.get_authorization"></a><div id="DigestAuthHandler.get_authorization-def"><a name="L173"></a><tt class="py-lineno"> 173</tt> <a class="py-toggle" href="#" id="DigestAuthHandler.get_authorization-toggle" onclick="return toggle('DigestAuthHandler.get_authorization');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.DigestAuthHandler-class.html#get_authorization">get_authorization</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">req</tt><tt class="py-op">,</tt> <tt class="py-param">chal</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DigestAuthHandler.get_authorization-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="DigestAuthHandler.get_authorization-expanded"><a name="L174"></a><tt class="py-lineno"> 174</tt> <tt class="py-line"> <tt class="py-name">qop</tt> <tt class="py-op">=</tt> <tt class="py-name">chal</tt><tt class="py-op">.</tt><tt id="link-12" class="py-name" targets="Method musicbrainz2.webservice.IWebService.get()=musicbrainz2.webservice.IWebService-class.html#get,Method musicbrainz2.webservice.WebService.get()=musicbrainz2.webservice.WebService-class.html#get"><a title="musicbrainz2.webservice.IWebService.get
musicbrainz2.webservice.WebService.get" class="py-name" href="#" onclick="return doclink('link-12', 'get', 'link-12');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'qop'</tt><tt class="py-op">)</tt> </tt>
<a name="L175"></a><tt class="py-lineno"> 175</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">qop</tt> <tt class="py-keyword">and</tt> <tt class="py-string">','</tt> <tt class="py-keyword">in</tt> <tt class="py-name">qop</tt> <tt class="py-keyword">and</tt> <tt class="py-string">'auth'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">qop</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">','</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L176"></a><tt class="py-lineno"> 176</tt> <tt class="py-line"> <tt class="py-name">chal</tt><tt class="py-op">[</tt><tt class="py-string">'qop'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-string">'auth'</tt> </tt>
<a name="L177"></a><tt class="py-lineno"> 177</tt> <tt class="py-line"> </tt>
<a name="L178"></a><tt class="py-lineno"> 178</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">HTTPDigestAuthHandler</tt><tt class="py-op">.</tt><tt class="py-name">get_authorization</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">req</tt><tt class="py-op">,</tt> <tt class="py-name">chal</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L179"></a><tt class="py-lineno"> 179</tt> <tt class="py-line"> </tt>
<a name="WebService"></a><div id="WebService-def"><a name="L180"></a><tt class="py-lineno"> 180</tt> <a class="py-toggle" href="#" id="WebService-toggle" onclick="return toggle('WebService');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.WebService-class.html">WebService</a><tt class="py-op">(</tt><tt class="py-base-class">IWebService</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="WebService-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="WebService-expanded"><a name="L181"></a><tt class="py-lineno"> 181</tt> <tt class="py-line"> <tt class="py-docstring">"""An interface to the MusicBrainz XML web service via HTTP.</tt> </tt>
<a name="L182"></a><tt class="py-lineno"> 182</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L183"></a><tt class="py-lineno"> 183</tt> <tt class="py-line"><tt class="py-docstring"> By default, this class uses the MusicBrainz server but may be</tt> </tt>
<a name="L184"></a><tt class="py-lineno"> 184</tt> <tt class="py-line"><tt class="py-docstring"> configured for accessing other servers as well using the</tt> </tt>
<a name="L185"></a><tt class="py-lineno"> 185</tt> <tt class="py-line"><tt class="py-docstring"> L{constructor <__init__>}. This implements L{IWebService}, so</tt> </tt>
<a name="L186"></a><tt class="py-lineno"> 186</tt> <tt class="py-line"><tt class="py-docstring"> additional documentation on method parameters can be found there.</tt> </tt>
<a name="L187"></a><tt class="py-lineno"> 187</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L188"></a><tt class="py-lineno"> 188</tt> <tt class="py-line"> </tt>
<a name="WebService.__init__"></a><div id="WebService.__init__-def"><a name="L189"></a><tt class="py-lineno"> 189</tt> <a class="py-toggle" href="#" id="WebService.__init__-toggle" onclick="return toggle('WebService.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.WebService-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">host</tt><tt class="py-op">=</tt><tt class="py-string">'musicbrainz.org'</tt><tt class="py-op">,</tt> <tt class="py-param">port</tt><tt class="py-op">=</tt><tt class="py-number">80</tt><tt class="py-op">,</tt> <tt class="py-param">pathPrefix</tt><tt class="py-op">=</tt><tt class="py-string">'/ws'</tt><tt class="py-op">,</tt> </tt>
<a name="L190"></a><tt class="py-lineno"> 190</tt> <tt class="py-line"> <tt class="py-param">username</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">password</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">realm</tt><tt class="py-op">=</tt><tt class="py-string">'musicbrainz.org'</tt><tt class="py-op">,</tt> </tt>
<a name="L191"></a><tt class="py-lineno"> 191</tt> <tt class="py-line"> <tt class="py-param">opener</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">userAgent</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="WebService.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="WebService.__init__-expanded"><a name="L192"></a><tt class="py-lineno"> 192</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt>
<a name="L193"></a><tt class="py-lineno"> 193</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L194"></a><tt class="py-lineno"> 194</tt> <tt class="py-line"><tt class="py-docstring"> This can be used without parameters. In this case, the</tt> </tt>
<a name="L195"></a><tt class="py-lineno"> 195</tt> <tt class="py-line"><tt class="py-docstring"> MusicBrainz server will be used.</tt> </tt>
<a name="L196"></a><tt class="py-lineno"> 196</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L197"></a><tt class="py-lineno"> 197</tt> <tt class="py-line"><tt class="py-docstring"> @param host: a string containing a host name</tt> </tt>
<a name="L198"></a><tt class="py-lineno"> 198</tt> <tt class="py-line"><tt class="py-docstring"> @param port: an integer containing a port number</tt> </tt>
<a name="L199"></a><tt class="py-lineno"> 199</tt> <tt class="py-line"><tt class="py-docstring"> @param pathPrefix: a string prepended to all URLs</tt> </tt>
<a name="L200"></a><tt class="py-lineno"> 200</tt> <tt class="py-line"><tt class="py-docstring"> @param username: a string containing a MusicBrainz user name</tt> </tt>
<a name="L201"></a><tt class="py-lineno"> 201</tt> <tt class="py-line"><tt class="py-docstring"> @param password: a string containing the user's password</tt> </tt>
<a name="L202"></a><tt class="py-lineno"> 202</tt> <tt class="py-line"><tt class="py-docstring"> @param realm: a string containing the realm used for authentication</tt> </tt>
<a name="L203"></a><tt class="py-lineno"> 203</tt> <tt class="py-line"><tt class="py-docstring"> @param opener: an C{urllib2.OpenerDirector} object used for queries</tt> </tt>
<a name="L204"></a><tt class="py-lineno"> 204</tt> <tt class="py-line"><tt class="py-docstring"> @param userAgent: a string containing the user agent</tt> </tt>
<a name="L205"></a><tt class="py-lineno"> 205</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L206"></a><tt class="py-lineno"> 206</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_host</tt> <tt class="py-op">=</tt> <tt class="py-name">host</tt> </tt>
<a name="L207"></a><tt class="py-lineno"> 207</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_port</tt> <tt class="py-op">=</tt> <tt class="py-name">port</tt> </tt>
<a name="L208"></a><tt class="py-lineno"> 208</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_username</tt> <tt class="py-op">=</tt> <tt class="py-name">username</tt> </tt>
<a name="L209"></a><tt class="py-lineno"> 209</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_password</tt> <tt class="py-op">=</tt> <tt class="py-name">password</tt> </tt>
<a name="L210"></a><tt class="py-lineno"> 210</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_realm</tt> <tt class="py-op">=</tt> <tt class="py-name">realm</tt> </tt>
<a name="L211"></a><tt class="py-lineno"> 211</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_pathPrefix</tt> <tt class="py-op">=</tt> <tt class="py-name">pathPrefix</tt> </tt>
<a name="L212"></a><tt class="py-lineno"> 212</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_log</tt> <tt class="py-op">=</tt> <tt class="py-name">logging</tt><tt class="py-op">.</tt><tt class="py-name">getLogger</tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L213"></a><tt class="py-lineno"> 213</tt> <tt class="py-line"> </tt>
<a name="L214"></a><tt class="py-lineno"> 214</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">opener</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L215"></a><tt class="py-lineno"> 215</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_opener</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">build_opener</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L216"></a><tt class="py-lineno"> 216</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L217"></a><tt class="py-lineno"> 217</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_opener</tt> <tt class="py-op">=</tt> <tt class="py-name">opener</tt> </tt>
<a name="L218"></a><tt class="py-lineno"> 218</tt> <tt class="py-line"> </tt>
<a name="L219"></a><tt class="py-lineno"> 219</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">userAgent</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L220"></a><tt class="py-lineno"> 220</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_userAgent</tt> <tt class="py-op">=</tt> <tt class="py-string">"python-musicbrainz/"</tt> <tt class="py-op">+</tt> <tt id="link-13" class="py-name"><a title="musicbrainz2" class="py-name" href="#" onclick="return doclink('link-13', 'musicbrainz2', 'link-1');">musicbrainz2</a></tt><tt class="py-op">.</tt><tt class="py-name">__version__</tt> </tt>
<a name="L221"></a><tt class="py-lineno"> 221</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L222"></a><tt class="py-lineno"> 222</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_userAgent</tt> <tt class="py-op">=</tt> <tt class="py-name">userAgent</tt><tt class="py-op">.</tt><tt class="py-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">"-"</tt><tt class="py-op">,</tt> <tt class="py-string">"/"</tt><tt class="py-op">)</tt> \ </tt>
<a name="L223"></a><tt class="py-lineno"> 223</tt> <tt class="py-line"> <tt class="py-op">+</tt> <tt class="py-string">" python-musicbrainz/"</tt> \ </tt>
<a name="L224"></a><tt class="py-lineno"> 224</tt> <tt class="py-line"> <tt class="py-op">+</tt> <tt id="link-14" class="py-name"><a title="musicbrainz2" class="py-name" href="#" onclick="return doclink('link-14', 'musicbrainz2', 'link-1');">musicbrainz2</a></tt><tt class="py-op">.</tt><tt class="py-name">__version__</tt> </tt>
<a name="L225"></a><tt class="py-lineno"> 225</tt> <tt class="py-line"> </tt>
<a name="L226"></a><tt class="py-lineno"> 226</tt> <tt class="py-line"> <tt class="py-name">passwordMgr</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_RedirectPasswordMgr</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L227"></a><tt class="py-lineno"> 227</tt> <tt class="py-line"> <tt class="py-name">authHandler</tt> <tt class="py-op">=</tt> <tt class="py-name">DigestAuthHandler</tt><tt class="py-op">(</tt><tt class="py-name">passwordMgr</tt><tt class="py-op">)</tt> </tt>
<a name="L228"></a><tt class="py-lineno"> 228</tt> <tt class="py-line"> <tt class="py-name">authHandler</tt><tt class="py-op">.</tt><tt class="py-name">add_password</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_realm</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-comment"># no host set</tt> </tt>
<a name="L229"></a><tt class="py-lineno"> 229</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_username</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_password</tt><tt class="py-op">)</tt> </tt>
<a name="L230"></a><tt class="py-lineno"> 230</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_opener</tt><tt class="py-op">.</tt><tt class="py-name">add_handler</tt><tt class="py-op">(</tt><tt class="py-name">authHandler</tt><tt class="py-op">)</tt> </tt>
</div><a name="L231"></a><tt class="py-lineno"> 231</tt> <tt class="py-line"> </tt>
<a name="L232"></a><tt class="py-lineno"> 232</tt> <tt class="py-line"> </tt>
<a name="WebService._makeUrl"></a><div id="WebService._makeUrl-def"><a name="L233"></a><tt class="py-lineno"> 233</tt> <a class="py-toggle" href="#" id="WebService._makeUrl-toggle" onclick="return toggle('WebService._makeUrl');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.WebService-class.html#_makeUrl">_makeUrl</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">entity</tt><tt class="py-op">,</tt> <tt class="py-param">id_</tt><tt class="py-op">,</tt> <tt class="py-param">include</tt><tt class="py-op">=</tt><tt class="py-op">(</tt> <tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-param">filter</tt><tt class="py-op">=</tt><tt class="py-op">{</tt> <tt class="py-op">}</tt><tt class="py-op">,</tt> </tt>
<a name="L234"></a><tt class="py-lineno"> 234</tt> <tt class="py-line"> <tt class="py-param">version</tt><tt class="py-op">=</tt><tt class="py-string">'1'</tt><tt class="py-op">,</tt> <tt class="py-param">type_</tt><tt class="py-op">=</tt><tt class="py-string">'xml'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="WebService._makeUrl-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="WebService._makeUrl-expanded"><a name="L235"></a><tt class="py-lineno"> 235</tt> <tt class="py-line"> <tt class="py-name">params</tt> <tt class="py-op">=</tt> <tt class="py-name">dict</tt><tt class="py-op">(</tt><tt class="py-name">filter</tt><tt class="py-op">)</tt> </tt>
<a name="L236"></a><tt class="py-lineno"> 236</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">type_</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L237"></a><tt class="py-lineno"> 237</tt> <tt class="py-line"> <tt class="py-name">params</tt><tt class="py-op">[</tt><tt class="py-string">'type'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">type_</tt> </tt>
<a name="L238"></a><tt class="py-lineno"> 238</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">include</tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L239"></a><tt class="py-lineno"> 239</tt> <tt class="py-line"> <tt class="py-name">params</tt><tt class="py-op">[</tt><tt class="py-string">'inc'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-string">' '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">include</tt><tt class="py-op">)</tt> </tt>
<a name="L240"></a><tt class="py-lineno"> 240</tt> <tt class="py-line"> </tt>
<a name="L241"></a><tt class="py-lineno"> 241</tt> <tt class="py-line"> <tt class="py-name">netloc</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_host</tt> </tt>
<a name="L242"></a><tt class="py-lineno"> 242</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_port</tt> <tt class="py-op">!=</tt> <tt class="py-number">80</tt><tt class="py-op">:</tt> </tt>
<a name="L243"></a><tt class="py-lineno"> 243</tt> <tt class="py-line"> <tt class="py-name">netloc</tt> <tt class="py-op">+=</tt> <tt class="py-string">':'</tt> <tt class="py-op">+</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_port</tt><tt class="py-op">)</tt> </tt>
<a name="L244"></a><tt class="py-lineno"> 244</tt> <tt class="py-line"> <tt class="py-name">path</tt> <tt class="py-op">=</tt> <tt class="py-string">'/'</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_pathPrefix</tt><tt class="py-op">,</tt> <tt class="py-name">version</tt><tt class="py-op">,</tt> <tt class="py-name">entity</tt><tt class="py-op">,</tt> <tt class="py-name">id_</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L245"></a><tt class="py-lineno"> 245</tt> <tt class="py-line"> </tt>
<a name="L246"></a><tt class="py-lineno"> 246</tt> <tt class="py-line"> <tt class="py-name">query</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">urlencode</tt><tt class="py-op">(</tt><tt class="py-name">params</tt><tt class="py-op">)</tt> </tt>
<a name="L247"></a><tt class="py-lineno"> 247</tt> <tt class="py-line"> </tt>
<a name="L248"></a><tt class="py-lineno"> 248</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt class="py-name">urlparse</tt><tt class="py-op">.</tt><tt class="py-name">urlunparse</tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-string">'http'</tt><tt class="py-op">,</tt> <tt class="py-name">netloc</tt><tt class="py-op">,</tt> <tt class="py-name">path</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">query</tt><tt class="py-op">,</tt><tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L249"></a><tt class="py-lineno"> 249</tt> <tt class="py-line"> </tt>
<a name="L250"></a><tt class="py-lineno"> 250</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">url</tt> </tt>
</div><a name="L251"></a><tt class="py-lineno"> 251</tt> <tt class="py-line"> </tt>
<a name="L252"></a><tt class="py-lineno"> 252</tt> <tt class="py-line"> </tt>
<a name="WebService._openUrl"></a><div id="WebService._openUrl-def"><a name="L253"></a><tt class="py-lineno"> 253</tt> <a class="py-toggle" href="#" id="WebService._openUrl-toggle" onclick="return toggle('WebService._openUrl');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.WebService-class.html#_openUrl">_openUrl</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">url</tt><tt class="py-op">,</tt> <tt class="py-param">data</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="WebService._openUrl-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="WebService._openUrl-expanded"><a name="L254"></a><tt class="py-lineno"> 254</tt> <tt class="py-line"> <tt class="py-name">req</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">)</tt> </tt>
<a name="L255"></a><tt class="py-lineno"> 255</tt> <tt class="py-line"> <tt class="py-name">req</tt><tt class="py-op">.</tt><tt class="py-name">add_header</tt><tt class="py-op">(</tt><tt class="py-string">'User-Agent'</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_userAgent</tt><tt class="py-op">)</tt> </tt>
<a name="L256"></a><tt class="py-lineno"> 256</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_opener</tt><tt class="py-op">.</tt><tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">req</tt><tt class="py-op">,</tt> <tt id="link-15" class="py-name" targets="Package musicbrainz2.data=musicbrainz2.data-module.html"><a title="musicbrainz2.data" class="py-name" href="#" onclick="return doclink('link-15', 'data', 'link-15');">data</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L257"></a><tt class="py-lineno"> 257</tt> <tt class="py-line"> </tt>
<a name="L258"></a><tt class="py-lineno"> 258</tt> <tt class="py-line"> </tt>
<a name="WebService.get"></a><div id="WebService.get-def"><a name="L259"></a><tt class="py-lineno"> 259</tt> <a class="py-toggle" href="#" id="WebService.get-toggle" onclick="return toggle('WebService.get');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.WebService-class.html#get">get</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">entity</tt><tt class="py-op">,</tt> <tt class="py-param">id_</tt><tt class="py-op">,</tt> <tt class="py-param">include</tt><tt class="py-op">=</tt><tt class="py-op">(</tt> <tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-param">filter</tt><tt class="py-op">=</tt><tt class="py-op">{</tt> <tt class="py-op">}</tt><tt class="py-op">,</tt> <tt class="py-param">version</tt><tt class="py-op">=</tt><tt class="py-string">'1'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="WebService.get-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="WebService.get-expanded"><a name="L260"></a><tt class="py-lineno"> 260</tt> <tt class="py-line"> <tt class="py-docstring">"""Query the web service via HTTP-GET.</tt> </tt>
<a name="L261"></a><tt class="py-lineno"> 261</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L262"></a><tt class="py-lineno"> 262</tt> <tt class="py-line"><tt class="py-docstring"> Returns a file-like object containing the result or raises a</tt> </tt>
<a name="L263"></a><tt class="py-lineno"> 263</tt> <tt class="py-line"><tt class="py-docstring"> L{WebServiceError}. Conditions leading to errors may be</tt> </tt>
<a name="L264"></a><tt class="py-lineno"> 264</tt> <tt class="py-line"><tt class="py-docstring"> invalid entities, IDs, C{include} or C{filter} parameters</tt> </tt>
<a name="L265"></a><tt class="py-lineno"> 265</tt> <tt class="py-line"><tt class="py-docstring"> and unsupported version numbers.</tt> </tt>
<a name="L266"></a><tt class="py-lineno"> 266</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L267"></a><tt class="py-lineno"> 267</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L268"></a><tt class="py-lineno"> 268</tt> <tt class="py-line"><tt class="py-docstring"> @raise RequestError: invalid IDs or parameters</tt> </tt>
<a name="L269"></a><tt class="py-lineno"> 269</tt> <tt class="py-line"><tt class="py-docstring"> @raise AuthenticationError: invalid user name and/or password</tt> </tt>
<a name="L270"></a><tt class="py-lineno"> 270</tt> <tt class="py-line"><tt class="py-docstring"> @raise ResourceNotFoundError: resource doesn't exist</tt> </tt>
<a name="L271"></a><tt class="py-lineno"> 271</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L272"></a><tt class="py-lineno"> 272</tt> <tt class="py-line"><tt class="py-docstring"> @see: L{IWebService.get}</tt> </tt>
<a name="L273"></a><tt class="py-lineno"> 273</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L274"></a><tt class="py-lineno"> 274</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_makeUrl</tt><tt class="py-op">(</tt><tt class="py-name">entity</tt><tt class="py-op">,</tt> <tt class="py-name">id_</tt><tt class="py-op">,</tt> <tt class="py-name">include</tt><tt class="py-op">,</tt> <tt class="py-name">filter</tt><tt class="py-op">,</tt> <tt class="py-name">version</tt><tt class="py-op">)</tt> </tt>
<a name="L275"></a><tt class="py-lineno"> 275</tt> <tt class="py-line"> </tt>
<a name="L276"></a><tt class="py-lineno"> 276</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_log</tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">'GET '</tt> <tt class="py-op">+</tt> <tt class="py-name">url</tt><tt class="py-op">)</tt> </tt>
<a name="L277"></a><tt class="py-lineno"> 277</tt> <tt class="py-line"> </tt>
<a name="L278"></a><tt class="py-lineno"> 278</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L279"></a><tt class="py-lineno"> 279</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_openUrl</tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">)</tt> </tt>
<a name="L280"></a><tt class="py-lineno"> 280</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">HTTPError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L281"></a><tt class="py-lineno"> 281</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_log</tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">"GET failed: "</tt> <tt class="py-op">+</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L282"></a><tt class="py-lineno"> 282</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name" targets="Variable musicbrainz2.model.Label.code=musicbrainz2.model.Label-class.html#code"><a title="musicbrainz2.model.Label.code" class="py-name" href="#" onclick="return doclink('link-16', 'code', 'link-16');">code</a></tt> <tt class="py-op">==</tt> <tt class="py-number">400</tt><tt class="py-op">:</tt> <tt class="py-comment"># in python 2.4: httplib.BAD_REQUEST</tt> </tt>
<a name="L283"></a><tt class="py-lineno"> 283</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-17" class="py-name" targets="Class musicbrainz2.webservice.RequestError=musicbrainz2.webservice.RequestError-class.html"><a title="musicbrainz2.webservice.RequestError" class="py-name" href="#" onclick="return doclink('link-17', 'RequestError', 'link-17');">RequestError</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L284"></a><tt class="py-lineno"> 284</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt id="link-18" class="py-name"><a title="musicbrainz2.model.Label.code" class="py-name" href="#" onclick="return doclink('link-18', 'code', 'link-16');">code</a></tt> <tt class="py-op">==</tt> <tt class="py-number">401</tt><tt class="py-op">:</tt> <tt class="py-comment"># httplib.UNAUTHORIZED</tt> </tt>
<a name="L285"></a><tt class="py-lineno"> 285</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-19" class="py-name" targets="Class musicbrainz2.webservice.AuthenticationError=musicbrainz2.webservice.AuthenticationError-class.html"><a title="musicbrainz2.webservice.AuthenticationError" class="py-name" href="#" onclick="return doclink('link-19', 'AuthenticationError', 'link-19');">AuthenticationError</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L286"></a><tt class="py-lineno"> 286</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt id="link-20" class="py-name"><a title="musicbrainz2.model.Label.code" class="py-name" href="#" onclick="return doclink('link-20', 'code', 'link-16');">code</a></tt> <tt class="py-op">==</tt> <tt class="py-number">404</tt><tt class="py-op">:</tt> <tt class="py-comment"># httplib.NOT_FOUND</tt> </tt>
<a name="L287"></a><tt class="py-lineno"> 287</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-21" class="py-name" targets="Class musicbrainz2.webservice.ResourceNotFoundError=musicbrainz2.webservice.ResourceNotFoundError-class.html"><a title="musicbrainz2.webservice.ResourceNotFoundError" class="py-name" href="#" onclick="return doclink('link-21', 'ResourceNotFoundError', 'link-21');">ResourceNotFoundError</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L288"></a><tt class="py-lineno"> 288</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L289"></a><tt class="py-lineno"> 289</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-22" class="py-name" targets="Class musicbrainz2.webservice.WebServiceError=musicbrainz2.webservice.WebServiceError-class.html"><a title="musicbrainz2.webservice.WebServiceError" class="py-name" href="#" onclick="return doclink('link-22', 'WebServiceError', 'link-22');">WebServiceError</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L290"></a><tt class="py-lineno"> 290</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">URLError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L291"></a><tt class="py-lineno"> 291</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_log</tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">"GET failed: "</tt> <tt class="py-op">+</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L292"></a><tt class="py-lineno"> 292</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-23" class="py-name" targets="Class musicbrainz2.webservice.ConnectionError=musicbrainz2.webservice.ConnectionError-class.html"><a title="musicbrainz2.webservice.ConnectionError" class="py-name" href="#" onclick="return doclink('link-23', 'ConnectionError', 'link-23');">ConnectionError</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
</div><a name="L293"></a><tt class="py-lineno"> 293</tt> <tt class="py-line"> </tt>
<a name="L294"></a><tt class="py-lineno"> 294</tt> <tt class="py-line"> </tt>
<a name="WebService.post"></a><div id="WebService.post-def"><a name="L295"></a><tt class="py-lineno"> 295</tt> <a class="py-toggle" href="#" id="WebService.post-toggle" onclick="return toggle('WebService.post');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.WebService-class.html#post">post</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">entity</tt><tt class="py-op">,</tt> <tt class="py-param">id_</tt><tt class="py-op">,</tt> <tt class="py-param">data</tt><tt class="py-op">,</tt> <tt class="py-param">version</tt><tt class="py-op">=</tt><tt class="py-string">'1'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="WebService.post-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="WebService.post-expanded"><a name="L296"></a><tt class="py-lineno"> 296</tt> <tt class="py-line"> <tt class="py-docstring">"""Send data to the web service via HTTP-POST.</tt> </tt>
<a name="L297"></a><tt class="py-lineno"> 297</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L298"></a><tt class="py-lineno"> 298</tt> <tt class="py-line"><tt class="py-docstring"> Note that this may require authentication. You can set</tt> </tt>
<a name="L299"></a><tt class="py-lineno"> 299</tt> <tt class="py-line"><tt class="py-docstring"> user name, password and realm in the L{constructor <__init__>}.</tt> </tt>
<a name="L300"></a><tt class="py-lineno"> 300</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L301"></a><tt class="py-lineno"> 301</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L302"></a><tt class="py-lineno"> 302</tt> <tt class="py-line"><tt class="py-docstring"> @raise RequestError: invalid IDs or parameters</tt> </tt>
<a name="L303"></a><tt class="py-lineno"> 303</tt> <tt class="py-line"><tt class="py-docstring"> @raise AuthenticationError: invalid user name and/or password</tt> </tt>
<a name="L304"></a><tt class="py-lineno"> 304</tt> <tt class="py-line"><tt class="py-docstring"> @raise ResourceNotFoundError: resource doesn't exist</tt> </tt>
<a name="L305"></a><tt class="py-lineno"> 305</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L306"></a><tt class="py-lineno"> 306</tt> <tt class="py-line"><tt class="py-docstring"> @see: L{IWebService.post}</tt> </tt>
<a name="L307"></a><tt class="py-lineno"> 307</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L308"></a><tt class="py-lineno"> 308</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_makeUrl</tt><tt class="py-op">(</tt><tt class="py-name">entity</tt><tt class="py-op">,</tt> <tt class="py-name">id_</tt><tt class="py-op">,</tt> <tt class="py-name">version</tt><tt class="py-op">=</tt><tt class="py-name">version</tt><tt class="py-op">,</tt> <tt class="py-name">type_</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L309"></a><tt class="py-lineno"> 309</tt> <tt class="py-line"> </tt>
<a name="L310"></a><tt class="py-lineno"> 310</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_log</tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">'POST '</tt> <tt class="py-op">+</tt> <tt class="py-name">url</tt><tt class="py-op">)</tt> </tt>
<a name="L311"></a><tt class="py-lineno"> 311</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_log</tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">'POST-BODY: '</tt> <tt class="py-op">+</tt> <tt id="link-24" class="py-name"><a title="musicbrainz2.data" class="py-name" href="#" onclick="return doclink('link-24', 'data', 'link-15');">data</a></tt><tt class="py-op">)</tt> </tt>
<a name="L312"></a><tt class="py-lineno"> 312</tt> <tt class="py-line"> </tt>
<a name="L313"></a><tt class="py-lineno"> 313</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L314"></a><tt class="py-lineno"> 314</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_openUrl</tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">,</tt> <tt id="link-25" class="py-name"><a title="musicbrainz2.data" class="py-name" href="#" onclick="return doclink('link-25', 'data', 'link-15');">data</a></tt><tt class="py-op">)</tt> </tt>
<a name="L315"></a><tt class="py-lineno"> 315</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">HTTPError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L316"></a><tt class="py-lineno"> 316</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_log</tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">"POST failed: "</tt> <tt class="py-op">+</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L317"></a><tt class="py-lineno"> 317</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt id="link-26" class="py-name"><a title="musicbrainz2.model.Label.code" class="py-name" href="#" onclick="return doclink('link-26', 'code', 'link-16');">code</a></tt> <tt class="py-op">==</tt> <tt class="py-number">400</tt><tt class="py-op">:</tt> <tt class="py-comment"># in python 2.4: httplib.BAD_REQUEST</tt> </tt>
<a name="L318"></a><tt class="py-lineno"> 318</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-27" class="py-name"><a title="musicbrainz2.webservice.RequestError" class="py-name" href="#" onclick="return doclink('link-27', 'RequestError', 'link-17');">RequestError</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L319"></a><tt class="py-lineno"> 319</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt id="link-28" class="py-name"><a title="musicbrainz2.model.Label.code" class="py-name" href="#" onclick="return doclink('link-28', 'code', 'link-16');">code</a></tt> <tt class="py-op">==</tt> <tt class="py-number">401</tt><tt class="py-op">:</tt> <tt class="py-comment"># httplib.UNAUTHORIZED</tt> </tt>
<a name="L320"></a><tt class="py-lineno"> 320</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-29" class="py-name"><a title="musicbrainz2.webservice.AuthenticationError" class="py-name" href="#" onclick="return doclink('link-29', 'AuthenticationError', 'link-19');">AuthenticationError</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L321"></a><tt class="py-lineno"> 321</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="musicbrainz2.model.Label.code" class="py-name" href="#" onclick="return doclink('link-30', 'code', 'link-16');">code</a></tt> <tt class="py-op">==</tt> <tt class="py-number">404</tt><tt class="py-op">:</tt> <tt class="py-comment"># httplib.NOT_FOUND</tt> </tt>
<a name="L322"></a><tt class="py-lineno"> 322</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-31" class="py-name"><a title="musicbrainz2.webservice.ResourceNotFoundError" class="py-name" href="#" onclick="return doclink('link-31', 'ResourceNotFoundError', 'link-21');">ResourceNotFoundError</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L323"></a><tt class="py-lineno"> 323</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L324"></a><tt class="py-lineno"> 324</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-32" class="py-name"><a title="musicbrainz2.webservice.WebServiceError" class="py-name" href="#" onclick="return doclink('link-32', 'WebServiceError', 'link-22');">WebServiceError</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L325"></a><tt class="py-lineno"> 325</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">URLError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L326"></a><tt class="py-lineno"> 326</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_log</tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">"POST failed: "</tt> <tt class="py-op">+</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L327"></a><tt class="py-lineno"> 327</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-33" class="py-name"><a title="musicbrainz2.webservice.ConnectionError" class="py-name" href="#" onclick="return doclink('link-33', 'ConnectionError', 'link-23');">ConnectionError</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
</div><a name="L328"></a><tt class="py-lineno"> 328</tt> <tt class="py-line"> </tt>
<a name="L329"></a><tt class="py-lineno"> 329</tt> <tt class="py-line"> </tt>
<a name="L330"></a><tt class="py-lineno"> 330</tt> <tt class="py-line"> <tt class="py-comment"># Special password manager which also works with redirects by simply</tt> </tt>
<a name="L331"></a><tt class="py-lineno"> 331</tt> <tt class="py-line"> <tt class="py-comment"># ignoring the URI. As a consequence, only *ONE* (username, password)</tt> </tt>
<a name="L332"></a><tt class="py-lineno"> 332</tt> <tt class="py-line"> <tt class="py-comment"># tuple per realm can be used for all URIs.</tt> </tt>
<a name="L333"></a><tt class="py-lineno"> 333</tt> <tt class="py-line"> <tt class="py-comment">#</tt> </tt>
<a name="WebService._RedirectPasswordMgr"></a><div id="WebService._RedirectPasswordMgr-def"><a name="L334"></a><tt class="py-lineno"> 334</tt> <a class="py-toggle" href="#" id="WebService._RedirectPasswordMgr-toggle" onclick="return toggle('WebService._RedirectPasswordMgr');">-</a><tt class="py-line"> <tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.WebService._RedirectPasswordMgr-class.html">_RedirectPasswordMgr</a><tt class="py-op">(</tt><tt class="py-base-class">urllib2</tt><tt class="py-op">.</tt><tt class="py-base-class">HTTPPasswordMgr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="WebService._RedirectPasswordMgr-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="WebService._RedirectPasswordMgr-expanded"><a name="WebService._RedirectPasswordMgr.__init__"></a><div id="WebService._RedirectPasswordMgr.__init__-def"><a name="L335"></a><tt class="py-lineno"> 335</tt> <a class="py-toggle" href="#" id="WebService._RedirectPasswordMgr.__init__-toggle" onclick="return toggle('WebService._RedirectPasswordMgr.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.WebService._RedirectPasswordMgr-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="WebService._RedirectPasswordMgr.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++++++++++++++++++++++"></div><div id="WebService._RedirectPasswordMgr.__init__-expanded"><a name="L336"></a><tt class="py-lineno"> 336</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_realms</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> <tt class="py-op">}</tt> </tt>
</div><a name="L337"></a><tt class="py-lineno"> 337</tt> <tt class="py-line"> </tt>
<a name="WebService._RedirectPasswordMgr.find_user_password"></a><div id="WebService._RedirectPasswordMgr.find_user_password-def"><a name="L338"></a><tt class="py-lineno"> 338</tt> <a class="py-toggle" href="#" id="WebService._RedirectPasswordMgr.find_user_password-toggle" onclick="return toggle('WebService._RedirectPasswordMgr.find_user_password');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.WebService._RedirectPasswordMgr-class.html#find_user_password">find_user_password</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">realm</tt><tt class="py-op">,</tt> <tt class="py-param">uri</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="WebService._RedirectPasswordMgr.find_user_password-collapsed" style="display:none;" pad="++++" indent="++++++++++++++++++++++++++++"></div><div id="WebService._RedirectPasswordMgr.find_user_password-expanded"><a name="L339"></a><tt class="py-lineno"> 339</tt> <tt class="py-line"> <tt class="py-comment"># ignoring the uri parameter intentionally</tt> </tt>
<a name="L340"></a><tt class="py-lineno"> 340</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L341"></a><tt class="py-lineno"> 341</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_realms</tt><tt class="py-op">[</tt><tt class="py-name">realm</tt><tt class="py-op">]</tt> </tt>
<a name="L342"></a><tt class="py-lineno"> 342</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">KeyError</tt><tt class="py-op">:</tt> </tt>
<a name="L343"></a><tt class="py-lineno"> 343</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
</div><a name="L344"></a><tt class="py-lineno"> 344</tt> <tt class="py-line"> </tt>
<a name="WebService._RedirectPasswordMgr.add_password"></a><div id="WebService._RedirectPasswordMgr.add_password-def"><a name="L345"></a><tt class="py-lineno"> 345</tt> <a class="py-toggle" href="#" id="WebService._RedirectPasswordMgr.add_password-toggle" onclick="return toggle('WebService._RedirectPasswordMgr.add_password');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.WebService._RedirectPasswordMgr-class.html#add_password">add_password</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">realm</tt><tt class="py-op">,</tt> <tt class="py-param">uri</tt><tt class="py-op">,</tt> <tt class="py-param">username</tt><tt class="py-op">,</tt> <tt class="py-param">password</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="WebService._RedirectPasswordMgr.add_password-collapsed" style="display:none;" pad="++++" indent="++++++++++++++++++++++++++++"></div><div id="WebService._RedirectPasswordMgr.add_password-expanded"><a name="L346"></a><tt class="py-lineno"> 346</tt> <tt class="py-line"> <tt class="py-comment"># ignoring the uri parameter intentionally</tt> </tt>
<a name="L347"></a><tt class="py-lineno"> 347</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_realms</tt><tt class="py-op">[</tt><tt class="py-name">realm</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">username</tt><tt class="py-op">,</tt> <tt class="py-name">password</tt><tt class="py-op">)</tt> </tt>
</div></div></div><a name="L348"></a><tt class="py-lineno"> 348</tt> <tt class="py-line"> </tt>
<a name="L349"></a><tt class="py-lineno"> 349</tt> <tt class="py-line"> </tt>
<a name="IFilter"></a><div id="IFilter-def"><a name="L350"></a><tt class="py-lineno"> 350</tt> <a class="py-toggle" href="#" id="IFilter-toggle" onclick="return toggle('IFilter');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.IFilter-class.html">IFilter</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IFilter-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="IFilter-expanded"><a name="L351"></a><tt class="py-lineno"> 351</tt> <tt class="py-line"> <tt class="py-docstring">"""A filter for collections.</tt> </tt>
<a name="L352"></a><tt class="py-lineno"> 352</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L353"></a><tt class="py-lineno"> 353</tt> <tt class="py-line"><tt class="py-docstring"> This is the interface all filters have to implement. Filter classes</tt> </tt>
<a name="L354"></a><tt class="py-lineno"> 354</tt> <tt class="py-line"><tt class="py-docstring"> are initialized with a set of criteria and are then applied to</tt> </tt>
<a name="L355"></a><tt class="py-lineno"> 355</tt> <tt class="py-line"><tt class="py-docstring"> collections of items. The criteria are usually strings or integer</tt> </tt>
<a name="L356"></a><tt class="py-lineno"> 356</tt> <tt class="py-line"><tt class="py-docstring"> values, depending on the filter.</tt> </tt>
<a name="L357"></a><tt class="py-lineno"> 357</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L358"></a><tt class="py-lineno"> 358</tt> <tt class="py-line"><tt class="py-docstring"> Note that all strings passed to filters should be unicode strings</tt> </tt>
<a name="L359"></a><tt class="py-lineno"> 359</tt> <tt class="py-line"><tt class="py-docstring"> (python type C{unicode}). Standard strings are converted to unicode</tt> </tt>
<a name="L360"></a><tt class="py-lineno"> 360</tt> <tt class="py-line"><tt class="py-docstring"> internally, but have a limitation: Only 7 Bit pure ASCII characters</tt> </tt>
<a name="L361"></a><tt class="py-lineno"> 361</tt> <tt class="py-line"><tt class="py-docstring"> may be used, otherwise a C{UnicodeDecodeError} is raised.</tt> </tt>
<a name="L362"></a><tt class="py-lineno"> 362</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="IFilter.createParameters"></a><div id="IFilter.createParameters-def"><a name="L363"></a><tt class="py-lineno"> 363</tt> <a class="py-toggle" href="#" id="IFilter.createParameters-toggle" onclick="return toggle('IFilter.createParameters');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.IFilter-class.html#createParameters">createParameters</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IFilter.createParameters-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="IFilter.createParameters-expanded"><a name="L364"></a><tt class="py-lineno"> 364</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a list of query parameters.</tt> </tt>
<a name="L365"></a><tt class="py-lineno"> 365</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L366"></a><tt class="py-lineno"> 366</tt> <tt class="py-line"><tt class="py-docstring"> This method creates a list of (C{parameter}, C{value}) tuples,</tt> </tt>
<a name="L367"></a><tt class="py-lineno"> 367</tt> <tt class="py-line"><tt class="py-docstring"> based on the contents of the implementing subclass.</tt> </tt>
<a name="L368"></a><tt class="py-lineno"> 368</tt> <tt class="py-line"><tt class="py-docstring"> C{parameter} is a string containing a parameter name</tt> </tt>
<a name="L369"></a><tt class="py-lineno"> 369</tt> <tt class="py-line"><tt class="py-docstring"> and C{value} an arbitrary string. No escaping of those strings</tt> </tt>
<a name="L370"></a><tt class="py-lineno"> 370</tt> <tt class="py-line"><tt class="py-docstring"> is required. </tt> </tt>
<a name="L371"></a><tt class="py-lineno"> 371</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L372"></a><tt class="py-lineno"> 372</tt> <tt class="py-line"><tt class="py-docstring"> @return: a sequence of (key, value) pairs</tt> </tt>
<a name="L373"></a><tt class="py-lineno"> 373</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L374"></a><tt class="py-lineno"> 374</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L375"></a><tt class="py-lineno"> 375</tt> <tt class="py-line"> </tt>
<a name="L376"></a><tt class="py-lineno"> 376</tt> <tt class="py-line"> </tt>
<a name="ArtistFilter"></a><div id="ArtistFilter-def"><a name="L377"></a><tt class="py-lineno"> 377</tt> <a class="py-toggle" href="#" id="ArtistFilter-toggle" onclick="return toggle('ArtistFilter');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.ArtistFilter-class.html">ArtistFilter</a><tt class="py-op">(</tt><tt class="py-base-class">IFilter</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ArtistFilter-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ArtistFilter-expanded"><a name="L378"></a><tt class="py-lineno"> 378</tt> <tt class="py-line"> <tt class="py-docstring">"""A filter for the artist collection."""</tt> </tt>
<a name="L379"></a><tt class="py-lineno"> 379</tt> <tt class="py-line"> </tt>
<a name="ArtistFilter.__init__"></a><div id="ArtistFilter.__init__-def"><a name="L380"></a><tt class="py-lineno"> 380</tt> <a class="py-toggle" href="#" id="ArtistFilter.__init__-toggle" onclick="return toggle('ArtistFilter.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.ArtistFilter-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">limit</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">offset</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">query</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ArtistFilter.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="ArtistFilter.__init__-expanded"><a name="L381"></a><tt class="py-lineno"> 381</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt>
<a name="L382"></a><tt class="py-lineno"> 382</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L383"></a><tt class="py-lineno"> 383</tt> <tt class="py-line"><tt class="py-docstring"> The C{query} parameter may contain a query in U{Lucene syntax</tt> </tt>
<a name="L384"></a><tt class="py-lineno"> 384</tt> <tt class="py-line"><tt class="py-docstring"> <http://lucene.apache.org/java/docs/queryparsersyntax.html>}.</tt> </tt>
<a name="L385"></a><tt class="py-lineno"> 385</tt> <tt class="py-line"><tt class="py-docstring"> Note that the C{name} and C{query} may not be used together.</tt> </tt>
<a name="L386"></a><tt class="py-lineno"> 386</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L387"></a><tt class="py-lineno"> 387</tt> <tt class="py-line"><tt class="py-docstring"> @param name: a unicode string containing the artist's name</tt> </tt>
<a name="L388"></a><tt class="py-lineno"> 388</tt> <tt class="py-line"><tt class="py-docstring"> @param limit: the maximum number of artists to return</tt> </tt>
<a name="L389"></a><tt class="py-lineno"> 389</tt> <tt class="py-line"><tt class="py-docstring"> @param offset: start results at this zero-based offset</tt> </tt>
<a name="L390"></a><tt class="py-lineno"> 390</tt> <tt class="py-line"><tt class="py-docstring"> @param query: a string containing a query in Lucene syntax</tt> </tt>
<a name="L391"></a><tt class="py-lineno"> 391</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L392"></a><tt class="py-lineno"> 392</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_params</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> </tt>
<a name="L393"></a><tt class="py-lineno"> 393</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'name'</tt><tt class="py-op">,</tt> <tt id="link-34" class="py-name" targets="Variable musicbrainz2.model.Artist.name=musicbrainz2.model.Artist-class.html#name,Variable musicbrainz2.model.Label.name=musicbrainz2.model.Label-class.html#name,Variable musicbrainz2.model.User.name=musicbrainz2.model.User-class.html#name"><a title="musicbrainz2.model.Artist.name
musicbrainz2.model.Label.name
musicbrainz2.model.User.name" class="py-name" href="#" onclick="return doclink('link-34', 'name', 'link-34');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L394"></a><tt class="py-lineno"> 394</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'limit'</tt><tt class="py-op">,</tt> <tt class="py-name">limit</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L395"></a><tt class="py-lineno"> 395</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'offset'</tt><tt class="py-op">,</tt> <tt class="py-name">offset</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L396"></a><tt class="py-lineno"> 396</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'query'</tt><tt class="py-op">,</tt> <tt class="py-name">query</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L397"></a><tt class="py-lineno"> 397</tt> <tt class="py-line"> <tt class="py-op">]</tt> </tt>
<a name="L398"></a><tt class="py-lineno"> 398</tt> <tt class="py-line"> </tt>
<a name="L399"></a><tt class="py-lineno"> 399</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">_paramsValid</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_params</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L400"></a><tt class="py-lineno"> 400</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'invalid combination of parameters'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L401"></a><tt class="py-lineno"> 401</tt> <tt class="py-line"> </tt>
<a name="ArtistFilter.createParameters"></a><div id="ArtistFilter.createParameters-def"><a name="L402"></a><tt class="py-lineno"> 402</tt> <a class="py-toggle" href="#" id="ArtistFilter.createParameters-toggle" onclick="return toggle('ArtistFilter.createParameters');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.ArtistFilter-class.html#createParameters">createParameters</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ArtistFilter.createParameters-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="ArtistFilter.createParameters-expanded"><a name="L403"></a><tt class="py-lineno"> 403</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">_createParameters</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_params</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L404"></a><tt class="py-lineno"> 404</tt> <tt class="py-line"> </tt>
<a name="L405"></a><tt class="py-lineno"> 405</tt> <tt class="py-line"> </tt>
<a name="LabelFilter"></a><div id="LabelFilter-def"><a name="L406"></a><tt class="py-lineno"> 406</tt> <a class="py-toggle" href="#" id="LabelFilter-toggle" onclick="return toggle('LabelFilter');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.LabelFilter-class.html">LabelFilter</a><tt class="py-op">(</tt><tt class="py-base-class">IFilter</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LabelFilter-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="LabelFilter-expanded"><a name="L407"></a><tt class="py-lineno"> 407</tt> <tt class="py-line"> <tt class="py-docstring">"""A filter for the label collection."""</tt> </tt>
<a name="L408"></a><tt class="py-lineno"> 408</tt> <tt class="py-line"> </tt>
<a name="LabelFilter.__init__"></a><div id="LabelFilter.__init__-def"><a name="L409"></a><tt class="py-lineno"> 409</tt> <a class="py-toggle" href="#" id="LabelFilter.__init__-toggle" onclick="return toggle('LabelFilter.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.LabelFilter-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">limit</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">offset</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">query</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LabelFilter.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="LabelFilter.__init__-expanded"><a name="L410"></a><tt class="py-lineno"> 410</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt>
<a name="L411"></a><tt class="py-lineno"> 411</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L412"></a><tt class="py-lineno"> 412</tt> <tt class="py-line"><tt class="py-docstring"> The C{query} parameter may contain a query in U{Lucene syntax</tt> </tt>
<a name="L413"></a><tt class="py-lineno"> 413</tt> <tt class="py-line"><tt class="py-docstring"> <http://lucene.apache.org/java/docs/queryparsersyntax.html>}.</tt> </tt>
<a name="L414"></a><tt class="py-lineno"> 414</tt> <tt class="py-line"><tt class="py-docstring"> Note that the C{name} and C{query} may not be used together.</tt> </tt>
<a name="L415"></a><tt class="py-lineno"> 415</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L416"></a><tt class="py-lineno"> 416</tt> <tt class="py-line"><tt class="py-docstring"> @param name: a unicode string containing the label's name</tt> </tt>
<a name="L417"></a><tt class="py-lineno"> 417</tt> <tt class="py-line"><tt class="py-docstring"> @param limit: the maximum number of labels to return</tt> </tt>
<a name="L418"></a><tt class="py-lineno"> 418</tt> <tt class="py-line"><tt class="py-docstring"> @param offset: start results at this zero-based offset</tt> </tt>
<a name="L419"></a><tt class="py-lineno"> 419</tt> <tt class="py-line"><tt class="py-docstring"> @param query: a string containing a query in Lucene syntax</tt> </tt>
<a name="L420"></a><tt class="py-lineno"> 420</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L421"></a><tt class="py-lineno"> 421</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_params</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> </tt>
<a name="L422"></a><tt class="py-lineno"> 422</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'name'</tt><tt class="py-op">,</tt> <tt id="link-35" class="py-name"><a title="musicbrainz2.model.Artist.name
musicbrainz2.model.Label.name
musicbrainz2.model.User.name" class="py-name" href="#" onclick="return doclink('link-35', 'name', 'link-34');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L423"></a><tt class="py-lineno"> 423</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'limit'</tt><tt class="py-op">,</tt> <tt class="py-name">limit</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L424"></a><tt class="py-lineno"> 424</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'offset'</tt><tt class="py-op">,</tt> <tt class="py-name">offset</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L425"></a><tt class="py-lineno"> 425</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'query'</tt><tt class="py-op">,</tt> <tt class="py-name">query</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L426"></a><tt class="py-lineno"> 426</tt> <tt class="py-line"> <tt class="py-op">]</tt> </tt>
<a name="L427"></a><tt class="py-lineno"> 427</tt> <tt class="py-line"> </tt>
<a name="L428"></a><tt class="py-lineno"> 428</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">_paramsValid</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_params</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L429"></a><tt class="py-lineno"> 429</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'invalid combination of parameters'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L430"></a><tt class="py-lineno"> 430</tt> <tt class="py-line"> </tt>
<a name="LabelFilter.createParameters"></a><div id="LabelFilter.createParameters-def"><a name="L431"></a><tt class="py-lineno"> 431</tt> <a class="py-toggle" href="#" id="LabelFilter.createParameters-toggle" onclick="return toggle('LabelFilter.createParameters');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.LabelFilter-class.html#createParameters">createParameters</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LabelFilter.createParameters-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="LabelFilter.createParameters-expanded"><a name="L432"></a><tt class="py-lineno"> 432</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">_createParameters</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_params</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L433"></a><tt class="py-lineno"> 433</tt> <tt class="py-line"> </tt>
<a name="ReleaseGroupFilter"></a><div id="ReleaseGroupFilter-def"><a name="L434"></a><tt class="py-lineno"> 434</tt> <a class="py-toggle" href="#" id="ReleaseGroupFilter-toggle" onclick="return toggle('ReleaseGroupFilter');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.ReleaseGroupFilter-class.html">ReleaseGroupFilter</a><tt class="py-op">(</tt><tt class="py-base-class">IFilter</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReleaseGroupFilter-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ReleaseGroupFilter-expanded"><a name="L435"></a><tt class="py-lineno"> 435</tt> <tt class="py-line"> <tt class="py-docstring">"""A filter for the release group collection."""</tt> </tt>
<a name="L436"></a><tt class="py-lineno"> 436</tt> <tt class="py-line"> </tt>
<a name="ReleaseGroupFilter.__init__"></a><div id="ReleaseGroupFilter.__init__-def"><a name="L437"></a><tt class="py-lineno"> 437</tt> <a class="py-toggle" href="#" id="ReleaseGroupFilter.__init__-toggle" onclick="return toggle('ReleaseGroupFilter.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.ReleaseGroupFilter-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">releaseTypes</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">artistName</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L438"></a><tt class="py-lineno"> 438</tt> <tt class="py-line"> <tt class="py-param">artistId</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">limit</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">offset</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">query</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReleaseGroupFilter.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="ReleaseGroupFilter.__init__-expanded"><a name="L439"></a><tt class="py-lineno"> 439</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt>
<a name="L440"></a><tt class="py-lineno"> 440</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L441"></a><tt class="py-lineno"> 441</tt> <tt class="py-line"><tt class="py-docstring"> If C{artistId} is set, only releases matching those IDs are</tt> </tt>
<a name="L442"></a><tt class="py-lineno"> 442</tt> <tt class="py-line"><tt class="py-docstring"> returned. The C{releaseTypes} parameter allows you to limit</tt> </tt>
<a name="L443"></a><tt class="py-lineno"> 443</tt> <tt class="py-line"><tt class="py-docstring"> the types of the release groups returned. You can set it to</tt> </tt>
<a name="L444"></a><tt class="py-lineno"> 444</tt> <tt class="py-line"><tt class="py-docstring"> C{(Release.TYPE_ALBUM, Release.TYPE_OFFICIAL)}, for example,</tt> </tt>
<a name="L445"></a><tt class="py-lineno"> 445</tt> <tt class="py-line"><tt class="py-docstring"> to only get officially released albums. Note that those values</tt> </tt>
<a name="L446"></a><tt class="py-lineno"> 446</tt> <tt class="py-line"><tt class="py-docstring"> are connected using the I{AND} operator. MusicBrainz' support</tt> </tt>
<a name="L447"></a><tt class="py-lineno"> 447</tt> <tt class="py-line"><tt class="py-docstring"> is currently very limited, so C{Release.TYPE_LIVE} and</tt> </tt>
<a name="L448"></a><tt class="py-lineno"> 448</tt> <tt class="py-line"><tt class="py-docstring"> C{Release.TYPE_COMPILATION} exclude each other (see U{the</tt> </tt>
<a name="L449"></a><tt class="py-lineno"> 449</tt> <tt class="py-line"><tt class="py-docstring"> documentation on release attributes</tt> </tt>
<a name="L450"></a><tt class="py-lineno"> 450</tt> <tt class="py-line"><tt class="py-docstring"> <http://wiki.musicbrainz.org/AlbumAttribute>} for more</tt> </tt>
<a name="L451"></a><tt class="py-lineno"> 451</tt> <tt class="py-line"><tt class="py-docstring"> information and all valid values).</tt> </tt>
<a name="L452"></a><tt class="py-lineno"> 452</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L453"></a><tt class="py-lineno"> 453</tt> <tt class="py-line"><tt class="py-docstring"> If both the C{artistName} and the C{artistId} parameter are</tt> </tt>
<a name="L454"></a><tt class="py-lineno"> 454</tt> <tt class="py-line"><tt class="py-docstring"> given, the server will ignore C{artistName}.</tt> </tt>
<a name="L455"></a><tt class="py-lineno"> 455</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L456"></a><tt class="py-lineno"> 456</tt> <tt class="py-line"><tt class="py-docstring"> The C{query} parameter may contain a query in U{Lucene syntax</tt> </tt>
<a name="L457"></a><tt class="py-lineno"> 457</tt> <tt class="py-line"><tt class="py-docstring"> <http://lucene.apache.org/java/docs/queryparsersyntax.html>}.</tt> </tt>
<a name="L458"></a><tt class="py-lineno"> 458</tt> <tt class="py-line"><tt class="py-docstring"> Note that C{query} may not be used together with the other</tt> </tt>
<a name="L459"></a><tt class="py-lineno"> 459</tt> <tt class="py-line"><tt class="py-docstring"> parameters except for C{limit} and C{offset}.</tt> </tt>
<a name="L460"></a><tt class="py-lineno"> 460</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L461"></a><tt class="py-lineno"> 461</tt> <tt class="py-line"><tt class="py-docstring"> @param title: a unicode string containing the release group's title</tt> </tt>
<a name="L462"></a><tt class="py-lineno"> 462</tt> <tt class="py-line"><tt class="py-docstring"> @param releaseTypes: a sequence of release type URIs</tt> </tt>
<a name="L463"></a><tt class="py-lineno"> 463</tt> <tt class="py-line"><tt class="py-docstring"> @param artistName: a unicode string containing the artist's name</tt> </tt>
<a name="L464"></a><tt class="py-lineno"> 464</tt> <tt class="py-line"><tt class="py-docstring"> @param artistId: a unicode string containing the artist's ID</tt> </tt>
<a name="L465"></a><tt class="py-lineno"> 465</tt> <tt class="py-line"><tt class="py-docstring"> @param limit: the maximum number of release groups to return</tt> </tt>
<a name="L466"></a><tt class="py-lineno"> 466</tt> <tt class="py-line"><tt class="py-docstring"> @param offset: start results at this zero-based offset</tt> </tt>
<a name="L467"></a><tt class="py-lineno"> 467</tt> <tt class="py-line"><tt class="py-docstring"> @param query: a string containing a query in Lucene syntax</tt> </tt>
<a name="L468"></a><tt class="py-lineno"> 468</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L469"></a><tt class="py-lineno"> 469</tt> <tt class="py-line"><tt class="py-docstring"> @see: the constants in L{musicbrainz2.model.Release}</tt> </tt>
<a name="L470"></a><tt class="py-lineno"> 470</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L471"></a><tt class="py-lineno"> 471</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">releaseTypes</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">or</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">releaseTypes</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L472"></a><tt class="py-lineno"> 472</tt> <tt class="py-line"> <tt class="py-name">releaseTypesStr</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L473"></a><tt class="py-lineno"> 473</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L474"></a><tt class="py-lineno"> 474</tt> <tt class="py-line"> <tt class="py-name">releaseTypesStr</tt> <tt class="py-op">=</tt> <tt class="py-string">' '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">map</tt><tt class="py-op">(</tt><tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-36" class="py-name" targets="Function musicbrainz2.utils.extractFragment()=musicbrainz2.utils-module.html#extractFragment"><a title="musicbrainz2.utils.extractFragment" class="py-name" href="#" onclick="return doclink('link-36', 'extractFragment', 'link-36');">extractFragment</a></tt><tt class="py-op">,</tt> <tt class="py-name">releaseTypes</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L475"></a><tt class="py-lineno"> 475</tt> <tt class="py-line"> </tt>
<a name="L476"></a><tt class="py-lineno"> 476</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_params</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> </tt>
<a name="L477"></a><tt class="py-lineno"> 477</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'title'</tt><tt class="py-op">,</tt> <tt id="link-37" class="py-name" targets="Variable musicbrainz2.model.Release.title=musicbrainz2.model.Release-class.html#title,Variable musicbrainz2.model.ReleaseGroup.title=musicbrainz2.model.ReleaseGroup-class.html#title,Variable musicbrainz2.model.Track.title=musicbrainz2.model.Track-class.html#title"><a title="musicbrainz2.model.Release.title
musicbrainz2.model.ReleaseGroup.title
musicbrainz2.model.Track.title" class="py-name" href="#" onclick="return doclink('link-37', 'title', 'link-37');">title</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L478"></a><tt class="py-lineno"> 478</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'releasetypes'</tt><tt class="py-op">,</tt> <tt class="py-name">releaseTypesStr</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L479"></a><tt class="py-lineno"> 479</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'artist'</tt><tt class="py-op">,</tt> <tt class="py-name">artistName</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L480"></a><tt class="py-lineno"> 480</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'artistid'</tt><tt class="py-op">,</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-38" class="py-name" targets="Function musicbrainz2.utils.extractUuid()=musicbrainz2.utils-module.html#extractUuid"><a title="musicbrainz2.utils.extractUuid" class="py-name" href="#" onclick="return doclink('link-38', 'extractUuid', 'link-38');">extractUuid</a></tt><tt class="py-op">(</tt><tt class="py-name">artistId</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L481"></a><tt class="py-lineno"> 481</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'limit'</tt><tt class="py-op">,</tt> <tt class="py-name">limit</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L482"></a><tt class="py-lineno"> 482</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'offset'</tt><tt class="py-op">,</tt> <tt class="py-name">offset</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L483"></a><tt class="py-lineno"> 483</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'query'</tt><tt class="py-op">,</tt> <tt class="py-name">query</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L484"></a><tt class="py-lineno"> 484</tt> <tt class="py-line"> <tt class="py-op">]</tt> </tt>
<a name="L485"></a><tt class="py-lineno"> 485</tt> <tt class="py-line"> </tt>
<a name="L486"></a><tt class="py-lineno"> 486</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">_paramsValid</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_params</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L487"></a><tt class="py-lineno"> 487</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'invalid combination of parameters'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L488"></a><tt class="py-lineno"> 488</tt> <tt class="py-line"> </tt>
<a name="ReleaseGroupFilter.createParameters"></a><div id="ReleaseGroupFilter.createParameters-def"><a name="L489"></a><tt class="py-lineno"> 489</tt> <a class="py-toggle" href="#" id="ReleaseGroupFilter.createParameters-toggle" onclick="return toggle('ReleaseGroupFilter.createParameters');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.ReleaseGroupFilter-class.html#createParameters">createParameters</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReleaseGroupFilter.createParameters-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="ReleaseGroupFilter.createParameters-expanded"><a name="L490"></a><tt class="py-lineno"> 490</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">_createParameters</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_params</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L491"></a><tt class="py-lineno"> 491</tt> <tt class="py-line"> </tt>
<a name="L492"></a><tt class="py-lineno"> 492</tt> <tt class="py-line"> </tt>
<a name="ReleaseFilter"></a><div id="ReleaseFilter-def"><a name="L493"></a><tt class="py-lineno"> 493</tt> <a class="py-toggle" href="#" id="ReleaseFilter-toggle" onclick="return toggle('ReleaseFilter');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.ReleaseFilter-class.html">ReleaseFilter</a><tt class="py-op">(</tt><tt class="py-base-class">IFilter</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReleaseFilter-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ReleaseFilter-expanded"><a name="L494"></a><tt class="py-lineno"> 494</tt> <tt class="py-line"> <tt class="py-docstring">"""A filter for the release collection."""</tt> </tt>
<a name="L495"></a><tt class="py-lineno"> 495</tt> <tt class="py-line"> </tt>
<a name="ReleaseFilter.__init__"></a><div id="ReleaseFilter.__init__-def"><a name="L496"></a><tt class="py-lineno"> 496</tt> <a class="py-toggle" href="#" id="ReleaseFilter.__init__-toggle" onclick="return toggle('ReleaseFilter.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.ReleaseFilter-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">discId</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">releaseTypes</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L497"></a><tt class="py-lineno"> 497</tt> <tt class="py-line"> <tt class="py-param">artistName</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">artistId</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">limit</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L498"></a><tt class="py-lineno"> 498</tt> <tt class="py-line"> <tt class="py-param">offset</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">query</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">trackCount</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReleaseFilter.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="ReleaseFilter.__init__-expanded"><a name="L499"></a><tt class="py-lineno"> 499</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt>
<a name="L500"></a><tt class="py-lineno"> 500</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L501"></a><tt class="py-lineno"> 501</tt> <tt class="py-line"><tt class="py-docstring"> If C{discId} or C{artistId} are set, only releases matching</tt> </tt>
<a name="L502"></a><tt class="py-lineno"> 502</tt> <tt class="py-line"><tt class="py-docstring"> those IDs are returned. The C{releaseTypes} parameter allows</tt> </tt>
<a name="L503"></a><tt class="py-lineno"> 503</tt> <tt class="py-line"><tt class="py-docstring"> to limit the types of the releases returned. You can set it to</tt> </tt>
<a name="L504"></a><tt class="py-lineno"> 504</tt> <tt class="py-line"><tt class="py-docstring"> C{(Release.TYPE_ALBUM, Release.TYPE_OFFICIAL)}, for example,</tt> </tt>
<a name="L505"></a><tt class="py-lineno"> 505</tt> <tt class="py-line"><tt class="py-docstring"> to only get officially released albums. Note that those values</tt> </tt>
<a name="L506"></a><tt class="py-lineno"> 506</tt> <tt class="py-line"><tt class="py-docstring"> are connected using the I{AND} operator. MusicBrainz' support</tt> </tt>
<a name="L507"></a><tt class="py-lineno"> 507</tt> <tt class="py-line"><tt class="py-docstring"> is currently very limited, so C{Release.TYPE_LIVE} and</tt> </tt>
<a name="L508"></a><tt class="py-lineno"> 508</tt> <tt class="py-line"><tt class="py-docstring"> C{Release.TYPE_COMPILATION} exclude each other (see U{the</tt> </tt>
<a name="L509"></a><tt class="py-lineno"> 509</tt> <tt class="py-line"><tt class="py-docstring"> documentation on release attributes</tt> </tt>
<a name="L510"></a><tt class="py-lineno"> 510</tt> <tt class="py-line"><tt class="py-docstring"> <http://wiki.musicbrainz.org/AlbumAttribute>} for more</tt> </tt>
<a name="L511"></a><tt class="py-lineno"> 511</tt> <tt class="py-line"><tt class="py-docstring"> information and all valid values).</tt> </tt>
<a name="L512"></a><tt class="py-lineno"> 512</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L513"></a><tt class="py-lineno"> 513</tt> <tt class="py-line"><tt class="py-docstring"> If both the C{artistName} and the C{artistId} parameter are</tt> </tt>
<a name="L514"></a><tt class="py-lineno"> 514</tt> <tt class="py-line"><tt class="py-docstring"> given, the server will ignore C{artistName}.</tt> </tt>
<a name="L515"></a><tt class="py-lineno"> 515</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L516"></a><tt class="py-lineno"> 516</tt> <tt class="py-line"><tt class="py-docstring"> The C{query} parameter may contain a query in U{Lucene syntax</tt> </tt>
<a name="L517"></a><tt class="py-lineno"> 517</tt> <tt class="py-line"><tt class="py-docstring"> <http://lucene.apache.org/java/docs/queryparsersyntax.html>}.</tt> </tt>
<a name="L518"></a><tt class="py-lineno"> 518</tt> <tt class="py-line"><tt class="py-docstring"> Note that C{query} may not be used together with the other</tt> </tt>
<a name="L519"></a><tt class="py-lineno"> 519</tt> <tt class="py-line"><tt class="py-docstring"> parameters except for C{limit} and C{offset}.</tt> </tt>
<a name="L520"></a><tt class="py-lineno"> 520</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L521"></a><tt class="py-lineno"> 521</tt> <tt class="py-line"><tt class="py-docstring"> @param title: a unicode string containing the release's title</tt> </tt>
<a name="L522"></a><tt class="py-lineno"> 522</tt> <tt class="py-line"><tt class="py-docstring"> @param discId: a unicode string containing the DiscID</tt> </tt>
<a name="L523"></a><tt class="py-lineno"> 523</tt> <tt class="py-line"><tt class="py-docstring"> @param releaseTypes: a sequence of release type URIs</tt> </tt>
<a name="L524"></a><tt class="py-lineno"> 524</tt> <tt class="py-line"><tt class="py-docstring"> @param artistName: a unicode string containing the artist's name</tt> </tt>
<a name="L525"></a><tt class="py-lineno"> 525</tt> <tt class="py-line"><tt class="py-docstring"> @param artistId: a unicode string containing the artist's ID</tt> </tt>
<a name="L526"></a><tt class="py-lineno"> 526</tt> <tt class="py-line"><tt class="py-docstring"> @param limit: the maximum number of releases to return</tt> </tt>
<a name="L527"></a><tt class="py-lineno"> 527</tt> <tt class="py-line"><tt class="py-docstring"> @param offset: start results at this zero-based offset</tt> </tt>
<a name="L528"></a><tt class="py-lineno"> 528</tt> <tt class="py-line"><tt class="py-docstring"> @param query: a string containing a query in Lucene syntax</tt> </tt>
<a name="L529"></a><tt class="py-lineno"> 529</tt> <tt class="py-line"><tt class="py-docstring"> @param trackCount: the number of tracks in the release</tt> </tt>
<a name="L530"></a><tt class="py-lineno"> 530</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L531"></a><tt class="py-lineno"> 531</tt> <tt class="py-line"><tt class="py-docstring"> @see: the constants in L{musicbrainz2.model.Release}</tt> </tt>
<a name="L532"></a><tt class="py-lineno"> 532</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L533"></a><tt class="py-lineno"> 533</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">releaseTypes</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">or</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">releaseTypes</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L534"></a><tt class="py-lineno"> 534</tt> <tt class="py-line"> <tt class="py-name">releaseTypesStr</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L535"></a><tt class="py-lineno"> 535</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L536"></a><tt class="py-lineno"> 536</tt> <tt class="py-line"> <tt class="py-name">tmp</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-39" class="py-name"><a title="musicbrainz2.utils.extractFragment" class="py-name" href="#" onclick="return doclink('link-39', 'extractFragment', 'link-36');">extractFragment</a></tt><tt class="py-op">(</tt><tt class="py-name">x</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">x</tt> <tt class="py-keyword">in</tt> <tt class="py-name">releaseTypes</tt> <tt class="py-op">]</tt> </tt>
<a name="L537"></a><tt class="py-lineno"> 537</tt> <tt class="py-line"> <tt class="py-name">releaseTypesStr</tt> <tt class="py-op">=</tt> <tt class="py-string">' '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">tmp</tt><tt class="py-op">)</tt> </tt>
<a name="L538"></a><tt class="py-lineno"> 538</tt> <tt class="py-line"> </tt>
<a name="L539"></a><tt class="py-lineno"> 539</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_params</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> </tt>
<a name="L540"></a><tt class="py-lineno"> 540</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'title'</tt><tt class="py-op">,</tt> <tt id="link-40" class="py-name"><a title="musicbrainz2.model.Release.title
musicbrainz2.model.ReleaseGroup.title
musicbrainz2.model.Track.title" class="py-name" href="#" onclick="return doclink('link-40', 'title', 'link-37');">title</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L541"></a><tt class="py-lineno"> 541</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'discid'</tt><tt class="py-op">,</tt> <tt class="py-name">discId</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L542"></a><tt class="py-lineno"> 542</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'releasetypes'</tt><tt class="py-op">,</tt> <tt class="py-name">releaseTypesStr</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L543"></a><tt class="py-lineno"> 543</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'artist'</tt><tt class="py-op">,</tt> <tt class="py-name">artistName</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L544"></a><tt class="py-lineno"> 544</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'artistid'</tt><tt class="py-op">,</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-41" class="py-name"><a title="musicbrainz2.utils.extractUuid" class="py-name" href="#" onclick="return doclink('link-41', 'extractUuid', 'link-38');">extractUuid</a></tt><tt class="py-op">(</tt><tt class="py-name">artistId</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L545"></a><tt class="py-lineno"> 545</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'limit'</tt><tt class="py-op">,</tt> <tt class="py-name">limit</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L546"></a><tt class="py-lineno"> 546</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'offset'</tt><tt class="py-op">,</tt> <tt class="py-name">offset</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L547"></a><tt class="py-lineno"> 547</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'query'</tt><tt class="py-op">,</tt> <tt class="py-name">query</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L548"></a><tt class="py-lineno"> 548</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'count'</tt><tt class="py-op">,</tt> <tt class="py-name">trackCount</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L549"></a><tt class="py-lineno"> 549</tt> <tt class="py-line"> <tt class="py-op">]</tt> </tt>
<a name="L550"></a><tt class="py-lineno"> 550</tt> <tt class="py-line"> </tt>
<a name="L551"></a><tt class="py-lineno"> 551</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">_paramsValid</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_params</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L552"></a><tt class="py-lineno"> 552</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'invalid combination of parameters'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L553"></a><tt class="py-lineno"> 553</tt> <tt class="py-line"> </tt>
<a name="ReleaseFilter.createParameters"></a><div id="ReleaseFilter.createParameters-def"><a name="L554"></a><tt class="py-lineno"> 554</tt> <a class="py-toggle" href="#" id="ReleaseFilter.createParameters-toggle" onclick="return toggle('ReleaseFilter.createParameters');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.ReleaseFilter-class.html#createParameters">createParameters</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReleaseFilter.createParameters-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="ReleaseFilter.createParameters-expanded"><a name="L555"></a><tt class="py-lineno"> 555</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">_createParameters</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_params</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L556"></a><tt class="py-lineno"> 556</tt> <tt class="py-line"> </tt>
<a name="L557"></a><tt class="py-lineno"> 557</tt> <tt class="py-line"> </tt>
<a name="TrackFilter"></a><div id="TrackFilter-def"><a name="L558"></a><tt class="py-lineno"> 558</tt> <a class="py-toggle" href="#" id="TrackFilter-toggle" onclick="return toggle('TrackFilter');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.TrackFilter-class.html">TrackFilter</a><tt class="py-op">(</tt><tt class="py-base-class">IFilter</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TrackFilter-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="TrackFilter-expanded"><a name="L559"></a><tt class="py-lineno"> 559</tt> <tt class="py-line"> <tt class="py-docstring">"""A filter for the track collection."""</tt> </tt>
<a name="L560"></a><tt class="py-lineno"> 560</tt> <tt class="py-line"> </tt>
<a name="TrackFilter.__init__"></a><div id="TrackFilter.__init__-def"><a name="L561"></a><tt class="py-lineno"> 561</tt> <a class="py-toggle" href="#" id="TrackFilter.__init__-toggle" onclick="return toggle('TrackFilter.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.TrackFilter-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">artistName</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">artistId</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L562"></a><tt class="py-lineno"> 562</tt> <tt class="py-line"> <tt class="py-param">releaseTitle</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">releaseId</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L563"></a><tt class="py-lineno"> 563</tt> <tt class="py-line"> <tt class="py-param">duration</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">puid</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">limit</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">offset</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L564"></a><tt class="py-lineno"> 564</tt> <tt class="py-line"> <tt class="py-param">query</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TrackFilter.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="TrackFilter.__init__-expanded"><a name="L565"></a><tt class="py-lineno"> 565</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt>
<a name="L566"></a><tt class="py-lineno"> 566</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L567"></a><tt class="py-lineno"> 567</tt> <tt class="py-line"><tt class="py-docstring"> If C{artistId}, C{releaseId} or C{puid} are set, only tracks</tt> </tt>
<a name="L568"></a><tt class="py-lineno"> 568</tt> <tt class="py-line"><tt class="py-docstring"> matching those IDs are returned.</tt> </tt>
<a name="L569"></a><tt class="py-lineno"> 569</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L570"></a><tt class="py-lineno"> 570</tt> <tt class="py-line"><tt class="py-docstring"> The server will ignore C{artistName} and C{releaseTitle} if</tt> </tt>
<a name="L571"></a><tt class="py-lineno"> 571</tt> <tt class="py-line"><tt class="py-docstring"> C{artistId} or ${releaseId} are set respectively.</tt> </tt>
<a name="L572"></a><tt class="py-lineno"> 572</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L573"></a><tt class="py-lineno"> 573</tt> <tt class="py-line"><tt class="py-docstring"> The C{query} parameter may contain a query in U{Lucene syntax</tt> </tt>
<a name="L574"></a><tt class="py-lineno"> 574</tt> <tt class="py-line"><tt class="py-docstring"> <http://lucene.apache.org/java/docs/queryparsersyntax.html>}.</tt> </tt>
<a name="L575"></a><tt class="py-lineno"> 575</tt> <tt class="py-line"><tt class="py-docstring"> Note that C{query} may not be used together with the other</tt> </tt>
<a name="L576"></a><tt class="py-lineno"> 576</tt> <tt class="py-line"><tt class="py-docstring"> parameters except for C{limit} and C{offset}.</tt> </tt>
<a name="L577"></a><tt class="py-lineno"> 577</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L578"></a><tt class="py-lineno"> 578</tt> <tt class="py-line"><tt class="py-docstring"> @param title: a unicode string containing the track's title</tt> </tt>
<a name="L579"></a><tt class="py-lineno"> 579</tt> <tt class="py-line"><tt class="py-docstring"> @param artistName: a unicode string containing the artist's name</tt> </tt>
<a name="L580"></a><tt class="py-lineno"> 580</tt> <tt class="py-line"><tt class="py-docstring"> @param artistId: a string containing the artist's ID</tt> </tt>
<a name="L581"></a><tt class="py-lineno"> 581</tt> <tt class="py-line"><tt class="py-docstring"> @param releaseTitle: a unicode string containing the release's title</tt> </tt>
<a name="L582"></a><tt class="py-lineno"> 582</tt> <tt class="py-line"><tt class="py-docstring"> @param releaseId: a string containing the release's title</tt> </tt>
<a name="L583"></a><tt class="py-lineno"> 583</tt> <tt class="py-line"><tt class="py-docstring"> @param duration: the track's length in milliseconds</tt> </tt>
<a name="L584"></a><tt class="py-lineno"> 584</tt> <tt class="py-line"><tt class="py-docstring"> @param puid: a string containing a PUID</tt> </tt>
<a name="L585"></a><tt class="py-lineno"> 585</tt> <tt class="py-line"><tt class="py-docstring"> @param limit: the maximum number of releases to return</tt> </tt>
<a name="L586"></a><tt class="py-lineno"> 586</tt> <tt class="py-line"><tt class="py-docstring"> @param offset: start results at this zero-based offset</tt> </tt>
<a name="L587"></a><tt class="py-lineno"> 587</tt> <tt class="py-line"><tt class="py-docstring"> @param query: a string containing a query in Lucene syntax</tt> </tt>
<a name="L588"></a><tt class="py-lineno"> 588</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L589"></a><tt class="py-lineno"> 589</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_params</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> </tt>
<a name="L590"></a><tt class="py-lineno"> 590</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'title'</tt><tt class="py-op">,</tt> <tt id="link-42" class="py-name"><a title="musicbrainz2.model.Release.title
musicbrainz2.model.ReleaseGroup.title
musicbrainz2.model.Track.title" class="py-name" href="#" onclick="return doclink('link-42', 'title', 'link-37');">title</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L591"></a><tt class="py-lineno"> 591</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'artist'</tt><tt class="py-op">,</tt> <tt class="py-name">artistName</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L592"></a><tt class="py-lineno"> 592</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'artistid'</tt><tt class="py-op">,</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-43" class="py-name"><a title="musicbrainz2.utils.extractUuid" class="py-name" href="#" onclick="return doclink('link-43', 'extractUuid', 'link-38');">extractUuid</a></tt><tt class="py-op">(</tt><tt class="py-name">artistId</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L593"></a><tt class="py-lineno"> 593</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'release'</tt><tt class="py-op">,</tt> <tt class="py-name">releaseTitle</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L594"></a><tt class="py-lineno"> 594</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'releaseid'</tt><tt class="py-op">,</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-44" class="py-name"><a title="musicbrainz2.utils.extractUuid" class="py-name" href="#" onclick="return doclink('link-44', 'extractUuid', 'link-38');">extractUuid</a></tt><tt class="py-op">(</tt><tt class="py-name">releaseId</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L595"></a><tt class="py-lineno"> 595</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'duration'</tt><tt class="py-op">,</tt> <tt id="link-45" class="py-name" targets="Variable musicbrainz2.model.Track.duration=musicbrainz2.model.Track-class.html#duration"><a title="musicbrainz2.model.Track.duration" class="py-name" href="#" onclick="return doclink('link-45', 'duration', 'link-45');">duration</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L596"></a><tt class="py-lineno"> 596</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'puid'</tt><tt class="py-op">,</tt> <tt class="py-name">puid</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L597"></a><tt class="py-lineno"> 597</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'limit'</tt><tt class="py-op">,</tt> <tt class="py-name">limit</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L598"></a><tt class="py-lineno"> 598</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'offset'</tt><tt class="py-op">,</tt> <tt class="py-name">offset</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L599"></a><tt class="py-lineno"> 599</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'query'</tt><tt class="py-op">,</tt> <tt class="py-name">query</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L600"></a><tt class="py-lineno"> 600</tt> <tt class="py-line"> <tt class="py-op">]</tt> </tt>
<a name="L601"></a><tt class="py-lineno"> 601</tt> <tt class="py-line"> </tt>
<a name="L602"></a><tt class="py-lineno"> 602</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">_paramsValid</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_params</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L603"></a><tt class="py-lineno"> 603</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'invalid combination of parameters'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L604"></a><tt class="py-lineno"> 604</tt> <tt class="py-line"> </tt>
<a name="TrackFilter.createParameters"></a><div id="TrackFilter.createParameters-def"><a name="L605"></a><tt class="py-lineno"> 605</tt> <a class="py-toggle" href="#" id="TrackFilter.createParameters-toggle" onclick="return toggle('TrackFilter.createParameters');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.TrackFilter-class.html#createParameters">createParameters</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TrackFilter.createParameters-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="TrackFilter.createParameters-expanded"><a name="L606"></a><tt class="py-lineno"> 606</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">_createParameters</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_params</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L607"></a><tt class="py-lineno"> 607</tt> <tt class="py-line"> </tt>
<a name="L608"></a><tt class="py-lineno"> 608</tt> <tt class="py-line"> </tt>
<a name="UserFilter"></a><div id="UserFilter-def"><a name="L609"></a><tt class="py-lineno"> 609</tt> <a class="py-toggle" href="#" id="UserFilter-toggle" onclick="return toggle('UserFilter');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.UserFilter-class.html">UserFilter</a><tt class="py-op">(</tt><tt class="py-base-class">IFilter</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="UserFilter-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="UserFilter-expanded"><a name="L610"></a><tt class="py-lineno"> 610</tt> <tt class="py-line"> <tt class="py-docstring">"""A filter for the user collection."""</tt> </tt>
<a name="L611"></a><tt class="py-lineno"> 611</tt> <tt class="py-line"> </tt>
<a name="UserFilter.__init__"></a><div id="UserFilter.__init__-def"><a name="L612"></a><tt class="py-lineno"> 612</tt> <a class="py-toggle" href="#" id="UserFilter.__init__-toggle" onclick="return toggle('UserFilter.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.UserFilter-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="UserFilter.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="UserFilter.__init__-expanded"><a name="L613"></a><tt class="py-lineno"> 613</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt>
<a name="L614"></a><tt class="py-lineno"> 614</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L615"></a><tt class="py-lineno"> 615</tt> <tt class="py-line"><tt class="py-docstring"> @param name: a unicode string containing a MusicBrainz user name</tt> </tt>
<a name="L616"></a><tt class="py-lineno"> 616</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L617"></a><tt class="py-lineno"> 617</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_name</tt> <tt class="py-op">=</tt> <tt id="link-46" class="py-name"><a title="musicbrainz2.model.Artist.name
musicbrainz2.model.Label.name
musicbrainz2.model.User.name" class="py-name" href="#" onclick="return doclink('link-46', 'name', 'link-34');">name</a></tt> </tt>
</div><a name="L618"></a><tt class="py-lineno"> 618</tt> <tt class="py-line"> </tt>
<a name="UserFilter.createParameters"></a><div id="UserFilter.createParameters-def"><a name="L619"></a><tt class="py-lineno"> 619</tt> <a class="py-toggle" href="#" id="UserFilter.createParameters-toggle" onclick="return toggle('UserFilter.createParameters');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.UserFilter-class.html#createParameters">createParameters</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="UserFilter.createParameters-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="UserFilter.createParameters-expanded"><a name="L620"></a><tt class="py-lineno"> 620</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_name</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L621"></a><tt class="py-lineno"> 621</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt> <tt class="py-op">(</tt><tt class="py-string">'name'</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_name</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-string">'utf-8'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-op">]</tt> </tt>
<a name="L622"></a><tt class="py-lineno"> 622</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L623"></a><tt class="py-lineno"> 623</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt> <tt class="py-op">]</tt> </tt>
</div></div><a name="L624"></a><tt class="py-lineno"> 624</tt> <tt class="py-line"> </tt>
<a name="L625"></a><tt class="py-lineno"> 625</tt> <tt class="py-line"> </tt>
<a name="IIncludes"></a><div id="IIncludes-def"><a name="L626"></a><tt class="py-lineno"> 626</tt> <a class="py-toggle" href="#" id="IIncludes-toggle" onclick="return toggle('IIncludes');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.IIncludes-class.html">IIncludes</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IIncludes-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="IIncludes-expanded"><a name="L627"></a><tt class="py-lineno"> 627</tt> <tt class="py-line"> <tt class="py-docstring">"""An interface implemented by include tag generators."""</tt> </tt>
<a name="IIncludes.createIncludeTags"></a><div id="IIncludes.createIncludeTags-def"><a name="L628"></a><tt class="py-lineno"> 628</tt> <a class="py-toggle" href="#" id="IIncludes.createIncludeTags-toggle" onclick="return toggle('IIncludes.createIncludeTags');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.IIncludes-class.html#createIncludeTags">createIncludeTags</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IIncludes.createIncludeTags-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="IIncludes.createIncludeTags-expanded"><a name="L629"></a><tt class="py-lineno"> 629</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L630"></a><tt class="py-lineno"> 630</tt> <tt class="py-line"> </tt>
<a name="L631"></a><tt class="py-lineno"> 631</tt> <tt class="py-line"> </tt>
<a name="ArtistIncludes"></a><div id="ArtistIncludes-def"><a name="L632"></a><tt class="py-lineno"> 632</tt> <a class="py-toggle" href="#" id="ArtistIncludes-toggle" onclick="return toggle('ArtistIncludes');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.ArtistIncludes-class.html">ArtistIncludes</a><tt class="py-op">(</tt><tt class="py-base-class">IIncludes</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ArtistIncludes-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ArtistIncludes-expanded"><a name="L633"></a><tt class="py-lineno"> 633</tt> <tt class="py-line"> <tt class="py-docstring">"""A specification on how much data to return with an artist.</tt> </tt>
<a name="L634"></a><tt class="py-lineno"> 634</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L635"></a><tt class="py-lineno"> 635</tt> <tt class="py-line"><tt class="py-docstring"> Example:</tt> </tt>
<a name="L636"></a><tt class="py-lineno"> 636</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L637"></a><tt class="py-lineno"> 637</tt> <tt class="py-line"><tt class="py-docstring"> >>> from musicbrainz2.model import Release</tt> </tt>
<a name="L638"></a><tt class="py-lineno"> 638</tt> <tt class="py-line"><tt class="py-docstring"> >>> from musicbrainz2.webservice import ArtistIncludes</tt> </tt>
<a name="L639"></a><tt class="py-lineno"> 639</tt> <tt class="py-line"><tt class="py-docstring"> >>> inc = ArtistIncludes(artistRelations=True, releaseRelations=True,</tt> </tt>
<a name="L640"></a><tt class="py-lineno"> 640</tt> <tt class="py-line"><tt class="py-docstring"> ... releases=(Release.TYPE_ALBUM, Release.TYPE_OFFICIAL))</tt> </tt>
<a name="L641"></a><tt class="py-lineno"> 641</tt> <tt class="py-line"><tt class="py-docstring"> >>></tt> </tt>
<a name="L642"></a><tt class="py-lineno"> 642</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L643"></a><tt class="py-lineno"> 643</tt> <tt class="py-line"><tt class="py-docstring"> The MusicBrainz server only supports some combinations of release</tt> </tt>
<a name="L644"></a><tt class="py-lineno"> 644</tt> <tt class="py-line"><tt class="py-docstring"> types for the C{releases} and C{vaReleases} include tags. At the</tt> </tt>
<a name="L645"></a><tt class="py-lineno"> 645</tt> <tt class="py-line"><tt class="py-docstring"> moment, not more than two release types should be selected, while</tt> </tt>
<a name="L646"></a><tt class="py-lineno"> 646</tt> <tt class="py-line"><tt class="py-docstring"> one of them has to be C{Release.TYPE_OFFICIAL},</tt> </tt>
<a name="L647"></a><tt class="py-lineno"> 647</tt> <tt class="py-line"><tt class="py-docstring"> C{Release.TYPE_PROMOTION} or C{Release.TYPE_BOOTLEG}.</tt> </tt>
<a name="L648"></a><tt class="py-lineno"> 648</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L649"></a><tt class="py-lineno"> 649</tt> <tt class="py-line"><tt class="py-docstring"> @note: Only one of C{releases} and C{vaReleases} may be given.</tt> </tt>
<a name="L650"></a><tt class="py-lineno"> 650</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="ArtistIncludes.__init__"></a><div id="ArtistIncludes.__init__-def"><a name="L651"></a><tt class="py-lineno"> 651</tt> <a class="py-toggle" href="#" id="ArtistIncludes.__init__-toggle" onclick="return toggle('ArtistIncludes.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.ArtistIncludes-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">aliases</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">releases</tt><tt class="py-op">=</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-param">vaReleases</tt><tt class="py-op">=</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L652"></a><tt class="py-lineno"> 652</tt> <tt class="py-line"> <tt class="py-param">artistRelations</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">releaseRelations</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L653"></a><tt class="py-lineno"> 653</tt> <tt class="py-line"> <tt class="py-param">trackRelations</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">urlRelations</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">tags</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L654"></a><tt class="py-lineno"> 654</tt> <tt class="py-line"> <tt class="py-param">ratings</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">releaseGroups</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ArtistIncludes.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="ArtistIncludes.__init__-expanded"><a name="L655"></a><tt class="py-lineno"> 655</tt> <tt class="py-line"> </tt>
<a name="L656"></a><tt class="py-lineno"> 656</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-47" class="py-name" targets="Variable musicbrainz2.model.Artist.releases=musicbrainz2.model.Artist-class.html#releases,Variable musicbrainz2.model.ReleaseGroup.releases=musicbrainz2.model.ReleaseGroup-class.html#releases,Variable musicbrainz2.model.Track.releases=musicbrainz2.model.Track-class.html#releases"><a title="musicbrainz2.model.Artist.releases
musicbrainz2.model.ReleaseGroup.releases
musicbrainz2.model.Track.releases" class="py-name" href="#" onclick="return doclink('link-47', 'releases', 'link-47');">releases</a></tt><tt class="py-op">,</tt> <tt class="py-name">basestring</tt><tt class="py-op">)</tt> </tt>
<a name="L657"></a><tt class="py-lineno"> 657</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">vaReleases</tt><tt class="py-op">,</tt> <tt class="py-name">basestring</tt><tt class="py-op">)</tt> </tt>
<a name="L658"></a><tt class="py-lineno"> 658</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-48" class="py-name"><a title="musicbrainz2.model.Artist.releases
musicbrainz2.model.ReleaseGroup.releases
musicbrainz2.model.Track.releases" class="py-name" href="#" onclick="return doclink('link-48', 'releases', 'link-47');">releases</a></tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt> <tt class="py-keyword">or</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">vaReleases</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt> </tt>
<a name="L659"></a><tt class="py-lineno"> 659</tt> <tt class="py-line"> </tt>
<a name="L660"></a><tt class="py-lineno"> 660</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_includes</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L661"></a><tt class="py-lineno"> 661</tt> <tt class="py-line"> <tt class="py-string">'aliases'</tt><tt class="py-op">:</tt> <tt id="link-49" class="py-name" targets="Variable musicbrainz2.model.Artist.aliases=musicbrainz2.model.Artist-class.html#aliases,Variable musicbrainz2.model.Label.aliases=musicbrainz2.model.Label-class.html#aliases"><a title="musicbrainz2.model.Artist.aliases
musicbrainz2.model.Label.aliases" class="py-name" href="#" onclick="return doclink('link-49', 'aliases', 'link-49');">aliases</a></tt><tt class="py-op">,</tt> </tt>
<a name="L662"></a><tt class="py-lineno"> 662</tt> <tt class="py-line"> <tt class="py-string">'artist-rels'</tt><tt class="py-op">:</tt> <tt class="py-name">artistRelations</tt><tt class="py-op">,</tt> </tt>
<a name="L663"></a><tt class="py-lineno"> 663</tt> <tt class="py-line"> <tt class="py-string">'release-groups'</tt><tt class="py-op">:</tt> <tt id="link-50" class="py-name" targets="Variable musicbrainz2.model.Artist.releaseGroups=musicbrainz2.model.Artist-class.html#releaseGroups"><a title="musicbrainz2.model.Artist.releaseGroups" class="py-name" href="#" onclick="return doclink('link-50', 'releaseGroups', 'link-50');">releaseGroups</a></tt><tt class="py-op">,</tt> </tt>
<a name="L664"></a><tt class="py-lineno"> 664</tt> <tt class="py-line"> <tt class="py-string">'release-rels'</tt><tt class="py-op">:</tt> <tt class="py-name">releaseRelations</tt><tt class="py-op">,</tt> </tt>
<a name="L665"></a><tt class="py-lineno"> 665</tt> <tt class="py-line"> <tt class="py-string">'track-rels'</tt><tt class="py-op">:</tt> <tt class="py-name">trackRelations</tt><tt class="py-op">,</tt> </tt>
<a name="L666"></a><tt class="py-lineno"> 666</tt> <tt class="py-line"> <tt class="py-string">'url-rels'</tt><tt class="py-op">:</tt> <tt class="py-name">urlRelations</tt><tt class="py-op">,</tt> </tt>
<a name="L667"></a><tt class="py-lineno"> 667</tt> <tt class="py-line"> <tt class="py-string">'tags'</tt><tt class="py-op">:</tt> <tt id="link-51" class="py-name" targets="Variable musicbrainz2.model.Entity.tags=musicbrainz2.model.Entity-class.html#tags"><a title="musicbrainz2.model.Entity.tags" class="py-name" href="#" onclick="return doclink('link-51', 'tags', 'link-51');">tags</a></tt><tt class="py-op">,</tt> </tt>
<a name="L668"></a><tt class="py-lineno"> 668</tt> <tt class="py-line"> <tt class="py-string">'ratings'</tt><tt class="py-op">:</tt> <tt class="py-name">ratings</tt><tt class="py-op">,</tt> </tt>
<a name="L669"></a><tt class="py-lineno"> 669</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
<a name="L670"></a><tt class="py-lineno"> 670</tt> <tt class="py-line"> </tt>
<a name="L671"></a><tt class="py-lineno"> 671</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">elem</tt> <tt class="py-keyword">in</tt> <tt id="link-52" class="py-name"><a title="musicbrainz2.model.Artist.releases
musicbrainz2.model.ReleaseGroup.releases
musicbrainz2.model.Track.releases" class="py-name" href="#" onclick="return doclink('link-52', 'releases', 'link-47');">releases</a></tt><tt class="py-op">:</tt> </tt>
<a name="L672"></a><tt class="py-lineno"> 672</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_includes</tt><tt class="py-op">[</tt><tt class="py-string">'sa-'</tt> <tt class="py-op">+</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-53" class="py-name"><a title="musicbrainz2.utils.extractFragment" class="py-name" href="#" onclick="return doclink('link-53', 'extractFragment', 'link-36');">extractFragment</a></tt><tt class="py-op">(</tt><tt class="py-name">elem</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L673"></a><tt class="py-lineno"> 673</tt> <tt class="py-line"> </tt>
<a name="L674"></a><tt class="py-lineno"> 674</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">elem</tt> <tt class="py-keyword">in</tt> <tt class="py-name">vaReleases</tt><tt class="py-op">:</tt> </tt>
<a name="L675"></a><tt class="py-lineno"> 675</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_includes</tt><tt class="py-op">[</tt><tt class="py-string">'va-'</tt> <tt class="py-op">+</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-54" class="py-name"><a title="musicbrainz2.utils.extractFragment" class="py-name" href="#" onclick="return doclink('link-54', 'extractFragment', 'link-36');">extractFragment</a></tt><tt class="py-op">(</tt><tt class="py-name">elem</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
</div><a name="L676"></a><tt class="py-lineno"> 676</tt> <tt class="py-line"> </tt>
<a name="ArtistIncludes.createIncludeTags"></a><div id="ArtistIncludes.createIncludeTags-def"><a name="L677"></a><tt class="py-lineno"> 677</tt> <a class="py-toggle" href="#" id="ArtistIncludes.createIncludeTags-toggle" onclick="return toggle('ArtistIncludes.createIncludeTags');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.ArtistIncludes-class.html#createIncludeTags">createIncludeTags</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ArtistIncludes.createIncludeTags-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="ArtistIncludes.createIncludeTags-expanded"><a name="L678"></a><tt class="py-lineno"> 678</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">_createIncludes</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_includes</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L679"></a><tt class="py-lineno"> 679</tt> <tt class="py-line"> </tt>
<a name="L680"></a><tt class="py-lineno"> 680</tt> <tt class="py-line"> </tt>
<a name="ReleaseIncludes"></a><div id="ReleaseIncludes-def"><a name="L681"></a><tt class="py-lineno"> 681</tt> <a class="py-toggle" href="#" id="ReleaseIncludes-toggle" onclick="return toggle('ReleaseIncludes');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.ReleaseIncludes-class.html">ReleaseIncludes</a><tt class="py-op">(</tt><tt class="py-base-class">IIncludes</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReleaseIncludes-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ReleaseIncludes-expanded"><a name="L682"></a><tt class="py-lineno"> 682</tt> <tt class="py-line"> <tt class="py-docstring">"""A specification on how much data to return with a release."""</tt> </tt>
<a name="ReleaseIncludes.__init__"></a><div id="ReleaseIncludes.__init__-def"><a name="L683"></a><tt class="py-lineno"> 683</tt> <a class="py-toggle" href="#" id="ReleaseIncludes.__init__-toggle" onclick="return toggle('ReleaseIncludes.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.ReleaseIncludes-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">artist</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">counts</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">releaseEvents</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L684"></a><tt class="py-lineno"> 684</tt> <tt class="py-line"> <tt class="py-param">discs</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">tracks</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L685"></a><tt class="py-lineno"> 685</tt> <tt class="py-line"> <tt class="py-param">artistRelations</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">releaseRelations</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L686"></a><tt class="py-lineno"> 686</tt> <tt class="py-line"> <tt class="py-param">trackRelations</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">urlRelations</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L687"></a><tt class="py-lineno"> 687</tt> <tt class="py-line"> <tt class="py-param">labels</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">tags</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">ratings</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">isrcs</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L688"></a><tt class="py-lineno"> 688</tt> <tt class="py-line"> <tt class="py-param">releaseGroup</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReleaseIncludes.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="ReleaseIncludes.__init__-expanded"><a name="L689"></a><tt class="py-lineno"> 689</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_includes</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L690"></a><tt class="py-lineno"> 690</tt> <tt class="py-line"> <tt class="py-string">'artist'</tt><tt class="py-op">:</tt> <tt id="link-55" class="py-name" targets="Variable musicbrainz2.model.Release.artist=musicbrainz2.model.Release-class.html#artist,Variable musicbrainz2.model.ReleaseGroup.artist=musicbrainz2.model.ReleaseGroup-class.html#artist,Variable musicbrainz2.model.Track.artist=musicbrainz2.model.Track-class.html#artist,Variable musicbrainz2.wsxml.ArtistResult.artist=musicbrainz2.wsxml.ArtistResult-class.html#artist,Variable musicbrainz2.wsxml.Metadata.artist=musicbrainz2.wsxml.Metadata-class.html#artist"><a title="musicbrainz2.model.Release.artist
musicbrainz2.model.ReleaseGroup.artist
musicbrainz2.model.Track.artist
musicbrainz2.wsxml.ArtistResult.artist
musicbrainz2.wsxml.Metadata.artist" class="py-name" href="#" onclick="return doclink('link-55', 'artist', 'link-55');">artist</a></tt><tt class="py-op">,</tt> </tt>
<a name="L691"></a><tt class="py-lineno"> 691</tt> <tt class="py-line"> <tt class="py-string">'counts'</tt><tt class="py-op">:</tt> <tt class="py-name">counts</tt><tt class="py-op">,</tt> </tt>
<a name="L692"></a><tt class="py-lineno"> 692</tt> <tt class="py-line"> <tt class="py-string">'labels'</tt><tt class="py-op">:</tt> <tt class="py-name">labels</tt><tt class="py-op">,</tt> </tt>
<a name="L693"></a><tt class="py-lineno"> 693</tt> <tt class="py-line"> <tt class="py-string">'release-groups'</tt><tt class="py-op">:</tt> <tt id="link-56" class="py-name" targets="Variable musicbrainz2.model.Release.releaseGroup=musicbrainz2.model.Release-class.html#releaseGroup,Variable musicbrainz2.wsxml.Metadata.releaseGroup=musicbrainz2.wsxml.Metadata-class.html#releaseGroup,Variable musicbrainz2.wsxml.ReleaseGroupResult.releaseGroup=musicbrainz2.wsxml.ReleaseGroupResult-class.html#releaseGroup"><a title="musicbrainz2.model.Release.releaseGroup
musicbrainz2.wsxml.Metadata.releaseGroup
musicbrainz2.wsxml.ReleaseGroupResult.releaseGroup" class="py-name" href="#" onclick="return doclink('link-56', 'releaseGroup', 'link-56');">releaseGroup</a></tt><tt class="py-op">,</tt> </tt>
<a name="L694"></a><tt class="py-lineno"> 694</tt> <tt class="py-line"> <tt class="py-string">'release-events'</tt><tt class="py-op">:</tt> <tt id="link-57" class="py-name" targets="Variable musicbrainz2.model.Release.releaseEvents=musicbrainz2.model.Release-class.html#releaseEvents"><a title="musicbrainz2.model.Release.releaseEvents" class="py-name" href="#" onclick="return doclink('link-57', 'releaseEvents', 'link-57');">releaseEvents</a></tt><tt class="py-op">,</tt> </tt>
<a name="L695"></a><tt class="py-lineno"> 695</tt> <tt class="py-line"> <tt class="py-string">'discs'</tt><tt class="py-op">:</tt> <tt id="link-58" class="py-name" targets="Variable musicbrainz2.model.Release.discs=musicbrainz2.model.Release-class.html#discs"><a title="musicbrainz2.model.Release.discs" class="py-name" href="#" onclick="return doclink('link-58', 'discs', 'link-58');">discs</a></tt><tt class="py-op">,</tt> </tt>
<a name="L696"></a><tt class="py-lineno"> 696</tt> <tt class="py-line"> <tt class="py-string">'tracks'</tt><tt class="py-op">:</tt> <tt id="link-59" class="py-name" targets="Variable musicbrainz2.model.Disc.tracks=musicbrainz2.model.Disc-class.html#tracks,Variable musicbrainz2.model.Release.tracks=musicbrainz2.model.Release-class.html#tracks"><a title="musicbrainz2.model.Disc.tracks
musicbrainz2.model.Release.tracks" class="py-name" href="#" onclick="return doclink('link-59', 'tracks', 'link-59');">tracks</a></tt><tt class="py-op">,</tt> </tt>
<a name="L697"></a><tt class="py-lineno"> 697</tt> <tt class="py-line"> <tt class="py-string">'artist-rels'</tt><tt class="py-op">:</tt> <tt class="py-name">artistRelations</tt><tt class="py-op">,</tt> </tt>
<a name="L698"></a><tt class="py-lineno"> 698</tt> <tt class="py-line"> <tt class="py-string">'release-rels'</tt><tt class="py-op">:</tt> <tt class="py-name">releaseRelations</tt><tt class="py-op">,</tt> </tt>
<a name="L699"></a><tt class="py-lineno"> 699</tt> <tt class="py-line"> <tt class="py-string">'track-rels'</tt><tt class="py-op">:</tt> <tt class="py-name">trackRelations</tt><tt class="py-op">,</tt> </tt>
<a name="L700"></a><tt class="py-lineno"> 700</tt> <tt class="py-line"> <tt class="py-string">'url-rels'</tt><tt class="py-op">:</tt> <tt class="py-name">urlRelations</tt><tt class="py-op">,</tt> </tt>
<a name="L701"></a><tt class="py-lineno"> 701</tt> <tt class="py-line"> <tt class="py-string">'tags'</tt><tt class="py-op">:</tt> <tt id="link-60" class="py-name"><a title="musicbrainz2.model.Entity.tags" class="py-name" href="#" onclick="return doclink('link-60', 'tags', 'link-51');">tags</a></tt><tt class="py-op">,</tt> </tt>
<a name="L702"></a><tt class="py-lineno"> 702</tt> <tt class="py-line"> <tt class="py-string">'ratings'</tt><tt class="py-op">:</tt> <tt class="py-name">ratings</tt><tt class="py-op">,</tt> </tt>
<a name="L703"></a><tt class="py-lineno"> 703</tt> <tt class="py-line"> <tt class="py-string">'isrcs'</tt><tt class="py-op">:</tt> <tt id="link-61" class="py-name" targets="Variable musicbrainz2.model.Track.isrcs=musicbrainz2.model.Track-class.html#isrcs"><a title="musicbrainz2.model.Track.isrcs" class="py-name" href="#" onclick="return doclink('link-61', 'isrcs', 'link-61');">isrcs</a></tt><tt class="py-op">,</tt> </tt>
<a name="L704"></a><tt class="py-lineno"> 704</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
<a name="L705"></a><tt class="py-lineno"> 705</tt> <tt class="py-line"> </tt>
<a name="L706"></a><tt class="py-lineno"> 706</tt> <tt class="py-line"> <tt class="py-comment"># Requesting labels without releaseEvents makes no sense,</tt> </tt>
<a name="L707"></a><tt class="py-lineno"> 707</tt> <tt class="py-line"> <tt class="py-comment"># so we pull in releaseEvents, if necessary.</tt> </tt>
<a name="L708"></a><tt class="py-lineno"> 708</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">labels</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt id="link-62" class="py-name"><a title="musicbrainz2.model.Release.releaseEvents" class="py-name" href="#" onclick="return doclink('link-62', 'releaseEvents', 'link-57');">releaseEvents</a></tt><tt class="py-op">:</tt> </tt>
<a name="L709"></a><tt class="py-lineno"> 709</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_includes</tt><tt class="py-op">[</tt><tt class="py-string">'release-events'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L710"></a><tt class="py-lineno"> 710</tt> <tt class="py-line"> <tt class="py-comment"># Ditto for isrcs with no tracks</tt> </tt>
<a name="L711"></a><tt class="py-lineno"> 711</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-63" class="py-name"><a title="musicbrainz2.model.Track.isrcs" class="py-name" href="#" onclick="return doclink('link-63', 'isrcs', 'link-61');">isrcs</a></tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt id="link-64" class="py-name"><a title="musicbrainz2.model.Disc.tracks
musicbrainz2.model.Release.tracks" class="py-name" href="#" onclick="return doclink('link-64', 'tracks', 'link-59');">tracks</a></tt><tt class="py-op">:</tt> </tt>
<a name="L712"></a><tt class="py-lineno"> 712</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_includes</tt><tt class="py-op">[</tt><tt class="py-string">'tracks'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
</div><a name="L713"></a><tt class="py-lineno"> 713</tt> <tt class="py-line"> </tt>
<a name="ReleaseIncludes.createIncludeTags"></a><div id="ReleaseIncludes.createIncludeTags-def"><a name="L714"></a><tt class="py-lineno"> 714</tt> <a class="py-toggle" href="#" id="ReleaseIncludes.createIncludeTags-toggle" onclick="return toggle('ReleaseIncludes.createIncludeTags');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.ReleaseIncludes-class.html#createIncludeTags">createIncludeTags</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReleaseIncludes.createIncludeTags-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="ReleaseIncludes.createIncludeTags-expanded"><a name="L715"></a><tt class="py-lineno"> 715</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">_createIncludes</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_includes</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L716"></a><tt class="py-lineno"> 716</tt> <tt class="py-line"> </tt>
<a name="L717"></a><tt class="py-lineno"> 717</tt> <tt class="py-line"> </tt>
<a name="ReleaseGroupIncludes"></a><div id="ReleaseGroupIncludes-def"><a name="L718"></a><tt class="py-lineno"> 718</tt> <a class="py-toggle" href="#" id="ReleaseGroupIncludes-toggle" onclick="return toggle('ReleaseGroupIncludes');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.ReleaseGroupIncludes-class.html">ReleaseGroupIncludes</a><tt class="py-op">(</tt><tt class="py-base-class">IIncludes</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReleaseGroupIncludes-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ReleaseGroupIncludes-expanded"><a name="L719"></a><tt class="py-lineno"> 719</tt> <tt class="py-line"> <tt class="py-docstring">"""A specification on how much data to return with a release group."""</tt> </tt>
<a name="L720"></a><tt class="py-lineno"> 720</tt> <tt class="py-line"> </tt>
<a name="ReleaseGroupIncludes.__init__"></a><div id="ReleaseGroupIncludes.__init__-def"><a name="L721"></a><tt class="py-lineno"> 721</tt> <a class="py-toggle" href="#" id="ReleaseGroupIncludes.__init__-toggle" onclick="return toggle('ReleaseGroupIncludes.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.ReleaseGroupIncludes-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">artist</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">releases</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">tags</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReleaseGroupIncludes.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="ReleaseGroupIncludes.__init__-expanded"><a name="L722"></a><tt class="py-lineno"> 722</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt>
<a name="L723"></a><tt class="py-lineno"> 723</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L724"></a><tt class="py-lineno"> 724</tt> <tt class="py-line"><tt class="py-docstring"> @param artist: Whether to include the release group's main artist info.</tt> </tt>
<a name="L725"></a><tt class="py-lineno"> 725</tt> <tt class="py-line"><tt class="py-docstring"> @param releases: Whether to include the release group's releases.</tt> </tt>
<a name="L726"></a><tt class="py-lineno"> 726</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L727"></a><tt class="py-lineno"> 727</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_includes</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L728"></a><tt class="py-lineno"> 728</tt> <tt class="py-line"> <tt class="py-string">'artist'</tt><tt class="py-op">:</tt> <tt id="link-65" class="py-name"><a title="musicbrainz2.model.Release.artist
musicbrainz2.model.ReleaseGroup.artist
musicbrainz2.model.Track.artist
musicbrainz2.wsxml.ArtistResult.artist
musicbrainz2.wsxml.Metadata.artist" class="py-name" href="#" onclick="return doclink('link-65', 'artist', 'link-55');">artist</a></tt><tt class="py-op">,</tt> </tt>
<a name="L729"></a><tt class="py-lineno"> 729</tt> <tt class="py-line"> <tt class="py-string">'releases'</tt><tt class="py-op">:</tt> <tt id="link-66" class="py-name"><a title="musicbrainz2.model.Artist.releases
musicbrainz2.model.ReleaseGroup.releases
musicbrainz2.model.Track.releases" class="py-name" href="#" onclick="return doclink('link-66', 'releases', 'link-47');">releases</a></tt><tt class="py-op">,</tt> </tt>
<a name="L730"></a><tt class="py-lineno"> 730</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
</div><a name="L731"></a><tt class="py-lineno"> 731</tt> <tt class="py-line"> </tt>
<a name="ReleaseGroupIncludes.createIncludeTags"></a><div id="ReleaseGroupIncludes.createIncludeTags-def"><a name="L732"></a><tt class="py-lineno"> 732</tt> <a class="py-toggle" href="#" id="ReleaseGroupIncludes.createIncludeTags-toggle" onclick="return toggle('ReleaseGroupIncludes.createIncludeTags');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.ReleaseGroupIncludes-class.html#createIncludeTags">createIncludeTags</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReleaseGroupIncludes.createIncludeTags-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="ReleaseGroupIncludes.createIncludeTags-expanded"><a name="L733"></a><tt class="py-lineno"> 733</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">_createIncludes</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_includes</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L734"></a><tt class="py-lineno"> 734</tt> <tt class="py-line"> </tt>
<a name="L735"></a><tt class="py-lineno"> 735</tt> <tt class="py-line"> </tt>
<a name="TrackIncludes"></a><div id="TrackIncludes-def"><a name="L736"></a><tt class="py-lineno"> 736</tt> <a class="py-toggle" href="#" id="TrackIncludes-toggle" onclick="return toggle('TrackIncludes');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.TrackIncludes-class.html">TrackIncludes</a><tt class="py-op">(</tt><tt class="py-base-class">IIncludes</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TrackIncludes-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="TrackIncludes-expanded"><a name="L737"></a><tt class="py-lineno"> 737</tt> <tt class="py-line"> <tt class="py-docstring">"""A specification on how much data to return with a track."""</tt> </tt>
<a name="TrackIncludes.__init__"></a><div id="TrackIncludes.__init__-def"><a name="L738"></a><tt class="py-lineno"> 738</tt> <a class="py-toggle" href="#" id="TrackIncludes.__init__-toggle" onclick="return toggle('TrackIncludes.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.TrackIncludes-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">artist</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">releases</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">puids</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L739"></a><tt class="py-lineno"> 739</tt> <tt class="py-line"> <tt class="py-param">artistRelations</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">releaseRelations</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L740"></a><tt class="py-lineno"> 740</tt> <tt class="py-line"> <tt class="py-param">trackRelations</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">urlRelations</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">tags</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L741"></a><tt class="py-lineno"> 741</tt> <tt class="py-line"> <tt class="py-param">ratings</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">isrcs</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TrackIncludes.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="TrackIncludes.__init__-expanded"><a name="L742"></a><tt class="py-lineno"> 742</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_includes</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L743"></a><tt class="py-lineno"> 743</tt> <tt class="py-line"> <tt class="py-string">'artist'</tt><tt class="py-op">:</tt> <tt id="link-67" class="py-name"><a title="musicbrainz2.model.Release.artist
musicbrainz2.model.ReleaseGroup.artist
musicbrainz2.model.Track.artist
musicbrainz2.wsxml.ArtistResult.artist
musicbrainz2.wsxml.Metadata.artist" class="py-name" href="#" onclick="return doclink('link-67', 'artist', 'link-55');">artist</a></tt><tt class="py-op">,</tt> </tt>
<a name="L744"></a><tt class="py-lineno"> 744</tt> <tt class="py-line"> <tt class="py-string">'releases'</tt><tt class="py-op">:</tt> <tt id="link-68" class="py-name"><a title="musicbrainz2.model.Artist.releases
musicbrainz2.model.ReleaseGroup.releases
musicbrainz2.model.Track.releases" class="py-name" href="#" onclick="return doclink('link-68', 'releases', 'link-47');">releases</a></tt><tt class="py-op">,</tt> </tt>
<a name="L745"></a><tt class="py-lineno"> 745</tt> <tt class="py-line"> <tt class="py-string">'puids'</tt><tt class="py-op">:</tt> <tt id="link-69" class="py-name" targets="Variable musicbrainz2.model.Track.puids=musicbrainz2.model.Track-class.html#puids"><a title="musicbrainz2.model.Track.puids" class="py-name" href="#" onclick="return doclink('link-69', 'puids', 'link-69');">puids</a></tt><tt class="py-op">,</tt> </tt>
<a name="L746"></a><tt class="py-lineno"> 746</tt> <tt class="py-line"> <tt class="py-string">'artist-rels'</tt><tt class="py-op">:</tt> <tt class="py-name">artistRelations</tt><tt class="py-op">,</tt> </tt>
<a name="L747"></a><tt class="py-lineno"> 747</tt> <tt class="py-line"> <tt class="py-string">'release-rels'</tt><tt class="py-op">:</tt> <tt class="py-name">releaseRelations</tt><tt class="py-op">,</tt> </tt>
<a name="L748"></a><tt class="py-lineno"> 748</tt> <tt class="py-line"> <tt class="py-string">'track-rels'</tt><tt class="py-op">:</tt> <tt class="py-name">trackRelations</tt><tt class="py-op">,</tt> </tt>
<a name="L749"></a><tt class="py-lineno"> 749</tt> <tt class="py-line"> <tt class="py-string">'url-rels'</tt><tt class="py-op">:</tt> <tt class="py-name">urlRelations</tt><tt class="py-op">,</tt> </tt>
<a name="L750"></a><tt class="py-lineno"> 750</tt> <tt class="py-line"> <tt class="py-string">'tags'</tt><tt class="py-op">:</tt> <tt id="link-70" class="py-name"><a title="musicbrainz2.model.Entity.tags" class="py-name" href="#" onclick="return doclink('link-70', 'tags', 'link-51');">tags</a></tt><tt class="py-op">,</tt> </tt>
<a name="L751"></a><tt class="py-lineno"> 751</tt> <tt class="py-line"> <tt class="py-string">'ratings'</tt><tt class="py-op">:</tt> <tt class="py-name">ratings</tt><tt class="py-op">,</tt> </tt>
<a name="L752"></a><tt class="py-lineno"> 752</tt> <tt class="py-line"> <tt class="py-string">'isrcs'</tt><tt class="py-op">:</tt> <tt id="link-71" class="py-name"><a title="musicbrainz2.model.Track.isrcs" class="py-name" href="#" onclick="return doclink('link-71', 'isrcs', 'link-61');">isrcs</a></tt><tt class="py-op">,</tt> </tt>
<a name="L753"></a><tt class="py-lineno"> 753</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
</div><a name="L754"></a><tt class="py-lineno"> 754</tt> <tt class="py-line"> </tt>
<a name="TrackIncludes.createIncludeTags"></a><div id="TrackIncludes.createIncludeTags-def"><a name="L755"></a><tt class="py-lineno"> 755</tt> <a class="py-toggle" href="#" id="TrackIncludes.createIncludeTags-toggle" onclick="return toggle('TrackIncludes.createIncludeTags');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.TrackIncludes-class.html#createIncludeTags">createIncludeTags</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TrackIncludes.createIncludeTags-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="TrackIncludes.createIncludeTags-expanded"><a name="L756"></a><tt class="py-lineno"> 756</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">_createIncludes</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_includes</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L757"></a><tt class="py-lineno"> 757</tt> <tt class="py-line"> </tt>
<a name="L758"></a><tt class="py-lineno"> 758</tt> <tt class="py-line"> </tt>
<a name="LabelIncludes"></a><div id="LabelIncludes-def"><a name="L759"></a><tt class="py-lineno"> 759</tt> <a class="py-toggle" href="#" id="LabelIncludes-toggle" onclick="return toggle('LabelIncludes');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.LabelIncludes-class.html">LabelIncludes</a><tt class="py-op">(</tt><tt class="py-base-class">IIncludes</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LabelIncludes-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="LabelIncludes-expanded"><a name="L760"></a><tt class="py-lineno"> 760</tt> <tt class="py-line"> <tt class="py-docstring">"""A specification on how much data to return with a label."""</tt> </tt>
<a name="LabelIncludes.__init__"></a><div id="LabelIncludes.__init__-def"><a name="L761"></a><tt class="py-lineno"> 761</tt> <a class="py-toggle" href="#" id="LabelIncludes.__init__-toggle" onclick="return toggle('LabelIncludes.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.LabelIncludes-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">aliases</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">tags</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">ratings</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LabelIncludes.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="LabelIncludes.__init__-expanded"><a name="L762"></a><tt class="py-lineno"> 762</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_includes</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L763"></a><tt class="py-lineno"> 763</tt> <tt class="py-line"> <tt class="py-string">'aliases'</tt><tt class="py-op">:</tt> <tt id="link-72" class="py-name"><a title="musicbrainz2.model.Artist.aliases
musicbrainz2.model.Label.aliases" class="py-name" href="#" onclick="return doclink('link-72', 'aliases', 'link-49');">aliases</a></tt><tt class="py-op">,</tt> </tt>
<a name="L764"></a><tt class="py-lineno"> 764</tt> <tt class="py-line"> <tt class="py-string">'tags'</tt><tt class="py-op">:</tt> <tt id="link-73" class="py-name"><a title="musicbrainz2.model.Entity.tags" class="py-name" href="#" onclick="return doclink('link-73', 'tags', 'link-51');">tags</a></tt><tt class="py-op">,</tt> </tt>
<a name="L765"></a><tt class="py-lineno"> 765</tt> <tt class="py-line"> <tt class="py-string">'ratings'</tt><tt class="py-op">:</tt> <tt class="py-name">ratings</tt><tt class="py-op">,</tt> </tt>
<a name="L766"></a><tt class="py-lineno"> 766</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
</div><a name="L767"></a><tt class="py-lineno"> 767</tt> <tt class="py-line"> </tt>
<a name="LabelIncludes.createIncludeTags"></a><div id="LabelIncludes.createIncludeTags-def"><a name="L768"></a><tt class="py-lineno"> 768</tt> <a class="py-toggle" href="#" id="LabelIncludes.createIncludeTags-toggle" onclick="return toggle('LabelIncludes.createIncludeTags');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.LabelIncludes-class.html#createIncludeTags">createIncludeTags</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LabelIncludes.createIncludeTags-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="LabelIncludes.createIncludeTags-expanded"><a name="L769"></a><tt class="py-lineno"> 769</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">_createIncludes</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_includes</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L770"></a><tt class="py-lineno"> 770</tt> <tt class="py-line"> </tt>
<a name="L771"></a><tt class="py-lineno"> 771</tt> <tt class="py-line"> </tt>
<a name="Query"></a><div id="Query-def"><a name="L772"></a><tt class="py-lineno"> 772</tt> <a class="py-toggle" href="#" id="Query-toggle" onclick="return toggle('Query');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html">Query</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="Query-expanded"><a name="L773"></a><tt class="py-lineno"> 773</tt> <tt class="py-line"> <tt class="py-docstring">"""A simple interface to the MusicBrainz web service.</tt> </tt>
<a name="L774"></a><tt class="py-lineno"> 774</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L775"></a><tt class="py-lineno"> 775</tt> <tt class="py-line"><tt class="py-docstring"> This is a facade which provides a simple interface to the MusicBrainz</tt> </tt>
<a name="L776"></a><tt class="py-lineno"> 776</tt> <tt class="py-line"><tt class="py-docstring"> web service. It hides all the details like fetching data from a server,</tt> </tt>
<a name="L777"></a><tt class="py-lineno"> 777</tt> <tt class="py-line"><tt class="py-docstring"> parsing the XML and creating an object tree. Using this class, you can</tt> </tt>
<a name="L778"></a><tt class="py-lineno"> 778</tt> <tt class="py-line"><tt class="py-docstring"> request data by ID or search the I{collection} of all resources</tt> </tt>
<a name="L779"></a><tt class="py-lineno"> 779</tt> <tt class="py-line"><tt class="py-docstring"> (artists, releases, or tracks) to retrieve those matching given</tt> </tt>
<a name="L780"></a><tt class="py-lineno"> 780</tt> <tt class="py-line"><tt class="py-docstring"> criteria. This document contains examples to get you started.</tt> </tt>
<a name="L781"></a><tt class="py-lineno"> 781</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L782"></a><tt class="py-lineno"> 782</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L783"></a><tt class="py-lineno"> 783</tt> <tt class="py-line"><tt class="py-docstring"> Working with Identifiers</tt> </tt>
<a name="L784"></a><tt class="py-lineno"> 784</tt> <tt class="py-line"><tt class="py-docstring"> ========================</tt> </tt>
<a name="L785"></a><tt class="py-lineno"> 785</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L786"></a><tt class="py-lineno"> 786</tt> <tt class="py-line"><tt class="py-docstring"> MusicBrainz uses absolute URIs as identifiers. For example, the artist</tt> </tt>
<a name="L787"></a><tt class="py-lineno"> 787</tt> <tt class="py-line"><tt class="py-docstring"> 'Tori Amos' is identified using the following URI::</tt> </tt>
<a name="L788"></a><tt class="py-lineno"> 788</tt> <tt class="py-line"><tt class="py-docstring"> http://musicbrainz.org/artist/c0b2500e-0cef-4130-869d-732b23ed9df5</tt> </tt>
<a name="L789"></a><tt class="py-lineno"> 789</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L790"></a><tt class="py-lineno"> 790</tt> <tt class="py-line"><tt class="py-docstring"> In some situations it is obvious from the context what type of </tt> </tt>
<a name="L791"></a><tt class="py-lineno"> 791</tt> <tt class="py-line"><tt class="py-docstring"> resource an ID refers to. In these cases, abbreviated identifiers may</tt> </tt>
<a name="L792"></a><tt class="py-lineno"> 792</tt> <tt class="py-line"><tt class="py-docstring"> be used, which are just the I{UUID} part of the URI. Thus the ID above</tt> </tt>
<a name="L793"></a><tt class="py-lineno"> 793</tt> <tt class="py-line"><tt class="py-docstring"> may also be written like this::</tt> </tt>
<a name="L794"></a><tt class="py-lineno"> 794</tt> <tt class="py-line"><tt class="py-docstring"> c0b2500e-0cef-4130-869d-732b23ed9df5</tt> </tt>
<a name="L795"></a><tt class="py-lineno"> 795</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L796"></a><tt class="py-lineno"> 796</tt> <tt class="py-line"><tt class="py-docstring"> All methods in this class which require IDs accept both the absolute</tt> </tt>
<a name="L797"></a><tt class="py-lineno"> 797</tt> <tt class="py-line"><tt class="py-docstring"> URI and the abbreviated form (aka the relative URI).</tt> </tt>
<a name="L798"></a><tt class="py-lineno"> 798</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L799"></a><tt class="py-lineno"> 799</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L800"></a><tt class="py-lineno"> 800</tt> <tt class="py-line"><tt class="py-docstring"> Creating a Query Object</tt> </tt>
<a name="L801"></a><tt class="py-lineno"> 801</tt> <tt class="py-line"><tt class="py-docstring"> =======================</tt> </tt>
<a name="L802"></a><tt class="py-lineno"> 802</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L803"></a><tt class="py-lineno"> 803</tt> <tt class="py-line"><tt class="py-docstring"> In most cases, creating a L{Query} object is as simple as this:</tt> </tt>
<a name="L804"></a><tt class="py-lineno"> 804</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L805"></a><tt class="py-lineno"> 805</tt> <tt class="py-line"><tt class="py-docstring"> >>> import musicbrainz2.webservice as ws</tt> </tt>
<a name="L806"></a><tt class="py-lineno"> 806</tt> <tt class="py-line"><tt class="py-docstring"> >>> q = ws.Query()</tt> </tt>
<a name="L807"></a><tt class="py-lineno"> 807</tt> <tt class="py-line"><tt class="py-docstring"> >>></tt> </tt>
<a name="L808"></a><tt class="py-lineno"> 808</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L809"></a><tt class="py-lineno"> 809</tt> <tt class="py-line"><tt class="py-docstring"> The instantiated object uses the standard L{WebService} class to</tt> </tt>
<a name="L810"></a><tt class="py-lineno"> 810</tt> <tt class="py-line"><tt class="py-docstring"> access the MusicBrainz web service. If you want to use a different </tt> </tt>
<a name="L811"></a><tt class="py-lineno"> 811</tt> <tt class="py-line"><tt class="py-docstring"> server or you have to pass user name and password because one of</tt> </tt>
<a name="L812"></a><tt class="py-lineno"> 812</tt> <tt class="py-line"><tt class="py-docstring"> your queries requires authentication, you have to create the</tt> </tt>
<a name="L813"></a><tt class="py-lineno"> 813</tt> <tt class="py-line"><tt class="py-docstring"> L{WebService} object yourself and configure it appropriately.</tt> </tt>
<a name="L814"></a><tt class="py-lineno"> 814</tt> <tt class="py-line"><tt class="py-docstring"> This example uses the MusicBrainz test server and also sets</tt> </tt>
<a name="L815"></a><tt class="py-lineno"> 815</tt> <tt class="py-line"><tt class="py-docstring"> authentication data:</tt> </tt>
<a name="L816"></a><tt class="py-lineno"> 816</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L817"></a><tt class="py-lineno"> 817</tt> <tt class="py-line"><tt class="py-docstring"> >>> import musicbrainz2.webservice as ws</tt> </tt>
<a name="L818"></a><tt class="py-lineno"> 818</tt> <tt class="py-line"><tt class="py-docstring"> >>> service = ws.WebService(host='test.musicbrainz.org',</tt> </tt>
<a name="L819"></a><tt class="py-lineno"> 819</tt> <tt class="py-line"><tt class="py-docstring"> ... username='whatever', password='secret')</tt> </tt>
<a name="L820"></a><tt class="py-lineno"> 820</tt> <tt class="py-line"><tt class="py-docstring"> >>> q = ws.Query(service)</tt> </tt>
<a name="L821"></a><tt class="py-lineno"> 821</tt> <tt class="py-line"><tt class="py-docstring"> >>></tt> </tt>
<a name="L822"></a><tt class="py-lineno"> 822</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L823"></a><tt class="py-lineno"> 823</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L824"></a><tt class="py-lineno"> 824</tt> <tt class="py-line"><tt class="py-docstring"> Querying for Individual Resources</tt> </tt>
<a name="L825"></a><tt class="py-lineno"> 825</tt> <tt class="py-line"><tt class="py-docstring"> =================================</tt> </tt>
<a name="L826"></a><tt class="py-lineno"> 826</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L827"></a><tt class="py-lineno"> 827</tt> <tt class="py-line"><tt class="py-docstring"> If the MusicBrainz ID of a resource is known, then the L{getArtistById},</tt> </tt>
<a name="L828"></a><tt class="py-lineno"> 828</tt> <tt class="py-line"><tt class="py-docstring"> L{getReleaseById}, or L{getTrackById} method can be used to retrieve</tt> </tt>
<a name="L829"></a><tt class="py-lineno"> 829</tt> <tt class="py-line"><tt class="py-docstring"> it. Example:</tt> </tt>
<a name="L830"></a><tt class="py-lineno"> 830</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L831"></a><tt class="py-lineno"> 831</tt> <tt class="py-line"><tt class="py-docstring"> >>> import musicbrainz2.webservice as ws</tt> </tt>
<a name="L832"></a><tt class="py-lineno"> 832</tt> <tt class="py-line"><tt class="py-docstring"> >>> q = ws.Query()</tt> </tt>
<a name="L833"></a><tt class="py-lineno"> 833</tt> <tt class="py-line"><tt class="py-docstring"> >>> artist = q.getArtistById('c0b2500e-0cef-4130-869d-732b23ed9df5')</tt> </tt>
<a name="L834"></a><tt class="py-lineno"> 834</tt> <tt class="py-line"><tt class="py-docstring"> >>> artist.name</tt> </tt>
<a name="L835"></a><tt class="py-lineno"> 835</tt> <tt class="py-line"><tt class="py-docstring"> u'Tori Amos'</tt> </tt>
<a name="L836"></a><tt class="py-lineno"> 836</tt> <tt class="py-line"><tt class="py-docstring"> >>> artist.sortName</tt> </tt>
<a name="L837"></a><tt class="py-lineno"> 837</tt> <tt class="py-line"><tt class="py-docstring"> u'Amos, Tori'</tt> </tt>
<a name="L838"></a><tt class="py-lineno"> 838</tt> <tt class="py-line"><tt class="py-docstring"> >>> print artist.type</tt> </tt>
<a name="L839"></a><tt class="py-lineno"> 839</tt> <tt class="py-line"><tt class="py-docstring"> http://musicbrainz.org/ns/mmd-1.0#Person</tt> </tt>
<a name="L840"></a><tt class="py-lineno"> 840</tt> <tt class="py-line"><tt class="py-docstring"> >>></tt> </tt>
<a name="L841"></a><tt class="py-lineno"> 841</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L842"></a><tt class="py-lineno"> 842</tt> <tt class="py-line"><tt class="py-docstring"> This returned just the basic artist data, however. To get more detail</tt> </tt>
<a name="L843"></a><tt class="py-lineno"> 843</tt> <tt class="py-line"><tt class="py-docstring"> about a resource, the C{include} parameters may be used which expect</tt> </tt>
<a name="L844"></a><tt class="py-lineno"> 844</tt> <tt class="py-line"><tt class="py-docstring"> an L{ArtistIncludes}, L{ReleaseIncludes}, or L{TrackIncludes} object,</tt> </tt>
<a name="L845"></a><tt class="py-lineno"> 845</tt> <tt class="py-line"><tt class="py-docstring"> depending on the resource type.</tt> </tt>
<a name="L846"></a><tt class="py-lineno"> 846</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L847"></a><tt class="py-lineno"> 847</tt> <tt class="py-line"><tt class="py-docstring"> To get data about a release which also includes the main artist</tt> </tt>
<a name="L848"></a><tt class="py-lineno"> 848</tt> <tt class="py-line"><tt class="py-docstring"> and all tracks, for example, the following query can be used:</tt> </tt>
<a name="L849"></a><tt class="py-lineno"> 849</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L850"></a><tt class="py-lineno"> 850</tt> <tt class="py-line"><tt class="py-docstring"> >>> import musicbrainz2.webservice as ws</tt> </tt>
<a name="L851"></a><tt class="py-lineno"> 851</tt> <tt class="py-line"><tt class="py-docstring"> >>> q = ws.Query()</tt> </tt>
<a name="L852"></a><tt class="py-lineno"> 852</tt> <tt class="py-line"><tt class="py-docstring"> >>> releaseId = '33dbcf02-25b9-4a35-bdb7-729455f33ad7'</tt> </tt>
<a name="L853"></a><tt class="py-lineno"> 853</tt> <tt class="py-line"><tt class="py-docstring"> >>> include = ws.ReleaseIncludes(artist=True, tracks=True)</tt> </tt>
<a name="L854"></a><tt class="py-lineno"> 854</tt> <tt class="py-line"><tt class="py-docstring"> >>> release = q.getReleaseById(releaseId, include)</tt> </tt>
<a name="L855"></a><tt class="py-lineno"> 855</tt> <tt class="py-line"><tt class="py-docstring"> >>> release.title</tt> </tt>
<a name="L856"></a><tt class="py-lineno"> 856</tt> <tt class="py-line"><tt class="py-docstring"> u'Tales of a Librarian'</tt> </tt>
<a name="L857"></a><tt class="py-lineno"> 857</tt> <tt class="py-line"><tt class="py-docstring"> >>> release.artist.name</tt> </tt>
<a name="L858"></a><tt class="py-lineno"> 858</tt> <tt class="py-line"><tt class="py-docstring"> u'Tori Amos'</tt> </tt>
<a name="L859"></a><tt class="py-lineno"> 859</tt> <tt class="py-line"><tt class="py-docstring"> >>> release.tracks[0].title</tt> </tt>
<a name="L860"></a><tt class="py-lineno"> 860</tt> <tt class="py-line"><tt class="py-docstring"> u'Precious Things'</tt> </tt>
<a name="L861"></a><tt class="py-lineno"> 861</tt> <tt class="py-line"><tt class="py-docstring"> >>></tt> </tt>
<a name="L862"></a><tt class="py-lineno"> 862</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L863"></a><tt class="py-lineno"> 863</tt> <tt class="py-line"><tt class="py-docstring"> Note that the query gets more expensive for the server the more</tt> </tt>
<a name="L864"></a><tt class="py-lineno"> 864</tt> <tt class="py-line"><tt class="py-docstring"> data you request, so please be nice.</tt> </tt>
<a name="L865"></a><tt class="py-lineno"> 865</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L866"></a><tt class="py-lineno"> 866</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L867"></a><tt class="py-lineno"> 867</tt> <tt class="py-line"><tt class="py-docstring"> Searching in Collections</tt> </tt>
<a name="L868"></a><tt class="py-lineno"> 868</tt> <tt class="py-line"><tt class="py-docstring"> ========================</tt> </tt>
<a name="L869"></a><tt class="py-lineno"> 869</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L870"></a><tt class="py-lineno"> 870</tt> <tt class="py-line"><tt class="py-docstring"> For each resource type (artist, release, and track), there is one</tt> </tt>
<a name="L871"></a><tt class="py-lineno"> 871</tt> <tt class="py-line"><tt class="py-docstring"> collection which contains all resources of a type. You can search</tt> </tt>
<a name="L872"></a><tt class="py-lineno"> 872</tt> <tt class="py-line"><tt class="py-docstring"> these collections using the L{getArtists}, L{getReleases}, and</tt> </tt>
<a name="L873"></a><tt class="py-lineno"> 873</tt> <tt class="py-line"><tt class="py-docstring"> L{getTracks} methods. The collections are huge, so you have to</tt> </tt>
<a name="L874"></a><tt class="py-lineno"> 874</tt> <tt class="py-line"><tt class="py-docstring"> use filters (L{ArtistFilter}, L{ReleaseFilter}, or L{TrackFilter})</tt> </tt>
<a name="L875"></a><tt class="py-lineno"> 875</tt> <tt class="py-line"><tt class="py-docstring"> to retrieve only resources matching given criteria.</tt> </tt>
<a name="L876"></a><tt class="py-lineno"> 876</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L877"></a><tt class="py-lineno"> 877</tt> <tt class="py-line"><tt class="py-docstring"> For example, If you want to search the release collection for</tt> </tt>
<a name="L878"></a><tt class="py-lineno"> 878</tt> <tt class="py-line"><tt class="py-docstring"> releases with a specified DiscID, you would use L{getReleases}</tt> </tt>
<a name="L879"></a><tt class="py-lineno"> 879</tt> <tt class="py-line"><tt class="py-docstring"> and a L{ReleaseFilter} object:</tt> </tt>
<a name="L880"></a><tt class="py-lineno"> 880</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L881"></a><tt class="py-lineno"> 881</tt> <tt class="py-line"><tt class="py-docstring"> >>> import musicbrainz2.webservice as ws</tt> </tt>
<a name="L882"></a><tt class="py-lineno"> 882</tt> <tt class="py-line"><tt class="py-docstring"> >>> q = ws.Query()</tt> </tt>
<a name="L883"></a><tt class="py-lineno"> 883</tt> <tt class="py-line"><tt class="py-docstring"> >>> filter = ws.ReleaseFilter(discId='8jJklE258v6GofIqDIrE.c5ejBE-')</tt> </tt>
<a name="L884"></a><tt class="py-lineno"> 884</tt> <tt class="py-line"><tt class="py-docstring"> >>> results = q.getReleases(filter=filter)</tt> </tt>
<a name="L885"></a><tt class="py-lineno"> 885</tt> <tt class="py-line"><tt class="py-docstring"> >>> results[0].score</tt> </tt>
<a name="L886"></a><tt class="py-lineno"> 886</tt> <tt class="py-line"><tt class="py-docstring"> 100</tt> </tt>
<a name="L887"></a><tt class="py-lineno"> 887</tt> <tt class="py-line"><tt class="py-docstring"> >>> results[0].release.title</tt> </tt>
<a name="L888"></a><tt class="py-lineno"> 888</tt> <tt class="py-line"><tt class="py-docstring"> u'Under the Pink'</tt> </tt>
<a name="L889"></a><tt class="py-lineno"> 889</tt> <tt class="py-line"><tt class="py-docstring"> >>></tt> </tt>
<a name="L890"></a><tt class="py-lineno"> 890</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L891"></a><tt class="py-lineno"> 891</tt> <tt class="py-line"><tt class="py-docstring"> The query returns a list of results (L{wsxml.ReleaseResult} objects</tt> </tt>
<a name="L892"></a><tt class="py-lineno"> 892</tt> <tt class="py-line"><tt class="py-docstring"> in this case), which are ordered by score, with a higher score</tt> </tt>
<a name="L893"></a><tt class="py-lineno"> 893</tt> <tt class="py-line"><tt class="py-docstring"> indicating a better match. Note that those results don't contain</tt> </tt>
<a name="L894"></a><tt class="py-lineno"> 894</tt> <tt class="py-line"><tt class="py-docstring"> all the data about a resource. If you need more detail, you can then</tt> </tt>
<a name="L895"></a><tt class="py-lineno"> 895</tt> <tt class="py-line"><tt class="py-docstring"> use the L{getArtistById}, L{getReleaseById}, or L{getTrackById}</tt> </tt>
<a name="L896"></a><tt class="py-lineno"> 896</tt> <tt class="py-line"><tt class="py-docstring"> methods to request the resource.</tt> </tt>
<a name="L897"></a><tt class="py-lineno"> 897</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L898"></a><tt class="py-lineno"> 898</tt> <tt class="py-line"><tt class="py-docstring"> All filters support the C{limit} argument to limit the number of</tt> </tt>
<a name="L899"></a><tt class="py-lineno"> 899</tt> <tt class="py-line"><tt class="py-docstring"> results returned. This defaults to 25, but the server won't send</tt> </tt>
<a name="L900"></a><tt class="py-lineno"> 900</tt> <tt class="py-line"><tt class="py-docstring"> more than 100 results to save bandwidth and processing power. Using</tt> </tt>
<a name="L901"></a><tt class="py-lineno"> 901</tt> <tt class="py-line"><tt class="py-docstring"> C{limit} and the C{offset} parameter, you can page through the</tt> </tt>
<a name="L902"></a><tt class="py-lineno"> 902</tt> <tt class="py-line"><tt class="py-docstring"> results.</tt> </tt>
<a name="L903"></a><tt class="py-lineno"> 903</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L904"></a><tt class="py-lineno"> 904</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L905"></a><tt class="py-lineno"> 905</tt> <tt class="py-line"><tt class="py-docstring"> Error Handling</tt> </tt>
<a name="L906"></a><tt class="py-lineno"> 906</tt> <tt class="py-line"><tt class="py-docstring"> ==============</tt> </tt>
<a name="L907"></a><tt class="py-lineno"> 907</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L908"></a><tt class="py-lineno"> 908</tt> <tt class="py-line"><tt class="py-docstring"> All methods in this class raise a L{WebServiceError} exception in case</tt> </tt>
<a name="L909"></a><tt class="py-lineno"> 909</tt> <tt class="py-line"><tt class="py-docstring"> of errors. Depending on the method, a subclass of L{WebServiceError} may</tt> </tt>
<a name="L910"></a><tt class="py-lineno"> 910</tt> <tt class="py-line"><tt class="py-docstring"> be raised which allows an application to handle errors more precisely.</tt> </tt>
<a name="L911"></a><tt class="py-lineno"> 911</tt> <tt class="py-line"><tt class="py-docstring"> The following example handles connection errors (invalid host name</tt> </tt>
<a name="L912"></a><tt class="py-lineno"> 912</tt> <tt class="py-line"><tt class="py-docstring"> etc.) separately and all other web service errors in a combined</tt> </tt>
<a name="L913"></a><tt class="py-lineno"> 913</tt> <tt class="py-line"><tt class="py-docstring"> catch clause:</tt> </tt>
<a name="L914"></a><tt class="py-lineno"> 914</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L915"></a><tt class="py-lineno"> 915</tt> <tt class="py-line"><tt class="py-docstring"> >>> try:</tt> </tt>
<a name="L916"></a><tt class="py-lineno"> 916</tt> <tt class="py-line"><tt class="py-docstring"> ... artist = q.getArtistById('c0b2500e-0cef-4130-869d-732b23ed9df5')</tt> </tt>
<a name="L917"></a><tt class="py-lineno"> 917</tt> <tt class="py-line"><tt class="py-docstring"> ... except ws.ConnectionError, e:</tt> </tt>
<a name="L918"></a><tt class="py-lineno"> 918</tt> <tt class="py-line"><tt class="py-docstring"> ... pass # implement your error handling here</tt> </tt>
<a name="L919"></a><tt class="py-lineno"> 919</tt> <tt class="py-line"><tt class="py-docstring"> ... except ws.WebServiceError, e:</tt> </tt>
<a name="L920"></a><tt class="py-lineno"> 920</tt> <tt class="py-line"><tt class="py-docstring"> ... pass # catches all other web service errors</tt> </tt>
<a name="L921"></a><tt class="py-lineno"> 921</tt> <tt class="py-line"><tt class="py-docstring"> ... </tt> </tt>
<a name="L922"></a><tt class="py-lineno"> 922</tt> <tt class="py-line"><tt class="py-docstring"> >>></tt> </tt>
<a name="L923"></a><tt class="py-lineno"> 923</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L924"></a><tt class="py-lineno"> 924</tt> <tt class="py-line"> </tt>
<a name="Query.__init__"></a><div id="Query.__init__-def"><a name="L925"></a><tt class="py-lineno"> 925</tt> <a class="py-toggle" href="#" id="Query.__init__-toggle" onclick="return toggle('Query.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">ws</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">wsFactory</tt><tt class="py-op">=</tt><tt id="link-74" class="py-name" targets="Class musicbrainz2.webservice.WebService=musicbrainz2.webservice.WebService-class.html"><a title="musicbrainz2.webservice.WebService" class="py-name" href="#" onclick="return doclink('link-74', 'WebService', 'link-74');">WebService</a></tt><tt class="py-op">,</tt> <tt class="py-param">clientId</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.__init__-expanded"><a name="L926"></a><tt class="py-lineno"> 926</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt>
<a name="L927"></a><tt class="py-lineno"> 927</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L928"></a><tt class="py-lineno"> 928</tt> <tt class="py-line"><tt class="py-docstring"> The C{ws} parameter has to be a subclass of L{IWebService}.</tt> </tt>
<a name="L929"></a><tt class="py-lineno"> 929</tt> <tt class="py-line"><tt class="py-docstring"> If it isn't given, the C{wsFactory} parameter is used to</tt> </tt>
<a name="L930"></a><tt class="py-lineno"> 930</tt> <tt class="py-line"><tt class="py-docstring"> create an L{IWebService} subclass.</tt> </tt>
<a name="L931"></a><tt class="py-lineno"> 931</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L932"></a><tt class="py-lineno"> 932</tt> <tt class="py-line"><tt class="py-docstring"> If the constructor is called without arguments, an instance</tt> </tt>
<a name="L933"></a><tt class="py-lineno"> 933</tt> <tt class="py-line"><tt class="py-docstring"> of L{WebService} is used, preconfigured to use the MusicBrainz</tt> </tt>
<a name="L934"></a><tt class="py-lineno"> 934</tt> <tt class="py-line"><tt class="py-docstring"> server. This should be enough for most users.</tt> </tt>
<a name="L935"></a><tt class="py-lineno"> 935</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L936"></a><tt class="py-lineno"> 936</tt> <tt class="py-line"><tt class="py-docstring"> If you want to use queries which require authentication you</tt> </tt>
<a name="L937"></a><tt class="py-lineno"> 937</tt> <tt class="py-line"><tt class="py-docstring"> have to pass a L{WebService} instance where user name and</tt> </tt>
<a name="L938"></a><tt class="py-lineno"> 938</tt> <tt class="py-line"><tt class="py-docstring"> password have been set.</tt> </tt>
<a name="L939"></a><tt class="py-lineno"> 939</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L940"></a><tt class="py-lineno"> 940</tt> <tt class="py-line"><tt class="py-docstring"> The C{clientId} parameter is required for data submission.</tt> </tt>
<a name="L941"></a><tt class="py-lineno"> 941</tt> <tt class="py-line"><tt class="py-docstring"> The format is C{'application-version'}, where C{application}</tt> </tt>
<a name="L942"></a><tt class="py-lineno"> 942</tt> <tt class="py-line"><tt class="py-docstring"> is your application's name and C{version} is a version</tt> </tt>
<a name="L943"></a><tt class="py-lineno"> 943</tt> <tt class="py-line"><tt class="py-docstring"> number which may not include a '-' character.</tt> </tt>
<a name="L944"></a><tt class="py-lineno"> 944</tt> <tt class="py-line"><tt class="py-docstring"> Even if you don't plan to submit data, setting this parameter is</tt> </tt>
<a name="L945"></a><tt class="py-lineno"> 945</tt> <tt class="py-line"><tt class="py-docstring"> encouraged because it will set the user agent used to make requests if</tt> </tt>
<a name="L946"></a><tt class="py-lineno"> 946</tt> <tt class="py-line"><tt class="py-docstring"> you don't supply the C{ws} parameter.</tt> </tt>
<a name="L947"></a><tt class="py-lineno"> 947</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L948"></a><tt class="py-lineno"> 948</tt> <tt class="py-line"><tt class="py-docstring"> @param ws: a subclass instance of L{IWebService}, or None</tt> </tt>
<a name="L949"></a><tt class="py-lineno"> 949</tt> <tt class="py-line"><tt class="py-docstring"> @param wsFactory: a callable object which creates an object</tt> </tt>
<a name="L950"></a><tt class="py-lineno"> 950</tt> <tt class="py-line"><tt class="py-docstring"> @param clientId: a unicode string containing the application's ID</tt> </tt>
<a name="L951"></a><tt class="py-lineno"> 951</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L952"></a><tt class="py-lineno"> 952</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">ws</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L953"></a><tt class="py-lineno"> 953</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_ws</tt> <tt class="py-op">=</tt> <tt class="py-name">wsFactory</tt><tt class="py-op">(</tt><tt class="py-name">userAgent</tt><tt class="py-op">=</tt><tt class="py-name">clientId</tt><tt class="py-op">)</tt> </tt>
<a name="L954"></a><tt class="py-lineno"> 954</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L955"></a><tt class="py-lineno"> 955</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_ws</tt> <tt class="py-op">=</tt> <tt class="py-name">ws</tt> </tt>
<a name="L956"></a><tt class="py-lineno"> 956</tt> <tt class="py-line"> </tt>
<a name="L957"></a><tt class="py-lineno"> 957</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_clientId</tt> <tt class="py-op">=</tt> <tt class="py-name">clientId</tt> </tt>
<a name="L958"></a><tt class="py-lineno"> 958</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_log</tt> <tt class="py-op">=</tt> <tt class="py-name">logging</tt><tt class="py-op">.</tt><tt class="py-name">getLogger</tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L959"></a><tt class="py-lineno"> 959</tt> <tt class="py-line"> </tt>
<a name="L960"></a><tt class="py-lineno"> 960</tt> <tt class="py-line"> </tt>
<a name="Query.getArtistById"></a><div id="Query.getArtistById-def"><a name="L961"></a><tt class="py-lineno"> 961</tt> <a class="py-toggle" href="#" id="Query.getArtistById-toggle" onclick="return toggle('Query.getArtistById');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#getArtistById">getArtistById</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">id_</tt><tt class="py-op">,</tt> <tt class="py-param">include</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.getArtistById-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.getArtistById-expanded"><a name="L962"></a><tt class="py-lineno"> 962</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns an artist.</tt> </tt>
<a name="L963"></a><tt class="py-lineno"> 963</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L964"></a><tt class="py-lineno"> 964</tt> <tt class="py-line"><tt class="py-docstring"> If no artist with that ID can be found, C{include} contains</tt> </tt>
<a name="L965"></a><tt class="py-lineno"> 965</tt> <tt class="py-line"><tt class="py-docstring"> invalid tags or there's a server problem, an exception is</tt> </tt>
<a name="L966"></a><tt class="py-lineno"> 966</tt> <tt class="py-line"><tt class="py-docstring"> raised.</tt> </tt>
<a name="L967"></a><tt class="py-lineno"> 967</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L968"></a><tt class="py-lineno"> 968</tt> <tt class="py-line"><tt class="py-docstring"> @param id_: a string containing the artist's ID</tt> </tt>
<a name="L969"></a><tt class="py-lineno"> 969</tt> <tt class="py-line"><tt class="py-docstring"> @param include: an L{ArtistIncludes} object, or None</tt> </tt>
<a name="L970"></a><tt class="py-lineno"> 970</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L971"></a><tt class="py-lineno"> 971</tt> <tt class="py-line"><tt class="py-docstring"> @return: an L{Artist <musicbrainz2.model.Artist>} object, or None</tt> </tt>
<a name="L972"></a><tt class="py-lineno"> 972</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L973"></a><tt class="py-lineno"> 973</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L974"></a><tt class="py-lineno"> 974</tt> <tt class="py-line"><tt class="py-docstring"> @raise RequestError: invalid ID or include tags</tt> </tt>
<a name="L975"></a><tt class="py-lineno"> 975</tt> <tt class="py-line"><tt class="py-docstring"> @raise ResourceNotFoundError: artist doesn't exist</tt> </tt>
<a name="L976"></a><tt class="py-lineno"> 976</tt> <tt class="py-line"><tt class="py-docstring"> @raise ResponseError: server returned invalid data</tt> </tt>
<a name="L977"></a><tt class="py-lineno"> 977</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L978"></a><tt class="py-lineno"> 978</tt> <tt class="py-line"> <tt class="py-name">uuid</tt> <tt class="py-op">=</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-75" class="py-name"><a title="musicbrainz2.utils.extractUuid" class="py-name" href="#" onclick="return doclink('link-75', 'extractUuid', 'link-38');">extractUuid</a></tt><tt class="py-op">(</tt><tt class="py-name">id_</tt><tt class="py-op">,</tt> <tt class="py-string">'artist'</tt><tt class="py-op">)</tt> </tt>
<a name="L979"></a><tt class="py-lineno"> 979</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_getFromWebService</tt><tt class="py-op">(</tt><tt class="py-string">'artist'</tt><tt class="py-op">,</tt> <tt class="py-name">uuid</tt><tt class="py-op">,</tt> <tt class="py-name">include</tt><tt class="py-op">)</tt> </tt>
<a name="L980"></a><tt class="py-lineno"> 980</tt> <tt class="py-line"> <tt id="link-76" class="py-name"><a title="musicbrainz2.model.Release.artist
musicbrainz2.model.ReleaseGroup.artist
musicbrainz2.model.Track.artist
musicbrainz2.wsxml.ArtistResult.artist
musicbrainz2.wsxml.Metadata.artist" class="py-name" href="#" onclick="return doclink('link-76', 'artist', 'link-55');">artist</a></tt> <tt class="py-op">=</tt> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-77" class="py-name" targets="Method musicbrainz2.model.Release.getArtist()=musicbrainz2.model.Release-class.html#getArtist,Method musicbrainz2.model.ReleaseGroup.getArtist()=musicbrainz2.model.ReleaseGroup-class.html#getArtist,Method musicbrainz2.model.Track.getArtist()=musicbrainz2.model.Track-class.html#getArtist,Method musicbrainz2.wsxml.ArtistResult.getArtist()=musicbrainz2.wsxml.ArtistResult-class.html#getArtist,Method musicbrainz2.wsxml.Metadata.getArtist()=musicbrainz2.wsxml.Metadata-class.html#getArtist"><a title="musicbrainz2.model.Release.getArtist
musicbrainz2.model.ReleaseGroup.getArtist
musicbrainz2.model.Track.getArtist
musicbrainz2.wsxml.ArtistResult.getArtist
musicbrainz2.wsxml.Metadata.getArtist" class="py-name" href="#" onclick="return doclink('link-77', 'getArtist', 'link-77');">getArtist</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L981"></a><tt class="py-lineno"> 981</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-78" class="py-name"><a title="musicbrainz2.model.Release.artist
musicbrainz2.model.ReleaseGroup.artist
musicbrainz2.model.Track.artist
musicbrainz2.wsxml.ArtistResult.artist
musicbrainz2.wsxml.Metadata.artist" class="py-name" href="#" onclick="return doclink('link-78', 'artist', 'link-55');">artist</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L982"></a><tt class="py-lineno"> 982</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-79" class="py-name"><a title="musicbrainz2.model.Release.artist
musicbrainz2.model.ReleaseGroup.artist
musicbrainz2.model.Track.artist
musicbrainz2.wsxml.ArtistResult.artist
musicbrainz2.wsxml.Metadata.artist" class="py-name" href="#" onclick="return doclink('link-79', 'artist', 'link-55');">artist</a></tt> </tt>
<a name="L983"></a><tt class="py-lineno"> 983</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L984"></a><tt class="py-lineno"> 984</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-80" class="py-name" targets="Class musicbrainz2.webservice.ResponseError=musicbrainz2.webservice.ResponseError-class.html"><a title="musicbrainz2.webservice.ResponseError" class="py-name" href="#" onclick="return doclink('link-80', 'ResponseError', 'link-80');">ResponseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"server didn't return artist"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L985"></a><tt class="py-lineno"> 985</tt> <tt class="py-line"> </tt>
<a name="L986"></a><tt class="py-lineno"> 986</tt> <tt class="py-line"> </tt>
<a name="Query.getArtists"></a><div id="Query.getArtists-def"><a name="L987"></a><tt class="py-lineno"> 987</tt> <a class="py-toggle" href="#" id="Query.getArtists-toggle" onclick="return toggle('Query.getArtists');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#getArtists">getArtists</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">filter</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.getArtists-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.getArtists-expanded"><a name="L988"></a><tt class="py-lineno"> 988</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns artists matching given criteria.</tt> </tt>
<a name="L989"></a><tt class="py-lineno"> 989</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L990"></a><tt class="py-lineno"> 990</tt> <tt class="py-line"><tt class="py-docstring"> @param filter: an L{ArtistFilter} object</tt> </tt>
<a name="L991"></a><tt class="py-lineno"> 991</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L992"></a><tt class="py-lineno"> 992</tt> <tt class="py-line"><tt class="py-docstring"> @return: a list of L{musicbrainz2.wsxml.ArtistResult} objects</tt> </tt>
<a name="L993"></a><tt class="py-lineno"> 993</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L994"></a><tt class="py-lineno"> 994</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L995"></a><tt class="py-lineno"> 995</tt> <tt class="py-line"><tt class="py-docstring"> @raise RequestError: invalid ID or include tags</tt> </tt>
<a name="L996"></a><tt class="py-lineno"> 996</tt> <tt class="py-line"><tt class="py-docstring"> @raise ResponseError: server returned invalid data</tt> </tt>
<a name="L997"></a><tt class="py-lineno"> 997</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L998"></a><tt class="py-lineno"> 998</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_getFromWebService</tt><tt class="py-op">(</tt><tt class="py-string">'artist'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">filter</tt><tt class="py-op">=</tt><tt class="py-name">filter</tt><tt class="py-op">)</tt> </tt>
<a name="L999"></a><tt class="py-lineno"> 999</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-81" class="py-name" targets="Method musicbrainz2.wsxml.Metadata.getArtistResults()=musicbrainz2.wsxml.Metadata-class.html#getArtistResults"><a title="musicbrainz2.wsxml.Metadata.getArtistResults" class="py-name" href="#" onclick="return doclink('link-81', 'getArtistResults', 'link-81');">getArtistResults</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1000"></a><tt class="py-lineno">1000</tt> <tt class="py-line"> </tt>
<a name="Query.getLabelById"></a><div id="Query.getLabelById-def"><a name="L1001"></a><tt class="py-lineno">1001</tt> <a class="py-toggle" href="#" id="Query.getLabelById-toggle" onclick="return toggle('Query.getLabelById');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#getLabelById">getLabelById</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">id_</tt><tt class="py-op">,</tt> <tt class="py-param">include</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.getLabelById-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.getLabelById-expanded"><a name="L1002"></a><tt class="py-lineno">1002</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns a L{model.Label}</tt> </tt>
<a name="L1003"></a><tt class="py-lineno">1003</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1004"></a><tt class="py-lineno">1004</tt> <tt class="py-line"><tt class="py-docstring"> If no label with that ID can be found, or there is a server problem,</tt> </tt>
<a name="L1005"></a><tt class="py-lineno">1005</tt> <tt class="py-line"><tt class="py-docstring"> an exception is raised.</tt> </tt>
<a name="L1006"></a><tt class="py-lineno">1006</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1007"></a><tt class="py-lineno">1007</tt> <tt class="py-line"><tt class="py-docstring"> @param id_: a string containing the label's ID.</tt> </tt>
<a name="L1008"></a><tt class="py-lineno">1008</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1009"></a><tt class="py-lineno">1009</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L1010"></a><tt class="py-lineno">1010</tt> <tt class="py-line"><tt class="py-docstring"> @raise RequestError: invalid ID or include tags</tt> </tt>
<a name="L1011"></a><tt class="py-lineno">1011</tt> <tt class="py-line"><tt class="py-docstring"> @raise ResourceNotFoundError: release doesn't exist</tt> </tt>
<a name="L1012"></a><tt class="py-lineno">1012</tt> <tt class="py-line"><tt class="py-docstring"> @raise ResponseError: server returned invalid data</tt> </tt>
<a name="L1013"></a><tt class="py-lineno">1013</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1014"></a><tt class="py-lineno">1014</tt> <tt class="py-line"> <tt class="py-name">uuid</tt> <tt class="py-op">=</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-82" class="py-name"><a title="musicbrainz2.utils.extractUuid" class="py-name" href="#" onclick="return doclink('link-82', 'extractUuid', 'link-38');">extractUuid</a></tt><tt class="py-op">(</tt><tt class="py-name">id_</tt><tt class="py-op">,</tt> <tt class="py-string">'label'</tt><tt class="py-op">)</tt> </tt>
<a name="L1015"></a><tt class="py-lineno">1015</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_getFromWebService</tt><tt class="py-op">(</tt><tt class="py-string">'label'</tt><tt class="py-op">,</tt> <tt class="py-name">uuid</tt><tt class="py-op">,</tt> <tt class="py-name">include</tt><tt class="py-op">)</tt> </tt>
<a name="L1016"></a><tt class="py-lineno">1016</tt> <tt class="py-line"> <tt id="link-83" class="py-name" targets="Variable musicbrainz2.model.ReleaseEvent.label=musicbrainz2.model.ReleaseEvent-class.html#label,Variable musicbrainz2.wsxml.LabelResult.label=musicbrainz2.wsxml.LabelResult-class.html#label,Variable musicbrainz2.wsxml.Metadata.label=musicbrainz2.wsxml.Metadata-class.html#label"><a title="musicbrainz2.model.ReleaseEvent.label
musicbrainz2.wsxml.LabelResult.label
musicbrainz2.wsxml.Metadata.label" class="py-name" href="#" onclick="return doclink('link-83', 'label', 'link-83');">label</a></tt> <tt class="py-op">=</tt> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-84" class="py-name" targets="Method musicbrainz2.model.ReleaseEvent.getLabel()=musicbrainz2.model.ReleaseEvent-class.html#getLabel,Method musicbrainz2.wsxml.LabelResult.getLabel()=musicbrainz2.wsxml.LabelResult-class.html#getLabel,Method musicbrainz2.wsxml.Metadata.getLabel()=musicbrainz2.wsxml.Metadata-class.html#getLabel"><a title="musicbrainz2.model.ReleaseEvent.getLabel
musicbrainz2.wsxml.LabelResult.getLabel
musicbrainz2.wsxml.Metadata.getLabel" class="py-name" href="#" onclick="return doclink('link-84', 'getLabel', 'link-84');">getLabel</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1017"></a><tt class="py-lineno">1017</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-85" class="py-name"><a title="musicbrainz2.model.ReleaseEvent.label
musicbrainz2.wsxml.LabelResult.label
musicbrainz2.wsxml.Metadata.label" class="py-name" href="#" onclick="return doclink('link-85', 'label', 'link-83');">label</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1018"></a><tt class="py-lineno">1018</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-86" class="py-name"><a title="musicbrainz2.model.ReleaseEvent.label
musicbrainz2.wsxml.LabelResult.label
musicbrainz2.wsxml.Metadata.label" class="py-name" href="#" onclick="return doclink('link-86', 'label', 'link-83');">label</a></tt> </tt>
<a name="L1019"></a><tt class="py-lineno">1019</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1020"></a><tt class="py-lineno">1020</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-87" class="py-name"><a title="musicbrainz2.webservice.ResponseError" class="py-name" href="#" onclick="return doclink('link-87', 'ResponseError', 'link-80');">ResponseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"server didn't return a label"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1021"></a><tt class="py-lineno">1021</tt> <tt class="py-line"> </tt>
<a name="Query.getLabels"></a><div id="Query.getLabels-def"><a name="L1022"></a><tt class="py-lineno">1022</tt> <a class="py-toggle" href="#" id="Query.getLabels-toggle" onclick="return toggle('Query.getLabels');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#getLabels">getLabels</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">filter</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.getLabels-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.getLabels-expanded"><a name="L1023"></a><tt class="py-lineno">1023</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_getFromWebService</tt><tt class="py-op">(</tt><tt class="py-string">'label'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">filter</tt><tt class="py-op">=</tt><tt class="py-name">filter</tt><tt class="py-op">)</tt> </tt>
<a name="L1024"></a><tt class="py-lineno">1024</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-88" class="py-name" targets="Method musicbrainz2.wsxml.Metadata.getLabelResults()=musicbrainz2.wsxml.Metadata-class.html#getLabelResults"><a title="musicbrainz2.wsxml.Metadata.getLabelResults" class="py-name" href="#" onclick="return doclink('link-88', 'getLabelResults', 'link-88');">getLabelResults</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1025"></a><tt class="py-lineno">1025</tt> <tt class="py-line"> </tt>
<a name="Query.getReleaseById"></a><div id="Query.getReleaseById-def"><a name="L1026"></a><tt class="py-lineno">1026</tt> <a class="py-toggle" href="#" id="Query.getReleaseById-toggle" onclick="return toggle('Query.getReleaseById');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#getReleaseById">getReleaseById</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">id_</tt><tt class="py-op">,</tt> <tt class="py-param">include</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.getReleaseById-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.getReleaseById-expanded"><a name="L1027"></a><tt class="py-lineno">1027</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns a release.</tt> </tt>
<a name="L1028"></a><tt class="py-lineno">1028</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1029"></a><tt class="py-lineno">1029</tt> <tt class="py-line"><tt class="py-docstring"> If no release with that ID can be found, C{include} contains</tt> </tt>
<a name="L1030"></a><tt class="py-lineno">1030</tt> <tt class="py-line"><tt class="py-docstring"> invalid tags or there's a server problem, and exception is</tt> </tt>
<a name="L1031"></a><tt class="py-lineno">1031</tt> <tt class="py-line"><tt class="py-docstring"> raised.</tt> </tt>
<a name="L1032"></a><tt class="py-lineno">1032</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1033"></a><tt class="py-lineno">1033</tt> <tt class="py-line"><tt class="py-docstring"> @param id_: a string containing the release's ID</tt> </tt>
<a name="L1034"></a><tt class="py-lineno">1034</tt> <tt class="py-line"><tt class="py-docstring"> @param include: a L{ReleaseIncludes} object, or None</tt> </tt>
<a name="L1035"></a><tt class="py-lineno">1035</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1036"></a><tt class="py-lineno">1036</tt> <tt class="py-line"><tt class="py-docstring"> @return: a L{Release <musicbrainz2.model.Release>} object, or None</tt> </tt>
<a name="L1037"></a><tt class="py-lineno">1037</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1038"></a><tt class="py-lineno">1038</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L1039"></a><tt class="py-lineno">1039</tt> <tt class="py-line"><tt class="py-docstring"> @raise RequestError: invalid ID or include tags</tt> </tt>
<a name="L1040"></a><tt class="py-lineno">1040</tt> <tt class="py-line"><tt class="py-docstring"> @raise ResourceNotFoundError: release doesn't exist</tt> </tt>
<a name="L1041"></a><tt class="py-lineno">1041</tt> <tt class="py-line"><tt class="py-docstring"> @raise ResponseError: server returned invalid data</tt> </tt>
<a name="L1042"></a><tt class="py-lineno">1042</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1043"></a><tt class="py-lineno">1043</tt> <tt class="py-line"> <tt class="py-name">uuid</tt> <tt class="py-op">=</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-89" class="py-name"><a title="musicbrainz2.utils.extractUuid" class="py-name" href="#" onclick="return doclink('link-89', 'extractUuid', 'link-38');">extractUuid</a></tt><tt class="py-op">(</tt><tt class="py-name">id_</tt><tt class="py-op">,</tt> <tt class="py-string">'release'</tt><tt class="py-op">)</tt> </tt>
<a name="L1044"></a><tt class="py-lineno">1044</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_getFromWebService</tt><tt class="py-op">(</tt><tt class="py-string">'release'</tt><tt class="py-op">,</tt> <tt class="py-name">uuid</tt><tt class="py-op">,</tt> <tt class="py-name">include</tt><tt class="py-op">)</tt> </tt>
<a name="L1045"></a><tt class="py-lineno">1045</tt> <tt class="py-line"> <tt id="link-90" class="py-name" targets="Variable musicbrainz2.wsxml.Metadata.release=musicbrainz2.wsxml.Metadata-class.html#release,Variable musicbrainz2.wsxml.ReleaseResult.release=musicbrainz2.wsxml.ReleaseResult-class.html#release"><a title="musicbrainz2.wsxml.Metadata.release
musicbrainz2.wsxml.ReleaseResult.release" class="py-name" href="#" onclick="return doclink('link-90', 'release', 'link-90');">release</a></tt> <tt class="py-op">=</tt> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-91" class="py-name" targets="Method musicbrainz2.wsxml.Metadata.getRelease()=musicbrainz2.wsxml.Metadata-class.html#getRelease,Method musicbrainz2.wsxml.ReleaseResult.getRelease()=musicbrainz2.wsxml.ReleaseResult-class.html#getRelease"><a title="musicbrainz2.wsxml.Metadata.getRelease
musicbrainz2.wsxml.ReleaseResult.getRelease" class="py-name" href="#" onclick="return doclink('link-91', 'getRelease', 'link-91');">getRelease</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1046"></a><tt class="py-lineno">1046</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-92" class="py-name"><a title="musicbrainz2.wsxml.Metadata.release
musicbrainz2.wsxml.ReleaseResult.release" class="py-name" href="#" onclick="return doclink('link-92', 'release', 'link-90');">release</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1047"></a><tt class="py-lineno">1047</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-93" class="py-name"><a title="musicbrainz2.wsxml.Metadata.release
musicbrainz2.wsxml.ReleaseResult.release" class="py-name" href="#" onclick="return doclink('link-93', 'release', 'link-90');">release</a></tt> </tt>
<a name="L1048"></a><tt class="py-lineno">1048</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1049"></a><tt class="py-lineno">1049</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-94" class="py-name"><a title="musicbrainz2.webservice.ResponseError" class="py-name" href="#" onclick="return doclink('link-94', 'ResponseError', 'link-80');">ResponseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"server didn't return release"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1050"></a><tt class="py-lineno">1050</tt> <tt class="py-line"> </tt>
<a name="L1051"></a><tt class="py-lineno">1051</tt> <tt class="py-line"> </tt>
<a name="Query.getReleases"></a><div id="Query.getReleases-def"><a name="L1052"></a><tt class="py-lineno">1052</tt> <a class="py-toggle" href="#" id="Query.getReleases-toggle" onclick="return toggle('Query.getReleases');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#getReleases">getReleases</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">filter</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.getReleases-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.getReleases-expanded"><a name="L1053"></a><tt class="py-lineno">1053</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns releases matching given criteria.</tt> </tt>
<a name="L1054"></a><tt class="py-lineno">1054</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1055"></a><tt class="py-lineno">1055</tt> <tt class="py-line"><tt class="py-docstring"> @param filter: a L{ReleaseFilter} object</tt> </tt>
<a name="L1056"></a><tt class="py-lineno">1056</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1057"></a><tt class="py-lineno">1057</tt> <tt class="py-line"><tt class="py-docstring"> @return: a list of L{musicbrainz2.wsxml.ReleaseResult} objects</tt> </tt>
<a name="L1058"></a><tt class="py-lineno">1058</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1059"></a><tt class="py-lineno">1059</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L1060"></a><tt class="py-lineno">1060</tt> <tt class="py-line"><tt class="py-docstring"> @raise RequestError: invalid ID or include tags</tt> </tt>
<a name="L1061"></a><tt class="py-lineno">1061</tt> <tt class="py-line"><tt class="py-docstring"> @raise ResponseError: server returned invalid data</tt> </tt>
<a name="L1062"></a><tt class="py-lineno">1062</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1063"></a><tt class="py-lineno">1063</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_getFromWebService</tt><tt class="py-op">(</tt><tt class="py-string">'release'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">filter</tt><tt class="py-op">=</tt><tt class="py-name">filter</tt><tt class="py-op">)</tt> </tt>
<a name="L1064"></a><tt class="py-lineno">1064</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-95" class="py-name" targets="Method musicbrainz2.wsxml.Metadata.getReleaseResults()=musicbrainz2.wsxml.Metadata-class.html#getReleaseResults"><a title="musicbrainz2.wsxml.Metadata.getReleaseResults" class="py-name" href="#" onclick="return doclink('link-95', 'getReleaseResults', 'link-95');">getReleaseResults</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1065"></a><tt class="py-lineno">1065</tt> <tt class="py-line"> </tt>
<a name="Query.getReleaseGroupById"></a><div id="Query.getReleaseGroupById-def"><a name="L1066"></a><tt class="py-lineno">1066</tt> <a class="py-toggle" href="#" id="Query.getReleaseGroupById-toggle" onclick="return toggle('Query.getReleaseGroupById');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#getReleaseGroupById">getReleaseGroupById</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">id_</tt><tt class="py-op">,</tt> <tt class="py-param">include</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.getReleaseGroupById-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.getReleaseGroupById-expanded"><a name="L1067"></a><tt class="py-lineno">1067</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns a release group.</tt> </tt>
<a name="L1068"></a><tt class="py-lineno">1068</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1069"></a><tt class="py-lineno">1069</tt> <tt class="py-line"><tt class="py-docstring"> If no release group with that ID can be found, C{include}</tt> </tt>
<a name="L1070"></a><tt class="py-lineno">1070</tt> <tt class="py-line"><tt class="py-docstring"> contains invalid tags, or there's a server problem, an</tt> </tt>
<a name="L1071"></a><tt class="py-lineno">1071</tt> <tt class="py-line"><tt class="py-docstring"> exception is raised.</tt> </tt>
<a name="L1072"></a><tt class="py-lineno">1072</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1073"></a><tt class="py-lineno">1073</tt> <tt class="py-line"><tt class="py-docstring"> @param id_: a string containing the release group's ID</tt> </tt>
<a name="L1074"></a><tt class="py-lineno">1074</tt> <tt class="py-line"><tt class="py-docstring"> @param include: a L{ReleaseGroupIncludes} object, or None</tt> </tt>
<a name="L1075"></a><tt class="py-lineno">1075</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1076"></a><tt class="py-lineno">1076</tt> <tt class="py-line"><tt class="py-docstring"> @return: a L{ReleaseGroup <musicbrainz2.model.ReleaseGroup>} object, or None</tt> </tt>
<a name="L1077"></a><tt class="py-lineno">1077</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1078"></a><tt class="py-lineno">1078</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L1079"></a><tt class="py-lineno">1079</tt> <tt class="py-line"><tt class="py-docstring"> @raise RequestError: invalid ID or include tags</tt> </tt>
<a name="L1080"></a><tt class="py-lineno">1080</tt> <tt class="py-line"><tt class="py-docstring"> @raise ResourceNotFoundError: release doesn't exist</tt> </tt>
<a name="L1081"></a><tt class="py-lineno">1081</tt> <tt class="py-line"><tt class="py-docstring"> @raise ResponseError: server returned invalid data</tt> </tt>
<a name="L1082"></a><tt class="py-lineno">1082</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1083"></a><tt class="py-lineno">1083</tt> <tt class="py-line"> <tt class="py-name">uuid</tt> <tt class="py-op">=</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-96" class="py-name"><a title="musicbrainz2.utils.extractUuid" class="py-name" href="#" onclick="return doclink('link-96', 'extractUuid', 'link-38');">extractUuid</a></tt><tt class="py-op">(</tt><tt class="py-name">id_</tt><tt class="py-op">,</tt> <tt class="py-string">'release-group'</tt><tt class="py-op">)</tt> </tt>
<a name="L1084"></a><tt class="py-lineno">1084</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_getFromWebService</tt><tt class="py-op">(</tt><tt class="py-string">'release-group'</tt><tt class="py-op">,</tt> <tt class="py-name">uuid</tt><tt class="py-op">,</tt> <tt class="py-name">include</tt><tt class="py-op">)</tt> </tt>
<a name="L1085"></a><tt class="py-lineno">1085</tt> <tt class="py-line"> <tt id="link-97" class="py-name"><a title="musicbrainz2.model.Release.releaseGroup
musicbrainz2.wsxml.Metadata.releaseGroup
musicbrainz2.wsxml.ReleaseGroupResult.releaseGroup" class="py-name" href="#" onclick="return doclink('link-97', 'releaseGroup', 'link-56');">releaseGroup</a></tt> <tt class="py-op">=</tt> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-98" class="py-name" targets="Method musicbrainz2.model.Release.getReleaseGroup()=musicbrainz2.model.Release-class.html#getReleaseGroup,Method musicbrainz2.wsxml.Metadata.getReleaseGroup()=musicbrainz2.wsxml.Metadata-class.html#getReleaseGroup,Method musicbrainz2.wsxml.ReleaseGroupResult.getReleaseGroup()=musicbrainz2.wsxml.ReleaseGroupResult-class.html#getReleaseGroup"><a title="musicbrainz2.model.Release.getReleaseGroup
musicbrainz2.wsxml.Metadata.getReleaseGroup
musicbrainz2.wsxml.ReleaseGroupResult.getReleaseGroup" class="py-name" href="#" onclick="return doclink('link-98', 'getReleaseGroup', 'link-98');">getReleaseGroup</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1086"></a><tt class="py-lineno">1086</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-99" class="py-name"><a title="musicbrainz2.model.Release.releaseGroup
musicbrainz2.wsxml.Metadata.releaseGroup
musicbrainz2.wsxml.ReleaseGroupResult.releaseGroup" class="py-name" href="#" onclick="return doclink('link-99', 'releaseGroup', 'link-56');">releaseGroup</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1087"></a><tt class="py-lineno">1087</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-100" class="py-name"><a title="musicbrainz2.model.Release.releaseGroup
musicbrainz2.wsxml.Metadata.releaseGroup
musicbrainz2.wsxml.ReleaseGroupResult.releaseGroup" class="py-name" href="#" onclick="return doclink('link-100', 'releaseGroup', 'link-56');">releaseGroup</a></tt> </tt>
<a name="L1088"></a><tt class="py-lineno">1088</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1089"></a><tt class="py-lineno">1089</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-101" class="py-name"><a title="musicbrainz2.webservice.ResponseError" class="py-name" href="#" onclick="return doclink('link-101', 'ResponseError', 'link-80');">ResponseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"server didn't return releaseGroup"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1090"></a><tt class="py-lineno">1090</tt> <tt class="py-line"> </tt>
<a name="Query.getReleaseGroups"></a><div id="Query.getReleaseGroups-def"><a name="L1091"></a><tt class="py-lineno">1091</tt> <a class="py-toggle" href="#" id="Query.getReleaseGroups-toggle" onclick="return toggle('Query.getReleaseGroups');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#getReleaseGroups">getReleaseGroups</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">filter</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.getReleaseGroups-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.getReleaseGroups-expanded"><a name="L1092"></a><tt class="py-lineno">1092</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns release groups matching the given criteria.</tt> </tt>
<a name="L1093"></a><tt class="py-lineno">1093</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1094"></a><tt class="py-lineno">1094</tt> <tt class="py-line"><tt class="py-docstring"> @param filter: a L{ReleaseGroupFilter} object</tt> </tt>
<a name="L1095"></a><tt class="py-lineno">1095</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1096"></a><tt class="py-lineno">1096</tt> <tt class="py-line"><tt class="py-docstring"> @return: a list of L{musicbrainz2.wsxml.ReleaseGroupResult} objects</tt> </tt>
<a name="L1097"></a><tt class="py-lineno">1097</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1098"></a><tt class="py-lineno">1098</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L1099"></a><tt class="py-lineno">1099</tt> <tt class="py-line"><tt class="py-docstring"> @raise RequestError: invalid ID or include tags</tt> </tt>
<a name="L1100"></a><tt class="py-lineno">1100</tt> <tt class="py-line"><tt class="py-docstring"> @raise ResponseError: server returned invalid data</tt> </tt>
<a name="L1101"></a><tt class="py-lineno">1101</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1102"></a><tt class="py-lineno">1102</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_getFromWebService</tt><tt class="py-op">(</tt><tt class="py-string">'release-group'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">filter</tt><tt class="py-op">=</tt><tt class="py-name">filter</tt><tt class="py-op">)</tt> </tt>
<a name="L1103"></a><tt class="py-lineno">1103</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-102" class="py-name" targets="Method musicbrainz2.wsxml.Metadata.getReleaseGroupResults()=musicbrainz2.wsxml.Metadata-class.html#getReleaseGroupResults"><a title="musicbrainz2.wsxml.Metadata.getReleaseGroupResults" class="py-name" href="#" onclick="return doclink('link-102', 'getReleaseGroupResults', 'link-102');">getReleaseGroupResults</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1104"></a><tt class="py-lineno">1104</tt> <tt class="py-line"> </tt>
<a name="Query.getTrackById"></a><div id="Query.getTrackById-def"><a name="L1105"></a><tt class="py-lineno">1105</tt> <a class="py-toggle" href="#" id="Query.getTrackById-toggle" onclick="return toggle('Query.getTrackById');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#getTrackById">getTrackById</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">id_</tt><tt class="py-op">,</tt> <tt class="py-param">include</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.getTrackById-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.getTrackById-expanded"><a name="L1106"></a><tt class="py-lineno">1106</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns a track.</tt> </tt>
<a name="L1107"></a><tt class="py-lineno">1107</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1108"></a><tt class="py-lineno">1108</tt> <tt class="py-line"><tt class="py-docstring"> If no track with that ID can be found, C{include} contains</tt> </tt>
<a name="L1109"></a><tt class="py-lineno">1109</tt> <tt class="py-line"><tt class="py-docstring"> invalid tags or there's a server problem, an exception is</tt> </tt>
<a name="L1110"></a><tt class="py-lineno">1110</tt> <tt class="py-line"><tt class="py-docstring"> raised.</tt> </tt>
<a name="L1111"></a><tt class="py-lineno">1111</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1112"></a><tt class="py-lineno">1112</tt> <tt class="py-line"><tt class="py-docstring"> @param id_: a string containing the track's ID</tt> </tt>
<a name="L1113"></a><tt class="py-lineno">1113</tt> <tt class="py-line"><tt class="py-docstring"> @param include: a L{TrackIncludes} object, or None</tt> </tt>
<a name="L1114"></a><tt class="py-lineno">1114</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1115"></a><tt class="py-lineno">1115</tt> <tt class="py-line"><tt class="py-docstring"> @return: a L{Track <musicbrainz2.model.Track>} object, or None</tt> </tt>
<a name="L1116"></a><tt class="py-lineno">1116</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1117"></a><tt class="py-lineno">1117</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L1118"></a><tt class="py-lineno">1118</tt> <tt class="py-line"><tt class="py-docstring"> @raise RequestError: invalid ID or include tags</tt> </tt>
<a name="L1119"></a><tt class="py-lineno">1119</tt> <tt class="py-line"><tt class="py-docstring"> @raise ResourceNotFoundError: track doesn't exist</tt> </tt>
<a name="L1120"></a><tt class="py-lineno">1120</tt> <tt class="py-line"><tt class="py-docstring"> @raise ResponseError: server returned invalid data</tt> </tt>
<a name="L1121"></a><tt class="py-lineno">1121</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1122"></a><tt class="py-lineno">1122</tt> <tt class="py-line"> <tt class="py-name">uuid</tt> <tt class="py-op">=</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-103" class="py-name"><a title="musicbrainz2.utils.extractUuid" class="py-name" href="#" onclick="return doclink('link-103', 'extractUuid', 'link-38');">extractUuid</a></tt><tt class="py-op">(</tt><tt class="py-name">id_</tt><tt class="py-op">,</tt> <tt class="py-string">'track'</tt><tt class="py-op">)</tt> </tt>
<a name="L1123"></a><tt class="py-lineno">1123</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_getFromWebService</tt><tt class="py-op">(</tt><tt class="py-string">'track'</tt><tt class="py-op">,</tt> <tt class="py-name">uuid</tt><tt class="py-op">,</tt> <tt class="py-name">include</tt><tt class="py-op">)</tt> </tt>
<a name="L1124"></a><tt class="py-lineno">1124</tt> <tt class="py-line"> <tt id="link-104" class="py-name" targets="Variable musicbrainz2.wsxml.Metadata.track=musicbrainz2.wsxml.Metadata-class.html#track,Variable musicbrainz2.wsxml.TrackResult.track=musicbrainz2.wsxml.TrackResult-class.html#track"><a title="musicbrainz2.wsxml.Metadata.track
musicbrainz2.wsxml.TrackResult.track" class="py-name" href="#" onclick="return doclink('link-104', 'track', 'link-104');">track</a></tt> <tt class="py-op">=</tt> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-105" class="py-name" targets="Method musicbrainz2.wsxml.Metadata.getTrack()=musicbrainz2.wsxml.Metadata-class.html#getTrack,Method musicbrainz2.wsxml.TrackResult.getTrack()=musicbrainz2.wsxml.TrackResult-class.html#getTrack"><a title="musicbrainz2.wsxml.Metadata.getTrack
musicbrainz2.wsxml.TrackResult.getTrack" class="py-name" href="#" onclick="return doclink('link-105', 'getTrack', 'link-105');">getTrack</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1125"></a><tt class="py-lineno">1125</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-106" class="py-name"><a title="musicbrainz2.wsxml.Metadata.track
musicbrainz2.wsxml.TrackResult.track" class="py-name" href="#" onclick="return doclink('link-106', 'track', 'link-104');">track</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1126"></a><tt class="py-lineno">1126</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-107" class="py-name"><a title="musicbrainz2.wsxml.Metadata.track
musicbrainz2.wsxml.TrackResult.track" class="py-name" href="#" onclick="return doclink('link-107', 'track', 'link-104');">track</a></tt> </tt>
<a name="L1127"></a><tt class="py-lineno">1127</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1128"></a><tt class="py-lineno">1128</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-108" class="py-name"><a title="musicbrainz2.webservice.ResponseError" class="py-name" href="#" onclick="return doclink('link-108', 'ResponseError', 'link-80');">ResponseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"server didn't return track"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1129"></a><tt class="py-lineno">1129</tt> <tt class="py-line"> </tt>
<a name="L1130"></a><tt class="py-lineno">1130</tt> <tt class="py-line"> </tt>
<a name="Query.getTracks"></a><div id="Query.getTracks-def"><a name="L1131"></a><tt class="py-lineno">1131</tt> <a class="py-toggle" href="#" id="Query.getTracks-toggle" onclick="return toggle('Query.getTracks');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#getTracks">getTracks</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">filter</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.getTracks-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.getTracks-expanded"><a name="L1132"></a><tt class="py-lineno">1132</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns tracks matching given criteria.</tt> </tt>
<a name="L1133"></a><tt class="py-lineno">1133</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1134"></a><tt class="py-lineno">1134</tt> <tt class="py-line"><tt class="py-docstring"> @param filter: a L{TrackFilter} object</tt> </tt>
<a name="L1135"></a><tt class="py-lineno">1135</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1136"></a><tt class="py-lineno">1136</tt> <tt class="py-line"><tt class="py-docstring"> @return: a list of L{musicbrainz2.wsxml.TrackResult} objects</tt> </tt>
<a name="L1137"></a><tt class="py-lineno">1137</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1138"></a><tt class="py-lineno">1138</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L1139"></a><tt class="py-lineno">1139</tt> <tt class="py-line"><tt class="py-docstring"> @raise RequestError: invalid ID or include tags</tt> </tt>
<a name="L1140"></a><tt class="py-lineno">1140</tt> <tt class="py-line"><tt class="py-docstring"> @raise ResponseError: server returned invalid data</tt> </tt>
<a name="L1141"></a><tt class="py-lineno">1141</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1142"></a><tt class="py-lineno">1142</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_getFromWebService</tt><tt class="py-op">(</tt><tt class="py-string">'track'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">filter</tt><tt class="py-op">=</tt><tt class="py-name">filter</tt><tt class="py-op">)</tt> </tt>
<a name="L1143"></a><tt class="py-lineno">1143</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-109" class="py-name" targets="Method musicbrainz2.wsxml.Metadata.getTrackResults()=musicbrainz2.wsxml.Metadata-class.html#getTrackResults"><a title="musicbrainz2.wsxml.Metadata.getTrackResults" class="py-name" href="#" onclick="return doclink('link-109', 'getTrackResults', 'link-109');">getTrackResults</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1144"></a><tt class="py-lineno">1144</tt> <tt class="py-line"> </tt>
<a name="L1145"></a><tt class="py-lineno">1145</tt> <tt class="py-line"> </tt>
<a name="Query.getUserByName"></a><div id="Query.getUserByName-def"><a name="L1146"></a><tt class="py-lineno">1146</tt> <a class="py-toggle" href="#" id="Query.getUserByName-toggle" onclick="return toggle('Query.getUserByName');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#getUserByName">getUserByName</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.getUserByName-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.getUserByName-expanded"><a name="L1147"></a><tt class="py-lineno">1147</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns information about a MusicBrainz user.</tt> </tt>
<a name="L1148"></a><tt class="py-lineno">1148</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1149"></a><tt class="py-lineno">1149</tt> <tt class="py-line"><tt class="py-docstring"> You can only request user data if you know the user name and</tt> </tt>
<a name="L1150"></a><tt class="py-lineno">1150</tt> <tt class="py-line"><tt class="py-docstring"> password for that account. If username and/or password are</tt> </tt>
<a name="L1151"></a><tt class="py-lineno">1151</tt> <tt class="py-line"><tt class="py-docstring"> incorrect, an L{AuthenticationError} is raised.</tt> </tt>
<a name="L1152"></a><tt class="py-lineno">1152</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1153"></a><tt class="py-lineno">1153</tt> <tt class="py-line"><tt class="py-docstring"> See the example in L{Query} on how to supply user name and</tt> </tt>
<a name="L1154"></a><tt class="py-lineno">1154</tt> <tt class="py-line"><tt class="py-docstring"> password.</tt> </tt>
<a name="L1155"></a><tt class="py-lineno">1155</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1156"></a><tt class="py-lineno">1156</tt> <tt class="py-line"><tt class="py-docstring"> @param name: a unicode string containing the user's name</tt> </tt>
<a name="L1157"></a><tt class="py-lineno">1157</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1158"></a><tt class="py-lineno">1158</tt> <tt class="py-line"><tt class="py-docstring"> @return: a L{User <musicbrainz2.model.User>} object</tt> </tt>
<a name="L1159"></a><tt class="py-lineno">1159</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1160"></a><tt class="py-lineno">1160</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L1161"></a><tt class="py-lineno">1161</tt> <tt class="py-line"><tt class="py-docstring"> @raise RequestError: invalid ID or include tags</tt> </tt>
<a name="L1162"></a><tt class="py-lineno">1162</tt> <tt class="py-line"><tt class="py-docstring"> @raise AuthenticationError: invalid user name and/or password</tt> </tt>
<a name="L1163"></a><tt class="py-lineno">1163</tt> <tt class="py-line"><tt class="py-docstring"> @raise ResourceNotFoundError: track doesn't exist</tt> </tt>
<a name="L1164"></a><tt class="py-lineno">1164</tt> <tt class="py-line"><tt class="py-docstring"> @raise ResponseError: server returned invalid data</tt> </tt>
<a name="L1165"></a><tt class="py-lineno">1165</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1166"></a><tt class="py-lineno">1166</tt> <tt class="py-line"> <tt class="py-name">filter</tt> <tt class="py-op">=</tt> <tt id="link-110" class="py-name" targets="Class musicbrainz2.webservice.UserFilter=musicbrainz2.webservice.UserFilter-class.html"><a title="musicbrainz2.webservice.UserFilter" class="py-name" href="#" onclick="return doclink('link-110', 'UserFilter', 'link-110');">UserFilter</a></tt><tt class="py-op">(</tt><tt id="link-111" class="py-name"><a title="musicbrainz2.model.Artist.name
musicbrainz2.model.Label.name
musicbrainz2.model.User.name" class="py-name" href="#" onclick="return doclink('link-111', 'name', 'link-34');">name</a></tt><tt class="py-op">=</tt><tt id="link-112" class="py-name"><a title="musicbrainz2.model.Artist.name
musicbrainz2.model.Label.name
musicbrainz2.model.User.name" class="py-name" href="#" onclick="return doclink('link-112', 'name', 'link-34');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1167"></a><tt class="py-lineno">1167</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_getFromWebService</tt><tt class="py-op">(</tt><tt class="py-string">'user'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-name">filter</tt><tt class="py-op">)</tt> </tt>
<a name="L1168"></a><tt class="py-lineno">1168</tt> <tt class="py-line"> </tt>
<a name="L1169"></a><tt class="py-lineno">1169</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-113" class="py-name" targets="Method musicbrainz2.wsxml.Metadata.getUserList()=musicbrainz2.wsxml.Metadata-class.html#getUserList"><a title="musicbrainz2.wsxml.Metadata.getUserList" class="py-name" href="#" onclick="return doclink('link-113', 'getUserList', 'link-113');">getUserList</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L1170"></a><tt class="py-lineno">1170</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-114" class="py-name"><a title="musicbrainz2.wsxml.Metadata.getUserList" class="py-name" href="#" onclick="return doclink('link-114', 'getUserList', 'link-113');">getUserList</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L1171"></a><tt class="py-lineno">1171</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1172"></a><tt class="py-lineno">1172</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-115" class="py-name"><a title="musicbrainz2.webservice.ResponseError" class="py-name" href="#" onclick="return doclink('link-115', 'ResponseError', 'link-80');">ResponseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"response didn't contain user data"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1173"></a><tt class="py-lineno">1173</tt> <tt class="py-line"> </tt>
<a name="L1174"></a><tt class="py-lineno">1174</tt> <tt class="py-line"> </tt>
<a name="Query._getFromWebService"></a><div id="Query._getFromWebService-def"><a name="L1175"></a><tt class="py-lineno">1175</tt> <a class="py-toggle" href="#" id="Query._getFromWebService-toggle" onclick="return toggle('Query._getFromWebService');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#_getFromWebService">_getFromWebService</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">entity</tt><tt class="py-op">,</tt> <tt class="py-param">id_</tt><tt class="py-op">,</tt> <tt class="py-param">include</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">filter</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query._getFromWebService-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query._getFromWebService-expanded"><a name="L1176"></a><tt class="py-lineno">1176</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">filter</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1177"></a><tt class="py-lineno">1177</tt> <tt class="py-line"> <tt class="py-name">filterParams</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> <tt class="py-op">]</tt> </tt>
<a name="L1178"></a><tt class="py-lineno">1178</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1179"></a><tt class="py-lineno">1179</tt> <tt class="py-line"> <tt class="py-name">filterParams</tt> <tt class="py-op">=</tt> <tt class="py-name">filter</tt><tt class="py-op">.</tt><tt id="link-116" class="py-name" targets="Method musicbrainz2.webservice.ArtistFilter.createParameters()=musicbrainz2.webservice.ArtistFilter-class.html#createParameters,Method musicbrainz2.webservice.IFilter.createParameters()=musicbrainz2.webservice.IFilter-class.html#createParameters,Method musicbrainz2.webservice.LabelFilter.createParameters()=musicbrainz2.webservice.LabelFilter-class.html#createParameters,Method musicbrainz2.webservice.ReleaseFilter.createParameters()=musicbrainz2.webservice.ReleaseFilter-class.html#createParameters,Method musicbrainz2.webservice.ReleaseGroupFilter.createParameters()=musicbrainz2.webservice.ReleaseGroupFilter-class.html#createParameters,Method musicbrainz2.webservice.TrackFilter.createParameters()=musicbrainz2.webservice.TrackFilter-class.html#createParameters,Method musicbrainz2.webservice.UserFilter.createParameters()=musicbrainz2.webservice.UserFilter-class.html#createParameters"><a title="musicbrainz2.webservice.ArtistFilter.createParameters
musicbrainz2.webservice.IFilter.createParameters
musicbrainz2.webservice.LabelFilter.createParameters
musicbrainz2.webservice.ReleaseFilter.createParameters
musicbrainz2.webservice.ReleaseGroupFilter.createParameters
musicbrainz2.webservice.TrackFilter.createParameters
musicbrainz2.webservice.UserFilter.createParameters" class="py-name" href="#" onclick="return doclink('link-116', 'createParameters', 'link-116');">createParameters</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1180"></a><tt class="py-lineno">1180</tt> <tt class="py-line"> </tt>
<a name="L1181"></a><tt class="py-lineno">1181</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">include</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1182"></a><tt class="py-lineno">1182</tt> <tt class="py-line"> <tt class="py-name">includeParams</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> <tt class="py-op">]</tt> </tt>
<a name="L1183"></a><tt class="py-lineno">1183</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1184"></a><tt class="py-lineno">1184</tt> <tt class="py-line"> <tt class="py-name">includeParams</tt> <tt class="py-op">=</tt> <tt class="py-name">include</tt><tt class="py-op">.</tt><tt id="link-117" class="py-name" targets="Method musicbrainz2.webservice.ArtistIncludes.createIncludeTags()=musicbrainz2.webservice.ArtistIncludes-class.html#createIncludeTags,Method musicbrainz2.webservice.IIncludes.createIncludeTags()=musicbrainz2.webservice.IIncludes-class.html#createIncludeTags,Method musicbrainz2.webservice.LabelIncludes.createIncludeTags()=musicbrainz2.webservice.LabelIncludes-class.html#createIncludeTags,Method musicbrainz2.webservice.ReleaseGroupIncludes.createIncludeTags()=musicbrainz2.webservice.ReleaseGroupIncludes-class.html#createIncludeTags,Method musicbrainz2.webservice.ReleaseIncludes.createIncludeTags()=musicbrainz2.webservice.ReleaseIncludes-class.html#createIncludeTags,Method musicbrainz2.webservice.TrackIncludes.createIncludeTags()=musicbrainz2.webservice.TrackIncludes-class.html#createIncludeTags"><a title="musicbrainz2.webservice.ArtistIncludes.createIncludeTags
musicbrainz2.webservice.IIncludes.createIncludeTags
musicbrainz2.webservice.LabelIncludes.createIncludeTags
musicbrainz2.webservice.ReleaseGroupIncludes.createIncludeTags
musicbrainz2.webservice.ReleaseIncludes.createIncludeTags
musicbrainz2.webservice.TrackIncludes.createIncludeTags" class="py-name" href="#" onclick="return doclink('link-117', 'createIncludeTags', 'link-117');">createIncludeTags</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1185"></a><tt class="py-lineno">1185</tt> <tt class="py-line"> </tt>
<a name="L1186"></a><tt class="py-lineno">1186</tt> <tt class="py-line"> <tt class="py-name">stream</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_ws</tt><tt class="py-op">.</tt><tt id="link-118" class="py-name"><a title="musicbrainz2.webservice.IWebService.get
musicbrainz2.webservice.WebService.get" class="py-name" href="#" onclick="return doclink('link-118', 'get', 'link-12');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">entity</tt><tt class="py-op">,</tt> <tt class="py-name">id_</tt><tt class="py-op">,</tt> <tt class="py-name">includeParams</tt><tt class="py-op">,</tt> <tt class="py-name">filterParams</tt><tt class="py-op">)</tt> </tt>
<a name="L1187"></a><tt class="py-lineno">1187</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1188"></a><tt class="py-lineno">1188</tt> <tt class="py-line"> <tt class="py-name">parser</tt> <tt class="py-op">=</tt> <tt id="link-119" class="py-name"><a title="musicbrainz2.wsxml.MbXmlParser" class="py-name" href="#" onclick="return doclink('link-119', 'MbXmlParser', 'link-7');">MbXmlParser</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1189"></a><tt class="py-lineno">1189</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">parser</tt><tt class="py-op">.</tt><tt id="link-120" class="py-name" targets="Method musicbrainz2.wsxml.MbXmlParser.parse()=musicbrainz2.wsxml.MbXmlParser-class.html#parse"><a title="musicbrainz2.wsxml.MbXmlParser.parse" class="py-name" href="#" onclick="return doclink('link-120', 'parse', 'link-120');">parse</a></tt><tt class="py-op">(</tt><tt class="py-name">stream</tt><tt class="py-op">)</tt> </tt>
<a name="L1190"></a><tt class="py-lineno">1190</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-121" class="py-name"><a title="musicbrainz2.wsxml.ParseError" class="py-name" href="#" onclick="return doclink('link-121', 'ParseError', 'link-8');">ParseError</a></tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L1191"></a><tt class="py-lineno">1191</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-122" class="py-name"><a title="musicbrainz2.webservice.ResponseError" class="py-name" href="#" onclick="return doclink('link-122', 'ResponseError', 'link-80');">ResponseError</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1192"></a><tt class="py-lineno">1192</tt> <tt class="py-line"> </tt>
<a name="L1193"></a><tt class="py-lineno">1193</tt> <tt class="py-line"> </tt>
<a name="Query.submitPuids"></a><div id="Query.submitPuids-def"><a name="L1194"></a><tt class="py-lineno">1194</tt> <a class="py-toggle" href="#" id="Query.submitPuids-toggle" onclick="return toggle('Query.submitPuids');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#submitPuids">submitPuids</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">tracks2puids</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.submitPuids-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.submitPuids-expanded"><a name="L1195"></a><tt class="py-lineno">1195</tt> <tt class="py-line"> <tt class="py-docstring">"""Submit track to PUID mappings.</tt> </tt>
<a name="L1196"></a><tt class="py-lineno">1196</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1197"></a><tt class="py-lineno">1197</tt> <tt class="py-line"><tt class="py-docstring"> The C{tracks2puids} parameter has to be a dictionary, with the</tt> </tt>
<a name="L1198"></a><tt class="py-lineno">1198</tt> <tt class="py-line"><tt class="py-docstring"> keys being MusicBrainz track IDs (either as absolute URIs or</tt> </tt>
<a name="L1199"></a><tt class="py-lineno">1199</tt> <tt class="py-line"><tt class="py-docstring"> in their 36 character ASCII representation) and the values</tt> </tt>
<a name="L1200"></a><tt class="py-lineno">1200</tt> <tt class="py-line"><tt class="py-docstring"> being PUIDs (ASCII, 36 characters).</tt> </tt>
<a name="L1201"></a><tt class="py-lineno">1201</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1202"></a><tt class="py-lineno">1202</tt> <tt class="py-line"><tt class="py-docstring"> Note that this method only works if a valid user name and</tt> </tt>
<a name="L1203"></a><tt class="py-lineno">1203</tt> <tt class="py-line"><tt class="py-docstring"> password have been set. See the example in L{Query} on how</tt> </tt>
<a name="L1204"></a><tt class="py-lineno">1204</tt> <tt class="py-line"><tt class="py-docstring"> to supply authentication data.</tt> </tt>
<a name="L1205"></a><tt class="py-lineno">1205</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1206"></a><tt class="py-lineno">1206</tt> <tt class="py-line"><tt class="py-docstring"> @param tracks2puids: a dictionary mapping track IDs to PUIDs</tt> </tt>
<a name="L1207"></a><tt class="py-lineno">1207</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1208"></a><tt class="py-lineno">1208</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L1209"></a><tt class="py-lineno">1209</tt> <tt class="py-line"><tt class="py-docstring"> @raise RequestError: invalid track or PUIDs</tt> </tt>
<a name="L1210"></a><tt class="py-lineno">1210</tt> <tt class="py-line"><tt class="py-docstring"> @raise AuthenticationError: invalid user name and/or password</tt> </tt>
<a name="L1211"></a><tt class="py-lineno">1211</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1212"></a><tt class="py-lineno">1212</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_clientId</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-string">'Please supply a client ID'</tt> </tt>
<a name="L1213"></a><tt class="py-lineno">1213</tt> <tt class="py-line"> <tt class="py-name">params</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> <tt class="py-op">]</tt> </tt>
<a name="L1214"></a><tt class="py-lineno">1214</tt> <tt class="py-line"> <tt class="py-name">params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-string">'client'</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_clientId</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-string">'utf-8'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L1215"></a><tt class="py-lineno">1215</tt> <tt class="py-line"> </tt>
<a name="L1216"></a><tt class="py-lineno">1216</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">trackId</tt><tt class="py-op">,</tt> <tt class="py-name">puid</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">tracks2puids</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1217"></a><tt class="py-lineno">1217</tt> <tt class="py-line"> <tt class="py-name">trackId</tt> <tt class="py-op">=</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-123" class="py-name"><a title="musicbrainz2.utils.extractUuid" class="py-name" href="#" onclick="return doclink('link-123', 'extractUuid', 'link-38');">extractUuid</a></tt><tt class="py-op">(</tt><tt class="py-name">trackId</tt><tt class="py-op">,</tt> <tt class="py-string">'track'</tt><tt class="py-op">)</tt> </tt>
<a name="L1218"></a><tt class="py-lineno">1218</tt> <tt class="py-line"> <tt class="py-name">params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-string">'puid'</tt><tt class="py-op">,</tt> <tt class="py-name">trackId</tt> <tt class="py-op">+</tt> <tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">puid</tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L1219"></a><tt class="py-lineno">1219</tt> <tt class="py-line"> </tt>
<a name="L1220"></a><tt class="py-lineno">1220</tt> <tt class="py-line"> <tt class="py-name">encodedStr</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">urlencode</tt><tt class="py-op">(</tt><tt class="py-name">params</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L1221"></a><tt class="py-lineno">1221</tt> <tt class="py-line"> </tt>
<a name="L1222"></a><tt class="py-lineno">1222</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_ws</tt><tt class="py-op">.</tt><tt id="link-124" class="py-name" targets="Method musicbrainz2.webservice.IWebService.post()=musicbrainz2.webservice.IWebService-class.html#post,Method musicbrainz2.webservice.WebService.post()=musicbrainz2.webservice.WebService-class.html#post"><a title="musicbrainz2.webservice.IWebService.post
musicbrainz2.webservice.WebService.post" class="py-name" href="#" onclick="return doclink('link-124', 'post', 'link-124');">post</a></tt><tt class="py-op">(</tt><tt class="py-string">'track'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">encodedStr</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1223"></a><tt class="py-lineno">1223</tt> <tt class="py-line"> </tt>
<a name="Query.submitISRCs"></a><div id="Query.submitISRCs-def"><a name="L1224"></a><tt class="py-lineno">1224</tt> <a class="py-toggle" href="#" id="Query.submitISRCs-toggle" onclick="return toggle('Query.submitISRCs');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#submitISRCs">submitISRCs</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">tracks2isrcs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.submitISRCs-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.submitISRCs-expanded"><a name="L1225"></a><tt class="py-lineno">1225</tt> <tt class="py-line"> <tt class="py-docstring">"""Submit track to ISRC mappings.</tt> </tt>
<a name="L1226"></a><tt class="py-lineno">1226</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1227"></a><tt class="py-lineno">1227</tt> <tt class="py-line"><tt class="py-docstring"> The C{tracks2isrcs} parameter has to be a dictionary, with the</tt> </tt>
<a name="L1228"></a><tt class="py-lineno">1228</tt> <tt class="py-line"><tt class="py-docstring"> keys being MusicBrainz track IDs (either as absolute URIs or</tt> </tt>
<a name="L1229"></a><tt class="py-lineno">1229</tt> <tt class="py-line"><tt class="py-docstring"> in their 36 character ASCII representation) and the values</tt> </tt>
<a name="L1230"></a><tt class="py-lineno">1230</tt> <tt class="py-line"><tt class="py-docstring"> being ISRCs (ASCII, 12 characters).</tt> </tt>
<a name="L1231"></a><tt class="py-lineno">1231</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1232"></a><tt class="py-lineno">1232</tt> <tt class="py-line"><tt class="py-docstring"> Note that this method only works if a valid user name and</tt> </tt>
<a name="L1233"></a><tt class="py-lineno">1233</tt> <tt class="py-line"><tt class="py-docstring"> password have been set. See the example in L{Query} on how</tt> </tt>
<a name="L1234"></a><tt class="py-lineno">1234</tt> <tt class="py-line"><tt class="py-docstring"> to supply authentication data.</tt> </tt>
<a name="L1235"></a><tt class="py-lineno">1235</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1236"></a><tt class="py-lineno">1236</tt> <tt class="py-line"><tt class="py-docstring"> @param tracks2isrcs: a dictionary mapping track IDs to ISRCs</tt> </tt>
<a name="L1237"></a><tt class="py-lineno">1237</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1238"></a><tt class="py-lineno">1238</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L1239"></a><tt class="py-lineno">1239</tt> <tt class="py-line"><tt class="py-docstring"> @raise RequestError: invalid track or ISRCs</tt> </tt>
<a name="L1240"></a><tt class="py-lineno">1240</tt> <tt class="py-line"><tt class="py-docstring"> @raise AuthenticationError: invalid user name and/or password</tt> </tt>
<a name="L1241"></a><tt class="py-lineno">1241</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1242"></a><tt class="py-lineno">1242</tt> <tt class="py-line"> <tt class="py-name">params</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> <tt class="py-op">]</tt> </tt>
<a name="L1243"></a><tt class="py-lineno">1243</tt> <tt class="py-line"> </tt>
<a name="L1244"></a><tt class="py-lineno">1244</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">trackId</tt><tt class="py-op">,</tt> <tt class="py-name">isrc</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">tracks2isrcs</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1245"></a><tt class="py-lineno">1245</tt> <tt class="py-line"> <tt class="py-name">trackId</tt> <tt class="py-op">=</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-125" class="py-name"><a title="musicbrainz2.utils.extractUuid" class="py-name" href="#" onclick="return doclink('link-125', 'extractUuid', 'link-38');">extractUuid</a></tt><tt class="py-op">(</tt><tt class="py-name">trackId</tt><tt class="py-op">,</tt> <tt class="py-string">'track'</tt><tt class="py-op">)</tt> </tt>
<a name="L1246"></a><tt class="py-lineno">1246</tt> <tt class="py-line"> <tt class="py-name">params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-string">'isrc'</tt><tt class="py-op">,</tt> <tt class="py-name">trackId</tt> <tt class="py-op">+</tt> <tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">isrc</tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L1247"></a><tt class="py-lineno">1247</tt> <tt class="py-line"> </tt>
<a name="L1248"></a><tt class="py-lineno">1248</tt> <tt class="py-line"> <tt class="py-name">encodedStr</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">urlencode</tt><tt class="py-op">(</tt><tt class="py-name">params</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L1249"></a><tt class="py-lineno">1249</tt> <tt class="py-line"> </tt>
<a name="L1250"></a><tt class="py-lineno">1250</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_ws</tt><tt class="py-op">.</tt><tt id="link-126" class="py-name"><a title="musicbrainz2.webservice.IWebService.post
musicbrainz2.webservice.WebService.post" class="py-name" href="#" onclick="return doclink('link-126', 'post', 'link-124');">post</a></tt><tt class="py-op">(</tt><tt class="py-string">'track'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">encodedStr</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1251"></a><tt class="py-lineno">1251</tt> <tt class="py-line"> </tt>
<a name="Query.addToUserCollection"></a><div id="Query.addToUserCollection-def"><a name="L1252"></a><tt class="py-lineno">1252</tt> <a class="py-toggle" href="#" id="Query.addToUserCollection-toggle" onclick="return toggle('Query.addToUserCollection');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#addToUserCollection">addToUserCollection</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">releases</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.addToUserCollection-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.addToUserCollection-expanded"><a name="L1253"></a><tt class="py-lineno">1253</tt> <tt class="py-line"> <tt class="py-docstring">"""Add releases to a user's collection.</tt> </tt>
<a name="L1254"></a><tt class="py-lineno">1254</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1255"></a><tt class="py-lineno">1255</tt> <tt class="py-line"><tt class="py-docstring"> The releases parameter must be a list. It can contain either L{Release}</tt> </tt>
<a name="L1256"></a><tt class="py-lineno">1256</tt> <tt class="py-line"><tt class="py-docstring"> objects or a string representing a MusicBrainz release ID (either as</tt> </tt>
<a name="L1257"></a><tt class="py-lineno">1257</tt> <tt class="py-line"><tt class="py-docstring"> absolute URIs or in their 36 character ASCII representation).</tt> </tt>
<a name="L1258"></a><tt class="py-lineno">1258</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1259"></a><tt class="py-lineno">1259</tt> <tt class="py-line"><tt class="py-docstring"> Adding a release that is already in the collection has no effect.</tt> </tt>
<a name="L1260"></a><tt class="py-lineno">1260</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1261"></a><tt class="py-lineno">1261</tt> <tt class="py-line"><tt class="py-docstring"> @param releases: a list of releases to add to the user collection</tt> </tt>
<a name="L1262"></a><tt class="py-lineno">1262</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1263"></a><tt class="py-lineno">1263</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L1264"></a><tt class="py-lineno">1264</tt> <tt class="py-line"><tt class="py-docstring"> @raise AuthenticationError: invalid user name and/or password</tt> </tt>
<a name="L1265"></a><tt class="py-lineno">1265</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1266"></a><tt class="py-lineno">1266</tt> <tt class="py-line"> <tt class="py-name">rels</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1267"></a><tt class="py-lineno">1267</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-127" class="py-name"><a title="musicbrainz2.wsxml.Metadata.release
musicbrainz2.wsxml.ReleaseResult.release" class="py-name" href="#" onclick="return doclink('link-127', 'release', 'link-90');">release</a></tt> <tt class="py-keyword">in</tt> <tt id="link-128" class="py-name"><a title="musicbrainz2.model.Artist.releases
musicbrainz2.model.ReleaseGroup.releases
musicbrainz2.model.Track.releases" class="py-name" href="#" onclick="return doclink('link-128', 'releases', 'link-47');">releases</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1268"></a><tt class="py-lineno">1268</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-129" class="py-name"><a title="musicbrainz2.wsxml.Metadata.release
musicbrainz2.wsxml.ReleaseResult.release" class="py-name" href="#" onclick="return doclink('link-129', 'release', 'link-90');">release</a></tt><tt class="py-op">,</tt> <tt id="link-130" class="py-name"><a title="musicbrainz2.model.Release" class="py-name" href="#" onclick="return doclink('link-130', 'Release', 'link-4');">Release</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1269"></a><tt class="py-lineno">1269</tt> <tt class="py-line"> <tt class="py-name">rels</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-131" class="py-name"><a title="musicbrainz2.utils.extractUuid" class="py-name" href="#" onclick="return doclink('link-131', 'extractUuid', 'link-38');">extractUuid</a></tt><tt class="py-op">(</tt><tt id="link-132" class="py-name"><a title="musicbrainz2.wsxml.Metadata.release
musicbrainz2.wsxml.ReleaseResult.release" class="py-name" href="#" onclick="return doclink('link-132', 'release', 'link-90');">release</a></tt><tt class="py-op">.</tt><tt id="link-133" class="py-name" targets="Variable musicbrainz2.model.Disc.id=musicbrainz2.model.Disc-class.html#id,Variable musicbrainz2.model.Entity.id=musicbrainz2.model.Entity-class.html#id"><a title="musicbrainz2.model.Disc.id
musicbrainz2.model.Entity.id" class="py-name" href="#" onclick="return doclink('link-133', 'id', 'link-133');">id</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1270"></a><tt class="py-lineno">1270</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1271"></a><tt class="py-lineno">1271</tt> <tt class="py-line"> <tt class="py-name">rels</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-134" class="py-name"><a title="musicbrainz2.utils.extractUuid" class="py-name" href="#" onclick="return doclink('link-134', 'extractUuid', 'link-38');">extractUuid</a></tt><tt class="py-op">(</tt><tt id="link-135" class="py-name"><a title="musicbrainz2.wsxml.Metadata.release
musicbrainz2.wsxml.ReleaseResult.release" class="py-name" href="#" onclick="return doclink('link-135', 'release', 'link-90');">release</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1272"></a><tt class="py-lineno">1272</tt> <tt class="py-line"> <tt class="py-name">encodedStr</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">urlencode</tt><tt class="py-op">(</tt><tt class="py-op">{</tt><tt class="py-string">'add'</tt><tt class="py-op">:</tt> <tt class="py-string">","</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">rels</tt><tt class="py-op">)</tt><tt class="py-op">}</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L1273"></a><tt class="py-lineno">1273</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_ws</tt><tt class="py-op">.</tt><tt id="link-136" class="py-name"><a title="musicbrainz2.webservice.IWebService.post
musicbrainz2.webservice.WebService.post" class="py-name" href="#" onclick="return doclink('link-136', 'post', 'link-124');">post</a></tt><tt class="py-op">(</tt><tt class="py-string">'collection'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">encodedStr</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1274"></a><tt class="py-lineno">1274</tt> <tt class="py-line"> </tt>
<a name="Query.removeFromUserCollection"></a><div id="Query.removeFromUserCollection-def"><a name="L1275"></a><tt class="py-lineno">1275</tt> <a class="py-toggle" href="#" id="Query.removeFromUserCollection-toggle" onclick="return toggle('Query.removeFromUserCollection');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#removeFromUserCollection">removeFromUserCollection</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">releases</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.removeFromUserCollection-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.removeFromUserCollection-expanded"><a name="L1276"></a><tt class="py-lineno">1276</tt> <tt class="py-line"> <tt class="py-docstring">"""Remove releases from a user's collection.</tt> </tt>
<a name="L1277"></a><tt class="py-lineno">1277</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1278"></a><tt class="py-lineno">1278</tt> <tt class="py-line"><tt class="py-docstring"> The releases parameter must be a list. It can contain either L{Release}</tt> </tt>
<a name="L1279"></a><tt class="py-lineno">1279</tt> <tt class="py-line"><tt class="py-docstring"> objects or a string representing a MusicBrainz release ID (either as</tt> </tt>
<a name="L1280"></a><tt class="py-lineno">1280</tt> <tt class="py-line"><tt class="py-docstring"> absolute URIs or in their 36 character ASCII representation).</tt> </tt>
<a name="L1281"></a><tt class="py-lineno">1281</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1282"></a><tt class="py-lineno">1282</tt> <tt class="py-line"><tt class="py-docstring"> Removing a release that is not in the collection has no effect.</tt> </tt>
<a name="L1283"></a><tt class="py-lineno">1283</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1284"></a><tt class="py-lineno">1284</tt> <tt class="py-line"><tt class="py-docstring"> @param releases: a list of releases to remove from the user collection</tt> </tt>
<a name="L1285"></a><tt class="py-lineno">1285</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1286"></a><tt class="py-lineno">1286</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L1287"></a><tt class="py-lineno">1287</tt> <tt class="py-line"><tt class="py-docstring"> @raise AuthenticationError: invalid user name and/or password</tt> </tt>
<a name="L1288"></a><tt class="py-lineno">1288</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1289"></a><tt class="py-lineno">1289</tt> <tt class="py-line"> <tt class="py-name">rels</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1290"></a><tt class="py-lineno">1290</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-137" class="py-name"><a title="musicbrainz2.wsxml.Metadata.release
musicbrainz2.wsxml.ReleaseResult.release" class="py-name" href="#" onclick="return doclink('link-137', 'release', 'link-90');">release</a></tt> <tt class="py-keyword">in</tt> <tt id="link-138" class="py-name"><a title="musicbrainz2.model.Artist.releases
musicbrainz2.model.ReleaseGroup.releases
musicbrainz2.model.Track.releases" class="py-name" href="#" onclick="return doclink('link-138', 'releases', 'link-47');">releases</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1291"></a><tt class="py-lineno">1291</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-139" class="py-name"><a title="musicbrainz2.wsxml.Metadata.release
musicbrainz2.wsxml.ReleaseResult.release" class="py-name" href="#" onclick="return doclink('link-139', 'release', 'link-90');">release</a></tt><tt class="py-op">,</tt> <tt id="link-140" class="py-name"><a title="musicbrainz2.model.Release" class="py-name" href="#" onclick="return doclink('link-140', 'Release', 'link-4');">Release</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1292"></a><tt class="py-lineno">1292</tt> <tt class="py-line"> <tt class="py-name">rels</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-141" class="py-name"><a title="musicbrainz2.utils.extractUuid" class="py-name" href="#" onclick="return doclink('link-141', 'extractUuid', 'link-38');">extractUuid</a></tt><tt class="py-op">(</tt><tt id="link-142" class="py-name"><a title="musicbrainz2.wsxml.Metadata.release
musicbrainz2.wsxml.ReleaseResult.release" class="py-name" href="#" onclick="return doclink('link-142', 'release', 'link-90');">release</a></tt><tt class="py-op">.</tt><tt id="link-143" class="py-name"><a title="musicbrainz2.model.Disc.id
musicbrainz2.model.Entity.id" class="py-name" href="#" onclick="return doclink('link-143', 'id', 'link-133');">id</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1293"></a><tt class="py-lineno">1293</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1294"></a><tt class="py-lineno">1294</tt> <tt class="py-line"> <tt class="py-name">rels</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-144" class="py-name"><a title="musicbrainz2.utils.extractUuid" class="py-name" href="#" onclick="return doclink('link-144', 'extractUuid', 'link-38');">extractUuid</a></tt><tt class="py-op">(</tt><tt id="link-145" class="py-name"><a title="musicbrainz2.wsxml.Metadata.release
musicbrainz2.wsxml.ReleaseResult.release" class="py-name" href="#" onclick="return doclink('link-145', 'release', 'link-90');">release</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1295"></a><tt class="py-lineno">1295</tt> <tt class="py-line"> <tt class="py-name">encodedStr</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">urlencode</tt><tt class="py-op">(</tt><tt class="py-op">{</tt><tt class="py-string">'remove'</tt><tt class="py-op">:</tt> <tt class="py-string">","</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">rels</tt><tt class="py-op">)</tt><tt class="py-op">}</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L1296"></a><tt class="py-lineno">1296</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_ws</tt><tt class="py-op">.</tt><tt id="link-146" class="py-name"><a title="musicbrainz2.webservice.IWebService.post
musicbrainz2.webservice.WebService.post" class="py-name" href="#" onclick="return doclink('link-146', 'post', 'link-124');">post</a></tt><tt class="py-op">(</tt><tt class="py-string">'collection'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">encodedStr</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1297"></a><tt class="py-lineno">1297</tt> <tt class="py-line"> </tt>
<a name="Query.getUserCollection"></a><div id="Query.getUserCollection-def"><a name="L1298"></a><tt class="py-lineno">1298</tt> <a class="py-toggle" href="#" id="Query.getUserCollection-toggle" onclick="return toggle('Query.getUserCollection');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#getUserCollection">getUserCollection</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">offset</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-param">maxitems</tt><tt class="py-op">=</tt><tt class="py-number">100</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.getUserCollection-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.getUserCollection-expanded"><a name="L1299"></a><tt class="py-lineno">1299</tt> <tt class="py-line"> <tt class="py-docstring">"""Get the releases that are in a user's collection</tt> </tt>
<a name="L1300"></a><tt class="py-lineno">1300</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1301"></a><tt class="py-lineno">1301</tt> <tt class="py-line"><tt class="py-docstring"> A maximum of 100 items will be returned for any one call</tt> </tt>
<a name="L1302"></a><tt class="py-lineno">1302</tt> <tt class="py-line"><tt class="py-docstring"> to this method. To fetch more than 100 items, use the offset</tt> </tt>
<a name="L1303"></a><tt class="py-lineno">1303</tt> <tt class="py-line"><tt class="py-docstring"> parameter.</tt> </tt>
<a name="L1304"></a><tt class="py-lineno">1304</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1305"></a><tt class="py-lineno">1305</tt> <tt class="py-line"><tt class="py-docstring"> @param offset: the offset to start fetching results from</tt> </tt>
<a name="L1306"></a><tt class="py-lineno">1306</tt> <tt class="py-line"><tt class="py-docstring"> @param maxitems: the upper limit on items to return</tt> </tt>
<a name="L1307"></a><tt class="py-lineno">1307</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1308"></a><tt class="py-lineno">1308</tt> <tt class="py-line"><tt class="py-docstring"> @return: a list of L{musicbrainz2.wsxml.ReleaseResult} objects</tt> </tt>
<a name="L1309"></a><tt class="py-lineno">1309</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1310"></a><tt class="py-lineno">1310</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L1311"></a><tt class="py-lineno">1311</tt> <tt class="py-line"><tt class="py-docstring"> @raise AuthenticationError: invalid user name and/or password</tt> </tt>
<a name="L1312"></a><tt class="py-lineno">1312</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1313"></a><tt class="py-lineno">1313</tt> <tt class="py-line"> <tt class="py-name">params</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> <tt class="py-string">'offset'</tt><tt class="py-op">:</tt> <tt class="py-name">offset</tt><tt class="py-op">,</tt> <tt class="py-string">'maxitems'</tt><tt class="py-op">:</tt> <tt class="py-name">maxitems</tt> <tt class="py-op">}</tt> </tt>
<a name="L1314"></a><tt class="py-lineno">1314</tt> <tt class="py-line"> </tt>
<a name="L1315"></a><tt class="py-lineno">1315</tt> <tt class="py-line"> <tt class="py-name">stream</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_ws</tt><tt class="py-op">.</tt><tt id="link-147" class="py-name"><a title="musicbrainz2.webservice.IWebService.get
musicbrainz2.webservice.WebService.get" class="py-name" href="#" onclick="return doclink('link-147', 'get', 'link-12');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'collection'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">filter</tt><tt class="py-op">=</tt><tt class="py-name">params</tt><tt class="py-op">)</tt> </tt>
<a name="L1316"></a><tt class="py-lineno">1316</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1317"></a><tt class="py-lineno">1317</tt> <tt class="py-line"> <tt class="py-name">parser</tt> <tt class="py-op">=</tt> <tt id="link-148" class="py-name"><a title="musicbrainz2.wsxml.MbXmlParser" class="py-name" href="#" onclick="return doclink('link-148', 'MbXmlParser', 'link-7');">MbXmlParser</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1318"></a><tt class="py-lineno">1318</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">parser</tt><tt class="py-op">.</tt><tt id="link-149" class="py-name"><a title="musicbrainz2.wsxml.MbXmlParser.parse" class="py-name" href="#" onclick="return doclink('link-149', 'parse', 'link-120');">parse</a></tt><tt class="py-op">(</tt><tt class="py-name">stream</tt><tt class="py-op">)</tt> </tt>
<a name="L1319"></a><tt class="py-lineno">1319</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-150" class="py-name"><a title="musicbrainz2.wsxml.ParseError" class="py-name" href="#" onclick="return doclink('link-150', 'ParseError', 'link-8');">ParseError</a></tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L1320"></a><tt class="py-lineno">1320</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-151" class="py-name"><a title="musicbrainz2.webservice.ResponseError" class="py-name" href="#" onclick="return doclink('link-151', 'ResponseError', 'link-80');">ResponseError</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L1321"></a><tt class="py-lineno">1321</tt> <tt class="py-line"> </tt>
<a name="L1322"></a><tt class="py-lineno">1322</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-152" class="py-name"><a title="musicbrainz2.wsxml.Metadata.getReleaseResults" class="py-name" href="#" onclick="return doclink('link-152', 'getReleaseResults', 'link-95');">getReleaseResults</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1323"></a><tt class="py-lineno">1323</tt> <tt class="py-line"> </tt>
<a name="Query.submitUserTags"></a><div id="Query.submitUserTags-def"><a name="L1324"></a><tt class="py-lineno">1324</tt> <a class="py-toggle" href="#" id="Query.submitUserTags-toggle" onclick="return toggle('Query.submitUserTags');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#submitUserTags">submitUserTags</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">entityUri</tt><tt class="py-op">,</tt> <tt class="py-param">tags</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.submitUserTags-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.submitUserTags-expanded"><a name="L1325"></a><tt class="py-lineno">1325</tt> <tt class="py-line"> <tt class="py-docstring">"""Submit folksonomy tags for an entity.</tt> </tt>
<a name="L1326"></a><tt class="py-lineno">1326</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1327"></a><tt class="py-lineno">1327</tt> <tt class="py-line"><tt class="py-docstring"> Note that all previously existing tags from the authenticated</tt> </tt>
<a name="L1328"></a><tt class="py-lineno">1328</tt> <tt class="py-line"><tt class="py-docstring"> user are replaced with the ones given to this method. Other</tt> </tt>
<a name="L1329"></a><tt class="py-lineno">1329</tt> <tt class="py-line"><tt class="py-docstring"> users' tags are not affected.</tt> </tt>
<a name="L1330"></a><tt class="py-lineno">1330</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1331"></a><tt class="py-lineno">1331</tt> <tt class="py-line"><tt class="py-docstring"> @param entityUri: a string containing an absolute MB ID</tt> </tt>
<a name="L1332"></a><tt class="py-lineno">1332</tt> <tt class="py-line"><tt class="py-docstring"> @param tags: A list of either L{Tag <musicbrainz2.model.Tag>} objects</tt> </tt>
<a name="L1333"></a><tt class="py-lineno">1333</tt> <tt class="py-line"><tt class="py-docstring"> or strings</tt> </tt>
<a name="L1334"></a><tt class="py-lineno">1334</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1335"></a><tt class="py-lineno">1335</tt> <tt class="py-line"><tt class="py-docstring"> @raise ValueError: invalid entityUri</tt> </tt>
<a name="L1336"></a><tt class="py-lineno">1336</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L1337"></a><tt class="py-lineno">1337</tt> <tt class="py-line"><tt class="py-docstring"> @raise RequestError: invalid ID, entity or tags</tt> </tt>
<a name="L1338"></a><tt class="py-lineno">1338</tt> <tt class="py-line"><tt class="py-docstring"> @raise AuthenticationError: invalid user name and/or password</tt> </tt>
<a name="L1339"></a><tt class="py-lineno">1339</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1340"></a><tt class="py-lineno">1340</tt> <tt class="py-line"> <tt class="py-name">entity</tt> <tt class="py-op">=</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-153" class="py-name" targets="Function musicbrainz2.utils.extractEntityType()=musicbrainz2.utils-module.html#extractEntityType"><a title="musicbrainz2.utils.extractEntityType" class="py-name" href="#" onclick="return doclink('link-153', 'extractEntityType', 'link-153');">extractEntityType</a></tt><tt class="py-op">(</tt><tt class="py-name">entityUri</tt><tt class="py-op">)</tt> </tt>
<a name="L1341"></a><tt class="py-lineno">1341</tt> <tt class="py-line"> <tt class="py-name">uuid</tt> <tt class="py-op">=</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-154" class="py-name"><a title="musicbrainz2.utils.extractUuid" class="py-name" href="#" onclick="return doclink('link-154', 'extractUuid', 'link-38');">extractUuid</a></tt><tt class="py-op">(</tt><tt class="py-name">entityUri</tt><tt class="py-op">,</tt> <tt class="py-name">entity</tt><tt class="py-op">)</tt> </tt>
<a name="L1342"></a><tt class="py-lineno">1342</tt> <tt class="py-line"> <tt class="py-name">params</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt> </tt>
<a name="L1343"></a><tt class="py-lineno">1343</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'type'</tt><tt class="py-op">,</tt> <tt class="py-string">'xml'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L1344"></a><tt class="py-lineno">1344</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'entity'</tt><tt class="py-op">,</tt> <tt class="py-name">entity</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L1345"></a><tt class="py-lineno">1345</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'id'</tt><tt class="py-op">,</tt> <tt class="py-name">uuid</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L1346"></a><tt class="py-lineno">1346</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'tags'</tt><tt class="py-op">,</tt> <tt class="py-string">','</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt class="py-name">tag</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-string">'utf-8'</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">tag</tt> <tt class="py-keyword">in</tt> <tt id="link-155" class="py-name"><a title="musicbrainz2.model.Entity.tags" class="py-name" href="#" onclick="return doclink('link-155', 'tags', 'link-51');">tags</a></tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1347"></a><tt class="py-lineno">1347</tt> <tt class="py-line"> <tt class="py-op">)</tt> </tt>
<a name="L1348"></a><tt class="py-lineno">1348</tt> <tt class="py-line"> </tt>
<a name="L1349"></a><tt class="py-lineno">1349</tt> <tt class="py-line"> <tt class="py-name">encodedStr</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">urlencode</tt><tt class="py-op">(</tt><tt class="py-name">params</tt><tt class="py-op">)</tt> </tt>
<a name="L1350"></a><tt class="py-lineno">1350</tt> <tt class="py-line"> </tt>
<a name="L1351"></a><tt class="py-lineno">1351</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_ws</tt><tt class="py-op">.</tt><tt id="link-156" class="py-name"><a title="musicbrainz2.webservice.IWebService.post
musicbrainz2.webservice.WebService.post" class="py-name" href="#" onclick="return doclink('link-156', 'post', 'link-124');">post</a></tt><tt class="py-op">(</tt><tt class="py-string">'tag'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">encodedStr</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1352"></a><tt class="py-lineno">1352</tt> <tt class="py-line"> </tt>
<a name="L1353"></a><tt class="py-lineno">1353</tt> <tt class="py-line"> </tt>
<a name="Query.getUserTags"></a><div id="Query.getUserTags-def"><a name="L1354"></a><tt class="py-lineno">1354</tt> <a class="py-toggle" href="#" id="Query.getUserTags-toggle" onclick="return toggle('Query.getUserTags');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#getUserTags">getUserTags</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">entityUri</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.getUserTags-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.getUserTags-expanded"><a name="L1355"></a><tt class="py-lineno">1355</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns a list of folksonomy tags a user has applied to an entity.</tt> </tt>
<a name="L1356"></a><tt class="py-lineno">1356</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1357"></a><tt class="py-lineno">1357</tt> <tt class="py-line"><tt class="py-docstring"> The given parameter has to be a fully qualified MusicBrainz ID, as</tt> </tt>
<a name="L1358"></a><tt class="py-lineno">1358</tt> <tt class="py-line"><tt class="py-docstring"> returned by other library functions.</tt> </tt>
<a name="L1359"></a><tt class="py-lineno">1359</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1360"></a><tt class="py-lineno">1360</tt> <tt class="py-line"><tt class="py-docstring"> Note that this method only works if a valid user name and</tt> </tt>
<a name="L1361"></a><tt class="py-lineno">1361</tt> <tt class="py-line"><tt class="py-docstring"> password have been set. Only the tags the authenticated user</tt> </tt>
<a name="L1362"></a><tt class="py-lineno">1362</tt> <tt class="py-line"><tt class="py-docstring"> applied to the entity will be returned. If username and/or</tt> </tt>
<a name="L1363"></a><tt class="py-lineno">1363</tt> <tt class="py-line"><tt class="py-docstring"> password are incorrect, an AuthenticationError is raised.</tt> </tt>
<a name="L1364"></a><tt class="py-lineno">1364</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1365"></a><tt class="py-lineno">1365</tt> <tt class="py-line"><tt class="py-docstring"> This method will return a list of L{Tag <musicbrainz2.model.Tag>}</tt> </tt>
<a name="L1366"></a><tt class="py-lineno">1366</tt> <tt class="py-line"><tt class="py-docstring"> objects.</tt> </tt>
<a name="L1367"></a><tt class="py-lineno">1367</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1368"></a><tt class="py-lineno">1368</tt> <tt class="py-line"><tt class="py-docstring"> @param entityUri: a string containing an absolute MB ID</tt> </tt>
<a name="L1369"></a><tt class="py-lineno">1369</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1370"></a><tt class="py-lineno">1370</tt> <tt class="py-line"><tt class="py-docstring"> @raise ValueError: invalid entityUri</tt> </tt>
<a name="L1371"></a><tt class="py-lineno">1371</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L1372"></a><tt class="py-lineno">1372</tt> <tt class="py-line"><tt class="py-docstring"> @raise RequestError: invalid ID or entity</tt> </tt>
<a name="L1373"></a><tt class="py-lineno">1373</tt> <tt class="py-line"><tt class="py-docstring"> @raise AuthenticationError: invalid user name and/or password</tt> </tt>
<a name="L1374"></a><tt class="py-lineno">1374</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1375"></a><tt class="py-lineno">1375</tt> <tt class="py-line"> <tt class="py-name">entity</tt> <tt class="py-op">=</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-157" class="py-name"><a title="musicbrainz2.utils.extractEntityType" class="py-name" href="#" onclick="return doclink('link-157', 'extractEntityType', 'link-153');">extractEntityType</a></tt><tt class="py-op">(</tt><tt class="py-name">entityUri</tt><tt class="py-op">)</tt> </tt>
<a name="L1376"></a><tt class="py-lineno">1376</tt> <tt class="py-line"> <tt class="py-name">uuid</tt> <tt class="py-op">=</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-158" class="py-name"><a title="musicbrainz2.utils.extractUuid" class="py-name" href="#" onclick="return doclink('link-158', 'extractUuid', 'link-38');">extractUuid</a></tt><tt class="py-op">(</tt><tt class="py-name">entityUri</tt><tt class="py-op">,</tt> <tt class="py-name">entity</tt><tt class="py-op">)</tt> </tt>
<a name="L1377"></a><tt class="py-lineno">1377</tt> <tt class="py-line"> <tt class="py-name">params</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> <tt class="py-string">'entity'</tt><tt class="py-op">:</tt> <tt class="py-name">entity</tt><tt class="py-op">,</tt> <tt class="py-string">'id'</tt><tt class="py-op">:</tt> <tt class="py-name">uuid</tt> <tt class="py-op">}</tt> </tt>
<a name="L1378"></a><tt class="py-lineno">1378</tt> <tt class="py-line"> </tt>
<a name="L1379"></a><tt class="py-lineno">1379</tt> <tt class="py-line"> <tt class="py-name">stream</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_ws</tt><tt class="py-op">.</tt><tt id="link-159" class="py-name"><a title="musicbrainz2.webservice.IWebService.get
musicbrainz2.webservice.WebService.get" class="py-name" href="#" onclick="return doclink('link-159', 'get', 'link-12');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'tag'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">filter</tt><tt class="py-op">=</tt><tt class="py-name">params</tt><tt class="py-op">)</tt> </tt>
<a name="L1380"></a><tt class="py-lineno">1380</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1381"></a><tt class="py-lineno">1381</tt> <tt class="py-line"> <tt class="py-name">parser</tt> <tt class="py-op">=</tt> <tt id="link-160" class="py-name"><a title="musicbrainz2.wsxml.MbXmlParser" class="py-name" href="#" onclick="return doclink('link-160', 'MbXmlParser', 'link-7');">MbXmlParser</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1382"></a><tt class="py-lineno">1382</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">parser</tt><tt class="py-op">.</tt><tt id="link-161" class="py-name"><a title="musicbrainz2.wsxml.MbXmlParser.parse" class="py-name" href="#" onclick="return doclink('link-161', 'parse', 'link-120');">parse</a></tt><tt class="py-op">(</tt><tt class="py-name">stream</tt><tt class="py-op">)</tt> </tt>
<a name="L1383"></a><tt class="py-lineno">1383</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-162" class="py-name"><a title="musicbrainz2.wsxml.ParseError" class="py-name" href="#" onclick="return doclink('link-162', 'ParseError', 'link-8');">ParseError</a></tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L1384"></a><tt class="py-lineno">1384</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-163" class="py-name"><a title="musicbrainz2.webservice.ResponseError" class="py-name" href="#" onclick="return doclink('link-163', 'ResponseError', 'link-80');">ResponseError</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L1385"></a><tt class="py-lineno">1385</tt> <tt class="py-line"> </tt>
<a name="L1386"></a><tt class="py-lineno">1386</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-164" class="py-name" targets="Method musicbrainz2.wsxml.Metadata.getTagList()=musicbrainz2.wsxml.Metadata-class.html#getTagList"><a title="musicbrainz2.wsxml.Metadata.getTagList" class="py-name" href="#" onclick="return doclink('link-164', 'getTagList', 'link-164');">getTagList</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1387"></a><tt class="py-lineno">1387</tt> <tt class="py-line"> </tt>
<a name="Query.submitUserRating"></a><div id="Query.submitUserRating-def"><a name="L1388"></a><tt class="py-lineno">1388</tt> <a class="py-toggle" href="#" id="Query.submitUserRating-toggle" onclick="return toggle('Query.submitUserRating');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#submitUserRating">submitUserRating</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">entityUri</tt><tt class="py-op">,</tt> <tt class="py-param">rating</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.submitUserRating-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.submitUserRating-expanded"><a name="L1389"></a><tt class="py-lineno">1389</tt> <tt class="py-line"> <tt class="py-docstring">"""Submit rating for an entity.</tt> </tt>
<a name="L1390"></a><tt class="py-lineno">1390</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1391"></a><tt class="py-lineno">1391</tt> <tt class="py-line"><tt class="py-docstring"> Note that all previously existing rating from the authenticated</tt> </tt>
<a name="L1392"></a><tt class="py-lineno">1392</tt> <tt class="py-line"><tt class="py-docstring"> user are replaced with the one given to this method. Other</tt> </tt>
<a name="L1393"></a><tt class="py-lineno">1393</tt> <tt class="py-line"><tt class="py-docstring"> users' ratings are not affected.</tt> </tt>
<a name="L1394"></a><tt class="py-lineno">1394</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1395"></a><tt class="py-lineno">1395</tt> <tt class="py-line"><tt class="py-docstring"> @param entityUri: a string containing an absolute MB ID</tt> </tt>
<a name="L1396"></a><tt class="py-lineno">1396</tt> <tt class="py-line"><tt class="py-docstring"> @param rating: A L{Rating <musicbrainz2.model.Rating>} object</tt> </tt>
<a name="L1397"></a><tt class="py-lineno">1397</tt> <tt class="py-line"><tt class="py-docstring"> or integer</tt> </tt>
<a name="L1398"></a><tt class="py-lineno">1398</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1399"></a><tt class="py-lineno">1399</tt> <tt class="py-line"><tt class="py-docstring"> @raise ValueError: invalid entityUri</tt> </tt>
<a name="L1400"></a><tt class="py-lineno">1400</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L1401"></a><tt class="py-lineno">1401</tt> <tt class="py-line"><tt class="py-docstring"> @raise RequestError: invalid ID, entity or tags</tt> </tt>
<a name="L1402"></a><tt class="py-lineno">1402</tt> <tt class="py-line"><tt class="py-docstring"> @raise AuthenticationError: invalid user name and/or password</tt> </tt>
<a name="L1403"></a><tt class="py-lineno">1403</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1404"></a><tt class="py-lineno">1404</tt> <tt class="py-line"> <tt class="py-name">entity</tt> <tt class="py-op">=</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-165" class="py-name"><a title="musicbrainz2.utils.extractEntityType" class="py-name" href="#" onclick="return doclink('link-165', 'extractEntityType', 'link-153');">extractEntityType</a></tt><tt class="py-op">(</tt><tt class="py-name">entityUri</tt><tt class="py-op">)</tt> </tt>
<a name="L1405"></a><tt class="py-lineno">1405</tt> <tt class="py-line"> <tt class="py-name">uuid</tt> <tt class="py-op">=</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-166" class="py-name"><a title="musicbrainz2.utils.extractUuid" class="py-name" href="#" onclick="return doclink('link-166', 'extractUuid', 'link-38');">extractUuid</a></tt><tt class="py-op">(</tt><tt class="py-name">entityUri</tt><tt class="py-op">,</tt> <tt class="py-name">entity</tt><tt class="py-op">)</tt> </tt>
<a name="L1406"></a><tt class="py-lineno">1406</tt> <tt class="py-line"> <tt class="py-name">params</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt> </tt>
<a name="L1407"></a><tt class="py-lineno">1407</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'type'</tt><tt class="py-op">,</tt> <tt class="py-string">'xml'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L1408"></a><tt class="py-lineno">1408</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'entity'</tt><tt class="py-op">,</tt> <tt class="py-name">entity</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L1409"></a><tt class="py-lineno">1409</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'id'</tt><tt class="py-op">,</tt> <tt class="py-name">uuid</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L1410"></a><tt class="py-lineno">1410</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'rating'</tt><tt class="py-op">,</tt> <tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt id="link-167" class="py-name" targets="Variable musicbrainz2.model.Entity.rating=musicbrainz2.model.Entity-class.html#rating,Variable musicbrainz2.wsxml.Metadata.rating=musicbrainz2.wsxml.Metadata-class.html#rating"><a title="musicbrainz2.model.Entity.rating
musicbrainz2.wsxml.Metadata.rating" class="py-name" href="#" onclick="return doclink('link-167', 'rating', 'link-167');">rating</a></tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-string">'utf-8'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1411"></a><tt class="py-lineno">1411</tt> <tt class="py-line"> <tt class="py-op">)</tt> </tt>
<a name="L1412"></a><tt class="py-lineno">1412</tt> <tt class="py-line"> </tt>
<a name="L1413"></a><tt class="py-lineno">1413</tt> <tt class="py-line"> <tt class="py-name">encodedStr</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">urlencode</tt><tt class="py-op">(</tt><tt class="py-name">params</tt><tt class="py-op">)</tt> </tt>
<a name="L1414"></a><tt class="py-lineno">1414</tt> <tt class="py-line"> </tt>
<a name="L1415"></a><tt class="py-lineno">1415</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_ws</tt><tt class="py-op">.</tt><tt id="link-168" class="py-name"><a title="musicbrainz2.webservice.IWebService.post
musicbrainz2.webservice.WebService.post" class="py-name" href="#" onclick="return doclink('link-168', 'post', 'link-124');">post</a></tt><tt class="py-op">(</tt><tt class="py-string">'rating'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">encodedStr</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1416"></a><tt class="py-lineno">1416</tt> <tt class="py-line"> </tt>
<a name="L1417"></a><tt class="py-lineno">1417</tt> <tt class="py-line"> </tt>
<a name="Query.getUserRating"></a><div id="Query.getUserRating-def"><a name="L1418"></a><tt class="py-lineno">1418</tt> <a class="py-toggle" href="#" id="Query.getUserRating-toggle" onclick="return toggle('Query.getUserRating');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#getUserRating">getUserRating</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">entityUri</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.getUserRating-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.getUserRating-expanded"><a name="L1419"></a><tt class="py-lineno">1419</tt> <tt class="py-line"> <tt class="py-docstring">"""Return the rating a user has applied to an entity.</tt> </tt>
<a name="L1420"></a><tt class="py-lineno">1420</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1421"></a><tt class="py-lineno">1421</tt> <tt class="py-line"><tt class="py-docstring"> The given parameter has to be a fully qualified MusicBrainz</tt> </tt>
<a name="L1422"></a><tt class="py-lineno">1422</tt> <tt class="py-line"><tt class="py-docstring"> ID, as returned by other library functions.</tt> </tt>
<a name="L1423"></a><tt class="py-lineno">1423</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1424"></a><tt class="py-lineno">1424</tt> <tt class="py-line"><tt class="py-docstring"> Note that this method only works if a valid user name and</tt> </tt>
<a name="L1425"></a><tt class="py-lineno">1425</tt> <tt class="py-line"><tt class="py-docstring"> password have been set. Only the rating the authenticated user</tt> </tt>
<a name="L1426"></a><tt class="py-lineno">1426</tt> <tt class="py-line"><tt class="py-docstring"> applied to the entity will be returned. If username and/or</tt> </tt>
<a name="L1427"></a><tt class="py-lineno">1427</tt> <tt class="py-line"><tt class="py-docstring"> password are incorrect, an AuthenticationError is raised.</tt> </tt>
<a name="L1428"></a><tt class="py-lineno">1428</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1429"></a><tt class="py-lineno">1429</tt> <tt class="py-line"><tt class="py-docstring"> This method will return a L{Rating <musicbrainz2.model.Rating>}</tt> </tt>
<a name="L1430"></a><tt class="py-lineno">1430</tt> <tt class="py-line"><tt class="py-docstring"> object.</tt> </tt>
<a name="L1431"></a><tt class="py-lineno">1431</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1432"></a><tt class="py-lineno">1432</tt> <tt class="py-line"><tt class="py-docstring"> @param entityUri: a string containing an absolute MB ID</tt> </tt>
<a name="L1433"></a><tt class="py-lineno">1433</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1434"></a><tt class="py-lineno">1434</tt> <tt class="py-line"><tt class="py-docstring"> @raise ValueError: invalid entityUri</tt> </tt>
<a name="L1435"></a><tt class="py-lineno">1435</tt> <tt class="py-line"><tt class="py-docstring"> @raise ConnectionError: couldn't connect to server</tt> </tt>
<a name="L1436"></a><tt class="py-lineno">1436</tt> <tt class="py-line"><tt class="py-docstring"> @raise RequestError: invalid ID or entity</tt> </tt>
<a name="L1437"></a><tt class="py-lineno">1437</tt> <tt class="py-line"><tt class="py-docstring"> @raise AuthenticationError: invalid user name and/or password</tt> </tt>
<a name="L1438"></a><tt class="py-lineno">1438</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1439"></a><tt class="py-lineno">1439</tt> <tt class="py-line"> <tt class="py-name">entity</tt> <tt class="py-op">=</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-169" class="py-name"><a title="musicbrainz2.utils.extractEntityType" class="py-name" href="#" onclick="return doclink('link-169', 'extractEntityType', 'link-153');">extractEntityType</a></tt><tt class="py-op">(</tt><tt class="py-name">entityUri</tt><tt class="py-op">)</tt> </tt>
<a name="L1440"></a><tt class="py-lineno">1440</tt> <tt class="py-line"> <tt class="py-name">uuid</tt> <tt class="py-op">=</tt> <tt class="py-name">mbutils</tt><tt class="py-op">.</tt><tt id="link-170" class="py-name"><a title="musicbrainz2.utils.extractUuid" class="py-name" href="#" onclick="return doclink('link-170', 'extractUuid', 'link-38');">extractUuid</a></tt><tt class="py-op">(</tt><tt class="py-name">entityUri</tt><tt class="py-op">,</tt> <tt class="py-name">entity</tt><tt class="py-op">)</tt> </tt>
<a name="L1441"></a><tt class="py-lineno">1441</tt> <tt class="py-line"> <tt class="py-name">params</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> <tt class="py-string">'entity'</tt><tt class="py-op">:</tt> <tt class="py-name">entity</tt><tt class="py-op">,</tt> <tt class="py-string">'id'</tt><tt class="py-op">:</tt> <tt class="py-name">uuid</tt> <tt class="py-op">}</tt> </tt>
<a name="L1442"></a><tt class="py-lineno">1442</tt> <tt class="py-line"> </tt>
<a name="L1443"></a><tt class="py-lineno">1443</tt> <tt class="py-line"> <tt class="py-name">stream</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_ws</tt><tt class="py-op">.</tt><tt id="link-171" class="py-name"><a title="musicbrainz2.webservice.IWebService.get
musicbrainz2.webservice.WebService.get" class="py-name" href="#" onclick="return doclink('link-171', 'get', 'link-12');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'rating'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">filter</tt><tt class="py-op">=</tt><tt class="py-name">params</tt><tt class="py-op">)</tt> </tt>
<a name="L1444"></a><tt class="py-lineno">1444</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1445"></a><tt class="py-lineno">1445</tt> <tt class="py-line"> <tt class="py-name">parser</tt> <tt class="py-op">=</tt> <tt id="link-172" class="py-name"><a title="musicbrainz2.wsxml.MbXmlParser" class="py-name" href="#" onclick="return doclink('link-172', 'MbXmlParser', 'link-7');">MbXmlParser</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1446"></a><tt class="py-lineno">1446</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">parser</tt><tt class="py-op">.</tt><tt id="link-173" class="py-name"><a title="musicbrainz2.wsxml.MbXmlParser.parse" class="py-name" href="#" onclick="return doclink('link-173', 'parse', 'link-120');">parse</a></tt><tt class="py-op">(</tt><tt class="py-name">stream</tt><tt class="py-op">)</tt> </tt>
<a name="L1447"></a><tt class="py-lineno">1447</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-174" class="py-name"><a title="musicbrainz2.wsxml.ParseError" class="py-name" href="#" onclick="return doclink('link-174', 'ParseError', 'link-8');">ParseError</a></tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L1448"></a><tt class="py-lineno">1448</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-175" class="py-name"><a title="musicbrainz2.webservice.ResponseError" class="py-name" href="#" onclick="return doclink('link-175', 'ResponseError', 'link-80');">ResponseError</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L1449"></a><tt class="py-lineno">1449</tt> <tt class="py-line"> </tt>
<a name="L1450"></a><tt class="py-lineno">1450</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-176" class="py-name" targets="Method musicbrainz2.model.Entity.getRating()=musicbrainz2.model.Entity-class.html#getRating,Method musicbrainz2.wsxml.Metadata.getRating()=musicbrainz2.wsxml.Metadata-class.html#getRating"><a title="musicbrainz2.model.Entity.getRating
musicbrainz2.wsxml.Metadata.getRating" class="py-name" href="#" onclick="return doclink('link-176', 'getRating', 'link-176');">getRating</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1451"></a><tt class="py-lineno">1451</tt> <tt class="py-line"> </tt>
<a name="Query.submitCDStub"></a><div id="Query.submitCDStub-def"><a name="L1452"></a><tt class="py-lineno">1452</tt> <a class="py-toggle" href="#" id="Query.submitCDStub-toggle" onclick="return toggle('Query.submitCDStub');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice.Query-class.html#submitCDStub">submitCDStub</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">cdstub</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Query.submitCDStub-collapsed" style="display:none;" pad="++++" indent="++++++++++++"></div><div id="Query.submitCDStub-expanded"><a name="L1453"></a><tt class="py-lineno">1453</tt> <tt class="py-line"> <tt class="py-docstring">"""Submit a CD Stub to the database.</tt> </tt>
<a name="L1454"></a><tt class="py-lineno">1454</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1455"></a><tt class="py-lineno">1455</tt> <tt class="py-line"><tt class="py-docstring"> The number of tracks added to the CD Stub must match the TOC and DiscID</tt> </tt>
<a name="L1456"></a><tt class="py-lineno">1456</tt> <tt class="py-line"><tt class="py-docstring"> otherwise the submission wil fail. The submission will also fail if </tt> </tt>
<a name="L1457"></a><tt class="py-lineno">1457</tt> <tt class="py-line"><tt class="py-docstring"> the Disc ID is already in the MusicBrainz database.</tt> </tt>
<a name="L1458"></a><tt class="py-lineno">1458</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1459"></a><tt class="py-lineno">1459</tt> <tt class="py-line"><tt class="py-docstring"> This method will only work if no user name and password are set.</tt> </tt>
<a name="L1460"></a><tt class="py-lineno">1460</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1461"></a><tt class="py-lineno">1461</tt> <tt class="py-line"><tt class="py-docstring"> @param cdstub: a L{CDStub} object to submit</tt> </tt>
<a name="L1462"></a><tt class="py-lineno">1462</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1463"></a><tt class="py-lineno">1463</tt> <tt class="py-line"><tt class="py-docstring"> @raise RequestError: Missmatching TOC/Track information or the</tt> </tt>
<a name="L1464"></a><tt class="py-lineno">1464</tt> <tt class="py-line"><tt class="py-docstring"> the CD Stub already exists or the Disc ID already exists</tt> </tt>
<a name="L1465"></a><tt class="py-lineno">1465</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1466"></a><tt class="py-lineno">1466</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_clientId</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-string">'Please supply a client ID'</tt> </tt>
<a name="L1467"></a><tt class="py-lineno">1467</tt> <tt class="py-line"> <tt id="link-177" class="py-name" targets="Module musicbrainz2.disc=musicbrainz2.disc-module.html"><a title="musicbrainz2.disc" class="py-name" href="#" onclick="return doclink('link-177', 'disc', 'link-177');">disc</a></tt> <tt class="py-op">=</tt> <tt class="py-name">cdstub</tt><tt class="py-op">.</tt><tt class="py-name">_disc</tt> </tt>
<a name="L1468"></a><tt class="py-lineno">1468</tt> <tt class="py-line"> <tt class="py-name">params</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> <tt class="py-op">]</tt> </tt>
<a name="L1469"></a><tt class="py-lineno">1469</tt> <tt class="py-line"> <tt class="py-name">params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-string">'client'</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_clientId</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-string">'utf-8'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L1470"></a><tt class="py-lineno">1470</tt> <tt class="py-line"> <tt class="py-name">params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-string">'discid'</tt><tt class="py-op">,</tt> <tt id="link-178" class="py-name"><a title="musicbrainz2.disc" class="py-name" href="#" onclick="return doclink('link-178', 'disc', 'link-177');">disc</a></tt><tt class="py-op">.</tt><tt id="link-179" class="py-name"><a title="musicbrainz2.model.Disc.id
musicbrainz2.model.Entity.id" class="py-name" href="#" onclick="return doclink('link-179', 'id', 'link-133');">id</a></tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L1471"></a><tt class="py-lineno">1471</tt> <tt class="py-line"> <tt class="py-name">params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-string">'title'</tt><tt class="py-op">,</tt> <tt class="py-name">cdstub</tt><tt class="py-op">.</tt><tt id="link-180" class="py-name"><a title="musicbrainz2.model.Release.title
musicbrainz2.model.ReleaseGroup.title
musicbrainz2.model.Track.title" class="py-name" href="#" onclick="return doclink('link-180', 'title', 'link-37');">title</a></tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L1472"></a><tt class="py-lineno">1472</tt> <tt class="py-line"> <tt class="py-name">params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-string">'artist'</tt><tt class="py-op">,</tt> <tt class="py-name">cdstub</tt><tt class="py-op">.</tt><tt id="link-181" class="py-name"><a title="musicbrainz2.model.Release.artist
musicbrainz2.model.ReleaseGroup.artist
musicbrainz2.model.Track.artist
musicbrainz2.wsxml.ArtistResult.artist
musicbrainz2.wsxml.Metadata.artist" class="py-name" href="#" onclick="return doclink('link-181', 'artist', 'link-55');">artist</a></tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L1473"></a><tt class="py-lineno">1473</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">cdstub</tt><tt class="py-op">.</tt><tt id="link-182" class="py-name" targets="Variable musicbrainz2.model.ReleaseEvent.barcode=musicbrainz2.model.ReleaseEvent-class.html#barcode"><a title="musicbrainz2.model.ReleaseEvent.barcode" class="py-name" href="#" onclick="return doclink('link-182', 'barcode', 'link-182');">barcode</a></tt> <tt class="py-op">!=</tt> <tt class="py-string">""</tt><tt class="py-op">:</tt> </tt>
<a name="L1474"></a><tt class="py-lineno">1474</tt> <tt class="py-line"> <tt class="py-name">params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-string">'barcode'</tt><tt class="py-op">,</tt> <tt class="py-name">cdstub</tt><tt class="py-op">.</tt><tt id="link-183" class="py-name"><a title="musicbrainz2.model.ReleaseEvent.barcode" class="py-name" href="#" onclick="return doclink('link-183', 'barcode', 'link-182');">barcode</a></tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L1475"></a><tt class="py-lineno">1475</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">cdstub</tt><tt class="py-op">.</tt><tt class="py-name">comment</tt> <tt class="py-op">!=</tt> <tt class="py-string">""</tt><tt class="py-op">:</tt> </tt>
<a name="L1476"></a><tt class="py-lineno">1476</tt> <tt class="py-line"> <tt class="py-name">params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-string">'comment'</tt><tt class="py-op">,</tt> <tt class="py-name">cdstub</tt><tt class="py-op">.</tt><tt class="py-name">comment</tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L1477"></a><tt class="py-lineno">1477</tt> <tt class="py-line"> </tt>
<a name="L1478"></a><tt class="py-lineno">1478</tt> <tt class="py-line"> <tt class="py-name">trackind</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L1479"></a><tt class="py-lineno">1479</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-184" class="py-name"><a title="musicbrainz2.wsxml.Metadata.track
musicbrainz2.wsxml.TrackResult.track" class="py-name" href="#" onclick="return doclink('link-184', 'track', 'link-104');">track</a></tt><tt class="py-op">,</tt><tt id="link-185" class="py-name"><a title="musicbrainz2.model.Release.artist
musicbrainz2.model.ReleaseGroup.artist
musicbrainz2.model.Track.artist
musicbrainz2.wsxml.ArtistResult.artist
musicbrainz2.wsxml.Metadata.artist" class="py-name" href="#" onclick="return doclink('link-185', 'artist', 'link-55');">artist</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">cdstub</tt><tt class="py-op">.</tt><tt id="link-186" class="py-name"><a title="musicbrainz2.model.Disc.tracks
musicbrainz2.model.Release.tracks" class="py-name" href="#" onclick="return doclink('link-186', 'tracks', 'link-59');">tracks</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1480"></a><tt class="py-lineno">1480</tt> <tt class="py-line"> <tt class="py-name">params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-string">'track%d'</tt> <tt class="py-op">%</tt> <tt class="py-name">trackind</tt><tt class="py-op">,</tt> <tt id="link-187" class="py-name"><a title="musicbrainz2.wsxml.Metadata.track
musicbrainz2.wsxml.TrackResult.track" class="py-name" href="#" onclick="return doclink('link-187', 'track', 'link-104');">track</a></tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L1481"></a><tt class="py-lineno">1481</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-188" class="py-name"><a title="musicbrainz2.model.Release.artist
musicbrainz2.model.ReleaseGroup.artist
musicbrainz2.model.Track.artist
musicbrainz2.wsxml.ArtistResult.artist
musicbrainz2.wsxml.Metadata.artist" class="py-name" href="#" onclick="return doclink('link-188', 'artist', 'link-55');">artist</a></tt> <tt class="py-op">!=</tt> <tt class="py-string">""</tt><tt class="py-op">:</tt> </tt>
<a name="L1482"></a><tt class="py-lineno">1482</tt> <tt class="py-line"> <tt class="py-name">params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-string">'artist%d'</tt> <tt class="py-op">%</tt> <tt class="py-name">trackind</tt><tt class="py-op">,</tt> <tt id="link-189" class="py-name"><a title="musicbrainz2.model.Release.artist
musicbrainz2.model.ReleaseGroup.artist
musicbrainz2.model.Track.artist
musicbrainz2.wsxml.ArtistResult.artist
musicbrainz2.wsxml.Metadata.artist" class="py-name" href="#" onclick="return doclink('link-189', 'artist', 'link-55');">artist</a></tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L1483"></a><tt class="py-lineno">1483</tt> <tt class="py-line"> </tt>
<a name="L1484"></a><tt class="py-lineno">1484</tt> <tt class="py-line"> <tt class="py-name">trackind</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1485"></a><tt class="py-lineno">1485</tt> <tt class="py-line"> </tt>
<a name="L1486"></a><tt class="py-lineno">1486</tt> <tt class="py-line"> <tt class="py-name">toc</tt> <tt class="py-op">=</tt> <tt class="py-string">"%d %d %d "</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-190" class="py-name"><a title="musicbrainz2.disc" class="py-name" href="#" onclick="return doclink('link-190', 'disc', 'link-177');">disc</a></tt><tt class="py-op">.</tt><tt id="link-191" class="py-name" targets="Variable musicbrainz2.model.Disc.firstTrackNum=musicbrainz2.model.Disc-class.html#firstTrackNum"><a title="musicbrainz2.model.Disc.firstTrackNum" class="py-name" href="#" onclick="return doclink('link-191', 'firstTrackNum', 'link-191');">firstTrackNum</a></tt><tt class="py-op">,</tt> <tt id="link-192" class="py-name"><a title="musicbrainz2.disc" class="py-name" href="#" onclick="return doclink('link-192', 'disc', 'link-177');">disc</a></tt><tt class="py-op">.</tt><tt id="link-193" class="py-name" targets="Variable musicbrainz2.model.Disc.lastTrackNum=musicbrainz2.model.Disc-class.html#lastTrackNum"><a title="musicbrainz2.model.Disc.lastTrackNum" class="py-name" href="#" onclick="return doclink('link-193', 'lastTrackNum', 'link-193');">lastTrackNum</a></tt><tt class="py-op">,</tt> <tt id="link-194" class="py-name"><a title="musicbrainz2.disc" class="py-name" href="#" onclick="return doclink('link-194', 'disc', 'link-177');">disc</a></tt><tt class="py-op">.</tt><tt id="link-195" class="py-name" targets="Variable musicbrainz2.model.Disc.sectors=musicbrainz2.model.Disc-class.html#sectors"><a title="musicbrainz2.model.Disc.sectors" class="py-name" href="#" onclick="return doclink('link-195', 'sectors', 'link-195');">sectors</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1487"></a><tt class="py-lineno">1487</tt> <tt class="py-line"> <tt class="py-name">toc</tt> <tt class="py-op">=</tt> <tt class="py-name">toc</tt> <tt class="py-op">+</tt> <tt class="py-string">' '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt> <tt class="py-name">map</tt><tt class="py-op">(</tt><tt class="py-keyword">lambda</tt> <tt class="py-name">x</tt><tt class="py-op">:</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">x</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-196" class="py-name"><a title="musicbrainz2.disc" class="py-name" href="#" onclick="return doclink('link-196', 'disc', 'link-177');">disc</a></tt><tt class="py-op">.</tt><tt id="link-197" class="py-name" targets="Method musicbrainz2.model.Disc.getTracks()=musicbrainz2.model.Disc-class.html#getTracks,Method musicbrainz2.model.Release.getTracks()=musicbrainz2.model.Release-class.html#getTracks,Method musicbrainz2.webservice.Query.getTracks()=musicbrainz2.webservice.Query-class.html#getTracks"><a title="musicbrainz2.model.Disc.getTracks
musicbrainz2.model.Release.getTracks
musicbrainz2.webservice.Query.getTracks" class="py-name" href="#" onclick="return doclink('link-197', 'getTracks', 'link-197');">getTracks</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L1488"></a><tt class="py-lineno">1488</tt> <tt class="py-line"> </tt>
<a name="L1489"></a><tt class="py-lineno">1489</tt> <tt class="py-line"> <tt class="py-name">params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-string">'toc'</tt><tt class="py-op">,</tt> <tt class="py-name">toc</tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L1490"></a><tt class="py-lineno">1490</tt> <tt class="py-line"> </tt>
<a name="L1491"></a><tt class="py-lineno">1491</tt> <tt class="py-line"> <tt class="py-name">encodedStr</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">urlencode</tt><tt class="py-op">(</tt><tt class="py-name">params</tt><tt class="py-op">)</tt> </tt>
<a name="L1492"></a><tt class="py-lineno">1492</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_ws</tt><tt class="py-op">.</tt><tt id="link-198" class="py-name"><a title="musicbrainz2.webservice.IWebService.post
musicbrainz2.webservice.WebService.post" class="py-name" href="#" onclick="return doclink('link-198', 'post', 'link-124');">post</a></tt><tt class="py-op">(</tt><tt class="py-string">'release'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">encodedStr</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L1493"></a><tt class="py-lineno">1493</tt> <tt class="py-line"> </tt>
<a name="_createIncludes"></a><div id="_createIncludes-def"><a name="L1494"></a><tt class="py-lineno">1494</tt> <a class="py-toggle" href="#" id="_createIncludes-toggle" onclick="return toggle('_createIncludes');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice-module.html#_createIncludes">_createIncludes</a><tt class="py-op">(</tt><tt class="py-param">tagMap</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_createIncludes-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_createIncludes-expanded"><a name="L1495"></a><tt class="py-lineno">1495</tt> <tt class="py-line"> <tt class="py-name">selected</tt> <tt class="py-op">=</tt> <tt class="py-name">filter</tt><tt class="py-op">(</tt><tt class="py-keyword">lambda</tt> <tt class="py-name">x</tt><tt class="py-op">:</tt> <tt class="py-name">x</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">tagMap</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1496"></a><tt class="py-lineno">1496</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">map</tt><tt class="py-op">(</tt><tt class="py-keyword">lambda</tt> <tt class="py-name">x</tt><tt class="py-op">:</tt> <tt class="py-name">x</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">selected</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1497"></a><tt class="py-lineno">1497</tt> <tt class="py-line"> </tt>
<a name="_createParameters"></a><div id="_createParameters-def"><a name="L1498"></a><tt class="py-lineno">1498</tt> <a class="py-toggle" href="#" id="_createParameters-toggle" onclick="return toggle('_createParameters');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice-module.html#_createParameters">_createParameters</a><tt class="py-op">(</tt><tt class="py-param">params</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_createParameters-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_createParameters-expanded"><a name="L1499"></a><tt class="py-lineno">1499</tt> <tt class="py-line"> <tt class="py-docstring">"""Remove (x, None) tuples and encode (x, str/unicode) to utf-8."""</tt> </tt>
<a name="L1500"></a><tt class="py-lineno">1500</tt> <tt class="py-line"> <tt class="py-name">ret</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> <tt class="py-op">]</tt> </tt>
<a name="L1501"></a><tt class="py-lineno">1501</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">p</tt> <tt class="py-keyword">in</tt> <tt class="py-name">params</tt><tt class="py-op">:</tt> </tt>
<a name="L1502"></a><tt class="py-lineno">1502</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">p</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">,</tt> <tt class="py-name">unicode</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1503"></a><tt class="py-lineno">1503</tt> <tt class="py-line"> <tt class="py-name">ret</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-name">p</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">p</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-string">'utf-8'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L1504"></a><tt class="py-lineno">1504</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">p</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1505"></a><tt class="py-lineno">1505</tt> <tt class="py-line"> <tt class="py-name">ret</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">p</tt><tt class="py-op">)</tt> </tt>
<a name="L1506"></a><tt class="py-lineno">1506</tt> <tt class="py-line"> </tt>
<a name="L1507"></a><tt class="py-lineno">1507</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">ret</tt> </tt>
</div><a name="L1508"></a><tt class="py-lineno">1508</tt> <tt class="py-line"> </tt>
<a name="_paramsValid"></a><div id="_paramsValid-def"><a name="L1509"></a><tt class="py-lineno">1509</tt> <a class="py-toggle" href="#" id="_paramsValid-toggle" onclick="return toggle('_paramsValid');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="musicbrainz2.webservice-module.html#_paramsValid">_paramsValid</a><tt class="py-op">(</tt><tt class="py-param">params</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_paramsValid-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_paramsValid-expanded"><a name="L1510"></a><tt class="py-lineno">1510</tt> <tt class="py-line"> <tt class="py-docstring">"""Check if the query parameter collides with other parameters."""</tt> </tt>
<a name="L1511"></a><tt class="py-lineno">1511</tt> <tt class="py-line"> <tt class="py-name">tmp</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> <tt class="py-op">]</tt> </tt>
<a name="L1512"></a><tt class="py-lineno">1512</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-199" class="py-name"><a title="musicbrainz2.model.Artist.name
musicbrainz2.model.Label.name
musicbrainz2.model.User.name" class="py-name" href="#" onclick="return doclink('link-199', 'name', 'link-34');">name</a></tt><tt class="py-op">,</tt> <tt id="link-200" class="py-name" targets="Variable musicbrainz2.model.AbstractAlias.value=musicbrainz2.model.AbstractAlias-class.html#value,Variable musicbrainz2.model.Rating.value=musicbrainz2.model.Rating-class.html#value,Variable musicbrainz2.model.Tag.value=musicbrainz2.model.Tag-class.html#value"><a title="musicbrainz2.model.AbstractAlias.value
musicbrainz2.model.Rating.value
musicbrainz2.model.Tag.value" class="py-name" href="#" onclick="return doclink('link-200', 'value', 'link-200');">value</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">params</tt><tt class="py-op">:</tt> </tt>
<a name="L1513"></a><tt class="py-lineno">1513</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-201" class="py-name"><a title="musicbrainz2.model.AbstractAlias.value
musicbrainz2.model.Rating.value
musicbrainz2.model.Tag.value" class="py-name" href="#" onclick="return doclink('link-201', 'value', 'link-200');">value</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt id="link-202" class="py-name"><a title="musicbrainz2.model.Artist.name
musicbrainz2.model.Label.name
musicbrainz2.model.User.name" class="py-name" href="#" onclick="return doclink('link-202', 'name', 'link-34');">name</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-string">'offset'</tt><tt class="py-op">,</tt> <tt class="py-string">'limit'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1514"></a><tt class="py-lineno">1514</tt> <tt class="py-line"> <tt class="py-name">tmp</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-203" class="py-name"><a title="musicbrainz2.model.Artist.name
musicbrainz2.model.Label.name
musicbrainz2.model.User.name" class="py-name" href="#" onclick="return doclink('link-203', 'name', 'link-34');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1515"></a><tt class="py-lineno">1515</tt> <tt class="py-line"> </tt>
<a name="L1516"></a><tt class="py-lineno">1516</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'query'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">tmp</tt> <tt class="py-keyword">and</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">tmp</tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L1517"></a><tt class="py-lineno">1517</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L1518"></a><tt class="py-lineno">1518</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1519"></a><tt class="py-lineno">1519</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
</div><a name="L1520"></a><tt class="py-lineno">1520</tt> <tt class="py-line"> </tt>
<a name="L1521"></a><tt class="py-lineno">1521</tt> <tt class="py-line"><tt class="py-keyword">if</tt> <tt class="py-name">__name__</tt> <tt class="py-op">==</tt> <tt class="py-string">'__main__'</tt><tt class="py-op">:</tt> </tt>
<a name="L1522"></a><tt class="py-lineno">1522</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt class="py-name">doctest</tt> </tt>
<a name="L1523"></a><tt class="py-lineno">1523</tt> <tt class="py-line"> <tt class="py-name">doctest</tt><tt class="py-op">.</tt><tt class="py-name">testmod</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1524"></a><tt class="py-lineno">1524</tt> <tt class="py-line"> </tt>
<a name="L1525"></a><tt class="py-lineno">1525</tt> <tt class="py-line"><tt class="py-comment"># EOF</tt> </tt>
<a name="L1526"></a><tt class="py-lineno">1526</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="musicbrainz2-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1
on Wed Aug 19 21:33:22 2015
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|