oauth2client.django_orm | index /usr/local/google/home/jcgregorio/projects/apiclient/oauth2client/django_orm.py

`OAuth 2.0 utilities for Django.
Utilities for using OAuth 2.0 in conjunction with
the Django datastore.`

Modules
`` |  |
base64 | django.db.models | oauth2client | pickle

Classes
`` |  | django.db.models.fields.Field(__builtin__.object) CredentialsField FlowField oauth2client.client.Storage(__builtin__.object) Storage
class CredentialsField(django.db.models.fields.Field)
`` |  | Method resolution order: CredentialsField django.db.models.fields.Field __builtin__.object Methods defined here: contribute_to_class(self, cls, name) db_type(self, connection=None) get_db_prep_value(self, value) to_python(self, value) Data and other attributes defined here: __metaclass__ = <class 'django.db.models.fields.subclassing.SubfieldBase'> `A metaclass for custom Field subclasses. This ensures the model's attribute has the descriptor protocol attached to it.` Methods inherited from django.db.models.fields.Field: __cmp__(self, other) __deepcopy__(self, memodict) __init__(self, verbose_name=None, name=None, primary_key=False, max_length=None, unique=False, blank=False, null=False, db_index=False, rel=None, default=<class django.db.models.fields.NOT_PROVIDED>, editable=True, serialize=True, unique_for_date=None, unique_for_month=None, unique_for_year=None, choices=None, help_text='', db_column=None, db_tablespace=None, auto_created=False) bind(self, fieldmapping, original, bound_field_class) formfield(self, form_class=<class 'django.forms.fields.CharField'>, **kwargs) `Returns a django.forms.Field instance for this database Field.` get_attname(self) get_attname_column(self) get_cache_name(self) get_choices(self, include_blank=True, blank_choice=[('', '---------')]) `Returns choices with a default blank choices included, for use as SelectField choices for this field.` get_choices_default(self) get_db_prep_lookup(self, lookup_type, value) `Returns field's value prepared for database lookup.` get_db_prep_save(self, value) `Returns field's value prepared for saving into a database.` get_default(self) `Returns the default value for this field.` get_flatchoices(self, include_blank=True, blank_choice=[('', '---------')]) `Returns flattened choices with a default blank choice included.` get_internal_type(self) get_validator_unique_lookup_type(self) has_default(self) `Returns a boolean of whether this field has a default value.` pre_save(self, model_instance, add) `Returns field's value just before saving.` save_form_data(self, instance, data) set_attributes_from_name(self, name) value_from_object(self, obj) `Returns the value of this field in the given model instance.` value_to_string(self, obj) `Returns a string value of this field from the passed obj. This is used by the serialization framework.` Data descriptors inherited from django.db.models.fields.Field: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` choices flatchoices `Flattened version of choices tuple.` unique Data and other attributes inherited from django.db.models.fields.Field: auto_creation_counter = -1 creation_counter = 0 empty_strings_allowed = True
class FlowField(django.db.models.fields.Field)
`` |  | Method resolution order: FlowField django.db.models.fields.Field __builtin__.object Methods defined here: contribute_to_class(self, cls, name) db_type(self, connection=None) get_db_prep_value(self, value) to_python(self, value) Data and other attributes defined here: __metaclass__ = <class 'django.db.models.fields.subclassing.SubfieldBase'> `A metaclass for custom Field subclasses. This ensures the model's attribute has the descriptor protocol attached to it.` Methods inherited from django.db.models.fields.Field: __cmp__(self, other) __deepcopy__(self, memodict) __init__(self, verbose_name=None, name=None, primary_key=False, max_length=None, unique=False, blank=False, null=False, db_index=False, rel=None, default=<class django.db.models.fields.NOT_PROVIDED>, editable=True, serialize=True, unique_for_date=None, unique_for_month=None, unique_for_year=None, choices=None, help_text='', db_column=None, db_tablespace=None, auto_created=False) bind(self, fieldmapping, original, bound_field_class) formfield(self, form_class=<class 'django.forms.fields.CharField'>, **kwargs) `Returns a django.forms.Field instance for this database Field.` get_attname(self) get_attname_column(self) get_cache_name(self) get_choices(self, include_blank=True, blank_choice=[('', '---------')]) `Returns choices with a default blank choices included, for use as SelectField choices for this field.` get_choices_default(self) get_db_prep_lookup(self, lookup_type, value) `Returns field's value prepared for database lookup.` get_db_prep_save(self, value) `Returns field's value prepared for saving into a database.` get_default(self) `Returns the default value for this field.` get_flatchoices(self, include_blank=True, blank_choice=[('', '---------')]) `Returns flattened choices with a default blank choice included.` get_internal_type(self) get_validator_unique_lookup_type(self) has_default(self) `Returns a boolean of whether this field has a default value.` pre_save(self, model_instance, add) `Returns field's value just before saving.` save_form_data(self, instance, data) set_attributes_from_name(self, name) value_from_object(self, obj) `Returns the value of this field in the given model instance.` value_to_string(self, obj) `Returns a string value of this field from the passed obj. This is used by the serialization framework.` Data descriptors inherited from django.db.models.fields.Field: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` choices flatchoices `Flattened version of choices tuple.` unique Data and other attributes inherited from django.db.models.fields.Field: auto_creation_counter = -1 creation_counter = 0 empty_strings_allowed = True
class Storage(oauth2client.client.Storage)
`` | `Store and retrieve a single credential to and from the datastore. This Storage helper presumes the Credentials have been stored as a CredenialsField on a db model class.`
| Method resolution order: Storage oauth2client.client.Storage __builtin__.object Methods defined here: __init__(self, model_class, key_name, key_value, property_name) `Constructor for Storage. Args: model: db.Model, model class key_name: string, key name for the entity that has the credentials key_value: string, key value for the entity that has the credentials property_name: string, name of the property that is an CredentialsProperty` get(self) `Retrieve Credential from datastore. Returns: oauth2client.Credentials` put(self, credentials) `Write a Credentials to the datastore. Args: credentials: Credentials, the credentials to store.` Methods inherited from oauth2client.client.Storage: acquire_lock(self) `Acquires any lock necessary to access this Storage. This lock is not reentrant.` locked_get(self) `Retrieve credential. The Storage lock must be held when this is called. Returns: oauth2client.client.Credentials` locked_put(self, credentials) `Write a credential. The Storage lock must be held when this is called. Args: credentials: Credentials, the credentials to store.` release_lock(self) `Release the Storage lock. Trying to release a lock that isn't held will result in a RuntimeError.` Data descriptors inherited from oauth2client.client.Storage: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)`

Data
`` |  | __author__ = 'jcgregorio@google.com (Joe Gregorio)'

Author
`` |  | jcgregorio@google.com (Joe Gregorio)