Core API

Provides a client to interact with Google Data API servers.

This module is used for version 2 of the Google Data APIs. The primary class in this module is GDClient.

GDClient: handles auth and CRUD operations when communicating with servers. GDataClient: deprecated client for version one services. Will be removed.
class gdata.client.GDClient(http_client=None, host=None, auth_token=None, source=None, xoauth_requestor_id=None, **kwargs)[source]

Communicates with Google Data servers to perform CRUD operations.

This class is currently experimental and may change in backwards incompatible ways.

This class exists to simplify the following three areas involved in using the Google Data APIs.

CRUD Operations:

The client provides a generic ‘request’ method for making HTTP requests. There are a number of convenience methods which are built on top of request, which include get_feed, get_entry, get_next, post, update, and delete. These methods contact the Google Data servers.

Auth:

Reading user-specific private data requires authorization from the user as do any changes to user data. An auth_token object can be passed into any of the HTTP requests to set the Authorization header in the request.

You may also want to set the auth_token member to a an object which can use modify_request to set the Authorization header in the HTTP request.

If you are authenticating using the email address and password, you can use the client_login method to obtain an auth token and set the auth_token member.

If you are using browser redirects, specifically AuthSub, you will want to use gdata.gauth.AuthSubToken.from_url to obtain the token after the redirect, and you will probably want to updgrade this since use token to a multiple use (session) token using the upgrade_token method.

API Versions:

This client is multi-version capable and can be used with Google Data API version 1 and version 2. The version should be specified by setting the api_version member to a string, either ‘1’ or ‘2’.

Batch(feed, uri=None, force=False, auth_token=None, **kwargs)

Sends a batch request to the server to execute operation entries.

Parameters:
  • feed – A batch feed containing batch entries, each is an operation.
  • uri – (optional) The uri to which the batch request feed should be POSTed. If none is provided, then the feed’s edit link will be used.
  • force – (optional) boolean set to True if you want the batch update to clobber all data. If False, the version in the information in the feed object will cause the server to check to see that no changes intervened between when you fetched the data and when you sent the changes.
  • auth_token – (optional) An object which sets the Authorization HTTP header in its modify_request method. Recommended classes include gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken among others.
ClientLogin(email, password, source, service=None, account_type='HOSTED_OR_GOOGLE', auth_url=<atom.http_core.Uri object at 0x2692090>, captcha_token=None, captcha_response=None)

Performs an auth request using the user’s email address and password.

In order to modify user specific data and read user private data, your application must be authorized by the user. One way to demonstrage authorization is by including a Client Login token in the Authorization HTTP header of all requests. This method requests the Client Login token by sending the user’s email address, password, the name of the application, and the service code for the service which will be accessed by the application. If the username and password are correct, the server will respond with the client login code and a new ClientLoginToken object will be set in the client’s auth_token member. With the auth_token set, future requests from this client will include the Client Login token.

For a list of service names, see http://code.google.com/apis/gdata/faq.html#clientlogin For more information on Client Login, see: http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html

Parameters:
  • email – str The user’s email address or username.
  • password – str The password for the user’s account.
  • source – str The name of your application. This can be anything you like but should should give some indication of which app is making the request.
  • service – str The service code for the service you would like to access. For example, ‘cp’ for contacts, ‘cl’ for calendar. For a full list see
  • http – //code.google.com/apis/gdata/faq.html#clientlogin If you are using a subclass of the gdata.client.GDClient, the service will usually be filled in for you so you do not need to specify it. For example see BloggerClient, SpreadsheetsClient, etc.
  • account_type – str (optional) The type of account which is being authenticated. This can be either ‘GOOGLE’ for a Google Account, ‘HOSTED’ for a Google Apps Account, or the default ‘HOSTED_OR_GOOGLE’ which will select the Google Apps Account if the same email address is used for both a Google Account and a Google Apps Account.
  • auth_url – str (optional) The URL to which the login request should be sent.
  • captcha_token – str (optional) If a previous login attempt was reponded to with a CAPTCHA challenge, this is the token which identifies the challenge (from the CAPTCHA’s URL).
  • captcha_response – str (optional) If a previous login attempt was reponded to with a CAPTCHA challenge, this is the response text which was contained in the challenge.
  • Returns – Generated token, which is also stored in this object.
  • Raises
  • RequestError or one of its suclasses (A) – BadAuthentication, BadAuthenticationServiceURL, ClientLoginFailed, ClientLoginTokenMissing, or CaptchaChallenge
Get(uri=None, auth_token=None, http_request=None, **kwargs)

Performs a request using the GET method, returns an HTTP response.

GetAccessToken(request_token, url='https://www.google.com/accounts/OAuthGetAccessToken')

Exchanges an authorized OAuth request token for an access token.

Contacts the Google OAuth server to upgrade a previously authorized request token. Once the request token is upgraded to an access token, the access token may be used to access the user’s data.

For more details, see the Google Accounts OAuth documentation: http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken

Parameters:
GetNext(feed, auth_token=None, converter=None, desired_class=None, **kwargs)

Fetches the next set of results from the feed.

When requesting a feed, the number of entries returned is capped at a service specific default limit (often 25 entries). You can specify your own entry-count cap using the max-results URL query parameter. If there are more results than could fit under max-results, the feed will contain a next link. This method performs a GET against this next results URL.

Return type:A new feed object containing the next set of entries in this feed.
GetOAuthToken(scopes, next, consumer_key, consumer_secret=None, rsa_private_key=None, url='https://www.google.com/accounts/OAuthGetRequestToken')

Obtains an OAuth request token to allow the user to authorize this app.

Once this client has a request token, the user can authorize the request token by visiting the authorization URL in their browser. After being redirected back to this app at the ‘next’ URL, this app can then exchange the authorized request token for an access token.

For more information see the documentation on Google Accounts with OAuth: http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess

Parameters:
  • scopes – list of strings or atom.http_core.Uri objects which specify the URL prefixes which this app will be accessing. For example, to access
  • Google Calendar API, you would want to use scopes (the) –
  • [‘https – //www.google.com/calendar/feeds/’,
  • ‘http – //www.google.com/calendar/feeds/’]
  • next – str or atom.http_core.Uri object, The URL which the user’s browser should be sent to after they authorize access to their data. This should be a URL in your application which will read the token information from the URL and upgrade the request token to an access token.
  • consumer_key – str This is the identifier for this application which you should have received when you registered your application with Google to use OAuth.
  • consumer_secret – str (optional) The shared secret between your app and Google which provides evidence that this request is coming from you application and not another app. If present, this libraries assumes you want to use an HMAC signature to verify requests. Keep this data a secret.
  • rsa_private_key – str (optional) The RSA private key which is used to generate a digital signature which is checked by Google’s server. If present, this library assumes that you want to use an RSA signature to verify requests. Keep this data a secret.
  • url – The URL to which a request for a token should be made. The default is Google’s OAuth request token provider.
ModifyRequest(http_request)

Adds or changes request before making the HTTP request.

This client will add the API version if it is specified. Subclasses may override this method to add their own request modifications before the request is made.

Put(uri=None, data=None, auth_token=None, http_request=None, **kwargs)

Sends data using the PUT method, returns an HTTP response.

Request(method=None, uri=None, auth_token=None, http_request=None, converter=None, desired_class=None, redirects_remaining=4, **kwargs)

Make an HTTP request to the server.

See also documentation for atom.client.AtomPubClient.request.

If a 302 redirect is sent from the server to the client, this client assumes that the redirect is in the form used by the Google Calendar API. The same request URI and method will be used as in the original request, but a gsessionid URL parameter will be added to the request URI with the value provided in the server’s 302 redirect response. If the 302 redirect is not in the format specified by the Google Calendar API, a RedirectError will be raised containing the body of the server’s response.

The method calls the client’s modify_request method to make any changes required by the client before the request is made. For example, a version 2 client could add a GData-Version: 2 header to the request in its modify_request method.

Parameters:
  • method – str The HTTP verb for this request, usually ‘GET’, ‘POST’, ‘PUT’, or ‘DELETE’
  • uri – atom.http_core.Uri, str, or unicode The URL being requested.
  • auth_token – An object which sets the Authorization HTTP header in its modify_request method. Recommended classes include gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken among others.
  • http_request – (optional) atom.http_core.HttpRequest
  • converter – function which takes the body of the response as its only argument and returns the desired object.
  • desired_class – class descended from atom.core.XmlElement to which a successful response should be converted. If there is no converter function specified (converter=None) then the desired_class will be used in calling the atom.core.parse function. If neither the desired_class nor the converter is specified, an HTTP reponse object will be returned.
  • redirects_remaining – (optional) int, if this number is 0 and the server sends a 302 redirect, the request method will raise an exception. This parameter is used in recursive request calls to avoid an infinite loop.Any additional arguments are passed through toatom.client.AtomPubClient.request.
Return type:

An HTTP response object (see atom.http_core.HttpResponse for a description of the object’s interface) if no converter was specified and no desired_class was specified. If a converter function was provided, the results of calling the converter are returned. If no converter was specified but a desired_class was provided, the response body will be converted to the class using atom.core.parse.

RevokeToken(token=None, url=<atom.http_core.Uri object at 0x2692110>)

Requests that the token be invalidated.

This method can be used for both AuthSub and OAuth tokens (to invalidate a ClientLogin token, the user must change their password).

Return type:True if the server responded with a 200. Raises: A RequestError if the server responds with a non-200 status.
Update(entry, auth_token=None, force=False, uri=None, **kwargs)

Edits the entry on the server by sending the XML for this entry.

Performs a PUT and converts the response to a new entry object with a matching class to the entry passed in.

Parameters:
  • entry
  • auth_token
  • force – boolean stating whether an update should be forced. Defaults to False. Normally, if a change has been made since the passed in entry was obtained, the server will not overwrite the entry since the changes were based on an obsolete version of the entry. Setting force to True will cause the update to silently overwrite whatever version is present.
  • uri – The uri to put to. If provided, this uri is PUT to rather than the inferred uri from the entry’s edit link.
Return type:

A new Entry object of a matching type to the entry which was passed in.

UpgradeToken(token=None, url=<atom.http_core.Uri object at 0x26920d0>)

Asks the Google auth server for a multi-use AuthSub token.

For details on AuthSub, see: http://code.google.com/apis/accounts/docs/AuthSub.html

Parameters:
  • token – gdata.gauth.AuthSubToken or gdata.gauth.SecureAuthSubToken (optional) If no token is passed in, the client’s auth_token member is used to request the new token. The token object will be modified to contain the new session token string.
  • url – str or atom.http_core.Uri (optional) The URL to which the token
  • request should be sent. Defaults to (upgrade) –
  • https – //www.google.com/accounts/AuthSubSessionToken
Return type:

The upgraded gdata.gauth.AuthSubToken object.

batch(feed, uri=None, force=False, auth_token=None, **kwargs)[source]

Sends a batch request to the server to execute operation entries.

Parameters:
  • feed – A batch feed containing batch entries, each is an operation.
  • uri – (optional) The uri to which the batch request feed should be POSTed. If none is provided, then the feed’s edit link will be used.
  • force – (optional) boolean set to True if you want the batch update to clobber all data. If False, the version in the information in the feed object will cause the server to check to see that no changes intervened between when you fetched the data and when you sent the changes.
  • auth_token – (optional) An object which sets the Authorization HTTP header in its modify_request method. Recommended classes include gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken among others.
client_login(email, password, source, service=None, account_type='HOSTED_OR_GOOGLE', auth_url=<atom.http_core.Uri object at 0x2692090>, captcha_token=None, captcha_response=None)[source]

Performs an auth request using the user’s email address and password.

In order to modify user specific data and read user private data, your application must be authorized by the user. One way to demonstrage authorization is by including a Client Login token in the Authorization HTTP header of all requests. This method requests the Client Login token by sending the user’s email address, password, the name of the application, and the service code for the service which will be accessed by the application. If the username and password are correct, the server will respond with the client login code and a new ClientLoginToken object will be set in the client’s auth_token member. With the auth_token set, future requests from this client will include the Client Login token.

For a list of service names, see http://code.google.com/apis/gdata/faq.html#clientlogin For more information on Client Login, see: http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html

Parameters:
  • email – str The user’s email address or username.
  • password – str The password for the user’s account.
  • source – str The name of your application. This can be anything you like but should should give some indication of which app is making the request.
  • service – str The service code for the service you would like to access. For example, ‘cp’ for contacts, ‘cl’ for calendar. For a full list see
  • http – //code.google.com/apis/gdata/faq.html#clientlogin If you are using a subclass of the gdata.client.GDClient, the service will usually be filled in for you so you do not need to specify it. For example see BloggerClient, SpreadsheetsClient, etc.
  • account_type – str (optional) The type of account which is being authenticated. This can be either ‘GOOGLE’ for a Google Account, ‘HOSTED’ for a Google Apps Account, or the default ‘HOSTED_OR_GOOGLE’ which will select the Google Apps Account if the same email address is used for both a Google Account and a Google Apps Account.
  • auth_url – str (optional) The URL to which the login request should be sent.
  • captcha_token – str (optional) If a previous login attempt was reponded to with a CAPTCHA challenge, this is the token which identifies the challenge (from the CAPTCHA’s URL).
  • captcha_response – str (optional) If a previous login attempt was reponded to with a CAPTCHA challenge, this is the response text which was contained in the challenge.
  • Returns – Generated token, which is also stored in this object.
  • Raises
  • RequestError or one of its suclasses (A) – BadAuthentication, BadAuthenticationServiceURL, ClientLoginFailed, ClientLoginTokenMissing, or CaptchaChallenge
get(uri=None, auth_token=None, http_request=None, **kwargs)

Performs a request using the GET method, returns an HTTP response.

get_access_token(request_token, url='https://www.google.com/accounts/OAuthGetAccessToken')[source]

Exchanges an authorized OAuth request token for an access token.

Contacts the Google OAuth server to upgrade a previously authorized request token. Once the request token is upgraded to an access token, the access token may be used to access the user’s data.

For more details, see the Google Accounts OAuth documentation: http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken

Parameters:
get_next(feed, auth_token=None, converter=None, desired_class=None, **kwargs)[source]

Fetches the next set of results from the feed.

When requesting a feed, the number of entries returned is capped at a service specific default limit (often 25 entries). You can specify your own entry-count cap using the max-results URL query parameter. If there are more results than could fit under max-results, the feed will contain a next link. This method performs a GET against this next results URL.

Return type:A new feed object containing the next set of entries in this feed.
get_oauth_token(scopes, next, consumer_key, consumer_secret=None, rsa_private_key=None, url='https://www.google.com/accounts/OAuthGetRequestToken')[source]

Obtains an OAuth request token to allow the user to authorize this app.

Once this client has a request token, the user can authorize the request token by visiting the authorization URL in their browser. After being redirected back to this app at the ‘next’ URL, this app can then exchange the authorized request token for an access token.

For more information see the documentation on Google Accounts with OAuth: http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess

Parameters:
  • scopes – list of strings or atom.http_core.Uri objects which specify the URL prefixes which this app will be accessing. For example, to access
  • Google Calendar API, you would want to use scopes (the) –
  • [‘https – //www.google.com/calendar/feeds/’,
  • ‘http – //www.google.com/calendar/feeds/’]
  • next – str or atom.http_core.Uri object, The URL which the user’s browser should be sent to after they authorize access to their data. This should be a URL in your application which will read the token information from the URL and upgrade the request token to an access token.
  • consumer_key – str This is the identifier for this application which you should have received when you registered your application with Google to use OAuth.
  • consumer_secret – str (optional) The shared secret between your app and Google which provides evidence that this request is coming from you application and not another app. If present, this libraries assumes you want to use an HMAC signature to verify requests. Keep this data a secret.
  • rsa_private_key – str (optional) The RSA private key which is used to generate a digital signature which is checked by Google’s server. If present, this library assumes that you want to use an RSA signature to verify requests. Keep this data a secret.
  • url – The URL to which a request for a token should be made. The default is Google’s OAuth request token provider.
modify_request(http_request)[source]

Adds or changes request before making the HTTP request.

This client will add the API version if it is specified. Subclasses may override this method to add their own request modifications before the request is made.

put(uri=None, data=None, auth_token=None, http_request=None, **kwargs)

Sends data using the PUT method, returns an HTTP response.

request(method=None, uri=None, auth_token=None, http_request=None, converter=None, desired_class=None, redirects_remaining=4, **kwargs)[source]

Make an HTTP request to the server.

See also documentation for atom.client.AtomPubClient.request.

If a 302 redirect is sent from the server to the client, this client assumes that the redirect is in the form used by the Google Calendar API. The same request URI and method will be used as in the original request, but a gsessionid URL parameter will be added to the request URI with the value provided in the server’s 302 redirect response. If the 302 redirect is not in the format specified by the Google Calendar API, a RedirectError will be raised containing the body of the server’s response.

The method calls the client’s modify_request method to make any changes required by the client before the request is made. For example, a version 2 client could add a GData-Version: 2 header to the request in its modify_request method.

Parameters:
  • method – str The HTTP verb for this request, usually ‘GET’, ‘POST’, ‘PUT’, or ‘DELETE’
  • uri – atom.http_core.Uri, str, or unicode The URL being requested.
  • auth_token – An object which sets the Authorization HTTP header in its modify_request method. Recommended classes include gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken among others.
  • http_request – (optional) atom.http_core.HttpRequest
  • converter – function which takes the body of the response as its only argument and returns the desired object.
  • desired_class – class descended from atom.core.XmlElement to which a successful response should be converted. If there is no converter function specified (converter=None) then the desired_class will be used in calling the atom.core.parse function. If neither the desired_class nor the converter is specified, an HTTP reponse object will be returned.
  • redirects_remaining – (optional) int, if this number is 0 and the server sends a 302 redirect, the request method will raise an exception. This parameter is used in recursive request calls to avoid an infinite loop.Any additional arguments are passed through toatom.client.AtomPubClient.request.
Return type:

An HTTP response object (see atom.http_core.HttpResponse for a description of the object’s interface) if no converter was specified and no desired_class was specified. If a converter function was provided, the results of calling the converter are returned. If no converter was specified but a desired_class was provided, the response body will be converted to the class using atom.core.parse.

revoke_token(token=None, url=<atom.http_core.Uri object at 0x2692110>)[source]

Requests that the token be invalidated.

This method can be used for both AuthSub and OAuth tokens (to invalidate a ClientLogin token, the user must change their password).

Return type:True if the server responded with a 200. Raises: A RequestError if the server responds with a non-200 status.
update(entry, auth_token=None, force=False, uri=None, **kwargs)[source]

Edits the entry on the server by sending the XML for this entry.

Performs a PUT and converts the response to a new entry object with a matching class to the entry passed in.

Parameters:
  • entry
  • auth_token
  • force – boolean stating whether an update should be forced. Defaults to False. Normally, if a change has been made since the passed in entry was obtained, the server will not overwrite the entry since the changes were based on an obsolete version of the entry. Setting force to True will cause the update to silently overwrite whatever version is present.
  • uri – The uri to put to. If provided, this uri is PUT to rather than the inferred uri from the entry’s edit link.
Return type:

A new Entry object of a matching type to the entry which was passed in.

upgrade_token(token=None, url=<atom.http_core.Uri object at 0x26920d0>)[source]

Asks the Google auth server for a multi-use AuthSub token.

For details on AuthSub, see: http://code.google.com/apis/accounts/docs/AuthSub.html

Parameters:
  • token – gdata.gauth.AuthSubToken or gdata.gauth.SecureAuthSubToken (optional) If no token is passed in, the client’s auth_token member is used to request the new token. The token object will be modified to contain the new session token string.
  • url – str or atom.http_core.Uri (optional) The URL to which the token
  • request should be sent. Defaults to (upgrade) –
  • https – //www.google.com/accounts/AuthSubSessionToken
Return type:

The upgraded gdata.gauth.AuthSubToken object.

class gdata.client.ResumableUploader(client, file_handle, content_type, total_file_size, chunk_size=None, desired_class=None)[source]

Resumable upload helper for the Google Data protocol.

QueryUploadStatus(uri=None)

Queries the current status of a resumable upload request.

Parameters:uri – str (optional) A resumable upload uri to query and override the one that is set in this object.
Return type:An integer representing the file position (byte) to resume the upload from or True if the upload is complete. Raises: RequestError if anything other than a HTTP 308 is returned when the request raises an exception.
UpdateFile(entry_or_resumable_edit_link, headers=None, force=False, auth_token=None, update_metadata=False, uri_params=None)

Updates the contents of an existing file using the resumable protocol.

If you are interested in pausing an upload or controlling the chunking yourself, use the upload_chunk() method instead.

Parameters:
  • entry_or_resumable_edit_link – object or string A gdata.data.GDEntry for the entry/file to update or the full uri of the link with rel #resumable-edit-media.
  • headers – dict Additional headers to send in the initial request to create the resumable upload request. These headers will override any default
  • sent in the request. For example (headers) – headers={‘Slug’: ‘MyTitle’}. force boolean (optional) True to force an update and set the If-Match header to ‘*’. If False and entry_or_resumable_edit_link is a gdata.data.GDEntry object, its etag value is used. Otherwise this parameter should be set to True to force the update.
  • auth_token – (optional) An object which sets the Authorization HTTP header in its modify_request method. Recommended classes include gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken among others.
  • update_metadata – (optional) True to also update the entry’s metadata with that in the given GDEntry object in entry_or_resumable_edit_link.
  • uri_params – (optional) Dict of additional parameters to attach to the URI. Some non-dict types are valid here, too, like list of tuple pairs.
Return type:

The final Atom entry created on the server. The entry object’s type will be the class specified in self.desired_class. Raises: RequestError if anything other than a HTTP 308 is returned when the request raises an exception.

UploadChunk(start_byte, content_bytes)

Uploads a byte range (chunk) to the resumable upload server.

Parameters:
  • start_byte – int The byte offset of the total file where the byte range passed in lives.
  • content_bytes – str The file contents of this chunk.
Return type:

The final Atom entry created on the server. The entry object’s type will be the class specified in self.desired_class. Raises: RequestError if the unique upload uri is not set or the server returns something other than an HTTP 308 when the upload is incomplete.

UploadFile(resumable_media_link, entry=None, headers=None, auth_token=None, **kwargs)

Uploads an entire file in chunks using the resumable upload protocol.

If you are interested in pausing an upload or controlling the chunking yourself, use the upload_chunk() method instead.

Parameters:
  • resumable_media_link – str The full URL for the #resumable-create-media for starting a resumable upload request.
  • entry – A (optional) gdata.data.GDEntry containging metadata to create the upload from.
  • headers – dict Additional headers to send in the initial request to create the resumable upload request. These headers will override any default
  • sent in the request. For example (headers) – headers={‘Slug’: ‘MyTitle’}.
  • auth_token – (optional) An object which sets the Authorization HTTP header in its modify_request method. Recommended classes include gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken among others.
  • kwargs – (optional) Other args to pass to self._init_session.
Return type:

The final Atom entry created on the server. The entry object’s type will be the class specified in self.desired_class. Raises: RequestError if anything other than a HTTP 308 is returned when the request raises an exception.

query_upload_status(uri=None)[source]

Queries the current status of a resumable upload request.

Parameters:uri – str (optional) A resumable upload uri to query and override the one that is set in this object.
Return type:An integer representing the file position (byte) to resume the upload from or True if the upload is complete. Raises: RequestError if anything other than a HTTP 308 is returned when the request raises an exception.
update_file(entry_or_resumable_edit_link, headers=None, force=False, auth_token=None, update_metadata=False, uri_params=None)[source]

Updates the contents of an existing file using the resumable protocol.

If you are interested in pausing an upload or controlling the chunking yourself, use the upload_chunk() method instead.

Parameters:
  • entry_or_resumable_edit_link – object or string A gdata.data.GDEntry for the entry/file to update or the full uri of the link with rel #resumable-edit-media.
  • headers – dict Additional headers to send in the initial request to create the resumable upload request. These headers will override any default
  • sent in the request. For example (headers) – headers={‘Slug’: ‘MyTitle’}. force boolean (optional) True to force an update and set the If-Match header to ‘*’. If False and entry_or_resumable_edit_link is a gdata.data.GDEntry object, its etag value is used. Otherwise this parameter should be set to True to force the update.
  • auth_token – (optional) An object which sets the Authorization HTTP header in its modify_request method. Recommended classes include gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken among others.
  • update_metadata – (optional) True to also update the entry’s metadata with that in the given GDEntry object in entry_or_resumable_edit_link.
  • uri_params – (optional) Dict of additional parameters to attach to the URI. Some non-dict types are valid here, too, like list of tuple pairs.
Return type:

The final Atom entry created on the server. The entry object’s type will be the class specified in self.desired_class. Raises: RequestError if anything other than a HTTP 308 is returned when the request raises an exception.

upload_chunk(start_byte, content_bytes)[source]

Uploads a byte range (chunk) to the resumable upload server.

Parameters:
  • start_byte – int The byte offset of the total file where the byte range passed in lives.
  • content_bytes – str The file contents of this chunk.
Return type:

The final Atom entry created on the server. The entry object’s type will be the class specified in self.desired_class. Raises: RequestError if the unique upload uri is not set or the server returns something other than an HTTP 308 when the upload is incomplete.

upload_file(resumable_media_link, entry=None, headers=None, auth_token=None, **kwargs)[source]

Uploads an entire file in chunks using the resumable upload protocol.

If you are interested in pausing an upload or controlling the chunking yourself, use the upload_chunk() method instead.

Parameters:
  • resumable_media_link – str The full URL for the #resumable-create-media for starting a resumable upload request.
  • entry – A (optional) gdata.data.GDEntry containging metadata to create the upload from.
  • headers – dict Additional headers to send in the initial request to create the resumable upload request. These headers will override any default
  • sent in the request. For example (headers) – headers={‘Slug’: ‘MyTitle’}.
  • auth_token – (optional) An object which sets the Authorization HTTP header in its modify_request method. Recommended classes include gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken among others.
  • kwargs – (optional) Other args to pass to self._init_session.
Return type:

The final Atom entry created on the server. The entry object’s type will be the class specified in self.desired_class. Raises: RequestError if anything other than a HTTP 308 is returned when the request raises an exception.

gdata.client.error_from_response(message, http_response, error_class, response_body=None)[source]

Creates a new exception and sets the HTTP information in the error.

Parameters:
  • message – str human readable message to be displayed if the exception is not caught.
  • http_response – The response from the server, contains error information.
  • error_class – The exception to be instantiated and populated with information from the http_response
  • response_body – str (optional) specify if the response has already been read from the http_response object.
gdata.client.get_xml_version(version)[source]

Determines which XML schema to use based on the client API version.

Parameters:version – string which is converted to an int. The version string is in the form ‘Major.Minor.x.y.z’ and only the major version number is considered. If None is provided assume version 1.

Provides classes and constants for the XML in the Google Data namespace.

Documentation for the raw XML which these classes represent can be found here: http://code.google.com/apis/gdata/docs/2.0/elements.html

class gdata.data.AdditionalName(text=None, *args, **kwargs)[source]

The gd:additionalName element.

Specifies additional (eg. middle) name of the person. Contains an attribute for the phonetic representaton of the name.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Agent(text=None, *args, **kwargs)[source]

The gd:agent element.

The agent who actually receives the mail. Used in work addresses. Also for ‘in care of’ or ‘c/o’.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.AttendeeStatus(text=None, *args, **kwargs)[source]

The gd:attendeeStatus element.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.AttendeeType(text=None, *args, **kwargs)[source]

The gd:attendeeType element.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.BatchEntry(atom_id=None, text=None, *args, **kwargs)[source]

An atom:entry for use in batch requests.

The BatchEntry contains additional members to specify the operation to be performed on this entry and a batch ID so that the server can reference individual operations in the response feed. For more information, see: http://code.google.com/apis/gdata/batch.html

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

Finds the first link with rel of alternate and type of text/html.

Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:A str for the URL in the link with a rel matching the POST type.

Find the first link with rel set to ‘self’

Return type:A str containing the link’s href or None if none of the links had rel equal to ‘self’
FindUrl(rel)

Returns the URL (as a string) in a link with the desired rel value.

Searches for a link or feed_link (if present) with the rel for ACL.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

batch_id

alias of BatchId

batch_operation

alias of BatchOperation

batch_status

alias of BatchStatus

content

alias of Content

control

alias of Control

Finds the first link with rel of alternate and type of text/html.

Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.

find_post_link()

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:A str for the URL in the link with a rel matching the POST type.

Find the first link with rel set to ‘self’

Return type:A str containing the link’s href or None if none of the links had rel equal to ‘self’
find_url(rel)

Returns the URL (as a string) in a link with the desired rel value.

Searches for a link or feed_link (if present) with the rel for ACL.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

id

alias of Id

published

alias of Published

rights

alias of Rights

source

alias of Source

summary

alias of Summary

title

alias of Title

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

updated

alias of Updated

class gdata.data.BatchFeed(atom_id=None, text=None, *args, **kwargs)[source]

A feed containing a list of batch request entries.

AddBatchEntry(entry=None, id_url_string=None, batch_id_string=None, operation_string=None)

Logic for populating members of a BatchEntry and adding to the feed.

If the entry is not a BatchEntry, it is converted to a BatchEntry so that the batch specific members will be present.

The id_url_string can be used in place of an entry if the batch operation applies to a URL. For example query and delete operations require just the URL of an entry, no body is sent in the HTTP request. If an id_url_string is sent instead of an entry, a BatchEntry is created and added to the feed.

This method also assigns the desired batch id to the entry so that it can be referenced in the server’s response. If the batch_id_string is None, this method will assign a batch_id to be the index at which this entry will be in the feed’s entry list.

Parameters:
  • entry – BatchEntry, atom.data.Entry, or another Entry flavor (optional) The entry which will be sent to the server as part of the batch request. The item must have a valid atom id so that the server knows which entry this request references.
  • id_url_string – str (optional) The URL of the entry to be acted on. You can find this URL in the text member of the atom id for an entry. If an entry is not sent, this id will be used to construct a new BatchEntry which will be added to the request feed.
  • batch_id_string – str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed’s entry array will be used as a count. Note that batch_ids should either always be specified or never, mixing could potentially result in duplicate batch ids.
  • operation_string – str (optional) The desired batch operation which will set the batch_operation.type member of the entry. Options are ‘insert’, ‘update’, ‘delete’, and ‘query’
  • Raises
  • MissingRequiredParameters – Raised if neither an id_ url_string nor an entry are provided in the request.
Return type:

The added entry.

AddDelete(url_string=None, entry=None, batch_id_string=None)

Adds a delete request to the batch request feed.

This method takes either the url_string which is the atom id of the item to be deleted, or the entry itself. The atom id of the entry must be present so that the server knows which entry should be deleted.

Parameters:
  • url_string – str (optional) The URL of the entry to be deleted. You can find this URL in the text member of the atom id for an entry.
  • entry – BatchEntry (optional) The entry to be deleted.
  • batch_id_string – str (optional)
  • Raises
  • MissingRequiredParameters – Raised if neither a url_string nor an entry are provided in the request.
AddInsert(entry, batch_id_string=None)

Add an insert request to the operations in this batch request feed.

If the entry doesn’t yet have an operation or a batch id, these will be set to the insert operation and a batch_id specified as a parameter.

Parameters:
  • entry – BatchEntry The entry which will be sent in the batch feed as an insert request.
  • batch_id_string – str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed’s entry array will be used as a count. Note that batch_ids should either always be specified or never, mixing could potentially result in duplicate batch ids.
AddQuery(url_string=None, entry=None, batch_id_string=None)

Adds a query request to the batch request feed.

This method takes either the url_string which is the query URL whose results will be added to the result feed. The query URL will be encapsulated in a BatchEntry, and you may pass in the BatchEntry with a query URL instead of sending a url_string.

Parameters:
  • url_string – str (optional)
  • entry – BatchEntry (optional)
  • batch_id_string – str (optional)
  • Raises – MissingRequiredParameters
AddUpdate(entry, batch_id_string=None)

Add an update request to the list of batch operations in this feed.

Sets the operation type of the entry to insert if it is not already set and assigns the desired batch id to the entry so that it can be referenced in the server’s response.

Parameters:
  • entry – BatchEntry The entry which will be sent to the server as an update (HTTP PUT) request. The item must have a valid atom id so that the server knows which entry to replace.
  • batch_id_string – str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed’s entry array will be used as a count. See also comments for AddInsert.
FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

Finds the first link with rel of alternate and type of text/html.

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:A str for the URL in the link with a rel matching the POST type.

Find the first link with rel set to ‘self’

Return type:A str containing the link’s href or None if none of the links had rel equal to ‘self’
FindUrl(rel)

Returns the URL (as a string) in a link with the desired rel value.

Searches for a link or feed_link (if present) with the rel for ACL.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

add_batch_entry(entry=None, id_url_string=None, batch_id_string=None, operation_string=None)[source]

Logic for populating members of a BatchEntry and adding to the feed.

If the entry is not a BatchEntry, it is converted to a BatchEntry so that the batch specific members will be present.

The id_url_string can be used in place of an entry if the batch operation applies to a URL. For example query and delete operations require just the URL of an entry, no body is sent in the HTTP request. If an id_url_string is sent instead of an entry, a BatchEntry is created and added to the feed.

This method also assigns the desired batch id to the entry so that it can be referenced in the server’s response. If the batch_id_string is None, this method will assign a batch_id to be the index at which this entry will be in the feed’s entry list.

Parameters:
  • entry – BatchEntry, atom.data.Entry, or another Entry flavor (optional) The entry which will be sent to the server as part of the batch request. The item must have a valid atom id so that the server knows which entry this request references.
  • id_url_string – str (optional) The URL of the entry to be acted on. You can find this URL in the text member of the atom id for an entry. If an entry is not sent, this id will be used to construct a new BatchEntry which will be added to the request feed.
  • batch_id_string – str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed’s entry array will be used as a count. Note that batch_ids should either always be specified or never, mixing could potentially result in duplicate batch ids.
  • operation_string – str (optional) The desired batch operation which will set the batch_operation.type member of the entry. Options are ‘insert’, ‘update’, ‘delete’, and ‘query’
  • Raises
  • MissingRequiredParameters – Raised if neither an id_ url_string nor an entry are provided in the request.
Return type:

The added entry.

add_delete(url_string=None, entry=None, batch_id_string=None)[source]

Adds a delete request to the batch request feed.

This method takes either the url_string which is the atom id of the item to be deleted, or the entry itself. The atom id of the entry must be present so that the server knows which entry should be deleted.

Parameters:
  • url_string – str (optional) The URL of the entry to be deleted. You can find this URL in the text member of the atom id for an entry.
  • entry – BatchEntry (optional) The entry to be deleted.
  • batch_id_string – str (optional)
  • Raises
  • MissingRequiredParameters – Raised if neither a url_string nor an entry are provided in the request.
add_insert(entry, batch_id_string=None)[source]

Add an insert request to the operations in this batch request feed.

If the entry doesn’t yet have an operation or a batch id, these will be set to the insert operation and a batch_id specified as a parameter.

Parameters:
  • entry – BatchEntry The entry which will be sent in the batch feed as an insert request.
  • batch_id_string – str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed’s entry array will be used as a count. Note that batch_ids should either always be specified or never, mixing could potentially result in duplicate batch ids.
add_query(url_string=None, entry=None, batch_id_string=None)[source]

Adds a query request to the batch request feed.

This method takes either the url_string which is the query URL whose results will be added to the result feed. The query URL will be encapsulated in a BatchEntry, and you may pass in the BatchEntry with a query URL instead of sending a url_string.

Parameters:
  • url_string – str (optional)
  • entry – BatchEntry (optional)
  • batch_id_string – str (optional)
  • Raises – MissingRequiredParameters
add_update(entry, batch_id_string=None)[source]

Add an update request to the list of batch operations in this feed.

Sets the operation type of the entry to insert if it is not already set and assigns the desired batch id to the entry so that it can be referenced in the server’s response.

Parameters:
  • entry – BatchEntry The entry which will be sent to the server as an update (HTTP PUT) request. The item must have a valid atom id so that the server knows which entry to replace.
  • batch_id_string – str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed’s entry array will be used as a count. See also comments for AddInsert.

Finds the first link with rel of alternate and type of text/html.

find_post_link()

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:A str for the URL in the link with a rel matching the POST type.

Find the first link with rel set to ‘self’

Return type:A str containing the link’s href or None if none of the links had rel equal to ‘self’
find_url(rel)

Returns the URL (as a string) in a link with the desired rel value.

generator

alias of Generator

Searches for a link or feed_link (if present) with the rel for ACL.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

icon

alias of Icon

id

alias of Id

interrupted

alias of BatchInterrupted

items_per_page

alias of ItemsPerPage

alias of Logo

rights

alias of Rights

start_index

alias of StartIndex

subtitle

alias of Subtitle

title

alias of Title

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

total_results

alias of TotalResults

updated

alias of Updated

class gdata.data.BatchId(text=None, *args, **kwargs)[source]

Identifies a single operation in a batch request.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.BatchInterrupted(text=None, *args, **kwargs)[source]

The batch:interrupted element sent if batch request was interrupted.

Only appears in a feed if some of the batch entries could not be processed. See: http://code.google.com/apis/gdata/batch.html#Handling_Errors

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.BatchOperation(text=None, *args, **kwargs)[source]

The CRUD operation which this batch entry represents.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.BatchStatus(text=None, *args, **kwargs)[source]

The batch:status element present in a batch response entry.

A status element contains the code (HTTP response code) and reason as elements. In a single request these fields would be part of the HTTP response, but in a batch request each Entry operation has a corresponding Entry in the response feed which includes status information.

See http://code.google.com/apis/gdata/batch.html#Handling_Errors

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.City(text=None, *args, **kwargs)[source]

The gd:city element.

Can be city, village, town, borough, etc. This is the postal town and not necessarily the place of residence or place of business.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Comments(text=None, *args, **kwargs)[source]

The gd:comments element.

Contains a comments feed for the enclosing entry (such as a calendar event).

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

alias of FeedLink

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Country(text=None, *args, **kwargs)[source]

The gd:country element.

The name or code of the country.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Deleted(text=None, *args, **kwargs)[source]

gd:deleted when present, indicates the containing entry is deleted.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Email(text=None, *args, **kwargs)[source]

The gd:email element.

An email address associated with the containing entity (which is usually an entity representing a person or a location).

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

The gd:entryLink element.

Represents a logically nested entry. For example, a <gd:who> representing a contact might have a nested entry from a contact feed.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

entry

alias of GDEntry

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.EventStatus(text=None, *args, **kwargs)[source]

The gd:eventStatus element.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.ExtendedProperty(text=None, *args, **kwargs)[source]

The Google Data extendedProperty element.

Used to store arbitrary key-value information specific to your application. The value can either be a text string stored as an XML attribute (.value), or an XML node (XmlBlob) as a child element.

This element is used in the Google Calendar data API and the Google Contacts data API.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetXmlBlob()

Returns the XML blob as an atom.core.XmlElement.

Return type:An XmlElement representing the blob’s XML, or None if no blob was set.
SetXmlBlob(blob)

Sets the contents of the extendedProperty to XML as a child node.

Since the extendedProperty is only allowed one child element as an XML blob, setting the XML blob will erase any preexisting member elements in this object.

Parameters:blob – str or atom.core.XmlElement representing the XML blob stored in the extendedProperty.
ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

get_xml_blob()[source]

Returns the XML blob as an atom.core.XmlElement.

Return type:An XmlElement representing the blob’s XML, or None if no blob was set.
set_xml_blob(blob)[source]

Sets the contents of the extendedProperty to XML as a child node.

Since the extendedProperty is only allowed one child element as an XML blob, setting the XML blob will erase any preexisting member elements in this object.

Parameters:blob – str or atom.core.XmlElement representing the XML blob stored in the extendedProperty.
to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.FamilyName(text=None, *args, **kwargs)[source]

The gd:familyName element.

Specifies family name of the person, eg. “Smith”.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

The gd:feedLink element.

Represents a logically nested feed. For example, a calendar feed might have a nested feed representing all comments on entries.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

feed

alias of GDFeed

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.FormattedAddress(text=None, *args, **kwargs)[source]

The gd:formattedAddress element.

The full, unstructured postal address.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.FullName(text=None, *args, **kwargs)[source]

The gd:fullName element.

Unstructured representation of the name.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.GDEntry(atom_id=None, text=None, *args, **kwargs)[source]

Extends Atom Entry to provide data processing

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

Finds the first link with rel of alternate and type of text/html.

Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:A str for the URL in the link with a rel matching the POST type.

Find the first link with rel set to ‘self’

Return type:A str containing the link’s href or None if none of the links had rel equal to ‘self’
FindUrl(rel)

Returns the URL (as a string) in a link with the desired rel value.

Searches for a link or feed_link (if present) with the rel for ACL.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

content

alias of Content

control

alias of Control

Finds the first link with rel of alternate and type of text/html.

Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.

find_post_link()

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:A str for the URL in the link with a rel matching the POST type.

Find the first link with rel set to ‘self’

Return type:A str containing the link’s href or None if none of the links had rel equal to ‘self’
find_url(rel)

Returns the URL (as a string) in a link with the desired rel value.

Searches for a link or feed_link (if present) with the rel for ACL.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

id

alias of Id

published

alias of Published

rights

alias of Rights

source

alias of Source

summary

alias of Summary

title

alias of Title

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

updated

alias of Updated

class gdata.data.GDFeed(atom_id=None, text=None, *args, **kwargs)[source]

A Feed from a GData service.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

Finds the first link with rel of alternate and type of text/html.

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:A str for the URL in the link with a rel matching the POST type.

Find the first link with rel set to ‘self’

Return type:A str containing the link’s href or None if none of the links had rel equal to ‘self’
FindUrl(rel)

Returns the URL (as a string) in a link with the desired rel value.

Searches for a link or feed_link (if present) with the rel for ACL.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

Finds the first link with rel of alternate and type of text/html.

find_post_link()

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:A str for the URL in the link with a rel matching the POST type.

Find the first link with rel set to ‘self’

Return type:A str containing the link’s href or None if none of the links had rel equal to ‘self’
find_url(rel)

Returns the URL (as a string) in a link with the desired rel value.

generator

alias of Generator

Searches for a link or feed_link (if present) with the rel for ACL.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

icon

alias of Icon

id

alias of Id

items_per_page

alias of ItemsPerPage

alias of Logo

rights

alias of Rights

start_index

alias of StartIndex

subtitle

alias of Subtitle

title

alias of Title

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

total_results

alias of TotalResults

updated

alias of Updated

class gdata.data.GivenName(text=None, *args, **kwargs)[source]

The gd:givenName element.

Specifies given name of the person, eg. “John”.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.HouseName(text=None, *args, **kwargs)[source]

The gd:housename element.

Used in places where houses or buildings have names (and not necessarily numbers), eg. “The Pillars”.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Im(text=None, *args, **kwargs)[source]

The gd:im element.

An instant messaging address associated with the containing entity.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.ItemsPerPage(text=None, *args, **kwargs)[source]

The opensearch:itemsPerPage element in GData feed.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.LinkFinder[source]

Mixin used in Feed and Entry classes to simplify link lookups by type.

Provides lookup methods for edit, edit-media, post, ACL and other special links which are common across Google Data APIs.

Finds the first link with rel of alternate and type of text/html.

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:A str for the URL in the link with a rel matching the POST type.

Find the first link with rel set to ‘self’

Return type:A str containing the link’s href or None if none of the links had rel equal to ‘self’
FindUrl(rel)

Returns the URL (as a string) in a link with the desired rel value.

Searches for a link or feed_link (if present) with the rel for ACL.

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

Finds the first link with rel of alternate and type of text/html.

find_post_link()[source]

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:A str for the URL in the link with a rel matching the POST type.

Find the first link with rel set to ‘self’

Return type:A str containing the link’s href or None if none of the links had rel equal to ‘self’
find_url(rel)

Returns the URL (as a string) in a link with the desired rel value.

Searches for a link or feed_link (if present) with the rel for ACL.

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

class gdata.data.MediaSource(file_handle=None, content_type=None, content_length=None, file_path=None, file_name=None)[source]

GData Entries can refer to media sources, so this class provides a place to store references to these objects along with some metadata.

SetFileHandle(file_name, content_type)

A helper function which can create a file handle from a given filename and set the content type and length all at once.

Parameters:
  • file_name – string The path and file name to the file containing the media
  • content_type – string A MIME type representing the type of the media
set_file_handle(file_name, content_type)[source]

A helper function which can create a file handle from a given filename and set the content type and length all at once.

Parameters:
  • file_name – string The path and file name to the file containing the media
  • content_type – string A MIME type representing the type of the media
class gdata.data.Money(text=None, *args, **kwargs)[source]

Describes money

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Name(text=None, *args, **kwargs)[source]

The gd:name element.

Allows storing person’s name in a structured way. Consists of given name, additional name, family name, prefix, suffix and full name.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

additional_name

alias of AdditionalName

family_name

alias of FamilyName

full_name

alias of FullName

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

given_name

alias of GivenName

name_prefix

alias of NamePrefix

name_suffix

alias of NameSuffix

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.NamePrefix(text=None, *args, **kwargs)[source]

The gd:namePrefix element.

Honorific prefix, eg. ‘Mr’ or ‘Mrs’.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.NameSuffix(text=None, *args, **kwargs)[source]

The gd:nameSuffix element.

Honorific suffix, eg. ‘san’ or ‘III’.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Neighborhood(text=None, *args, **kwargs)[source]

The gd:neighborhood element.

This is used to disambiguate a street address when a city contains more than one street with the same name, or to specify a small place whose mail is routed through a larger postal town. In China it could be a county or a minor city.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.OrgDepartment(text=None, *args, **kwargs)[source]

The gd:orgDepartment element.

Describes a department within an organization. Must appear within a gd:organization element.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.OrgJobDescription(text=None, *args, **kwargs)[source]

The gd:orgJobDescription element.

Describes a job within an organization. Must appear within a gd:organization element.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.OrgName(text=None, *args, **kwargs)[source]

The gd:orgName element.

The name of the organization. Must appear within a gd:organization element.

Contains a Yomigana attribute (Japanese reading aid) for the organization name.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.OrgSymbol(text=None, *args, **kwargs)[source]

The gd:orgSymbol element.

Provides a symbol of an organization. Must appear within a gd:organization element.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.OrgTitle(text=None, *args, **kwargs)[source]

The gd:orgTitle element.

The title of a person within an organization. Must appear within a gd:organization element.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Organization(text=None, *args, **kwargs)[source]

The gd:organization element.

An organization, typically associated with a contact.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

department

alias of OrgDepartment

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

job_description

alias of OrgJobDescription

name

alias of OrgName

symbol

alias of OrgSymbol

title

alias of OrgTitle

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.OriginalEvent(text=None, *args, **kwargs)[source]

The gd:originalEvent element.

Equivalent to the Recurrence ID property specified in section 4.8.4.4 of RFC 2445. Appears in every instance of a recurring event, to identify the original event.

Contains a <gd:when> element specifying the original start time of the instance that has become an exception.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

when

alias of When

class gdata.data.PhoneNumber(text=None, *args, **kwargs)[source]

The gd:phoneNumber element.

A phone number associated with the containing entity (which is usually an entity representing a person or a location).

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.PoBox(text=None, *args, **kwargs)[source]

The gd:pobox element.

Covers actual P.O. boxes, drawers, locked bags, etc. This is usually but not always mutually exclusive with street.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.PostalAddress(text=None, *args, **kwargs)[source]

The gd:postalAddress element.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Postcode(text=None, *args, **kwargs)[source]

The gd:postcode element.

Postal code. Usually country-wide, but sometimes specific to the city (e.g. “2” in “Dublin 2, Ireland” addresses).

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Rating(text=None, *args, **kwargs)[source]

The gd:rating element.

Represents a numeric rating of the enclosing entity, such as a comment. Each rating supplies its own scale, although it may be normalized by a service; for example, some services might convert all ratings to a scale from 1 to 5.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Recurrence(text=None, *args, **kwargs)[source]

The gd:recurrence element.

Represents the dates and times when a recurring event takes place.

The string that defines the recurrence consists of a set of properties, each of which is defined in the iCalendar standard (RFC 2445).

Specifically, the string usually begins with a DTSTART property that indicates the starting time of the first instance of the event, and often a DTEND property or a DURATION property to indicate when the first instance ends. Next come RRULE, RDATE, EXRULE, and/or EXDATE properties, which collectively define a recurring event and its exceptions (but see below). (See section 4.8.5 of RFC 2445 for more information about these recurrence component properties.) Last comes a VTIMEZONE component, providing detailed timezone rules for any timezone ID mentioned in the preceding properties.

Google services like Google Calendar don’t generally generate EXRULE and EXDATE properties to represent exceptions to recurring events; instead, they generate <gd:recurrenceException> elements. However, Google services may include EXRULE and/or EXDATE properties anyway; for example, users can import events and exceptions into Calendar, and if those imported events contain EXRULE or EXDATE properties, then Calendar will provide those properties when it sends a <gd:recurrence> element.

Note the the use of <gd:recurrenceException> means that you can’t be sure just from examining a <gd:recurrence> element whether there are any exceptions to the recurrence description. To ensure that you find all exceptions, look for <gd:recurrenceException> elements in the feed, and use their <gd:originalEvent> elements to match them up with <gd:recurrence> elements.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.RecurrenceException(text=None, *args, **kwargs)[source]

The gd:recurrenceException element.

Represents an event that’s an exception to a recurring event-that is, an instance of a recurring event in which one or more aspects of the recurring event (such as attendance list, time, or location) have been changed.

Contains a <gd:originalEvent> element that specifies the original recurring event that this event is an exception to.

When you change an instance of a recurring event, that instance becomes an exception. Depending on what change you made to it, the exception behaves in either of two different ways when the original recurring event is changed:

  • If you add, change, or remove comments, attendees, or attendee responses, then the exception remains tied to the original event, and changes to the original event also change the exception.
  • If you make any other changes to the exception (such as changing the time or location) then the instance becomes “specialized,” which means that it’s no longer as tightly tied to the original event. If you change the original event, specialized exceptions don’t change. But see below.

For example, say you have a meeting every Tuesday and Thursday at 2:00 p.m. If you change the attendance list for this Thursday’s meeting (but not for the regularly scheduled meeting), then it becomes an exception. If you change the time for this Thursday’s meeting (but not for the regularly scheduled meeting), then it becomes specialized.

Regardless of whether an exception is specialized or not, if you do something that deletes the instance that the exception was derived from, then the exception is deleted. Note that changing the day or time of a recurring event deletes all instances, and creates new ones.

For example, after you’ve specialized this Thursday’s meeting, say you change the recurring meeting to happen on Monday, Wednesday, and Friday. That change deletes all of the recurring instances of the Tuesday/Thursday meeting, including the specialized one.

If a particular instance of a recurring event is deleted, then that instance appears as a <gd:recurrenceException> containing a <gd:entryLink> that has its <gd:eventStatus> set to “http://schemas.google.com/g/2005#event.canceled”. (For more information about canceled events, see RFC 2445.)

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

alias of EntryLink

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

original_event

alias of OriginalEvent

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Region(text=None, *args, **kwargs)[source]

The gd:region element.

A state, province, county (in Ireland), Land (in Germany), departement (in France), etc.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Reminder(text=None, *args, **kwargs)[source]

The gd:reminder element.

A time interval, indicating how long before the containing entity’s start time or due time attribute a reminder should be issued. Alternatively, may specify an absolute time at which a reminder should be issued. Also specifies a notification method, indicating what medium the system should use to remind the user.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.StartIndex(text=None, *args, **kwargs)[source]

The opensearch:startIndex element in GData feed.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Street(text=None, *args, **kwargs)[source]

The gd:street element.

Can be street, avenue, road, etc. This element also includes the house number and room/apartment/flat/floor number.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.StructuredPostalAddress(text=None, *args, **kwargs)[source]

The gd:structuredPostalAddress element.

Postal address split into components. It allows to store the address in locale independent format. The fields can be interpreted and used to generate formatted, locale dependent address. The following elements reperesent parts of the address: agent, house name, street, P.O. box, neighborhood, city, subregion, region, postal code, country. The subregion element is not used for postal addresses, it is provided for extended uses of addresses only. In order to store postal address in an unstructured form formatted address field is provided.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

agent

alias of Agent

city

alias of City

country

alias of Country

formatted_address

alias of FormattedAddress

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

house_name

alias of HouseName

neighborhood

alias of Neighborhood

po_box

alias of PoBox

postcode

alias of Postcode

region

alias of Region

street

alias of Street

subregion

alias of Subregion

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Subregion(text=None, *args, **kwargs)[source]

The gd:subregion element.

Handles administrative districts such as U.S. or U.K. counties that are not used for mail addressing purposes. Subregion is not intended for delivery addresses.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.TotalResults(text=None, *args, **kwargs)[source]

opensearch:TotalResults for a GData feed.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Transparency(text=None, *args, **kwargs)[source]

The gd:transparency element:

Extensible enum corresponding to the TRANSP property defined in RFC 244.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Visibility(text=None, *args, **kwargs)[source]

The gd:visibility element.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.When(text=None, *args, **kwargs)[source]

The gd:when element.

Represents a period of time or an instant.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Where(text=None, *args, **kwargs)[source]

The gd:where element.

A place (such as an event location) associated with the containing entity. The type of the association is determined by the rel attribute; the details of the location are contained in an embedded or linked-to Contact entry.

A <gd:where> element is more general than a <gd:geoPt> element. The former identifies a place using a text description and/or a Contact entry, while the latter identifies a place using a specific geographic location.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

alias of EntryLink

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

class gdata.data.Who(text=None, *args, **kwargs)[source]

The gd:who element.

A person associated with the containing entity. The type of the association is determined by the rel attribute; the details about the person are contained in an embedded or linked-to Contact entry.

The <gd:who> element can be used to specify email senders and recipients, calendar event organizers, and so on.

FindChildren(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

attendee_status

alias of AttendeeStatus

attendee_type

alias of AttendeeType

alias of EntryLink

get_attributes(tag=None, namespace=None, version=1)

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:

A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:
  • tag – str
  • namespace – str
  • version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:

A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)

Converts this object to XML.

Previous topic

API

This Page