/usr/share/doc/python-gdata-doc/pydocs/gdata.base.service.html is in python-gdata-doc 2.0.14-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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module gdata.base.service</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="gdata.html"><font color="#ffffff">gdata</font></a>.<a href="gdata.base.html"><font color="#ffffff">base</font></a>.service</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/lib/python2.6/dist-packages/gdata/base/service.py">/usr/local/lib/python2.6/dist-packages/gdata/base/service.py</a></font></td></tr></table>
<p><tt><a href="#GBaseService">GBaseService</a> extends the <a href="gdata.service.html#GDataService">GDataService</a> to streamline Google Base operations.<br>
<br>
<a href="#GBaseService">GBaseService</a>: Provides methods to query feeds and manipulate items. Extends <br>
<a href="gdata.service.html#GDataService">GDataService</a>.<br>
<br>
DictionaryToParamList: Function which converts a dictionary into a list of <br>
URL arguments (represented as strings). This is a <br>
utility function used in CRUD operations.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="atom.html">atom</a><br>
</td><td width="25%" valign=top><a href="gdata.html">gdata</a><br>
</td><td width="25%" valign=top><a href="urllib.html">urllib</a><br>
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.base.service.html#Error">Error</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.base.service.html#RequestError">RequestError</a>
</font></dt></dl>
</dd>
</dl>
</dd>
<dt><font face="helvetica, arial"><a href="gdata.service.html#GDataService">gdata.service.GDataService</a>(<a href="atom.service.html#AtomService">atom.service.AtomService</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.base.service.html#GBaseService">GBaseService</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="gdata.service.html#Query">gdata.service.Query</a>(<a href="__builtin__.html#dict">__builtin__.dict</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.base.service.html#BaseQuery">BaseQuery</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="BaseQuery">class <strong>BaseQuery</strong></a>(<a href="gdata.service.html#Query">gdata.service.Query</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.base.service.html#BaseQuery">BaseQuery</a></dd>
<dd><a href="gdata.service.html#Query">gdata.service.Query</a></dd>
<dd><a href="__builtin__.html#dict">__builtin__.dict</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>bq</strong></dt>
<dd><tt>The bq query parameter</tt></dd>
</dl>
<hr>
Methods inherited from <a href="gdata.service.html#Query">gdata.service.Query</a>:<br>
<dl><dt><a name="BaseQuery-ToUri"><strong>ToUri</strong></a>(self)</dt></dl>
<dl><dt><a name="BaseQuery-__init__"><strong>__init__</strong></a>(self, feed<font color="#909090">=None</font>, text_query<font color="#909090">=None</font>, params<font color="#909090">=None</font>, categories<font color="#909090">=None</font>)</dt><dd><tt>Constructor for <a href="gdata.service.html#Query">Query</a><br>
<br>
Args:<br>
feed: str (optional) The path for the feed (Examples: <br>
'/base/feeds/snippets' or 'calendar/feeds/jo@gmail.com/private/full'<br>
text_query: str (optional) The contents of the q query parameter. The<br>
contents of the text_query are URL escaped upon conversion to a URI.<br>
params: dict (optional) Parameter value string pairs which become URL<br>
params when translated to a URI. These parameters are added to the<br>
query's items (key-value pairs).<br>
categories: list (optional) List of category strings which should be<br>
included as query categories. See <br>
<a href="http://code.google.com/apis/gdata/reference.html#Queries">http://code.google.com/apis/gdata/reference.html#Queries</a> for <br>
details. If you want to get results from category A or B (both <br>
categories), specify a single list item 'A|B'.</tt></dd></dl>
<dl><dt><a name="BaseQuery-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Data descriptors inherited from <a href="gdata.service.html#Query">gdata.service.Query</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<dl><dt><strong>alt</strong></dt>
<dd><tt>The feed query's alt parameter</tt></dd>
</dl>
<dl><dt><strong>author</strong></dt>
<dd><tt>The feed query's author parameter</tt></dd>
</dl>
<dl><dt><strong>max_results</strong></dt>
<dd><tt>The feed query's max-results parameter</tt></dd>
</dl>
<dl><dt><strong>orderby</strong></dt>
<dd><tt>The feed query's orderby parameter</tt></dd>
</dl>
<dl><dt><strong>published_max</strong></dt>
<dd><tt>The feed query's published-max parameter</tt></dd>
</dl>
<dl><dt><strong>published_min</strong></dt>
<dd><tt>The feed query's published-min parameter</tt></dd>
</dl>
<dl><dt><strong>start_index</strong></dt>
<dd><tt>The feed query's start-index parameter</tt></dd>
</dl>
<dl><dt><strong>text_query</strong></dt>
<dd><tt>The feed query's q parameter</tt></dd>
</dl>
<dl><dt><strong>updated_max</strong></dt>
<dd><tt>The feed query's updated-max parameter</tt></dd>
</dl>
<dl><dt><strong>updated_min</strong></dt>
<dd><tt>The feed query's updated-min parameter</tt></dd>
</dl>
<hr>
Methods inherited from <a href="__builtin__.html#dict">__builtin__.dict</a>:<br>
<dl><dt><a name="BaseQuery-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#BaseQuery-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
<dl><dt><a name="BaseQuery-__contains__"><strong>__contains__</strong></a>(...)</dt><dd><tt>D.<a href="#BaseQuery-__contains__">__contains__</a>(k) -> True if D has a key k, else False</tt></dd></dl>
<dl><dt><a name="BaseQuery-__delitem__"><strong>__delitem__</strong></a>(...)</dt><dd><tt>x.<a href="#BaseQuery-__delitem__">__delitem__</a>(y) <==> del x[y]</tt></dd></dl>
<dl><dt><a name="BaseQuery-__eq__"><strong>__eq__</strong></a>(...)</dt><dd><tt>x.<a href="#BaseQuery-__eq__">__eq__</a>(y) <==> x==y</tt></dd></dl>
<dl><dt><a name="BaseQuery-__ge__"><strong>__ge__</strong></a>(...)</dt><dd><tt>x.<a href="#BaseQuery-__ge__">__ge__</a>(y) <==> x>=y</tt></dd></dl>
<dl><dt><a name="BaseQuery-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#BaseQuery-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
<dl><dt><a name="BaseQuery-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#BaseQuery-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
<dl><dt><a name="BaseQuery-__gt__"><strong>__gt__</strong></a>(...)</dt><dd><tt>x.<a href="#BaseQuery-__gt__">__gt__</a>(y) <==> x>y</tt></dd></dl>
<dl><dt><a name="BaseQuery-__iter__"><strong>__iter__</strong></a>(...)</dt><dd><tt>x.<a href="#BaseQuery-__iter__">__iter__</a>() <==> iter(x)</tt></dd></dl>
<dl><dt><a name="BaseQuery-__le__"><strong>__le__</strong></a>(...)</dt><dd><tt>x.<a href="#BaseQuery-__le__">__le__</a>(y) <==> x<=y</tt></dd></dl>
<dl><dt><a name="BaseQuery-__len__"><strong>__len__</strong></a>(...)</dt><dd><tt>x.<a href="#BaseQuery-__len__">__len__</a>() <==> len(x)</tt></dd></dl>
<dl><dt><a name="BaseQuery-__lt__"><strong>__lt__</strong></a>(...)</dt><dd><tt>x.<a href="#BaseQuery-__lt__">__lt__</a>(y) <==> x<y</tt></dd></dl>
<dl><dt><a name="BaseQuery-__ne__"><strong>__ne__</strong></a>(...)</dt><dd><tt>x.<a href="#BaseQuery-__ne__">__ne__</a>(y) <==> x!=y</tt></dd></dl>
<dl><dt><a name="BaseQuery-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#BaseQuery-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
<dl><dt><a name="BaseQuery-__setitem__"><strong>__setitem__</strong></a>(...)</dt><dd><tt>x.<a href="#BaseQuery-__setitem__">__setitem__</a>(i, y) <==> x[i]=y</tt></dd></dl>
<dl><dt><a name="BaseQuery-__sizeof__"><strong>__sizeof__</strong></a>(...)</dt><dd><tt>D.<a href="#BaseQuery-__sizeof__">__sizeof__</a>() -> size of D in memory, in bytes</tt></dd></dl>
<dl><dt><a name="BaseQuery-clear"><strong>clear</strong></a>(...)</dt><dd><tt>D.<a href="#BaseQuery-clear">clear</a>() -> None. Remove all items from D.</tt></dd></dl>
<dl><dt><a name="BaseQuery-copy"><strong>copy</strong></a>(...)</dt><dd><tt>D.<a href="#BaseQuery-copy">copy</a>() -> a shallow copy of D</tt></dd></dl>
<dl><dt><a name="BaseQuery-get"><strong>get</strong></a>(...)</dt><dd><tt>D.<a href="#BaseQuery-get">get</a>(k[,d]) -> D[k] if k in D, else d. d defaults to None.</tt></dd></dl>
<dl><dt><a name="BaseQuery-has_key"><strong>has_key</strong></a>(...)</dt><dd><tt>D.<a href="#BaseQuery-has_key">has_key</a>(k) -> True if D has a key k, else False</tt></dd></dl>
<dl><dt><a name="BaseQuery-items"><strong>items</strong></a>(...)</dt><dd><tt>D.<a href="#BaseQuery-items">items</a>() -> list of D's (key, value) pairs, as 2-tuples</tt></dd></dl>
<dl><dt><a name="BaseQuery-iteritems"><strong>iteritems</strong></a>(...)</dt><dd><tt>D.<a href="#BaseQuery-iteritems">iteritems</a>() -> an iterator over the (key, value) items of D</tt></dd></dl>
<dl><dt><a name="BaseQuery-iterkeys"><strong>iterkeys</strong></a>(...)</dt><dd><tt>D.<a href="#BaseQuery-iterkeys">iterkeys</a>() -> an iterator over the keys of D</tt></dd></dl>
<dl><dt><a name="BaseQuery-itervalues"><strong>itervalues</strong></a>(...)</dt><dd><tt>D.<a href="#BaseQuery-itervalues">itervalues</a>() -> an iterator over the values of D</tt></dd></dl>
<dl><dt><a name="BaseQuery-keys"><strong>keys</strong></a>(...)</dt><dd><tt>D.<a href="#BaseQuery-keys">keys</a>() -> list of D's keys</tt></dd></dl>
<dl><dt><a name="BaseQuery-pop"><strong>pop</strong></a>(...)</dt><dd><tt>D.<a href="#BaseQuery-pop">pop</a>(k[,d]) -> v, remove specified key and return the corresponding value.<br>
If key is not found, d is returned if given, otherwise KeyError is raised</tt></dd></dl>
<dl><dt><a name="BaseQuery-popitem"><strong>popitem</strong></a>(...)</dt><dd><tt>D.<a href="#BaseQuery-popitem">popitem</a>() -> (k, v), remove and return some (key, value) pair as a<br>
2-tuple; but raise KeyError if D is empty.</tt></dd></dl>
<dl><dt><a name="BaseQuery-setdefault"><strong>setdefault</strong></a>(...)</dt><dd><tt>D.<a href="#BaseQuery-setdefault">setdefault</a>(k[,d]) -> D.<a href="#BaseQuery-get">get</a>(k,d), also set D[k]=d if k not in D</tt></dd></dl>
<dl><dt><a name="BaseQuery-update"><strong>update</strong></a>(...)</dt><dd><tt>D.<a href="#BaseQuery-update">update</a>(E, **F) -> None. Update D from dict/iterable E and F.<br>
If E has a .<a href="#BaseQuery-keys">keys</a>() method, does: for k in E: D[k] = E[k]<br>
If E lacks .<a href="#BaseQuery-keys">keys</a>() method, does: for (k, v) in E: D[k] = v<br>
In either case, this is followed by: for k in F: D[k] = F[k]</tt></dd></dl>
<dl><dt><a name="BaseQuery-values"><strong>values</strong></a>(...)</dt><dd><tt>D.<a href="#BaseQuery-values">values</a>() -> list of D's values</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="__builtin__.html#dict">__builtin__.dict</a>:<br>
<dl><dt><strong>__hash__</strong> = None</dl>
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#BaseQuery-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>
<dl><dt><strong>fromkeys</strong> = <built-in method fromkeys of type object><dd><tt>dict.<a href="#BaseQuery-fromkeys">fromkeys</a>(S[,v]) -> New dict with keys from S and values equal to v.<br>
v defaults to None.</tt></dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="Error">class <strong>Error</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.base.service.html#Error">Error</a></dd>
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl><dt><a name="Error-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#Error-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>
<hr>
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><a name="Error-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
<dl><dt><a name="Error-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
<dl><dt><a name="Error-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
<dl><dt><a name="Error-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
<br>
Use of negative indices is not supported.</tt></dd></dl>
<dl><dt><a name="Error-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
<dl><dt><a name="Error-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
<dl><dt><a name="Error-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
<dl><dt><a name="Error-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
<dl><dt><a name="Error-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
<dl><dt><a name="Error-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
<hr>
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
</dl>
<dl><dt><strong>args</strong></dt>
</dl>
<dl><dt><strong>message</strong></dt>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="GBaseService">class <strong>GBaseService</strong></a>(<a href="gdata.service.html#GDataService">gdata.service.GDataService</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Client for the Google Base service.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.base.service.html#GBaseService">GBaseService</a></dd>
<dd><a href="gdata.service.html#GDataService">gdata.service.GDataService</a></dd>
<dd><a href="atom.service.html#AtomService">atom.service.AtomService</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="GBaseService-DeleteItem"><strong>DeleteItem</strong></a>(self, item_id, url_params<font color="#909090">=None</font>, escape_params<font color="#909090">=True</font>)</dt><dd><tt>Removes an item with the specified ID from Google Base.<br>
<br>
Args:<br>
item_id: string The ID of the item to be deleted. Example:<br>
'<a href="http://www.google.com/base/feeds/items/13185446517496042648">http://www.google.com/base/feeds/items/13185446517496042648</a>'<br>
url_params: dict (optional) Additional URL parameters to be included<br>
in the deletion request.<br>
escape_params: boolean (optional) If true, the url_parameters will be<br>
escaped before they are included in the request.<br>
<br>
Returns:<br>
True if the delete succeeded.</tt></dd></dl>
<dl><dt><a name="GBaseService-ExecuteBatch"><strong>ExecuteBatch</strong></a>(self, batch_feed, converter<font color="#909090">=<function GBaseItemFeedFromString></font>)</dt><dd><tt>Sends a batch request feed to the server.<br>
<br>
Args: <br>
batch_feed: gdata.BatchFeed A feed containing BatchEntry elements which<br>
contain the desired CRUD operation and any necessary entry data.<br>
converter: Function (optional) Function to be executed on the server's<br>
response. This function should take one string as a parameter. The<br>
default value is GBaseItemFeedFromString which will turn the result <br>
into a gdata.base.GBaseItem object.<br>
<br>
Returns:<br>
A gdata.BatchFeed containing the results.</tt></dd></dl>
<dl><dt><a name="GBaseService-GetAttribute"><strong>GetAttribute</strong></a>(self, uri)</dt></dl>
<dl><dt><a name="GBaseService-GetItem"><strong>GetItem</strong></a>(self, uri)</dt></dl>
<dl><dt><a name="GBaseService-GetItemType"><strong>GetItemType</strong></a>(self, uri)</dt></dl>
<dl><dt><a name="GBaseService-GetLocale"><strong>GetLocale</strong></a>(self, uri)</dt></dl>
<dl><dt><a name="GBaseService-GetSnippet"><strong>GetSnippet</strong></a>(self, uri)</dt></dl>
<dl><dt><a name="GBaseService-InsertItem"><strong>InsertItem</strong></a>(self, new_item, url_params<font color="#909090">=None</font>, escape_params<font color="#909090">=True</font>, converter<font color="#909090">=None</font>)</dt><dd><tt>Adds an item to Google Base.<br>
<br>
Args: <br>
new_item: atom.Entry or subclass A new item which is to be added to <br>
Google Base.<br>
url_params: dict (optional) Additional URL parameters to be included<br>
in the insertion request. <br>
escape_params: boolean (optional) If true, the url_parameters will be<br>
escaped before they are included in the request.<br>
converter: func (optional) Function which is executed on the server's<br>
response before it is returned. Usually this is a function like<br>
GBaseItemFromString which will parse the response and turn it into<br>
an object.<br>
<br>
Returns:<br>
If converter is defined, the results of running converter on the server's<br>
response. Otherwise, it will be a GBaseItem.</tt></dd></dl>
<dl><dt><a name="GBaseService-Query"><strong>Query</strong></a>(self, uri, converter<font color="#909090">=None</font>)</dt><dd><tt>Performs a style query and returns a resulting feed or entry.<br>
<br>
Args:<br>
uri: string The full URI which be queried. Examples include<br>
'/base/feeds/snippets?bq=digital+camera', <br>
'<a href="http://www.google.com/base/feeds/snippets?bq=digital+camera">http://www.google.com/base/feeds/snippets?bq=digital+camera</a>'<br>
'/base/feeds/items'<br>
I recommend creating a URI using a query class.<br>
converter: func (optional) A function which will be executed on the<br>
server's response. Examples include GBaseItemFromString, etc. <br>
<br>
Returns:<br>
If converter was specified, returns the results of calling converter on<br>
the server's response. If converter was not specified, and the result<br>
was an Atom Entry, returns a GBaseItem, by default, the method returns<br>
the result of calling gdata.service's Get method.</tt></dd></dl>
<dl><dt><a name="GBaseService-QueryAttributesFeed"><strong>QueryAttributesFeed</strong></a>(self, uri)</dt></dl>
<dl><dt><a name="GBaseService-QueryItemTypesFeed"><strong>QueryItemTypesFeed</strong></a>(self, uri)</dt></dl>
<dl><dt><a name="GBaseService-QueryItemsFeed"><strong>QueryItemsFeed</strong></a>(self, uri)</dt></dl>
<dl><dt><a name="GBaseService-QueryLocalesFeed"><strong>QueryLocalesFeed</strong></a>(self, uri)</dt></dl>
<dl><dt><a name="GBaseService-QuerySnippetsFeed"><strong>QuerySnippetsFeed</strong></a>(self, uri)</dt></dl>
<dl><dt><a name="GBaseService-UpdateItem"><strong>UpdateItem</strong></a>(self, item_id, updated_item, url_params<font color="#909090">=None</font>, escape_params<font color="#909090">=True</font>, converter<font color="#909090">=<function GBaseItemFromString></font>)</dt><dd><tt>Updates an existing item.<br>
<br>
Args:<br>
item_id: string The ID of the item to be updated. Example:<br>
'<a href="http://www.google.com/base/feeds/items/13185446517496042648">http://www.google.com/base/feeds/items/13185446517496042648</a>'<br>
updated_item: atom.Entry, subclass, or string, containing<br>
the Atom Entry which will replace the base item which is <br>
stored at the item_id.<br>
url_params: dict (optional) Additional URL parameters to be included<br>
in the update request.<br>
escape_params: boolean (optional) If true, the url_parameters will be<br>
escaped before they are included in the request.<br>
converter: func (optional) Function which is executed on the server's<br>
response before it is returned. Usually this is a function like<br>
GBaseItemFromString which will parse the response and turn it into<br>
an object.<br>
<br>
Returns:<br>
If converter is defined, the results of running converter on the server's<br>
response. Otherwise, it will be a GBaseItem.</tt></dd></dl>
<dl><dt><a name="GBaseService-__init__"><strong>__init__</strong></a>(self, email<font color="#909090">=None</font>, password<font color="#909090">=None</font>, source<font color="#909090">=None</font>, server<font color="#909090">='base.google.com'</font>, api_key<font color="#909090">=None</font>, additional_headers<font color="#909090">=None</font>, handler<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Creates a client for the Google Base service.<br>
<br>
Args:<br>
email: string (optional) The user's email address, used for<br>
authentication.<br>
password: string (optional) The user's password.<br>
source: string (optional) The name of the user's application.<br>
server: string (optional) The name of the server to which a connection<br>
will be opened. Default value: 'base.google.com'.<br>
api_key: string (optional) The Google Base API key to use.<br>
**kwargs: The other parameters to pass to gdata.service.<a href="gdata.service.html#GDataService">GDataService</a><br>
constructor.</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>api_key</strong></dt>
<dd><tt>Get or set the API key to be included in all requests.</tt></dd>
</dl>
<hr>
Methods inherited from <a href="gdata.service.html#GDataService">gdata.service.GDataService</a>:<br>
<dl><dt><a name="GBaseService-AuthSubTokenInfo"><strong>AuthSubTokenInfo</strong></a>(self)</dt><dd><tt>Fetches the AuthSub token's metadata from the server.<br>
<br>
Raises:<br>
NonAuthSubToken if the user's auth token is not an AuthSub token</tt></dd></dl>
<dl><dt><a name="GBaseService-ClientLogin"><strong>ClientLogin</strong></a>(self, username, password, account_type<font color="#909090">=None</font>, service<font color="#909090">=None</font>, auth_service_url<font color="#909090">=None</font>, source<font color="#909090">=None</font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt><dd><tt>Convenience method for authenticating using ProgrammaticLogin. <br>
<br>
Sets values for email, password, and other optional members.<br>
<br>
Args:<br>
username:<br>
password:<br>
account_type: string (optional)<br>
service: string (optional)<br>
auth_service_url: string (optional)<br>
captcha_token: string (optional)<br>
captcha_response: string (optional)</tt></dd></dl>
<dl><dt><a name="GBaseService-Delete"><strong>Delete</strong></a>(self, uri, extra_headers<font color="#909090">=None</font>, url_params<font color="#909090">=None</font>, escape_params<font color="#909090">=True</font>, redirects_remaining<font color="#909090">=4</font>)</dt><dd><tt>Deletes the entry at the given URI.<br>
<br>
Args:<br>
uri: string The URI of the entry to be deleted. Example: <br>
'/base/feeds/items/ITEM-ID'<br>
extra_headers: dict (optional) HTTP headers which are to be included.<br>
The client automatically sets the Content-Type and<br>
Authorization headers.<br>
url_params: dict (optional) Additional URL parameters to be included<br>
in the URI. These are translated into query arguments<br>
in the form '&dict_key=value&...'.<br>
Example: {'max-results': '250'} becomes &max-results=250<br>
escape_params: boolean (optional) If false, the calling code has already<br>
ensured that the query will form a valid URL (all<br>
reserved characters have been escaped). If true, this<br>
method will escape the query and any URL parameters<br>
provided.<br>
<br>
Returns:<br>
True if the entry was deleted.</tt></dd></dl>
<dl><dt><a name="GBaseService-FetchOAuthRequestToken"><strong>FetchOAuthRequestToken</strong></a>(self, scopes<font color="#909090">=None</font>, extra_parameters<font color="#909090">=None</font>, request_url<font color="#909090">='https://www.google.com/accounts/OAuthGetRequestToken'</font>, oauth_callback<font color="#909090">=None</font>)</dt><dd><tt>Fetches and sets the OAuth request token and returns it.<br>
<br>
Args:<br>
scopes: string or list of string base URL(s) of the service(s) to be<br>
accessed. If None, then this method tries to determine the<br>
scope(s) from the current service.<br>
extra_parameters: dict (optional) key-value pairs as any additional<br>
parameters to be included in the URL and signature while making a<br>
request for fetching an OAuth request token. All the OAuth parameters<br>
are added by default. But if provided through this argument, any<br>
default parameters will be overwritten. For e.g. a default parameter<br>
oauth_version 1.0 can be overwritten if<br>
extra_parameters = {'oauth_version': '2.0'}<br>
request_url: Request token URL. The default is<br>
'https://www.google.com/accounts/OAuthGetRequestToken'.<br>
oauth_callback: str (optional) If set, it is assume the client is using<br>
the OAuth v1.0a protocol where the callback url is sent in the<br>
request token step. If the oauth_callback is also set in<br>
extra_params, this value will override that one.<br>
<br>
Returns:<br>
The fetched request token as a gdata.auth.OAuthToken object.<br>
<br>
Raises:<br>
FetchingOAuthRequestTokenFailed if the server responded to the request<br>
with an error.</tt></dd></dl>
<dl><dt><a name="GBaseService-GenerateAuthSubURL"><strong>GenerateAuthSubURL</strong></a>(self, next, scope, secure<font color="#909090">=False</font>, session<font color="#909090">=True</font>, domain<font color="#909090">='default'</font>)</dt><dd><tt>Generate a URL at which the user will login and be redirected back.<br>
<br>
Users enter their credentials on a Google login page and a token is sent<br>
to the URL specified in next. See documentation for AuthSub login at:<br>
<a href="http://code.google.com/apis/accounts/docs/AuthSub.html">http://code.google.com/apis/accounts/docs/AuthSub.html</a><br>
<br>
Args:<br>
next: string The URL user will be sent to after logging in.<br>
scope: string or list of strings. The URLs of the services to be <br>
accessed.<br>
secure: boolean (optional) Determines whether or not the issued token<br>
is a secure token.<br>
session: boolean (optional) Determines whether or not the issued token<br>
can be upgraded to a session token.</tt></dd></dl>
<dl><dt><a name="GBaseService-GenerateOAuthAuthorizationURL"><strong>GenerateOAuthAuthorizationURL</strong></a>(self, request_token<font color="#909090">=None</font>, callback_url<font color="#909090">=None</font>, extra_params<font color="#909090">=None</font>, include_scopes_in_callback<font color="#909090">=False</font>, scopes_param_prefix<font color="#909090">='oauth_token_scope'</font>, request_url<font color="#909090">='https://www.google.com/accounts/OAuthAuthorizeToken'</font>)</dt><dd><tt>Generates URL at which user will login to authorize the request token.<br>
<br>
Args:<br>
request_token: gdata.auth.OAuthToken (optional) OAuth request token.<br>
If not specified, then the current token will be used if it is of<br>
type <gdata.auth.OAuthToken>, else it is found by looking in the<br>
token_store by looking for a token for the current scope. <br>
callback_url: string (optional) The URL user will be sent to after<br>
logging in and granting access.<br>
extra_params: dict (optional) Additional parameters to be sent.<br>
include_scopes_in_callback: Boolean (default=False) if set to True, and<br>
if 'callback_url' is present, the 'callback_url' will be modified to<br>
include the scope(s) from the request token as a URL parameter. The<br>
key for the 'callback' URL's scope parameter will be<br>
OAUTH_SCOPE_URL_PARAM_NAME. The benefit of including the scope URL as<br>
a parameter to the 'callback' URL, is that the page which receives<br>
the OAuth token will be able to tell which URLs the token grants<br>
access to.<br>
scopes_param_prefix: string (default='oauth_token_scope') The URL<br>
parameter key which maps to the list of valid scopes for the token.<br>
This URL parameter will be included in the callback URL along with<br>
the scopes of the token as value if include_scopes_in_callback=True.<br>
request_url: Authorization URL. The default is<br>
'https://www.google.com/accounts/OAuthAuthorizeToken'.<br>
Returns:<br>
A string URL at which the user is required to login.<br>
<br>
Raises:<br>
NonOAuthToken if the user's request token is not an OAuth token or if a<br>
request token was not available.</tt></dd></dl>
<dl><dt><a name="GBaseService-Get"><strong>Get</strong></a>(self, uri, extra_headers<font color="#909090">=None</font>, redirects_remaining<font color="#909090">=4</font>, encoding<font color="#909090">='UTF-8'</font>, converter<font color="#909090">=None</font>)</dt><dd><tt><a href="gdata.service.html#Query">Query</a> the GData API with the given URI<br>
<br>
The uri is the portion of the URI after the server value <br>
(ex: www.google.com).<br>
<br>
To perform a query against Google Base, set the server to <br>
'base.google.com' and set the uri to '/base/feeds/...', where ... is <br>
your query. For example, to find snippets for all digital cameras uri <br>
should be set to: '/base/feeds/snippets?bq=digital+camera'<br>
<br>
Args:<br>
uri: string The query in the form of a URI. Example:<br>
'/base/feeds/snippets?bq=digital+camera'.<br>
extra_headers: dictionary (optional) Extra HTTP headers to be included<br>
in the GET request. These headers are in addition to <br>
those stored in the client's additional_headers property.<br>
The client automatically sets the Content-Type and <br>
Authorization headers.<br>
redirects_remaining: int (optional) Tracks the number of additional<br>
redirects this method will allow. If the service object receives<br>
a redirect and remaining is 0, it will not follow the redirect. <br>
This was added to avoid infinite redirect loops.<br>
encoding: string (optional) The character encoding for the server's<br>
response. Default is UTF-8<br>
converter: func (optional) A function which will transform<br>
the server's results before it is returned. Example: use <br>
GDataFeedFromString to parse the server response as if it<br>
were a GDataFeed.<br>
<br>
Returns:<br>
If there is no ResultsTransformer specified in the call, a GDataFeed <br>
or GDataEntry depending on which is sent from the server. If the <br>
response is niether a feed or entry and there is no ResultsTransformer,<br>
return a string. If there is a ResultsTransformer, the returned value <br>
will be that of the ResultsTransformer function.</tt></dd></dl>
<dl><dt><a name="GBaseService-GetAuthSubToken"><strong>GetAuthSubToken</strong></a>(self)</dt><dd><tt>Returns the AuthSub token as a string.<br>
<br>
If the token is an gdta.auth.AuthSubToken, the Authorization Label<br>
("AuthSub token") is removed.<br>
<br>
This method examines the current_token to see if it is an AuthSubToken<br>
or SecureAuthSubToken. If not, it searches the token_store for a token<br>
which matches the current scope.<br>
<br>
The current scope is determined by the service name string member.<br>
<br>
Returns:<br>
If the current_token is set to an AuthSubToken/SecureAuthSubToken,<br>
return the token string. If there is no current_token, a token string<br>
for a token which matches the service object's default scope is returned.<br>
If there are no tokens valid for the scope, returns None.</tt></dd></dl>
<dl><dt><a name="GBaseService-GetClientLoginToken"><strong>GetClientLoginToken</strong></a>(self)</dt><dd><tt>Returns the token string for the current token or a token matching the <br>
service scope.<br>
<br>
If the current_token is a ClientLoginToken, the token string for <br>
the current token is returned. If the current_token is not set, this method<br>
searches for a token in the token_store which is valid for the service <br>
object's current scope.<br>
<br>
The current scope is determined by the service name string member.<br>
The token string is the end of the Authorization header, it doesn not<br>
include the ClientLogin label.</tt></dd></dl>
<dl><dt><a name="GBaseService-GetEntry"><strong>GetEntry</strong></a>(self, uri, extra_headers<font color="#909090">=None</font>)</dt><dd><tt><a href="gdata.service.html#Query">Query</a> the GData API with the given URI and receive an Entry.<br>
<br>
See also documentation for gdata.service.Get<br>
<br>
Args:<br>
uri: string The query in the form of a URI. Example:<br>
'/base/feeds/snippets?bq=digital+camera'.<br>
extra_headers: dictionary (optional) Extra HTTP headers to be included<br>
in the GET request. These headers are in addition to<br>
those stored in the client's additional_headers property.<br>
The client automatically sets the Content-Type and<br>
Authorization headers.<br>
<br>
Returns:<br>
A GDataEntry built from the XML in the server's response.</tt></dd></dl>
<dl><dt><a name="GBaseService-GetFeed"><strong>GetFeed</strong></a>(self, uri, extra_headers<font color="#909090">=None</font>, converter<font color="#909090">=<function GDataFeedFromString></font>)</dt><dd><tt><a href="gdata.service.html#Query">Query</a> the GData API with the given URI and receive a Feed.<br>
<br>
See also documentation for gdata.service.Get<br>
<br>
Args:<br>
uri: string The query in the form of a URI. Example:<br>
'/base/feeds/snippets?bq=digital+camera'.<br>
extra_headers: dictionary (optional) Extra HTTP headers to be included<br>
in the GET request. These headers are in addition to<br>
those stored in the client's additional_headers property.<br>
The client automatically sets the Content-Type and<br>
Authorization headers.<br>
<br>
Returns:<br>
A GDataFeed built from the XML in the server's response.</tt></dd></dl>
<dl><dt><a name="GBaseService-GetGeneratorFromLinkFinder"><strong>GetGeneratorFromLinkFinder</strong></a>(self, link_finder, func, num_retries<font color="#909090">=3</font>, delay<font color="#909090">=1</font>, backoff<font color="#909090">=2</font>)</dt><dd><tt>returns a generator for pagination</tt></dd></dl>
<dl><dt><a name="GBaseService-GetMedia"><strong>GetMedia</strong></a>(self, uri, extra_headers<font color="#909090">=None</font>)</dt><dd><tt>Returns a MediaSource containing media and its metadata from the given<br>
URI string.</tt></dd></dl>
<dl><dt><a name="GBaseService-GetNext"><strong>GetNext</strong></a>(self, feed)</dt><dd><tt>Requests the next 'page' of results in the feed.<br>
<br>
This method uses the feed's next link to request an additional feed<br>
and uses the class of the feed to convert the results of the GET request.<br>
<br>
Args:<br>
feed: atom.Feed or a subclass. The feed should contain a next link and<br>
the type of the feed will be applied to the results from the <br>
server. The new feed which is returned will be of the same class<br>
as this feed which was passed in.<br>
<br>
Returns:<br>
A new feed representing the next set of results in the server's feed.<br>
The type of this feed will match that of the feed argument.</tt></dd></dl>
<dl><dt><a name="GBaseService-GetOAuthInputParameters"><strong>GetOAuthInputParameters</strong></a>(self)</dt></dl>
<dl><dt><a name="GBaseService-GetWithRetries"><strong>GetWithRetries</strong></a>(self, uri, extra_headers<font color="#909090">=None</font>, redirects_remaining<font color="#909090">=4</font>, encoding<font color="#909090">='UTF-8'</font>, converter<font color="#909090">=None</font>, num_retries<font color="#909090">=3</font>, delay<font color="#909090">=1</font>, backoff<font color="#909090">=2</font>, logger<font color="#909090">=None</font>)</dt><dd><tt>This is a wrapper method for Get with retrying capability.<br>
<br>
To avoid various errors while retrieving bulk entities by retrying<br>
specified times.<br>
<br>
Note this method relies on the time module and so may not be usable<br>
by default in Python2.2.<br>
<br>
Args:<br>
num_retries: Integer; the retry count.<br>
delay: Integer; the initial delay for retrying.<br>
backoff: Integer; how much the delay should lengthen after each failure.<br>
logger: An object which has a <a href="#GBaseService-debug">debug</a>(str) method to receive logging<br>
messages. Recommended that you pass in the logging module.<br>
Raises:<br>
ValueError if any of the parameters has an invalid value.<br>
RanOutOfTries on failure after number of retries.</tt></dd></dl>
<dl><dt><a name="GBaseService-Post"><strong>Post</strong></a>(self, data, uri, extra_headers<font color="#909090">=None</font>, url_params<font color="#909090">=None</font>, escape_params<font color="#909090">=True</font>, redirects_remaining<font color="#909090">=4</font>, media_source<font color="#909090">=None</font>, converter<font color="#909090">=None</font>)</dt><dd><tt>Insert or update data into a GData service at the given URI.<br>
<br>
Args:<br>
data: string, ElementTree._Element, atom.Entry, or gdata.GDataEntry The<br>
XML to be sent to the uri.<br>
uri: string The location (feed) to which the data should be inserted.<br>
Example: '/base/feeds/items'.<br>
extra_headers: dict (optional) HTTP headers which are to be included.<br>
The client automatically sets the Content-Type,<br>
Authorization, and Content-Length headers.<br>
url_params: dict (optional) Additional URL parameters to be included<br>
in the URI. These are translated into query arguments<br>
in the form '&dict_key=value&...'.<br>
Example: {'max-results': '250'} becomes &max-results=250<br>
escape_params: boolean (optional) If false, the calling code has already<br>
ensured that the query will form a valid URL (all<br>
reserved characters have been escaped). If true, this<br>
method will escape the query and any URL parameters<br>
provided.<br>
media_source: MediaSource (optional) Container for the media to be sent<br>
along with the entry, if provided.<br>
converter: func (optional) A function which will be executed on the<br>
server's response. Often this is a function like<br>
GDataEntryFromString which will parse the body of the server's<br>
response and return a GDataEntry.<br>
<br>
Returns:<br>
If the post succeeded, this method will return a GDataFeed, GDataEntry,<br>
or the results of running converter on the server's result body (if<br>
converter was specified).</tt></dd></dl>
<dl><dt><a name="GBaseService-PostOrPut"><strong>PostOrPut</strong></a>(self, verb, data, uri, extra_headers<font color="#909090">=None</font>, url_params<font color="#909090">=None</font>, escape_params<font color="#909090">=True</font>, redirects_remaining<font color="#909090">=4</font>, media_source<font color="#909090">=None</font>, converter<font color="#909090">=None</font>)</dt><dd><tt>Insert data into a GData service at the given URI.<br>
<br>
Args:<br>
verb: string, either 'POST' or 'PUT'<br>
data: string, ElementTree._Element, atom.Entry, or gdata.GDataEntry The<br>
XML to be sent to the uri. <br>
uri: string The location (feed) to which the data should be inserted. <br>
Example: '/base/feeds/items'. <br>
extra_headers: dict (optional) HTTP headers which are to be included. <br>
The client automatically sets the Content-Type,<br>
Authorization, and Content-Length headers.<br>
url_params: dict (optional) Additional URL parameters to be included<br>
in the URI. These are translated into query arguments<br>
in the form '&dict_key=value&...'.<br>
Example: {'max-results': '250'} becomes &max-results=250<br>
escape_params: boolean (optional) If false, the calling code has already<br>
ensured that the query will form a valid URL (all<br>
reserved characters have been escaped). If true, this<br>
method will escape the query and any URL parameters<br>
provided.<br>
media_source: MediaSource (optional) Container for the media to be sent<br>
along with the entry, if provided.<br>
converter: func (optional) A function which will be executed on the <br>
server's response. Often this is a function like <br>
GDataEntryFromString which will parse the body of the server's <br>
response and return a GDataEntry.<br>
<br>
Returns:<br>
If the post succeeded, this method will return a GDataFeed, GDataEntry,<br>
or the results of running converter on the server's result body (if<br>
converter was specified).</tt></dd></dl>
<dl><dt><a name="GBaseService-ProgrammaticLogin"><strong>ProgrammaticLogin</strong></a>(self, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt><dd><tt>Authenticates the user and sets the GData Auth token.<br>
<br>
Login retreives a temporary auth token which must be used with all<br>
requests to GData services. The auth token is stored in the GData client<br>
object.<br>
<br>
Login is also used to respond to a captcha challenge. If the user's login<br>
attempt failed with a CaptchaRequired error, the user can respond by<br>
calling Login with the captcha token and the answer to the challenge.<br>
<br>
Args:<br>
captcha_token: string (optional) The identifier for the captcha challenge<br>
which was presented to the user.<br>
captcha_response: string (optional) The user's answer to the captch <br>
challenge.<br>
<br>
Raises:<br>
CaptchaRequired if the login service will require a captcha response<br>
BadAuthentication if the login service rejected the username or password<br>
<a href="#Error">Error</a> if the login service responded with a 403 different from the above</tt></dd></dl>
<dl><dt><a name="GBaseService-Put"><strong>Put</strong></a>(self, data, uri, extra_headers<font color="#909090">=None</font>, url_params<font color="#909090">=None</font>, escape_params<font color="#909090">=True</font>, redirects_remaining<font color="#909090">=3</font>, media_source<font color="#909090">=None</font>, converter<font color="#909090">=None</font>)</dt><dd><tt>Updates an entry at the given URI.<br>
<br>
Args:<br>
data: string, ElementTree._Element, or xml_wrapper.ElementWrapper The <br>
XML containing the updated data.<br>
uri: string A URI indicating entry to which the update will be applied.<br>
Example: '/base/feeds/items/ITEM-ID'<br>
extra_headers: dict (optional) HTTP headers which are to be included.<br>
The client automatically sets the Content-Type,<br>
Authorization, and Content-Length headers.<br>
url_params: dict (optional) Additional URL parameters to be included<br>
in the URI. These are translated into query arguments<br>
in the form '&dict_key=value&...'.<br>
Example: {'max-results': '250'} becomes &max-results=250<br>
escape_params: boolean (optional) If false, the calling code has already<br>
ensured that the query will form a valid URL (all<br>
reserved characters have been escaped). If true, this<br>
method will escape the query and any URL parameters<br>
provided.<br>
converter: func (optional) A function which will be executed on the <br>
server's response. Often this is a function like <br>
GDataEntryFromString which will parse the body of the server's <br>
response and return a GDataEntry.<br>
<br>
Returns:<br>
If the put succeeded, this method will return a GDataFeed, GDataEntry,<br>
or the results of running converter on the server's result body (if<br>
converter was specified).</tt></dd></dl>
<dl><dt><a name="GBaseService-RevokeAuthSubToken"><strong>RevokeAuthSubToken</strong></a>(self)</dt><dd><tt>Revokes an existing AuthSub token.<br>
<br>
Raises:<br>
NonAuthSubToken if the user's auth token is not an AuthSub token</tt></dd></dl>
<dl><dt><a name="GBaseService-RevokeOAuthToken"><strong>RevokeOAuthToken</strong></a>(self, request_url<font color="#909090">='https://www.google.com/accounts/AuthSubRevokeToken'</font>)</dt><dd><tt>Revokes an existing OAuth token.<br>
<br>
request_url: Token revoke URL. The default is<br>
'https://www.google.com/accounts/AuthSubRevokeToken'.<br>
Raises:<br>
NonOAuthToken if the user's auth token is not an OAuth token.<br>
RevokingOAuthTokenFailed if request for revoking an OAuth token failed.</tt></dd></dl>
<dl><dt><a name="GBaseService-SetAuthSubToken"><strong>SetAuthSubToken</strong></a>(self, token, scopes<font color="#909090">=None</font>, rsa_key<font color="#909090">=None</font>)</dt><dd><tt>Sets the token sent in requests to an AuthSub token.<br>
<br>
Sets the current_token and attempts to add the token to the token_store.<br>
<br>
Only use this method if you have received a token from the AuthSub<br>
service. The auth token is set automatically when <a href="#GBaseService-UpgradeToSessionToken">UpgradeToSessionToken</a>()<br>
is used. See documentation for Google AuthSub here:<br>
<a href="http://code.google.com/apis/accounts/AuthForWebApps.html">http://code.google.com/apis/accounts/AuthForWebApps.html</a> <br>
<br>
Args:<br>
token: gdata.auth.AuthSubToken or gdata.auth.SecureAuthSubToken or string<br>
The token returned by the AuthSub service. If the token is an<br>
AuthSubToken or SecureAuthSubToken, the scope information stored in<br>
the token is used. If the token is a string, the scopes parameter is<br>
used to determine the valid scopes.<br>
scopes: list of URLs for which the token is valid. This is only used<br>
if the token parameter is a string.<br>
rsa_key: string (optional) Private key required for RSA_SHA1 signature<br>
method. This parameter is necessary if the token is a string<br>
representing a secure token.</tt></dd></dl>
<dl><dt><a name="GBaseService-SetClientLoginToken"><strong>SetClientLoginToken</strong></a>(self, token, scopes<font color="#909090">=None</font>)</dt><dd><tt>Sets the token sent in requests to a ClientLogin token.<br>
<br>
This method sets the current_token to a new ClientLoginToken and it <br>
also attempts to add the ClientLoginToken to the token_store.<br>
<br>
Only use this method if you have received a token from the ClientLogin<br>
service. The auth_token is set automatically when <a href="#GBaseService-ProgrammaticLogin">ProgrammaticLogin</a>()<br>
is used. See documentation for Google ClientLogin here:<br>
<a href="http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html">http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html</a><br>
<br>
Args:<br>
token: string or instance of a ClientLoginToken.</tt></dd></dl>
<dl><dt><a name="GBaseService-SetOAuthInputParameters"><strong>SetOAuthInputParameters</strong></a>(self, signature_method, consumer_key, consumer_secret<font color="#909090">=None</font>, rsa_key<font color="#909090">=None</font>, two_legged_oauth<font color="#909090">=False</font>, requestor_id<font color="#909090">=None</font>)</dt><dd><tt>Sets parameters required for using OAuth authentication mechanism.<br>
<br>
NOTE: Though consumer_secret and rsa_key are optional, either of the two<br>
is required depending on the value of the signature_method.<br>
<br>
Args:<br>
signature_method: class which provides implementation for strategy class<br>
oauth.oauth.OAuthSignatureMethod. Signature method to be used for<br>
signing each request. Valid implementations are provided as the<br>
constants defined by gdata.auth.OAuthSignatureMethod. Currently<br>
they are gdata.auth.OAuthSignatureMethod.RSA_SHA1 and<br>
gdata.auth.OAuthSignatureMethod.HMAC_SHA1<br>
consumer_key: string Domain identifying third_party web application.<br>
consumer_secret: string (optional) Secret generated during registration.<br>
Required only for HMAC_SHA1 signature method.<br>
rsa_key: string (optional) Private key required for RSA_SHA1 signature<br>
method.<br>
two_legged_oauth: boolean (optional) Enables two-legged OAuth process.<br>
requestor_id: string (optional) User email adress to make requests on<br>
their behalf. This parameter should only be set when two_legged_oauth<br>
is True.</tt></dd></dl>
<dl><dt><a name="GBaseService-SetOAuthToken"><strong>SetOAuthToken</strong></a>(self, oauth_token)</dt><dd><tt>Attempts to set the current token and add it to the token store.<br>
<br>
The oauth_token can be any OAuth token i.e. unauthorized request token,<br>
authorized request token or access token.<br>
This method also attempts to add the token to the token store.<br>
Use this method any time you want the current token to point to the<br>
oauth_token passed. For e.g. call this method with the request token<br>
you receive from FetchOAuthRequestToken.<br>
<br>
Args:<br>
request_token: gdata.auth.OAuthToken OAuth request token.</tt></dd></dl>
<dl><dt><a name="GBaseService-UpgradeToOAuthAccessToken"><strong>UpgradeToOAuthAccessToken</strong></a>(self, authorized_request_token<font color="#909090">=None</font>, request_url<font color="#909090">='https://www.google.com/accounts/OAuthGetAccessToken'</font>, oauth_version<font color="#909090">='1.0'</font>, oauth_verifier<font color="#909090">=None</font>)</dt><dd><tt>Upgrades the authorized request token to an access token and returns it<br>
<br>
Args:<br>
authorized_request_token: gdata.auth.OAuthToken (optional) OAuth request<br>
token. If not specified, then the current token will be used if it is<br>
of type <gdata.auth.OAuthToken>, else it is found by looking in the<br>
token_store by looking for a token for the current scope.<br>
request_url: Access token URL. The default is<br>
'https://www.google.com/accounts/OAuthGetAccessToken'.<br>
oauth_version: str (default='1.0') oauth_version parameter. All other<br>
'oauth_' parameters are added by default. This parameter too, is<br>
added by default but here you can override it's value.<br>
oauth_verifier: str (optional) If present, it is assumed that the client<br>
will use the OAuth v1.0a protocol which includes passing the<br>
oauth_verifier (as returned by the SP) in the access token step.<br>
<br>
Returns:<br>
Access token<br>
<br>
Raises:<br>
NonOAuthToken if the user's authorized request token is not an OAuth<br>
token or if an authorized request token was not available.<br>
TokenUpgradeFailed if the server responded to the request with an <br>
error.</tt></dd></dl>
<dl><dt><a name="GBaseService-UpgradeToSessionToken"><strong>UpgradeToSessionToken</strong></a>(self, token<font color="#909090">=None</font>)</dt><dd><tt>Upgrades a single use AuthSub token to a session token.<br>
<br>
Args:<br>
token: A gdata.auth.AuthSubToken or gdata.auth.SecureAuthSubToken<br>
(optional) which is good for a single use but can be upgraded<br>
to a session token. If no token is passed in, the token<br>
is found by looking in the token_store by looking for a token<br>
for the current scope.<br>
<br>
Raises:<br>
NonAuthSubToken if the user's auth token is not an AuthSub token<br>
TokenUpgradeFailed if the server responded to the request with an <br>
error.</tt></dd></dl>
<dl><dt><a name="GBaseService-upgrade_to_session_token"><strong>upgrade_to_session_token</strong></a>(self, token)</dt><dd><tt>Upgrades a single use AuthSub token to a session token.<br>
<br>
Args:<br>
token: A gdata.auth.AuthSubToken or gdata.auth.SecureAuthSubToken<br>
which is good for a single use but can be upgraded to a<br>
session token.<br>
<br>
Returns:<br>
The upgraded token as a gdata.auth.AuthSubToken object.<br>
<br>
Raises:<br>
TokenUpgradeFailed if the server responded to the request with an <br>
error.</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="gdata.service.html#GDataService">gdata.service.GDataService</a>:<br>
<dl><dt><strong>captcha_token</strong></dt>
<dd><tt>Get the captcha token for a login request.</tt></dd>
</dl>
<dl><dt><strong>captcha_url</strong></dt>
<dd><tt>Get the captcha URL for a login request.</tt></dd>
</dl>
<dl><dt><strong>source</strong></dt>
<dd><tt>The source is the name of the application making the request. <br>
It should be in the form company_id-app_name-app_version</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="gdata.service.html#GDataService">gdata.service.GDataService</a>:<br>
<dl><dt><strong>auth_token</strong> = None</dl>
<dl><dt><strong>handler</strong> = None</dl>
<dl><dt><strong>tokens</strong> = None</dl>
<hr>
Methods inherited from <a href="atom.service.html#AtomService">atom.service.AtomService</a>:<br>
<dl><dt><a name="GBaseService-UseBasicAuth"><strong>UseBasicAuth</strong></a>(self, username, password, for_proxy<font color="#909090">=False</font>)</dt><dd><tt>Sets an Authenticaiton: Basic HTTP header containing plaintext.<br>
<br>
Deprecated, use use_basic_auth instead.<br>
<br>
The username and password are base64 encoded and added to an HTTP header<br>
which will be included in each request. Note that your username and <br>
password are sent in plaintext.<br>
<br>
Args:<br>
username: str<br>
password: str</tt></dd></dl>
<dl><dt><a name="GBaseService-request"><strong>request</strong></a>(*args, **kwargs)</dt><dd><tt># The deprecated_function wraps the actual call to f.</tt></dd></dl>
<dl><dt><a name="GBaseService-use_basic_auth"><strong>use_basic_auth</strong></a>(self, username, password, scopes<font color="#909090">=None</font>)</dt></dl>
<hr>
Data descriptors inherited from <a href="atom.service.html#AtomService">atom.service.AtomService</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<dl><dt><strong>debug</strong></dt>
<dd><tt>If True, HTTP debug information is printed.</tt></dd>
</dl>
<dl><dt><strong>override_token</strong></dt>
</dl>
<hr>
Data and other attributes inherited from <a href="atom.service.html#AtomService">atom.service.AtomService</a>:<br>
<dl><dt><strong>auto_set_current_token</strong> = True</dl>
<dl><dt><strong>auto_store_tokens</strong> = True</dl>
<dl><dt><strong>current_token</strong> = None</dl>
<dl><dt><strong>port</strong> = 80</dl>
<dl><dt><strong>ssl</strong> = False</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="RequestError">class <strong>RequestError</strong></a>(<a href="gdata.base.service.html#Error">Error</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.base.service.html#RequestError">RequestError</a></dd>
<dd><a href="gdata.base.service.html#Error">Error</a></dd>
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Data descriptors inherited from <a href="gdata.base.service.html#Error">Error</a>:<br>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl><dt><a name="RequestError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#RequestError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>
<hr>
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><a name="RequestError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
<dl><dt><a name="RequestError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
<dl><dt><a name="RequestError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
<dl><dt><a name="RequestError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
<br>
Use of negative indices is not supported.</tt></dd></dl>
<dl><dt><a name="RequestError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
<dl><dt><a name="RequestError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
<dl><dt><a name="RequestError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
<dl><dt><a name="RequestError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
<dl><dt><a name="RequestError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
<dl><dt><a name="RequestError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
<hr>
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
</dl>
<dl><dt><strong>args</strong></dt>
</dl>
<dl><dt><strong>message</strong></dt>
</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>BASE_BATCH_URL</strong> = 'http://www.google.com/base/feeds/items/batch'<br>
<strong>__author__</strong> = 'api.jscudder (Jeffrey Scudder)'</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#7799ee">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td>
<td width="100%">api.jscudder (Jeffrey Scudder)</td></tr></table>
</body></html>
|