σ ‚Ύ^Yc@@skdZddlmZddlZddlmZdejjfd„ƒYZ dej fd„ƒYZ dS( s₯OAuth 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() i(tabsolute_importN(tclienttCredentialsTypecB@seZdZRS(sXType representing credentials. Alias for :class:`sqlalchemy.types.PickleType`. (t__name__t __module__t__doc__(((sE/tmp/pip-build-kpPAdC/oauth2client/oauth2client/contrib/sqlalchemy.pyRdstStoragecB@s2eZdZd„Zd„Zd„Zd„ZRS(s²Store 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. cC@sDtt|ƒjƒ||_||_||_||_||_dS(s?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(tsuperRt__init__tsessiont model_classtkey_namet key_valuet property_name(tselfR R R R R ((sE/tmp/pip-build-kpPAdC/oauth2client/oauth2client/contrib/sqlalchemy.pyRrs     cC@s†i|j|j6}|jj|jƒj|}|jƒ}|r~t||jƒ}|rzt |dƒrz|j |ƒn|SdSdS(szRetrieve stored credential. Returns: A :class:`oauth2client.Credentials` instance or `None`. t set_storeN( R R R tqueryR t filter_bytfirsttgetattrR thasattrRtNone(RtfiltersRtentityt credential((sE/tmp/pip-build-kpPAdC/oauth2client/oauth2client/contrib/sqlalchemy.pyt locked_getˆs cC@s|i|j|j6}|jj|jƒj|}|jƒ}|sU|j|}nt||j|ƒ|jj |ƒdS(sƒWrite a credentials to the SQLAlchemy datastore. Args: credentials: :class:`oauth2client.Credentials` N( R R R RR RRtsetattrR tadd(Rt credentialsRRR((sE/tmp/pip-build-kpPAdC/oauth2client/oauth2client/contrib/sqlalchemy.pyt locked_putšs cC@s9i|j|j6}|jj|jƒj|jƒdS(s1Delete credentials from the SQLAlchemy datastore.N(R R R RR Rtdelete(RR((sE/tmp/pip-build-kpPAdC/oauth2client/oauth2client/contrib/sqlalchemy.pyt locked_deleteͺs(RRRRRRR(((sE/tmp/pip-build-kpPAdC/oauth2client/oauth2client/contrib/sqlalchemy.pyRks    ( Rt __future__Rtsqlalchemy.typest sqlalchemyt oauth2clientRttypest PickleTypeRR(((sE/tmp/pip-build-kpPAdC/oauth2client/oauth2client/contrib/sqlalchemy.pyt[s