~dZddlmZddlZddlmZGddejjZ GddejZ y) aOAuth 2.0 utilities for SQLAlchemy. Utilities for using OAuth 2.0 in conjunction with a SQLAlchemy. Configuration ============= In order to use this storage, you'll need to create table with :class:`oauth2client.contrib.sqlalchemy.CredentialsType` column. It's recommended to either put this column on some sort of user info table or put the column in a table with a belongs-to relationship to a user info table. Here's an example of a simple table with a :class:`CredentialsType` column that's related to a user table by the `user_id` key. .. code-block:: python from sqlalchemy import Column, ForeignKey, Integer from sqlalchemy.ext.declarative import declarative_base from sqlalchemy.orm import relationship from oauth2client.contrib.sqlalchemy import CredentialsType Base = declarative_base() class Credentials(Base): __tablename__ = 'credentials' user_id = Column(Integer, ForeignKey('user.id')) credentials = Column(CredentialsType) class User(Base): id = Column(Integer, primary_key=True) # bunch of other columns credentials = relationship('Credentials') Usage ===== With tables ready, you are now able to store credentials in database. We will reuse tables defined above. .. code-block:: python from sqlalchemy.orm import Session from oauth2client.client import OAuth2Credentials from oauth2client.contrib.sql_alchemy import Storage session = Session() user = session.query(User).first() storage = Storage( session=session, model_class=Credentials, # This is the key column used to identify # the row that stores the credentials. key_name='user_id', key_value=user.id, property_name='credentials', ) # Store credentials = OAuth2Credentials(...) storage.put(credentials) # Retrieve credentials = storage.get() # Delete storage.delete() )absolute_importN)clientceZdZdZy)CredentialsTypezXType representing credentials. Alias for :class:`sqlalchemy.types.PickleType`. N)__name__ __module__ __qualname____doc__2lib/third_party/oauth2client/contrib/sqlalchemy.pyrrdsr rc4eZdZdZfdZdZdZdZxZS)StoragezStore and retrieve a single credential to and from SQLAlchemy. This helper presumes the Credentials have been stored as a Credentials column on a db model class. cptt| ||_||_||_||_||_y)a?Constructor for Storage. Args: session: An instance of :class:`sqlalchemy.orm.Session`. model_class: SQLAlchemy declarative mapping. key_name: string, key name for the entity that has the credentials key_value: key value for the entity that has the credentials property_name: A string indicating which property on the ``model_class`` to store the credentials. This property must be a :class:`CredentialsType` column. N)superr__init__session model_classkey_name key_value property_name)selfrrrrr __class__s r rzStorage.__init__rs7 gt%' &  "*r c0|j|ji}|jj|jj di|}|j }|r7t||j}|rt|dr|j||Sy)zzRetrieve stored credential. Returns: A :class:`oauth2client.Credentials` instance or `None`. set_storeNr ) rrrqueryr filter_byfirstgetattrrhasattrr)rfiltersrentity credentials r locked_getzStorage.locked_gets ==$..1> ""4#3#34>>II  ););$$T* r cJ|j|ji}|jj|jj di|}|j }|s|jdi|}t||j||jj|y)zWrite a credentials to the SQLAlchemy datastore. Args: credentials: :class:`oauth2client.Credentials` Nr ) rrrrrrrsetattrradd)r credentialsr!rr"s r locked_putzStorage.locked_puts ==$..1> ""4#3#34>>II%T%%00F**K8  r c|j|ji}|jj|jj di|j y)z1Delete credentials from the SQLAlchemy datastore.Nr )rrrrrrdelete)rr!s r locked_deletezStorage.locked_deletesE==$..16 4++,66AAHHJr ) rrr r rr$r)r, __classcell__)rs@r rrks +,$! Kr r) r __future__rsqlalchemy.types sqlalchemy oauth2clientrtypes PickleTyperrr r r r4sCL\'j&&11BKfnnBKr