|  |  | 
__builtin__.object
AtomService
atom.http_interface.GenericToken(__builtin__.object)
BasicAuthToken
 
 
| class AtomService(__builtin__.object)
 |  |  | Performs Atom Publishing Protocol CRUD operations. 
 The AtomService contains methods to perform HTTP CRUD operations.
 
 |  |  | Methods defined here: 
 Delete(self, uri, extra_headers=None, url_params=None, escape_params=True)Deletes the entry at the given URI.
 Args:
 uri: string The URI of the entry to be deleted. Example:
 '/base/feeds/items/ITEM-ID'
 extra_headers: dict (optional) HTTP headers which are to be included.
 The client automatically sets the Content-Type and
 Authorization headers.
 url_params: dict (optional) Additional URL parameters to be included
 in the URI. These are translated into query arguments
 in the form '&dict_key=value&...'.
 Example: {'max-results': '250'} becomes &max-results=250
 escape_params: boolean (optional) If false, the calling code has already
 ensured that the query will form a valid URL (all
 reserved characters have been escaped). If true, this
 method will escape the query and any URL parameters
 provided.
 
 Returns:
 httplib.HTTPResponse Server's response to the DELETE request.
 Get(self, uri, extra_headers=None, url_params=None, escape_params=True)Query the APP server with the given URI
 The uri is the portion of the URI after the server value
 (server example: 'www.google.com').
 
 Example use:
 To perform a query against Google Base, set the server to
 'base.google.com' and set the uri to '/base/feeds/...', where ... is
 your query. For example, to find snippets for all digital cameras uri
 should be set to: '/base/feeds/snippets?bq=digital+camera'
 
 Args:
 uri: string The query in the form of a URI. Example:
 '/base/feeds/snippets?bq=digital+camera'.
 extra_headers: dicty (optional) Extra HTTP headers to be included
 in the GET request. These headers are in addition to
 those stored in the client's additional_headers property.
 The client automatically sets the Content-Type and
 Authorization headers.
 url_params: dict (optional) Additional URL parameters to be included
 in the query. These are translated into query arguments
 in the form '&dict_key=value&...'.
 Example: {'max-results': '250'} becomes &max-results=250
 escape_params: boolean (optional) If false, the calling code has already
 ensured that the query will form a valid URL (all
 reserved characters have been escaped). If true, this
 method will escape the query and any URL parameters
 provided.
 
 Returns:
 httplib.HTTPResponse The server's response to the GET request.
 Post(self, data, uri, extra_headers=None, url_params=None, escape_params=True, content_type='application/atom+xml')Insert data into an APP server at the given URI.
 Args:
 data: string, ElementTree._Element, or something with a __str__ method
 The XML to be sent to the uri.
 uri: string The location (feed) to which the data should be inserted.
 Example: '/base/feeds/items'.
 extra_headers: dict (optional) HTTP headers which are to be included.
 The client automatically sets the Content-Type,
 Authorization, and Content-Length headers.
 url_params: dict (optional) Additional URL parameters to be included
 in the URI. These are translated into query arguments
 in the form '&dict_key=value&...'.
 Example: {'max-results': '250'} becomes &max-results=250
 escape_params: boolean (optional) If false, the calling code has already
 ensured that the query will form a valid URL (all
 reserved characters have been escaped). If true, this
 method will escape the query and any URL parameters
 provided.
 
 Returns:
 httplib.HTTPResponse Server's response to the POST request.
 Put(self, data, uri, extra_headers=None, url_params=None, escape_params=True, content_type='application/atom+xml')Updates an entry at the given URI.
 Args:
 data: string, ElementTree._Element, or xml_wrapper.ElementWrapper The
 XML containing the updated data.
 uri: string A URI indicating entry to which the update will be applied.
 Example: '/base/feeds/items/ITEM-ID'
 extra_headers: dict (optional) HTTP headers which are to be included.
 The client automatically sets the Content-Type,
 Authorization, and Content-Length headers.
 url_params: dict (optional) Additional URL parameters to be included
 in the URI. These are translated into query arguments
 in the form '&dict_key=value&...'.
 Example: {'max-results': '250'} becomes &max-results=250
 escape_params: boolean (optional) If false, the calling code has already
 ensured that the query will form a valid URL (all
 reserved characters have been escaped). If true, this
 method will escape the query and any URL parameters
 provided.
 
 Returns:
 httplib.HTTPResponse Server's response to the PUT request.
 UseBasicAuth(self, username, password, for_proxy=False)Sets an Authenticaiton: Basic HTTP header containing plaintext.
 Deprecated, use use_basic_auth instead.
 
 The username and password are base64 encoded and added to an HTTP header
 which will be included in each request. Note that your username and
 password are sent in plaintext.
 
 Args:
 username: str
 password: str
 __init__(*args, **kwargs)# The deprecated_function wraps the actual call to f.
 request(*args, **kwargs)# The deprecated_function wraps the actual call to f.
 use_basic_auth(self, username, password, scopes=None)
 Data descriptors defined here:
 
 __dict__dictionary for instance variables (if defined)
 __weakref__list of weak references to the object (if defined)
 debugIf True, HTTP debug information is printed.
 override_token
 Data and other attributes defined here:
 
 auto_set_current_token = True
 auto_store_tokens = True
 current_token = None
 port = 80
 ssl = False
 |  
 
| class BasicAuthToken(atom.http_interface.GenericToken)
 |  |  |  | Method resolution order:BasicAuthTokenatom.http_interface.GenericToken__builtin__.object
 Methods defined here:
 
 __init__(self, auth_header, scopes=None)Creates a token used to add Basic Auth headers to HTTP requests.
 Args:
 auth_header: str The value for the Authorization header.
 scopes: list of str or atom.url.Url specifying the beginnings of URLs
 for which this token can be used. For example, if scopes contains
 'http://example.com/foo', then this token can be used for a request to
 'http://example.com/foo/bar' but it cannot be used for a request to
 'http://example.com/baz'
 __str__(self)
 perform_request(self, http_client, operation, url, data=None, headers=None)Sets the Authorization header to the basic auth string.
 valid_for_scope(self, url)Tells the caller if the token authorizes access to the desired URL.
 Data descriptors inherited from atom.http_interface.GenericToken:
 
 __dict__dictionary for instance variables (if defined)
 __weakref__list of weak references to the object (if defined)
 |  |