HEX

File: //proc/self/root/opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/ext/indexable.pyc
�
��4]c@@sidZddlmZddlmZddlmZddlmZdgZ	defd��YZ
d	S(
s6Define attributes on ORM-mapped classes that have "index" attributes for
columns with :class:`~.types.Indexable` types.

"index" means the attribute is associated with an element of an
:class:`~.types.Indexable` column with the predefined index to access it.
The :class:`~.types.Indexable` types include types such as
:class:`~.types.ARRAY`, :class:`~.types.JSON` and
:class:`~.postgresql.HSTORE`.



The :mod:`~sqlalchemy.ext.indexable` extension provides
:class:`~.schema.Column`-like interface for any element of an
:class:`~.types.Indexable` typed column. In simple cases, it can be
treated as a :class:`~.schema.Column` - mapped attribute.


.. versionadded:: 1.1

Synopsis
========

Given ``Person`` as a model with a primary key and JSON data field.
While this field may have any number of elements encoded within it,
we would like to refer to the element called ``name`` individually
as a dedicated attribute which behaves like a standalone column::

    from sqlalchemy import Column, JSON, Integer
    from sqlalchemy.ext.declarative import declarative_base
    from sqlalchemy.ext.indexable import index_property

    Base = declarative_base()

    class Person(Base):
        __tablename__ = 'person'

        id = Column(Integer, primary_key=True)
        data = Column(JSON)

        name = index_property('data', 'name')


Above, the ``name`` attribute now behaves like a mapped column.   We
can compose a new ``Person`` and set the value of ``name``::

    >>> person = Person(name='Alchemist')

The value is now accessible::

    >>> person.name
    'Alchemist'

Behind the scenes, the JSON field was initialized to a new blank dictionary
and the field was set::

    >>> person.data
    {"name": "Alchemist'}

The field is mutable in place::

    >>> person.name = 'Renamed'
    >>> person.name
    'Renamed'
    >>> person.data
    {'name': 'Renamed'}

When using :class:`.index_property`, the change that we make to the indexable
structure is also automatically tracked as history; we no longer need
to use :class:`~.mutable.MutableDict` in order to track this change
for the unit of work.

Deletions work normally as well::

    >>> del person.name
    >>> person.data
    {}

Above, deletion of ``person.name`` deletes the value from the dictionary,
but not the dictionary itself.

A missing key will produce ``AttributeError``::

    >>> person = Person()
    >>> person.name
    ...
    AttributeError: 'name'

Unless you set a default value::

    >>> class Person(Base):
    >>>     __tablename__ = 'person'
    >>>
    >>>     id = Column(Integer, primary_key=True)
    >>>     data = Column(JSON)
    >>>
    >>>     name = index_property('data', 'name', default=None)  # See default

    >>> person = Person()
    >>> print(person.name)
    None


The attributes are also accessible at the class level.
Below, we illustrate ``Person.name`` used to generate
an indexed SQL criteria::

    >>> from sqlalchemy.orm import Session
    >>> session = Session()
    >>> query = session.query(Person).filter(Person.name == 'Alchemist')

The above query is equivalent to::

    >>> query = session.query(Person).filter(Person.data['name'] == 'Alchemist')

Multiple :class:`.index_property` objects can be chained to produce
multiple levels of indexing::

    from sqlalchemy import Column, JSON, Integer
    from sqlalchemy.ext.declarative import declarative_base
    from sqlalchemy.ext.indexable import index_property

    Base = declarative_base()

    class Person(Base):
        __tablename__ = 'person'

        id = Column(Integer, primary_key=True)
        data = Column(JSON)

        birthday = index_property('data', 'birthday')
        year = index_property('birthday', 'year')
        month = index_property('birthday', 'month')
        day = index_property('birthday', 'day')

Above, a query such as::

    q = session.query(Person).filter(Person.year == '1980')

On a PostgreSQL backend, the above query will render as::

    SELECT person.id, person.data
    FROM person
    WHERE person.data -> %(data_1)s -> %(param_1)s = %(param_2)s

Default Values
==============

:class:`.index_property` includes special behaviors for when the indexed
data structure does not exist, and a set operation is called:

* For an :class:`.index_property` that is given an integer index value,
  the default data structure will be a Python list of ``None`` values,
  at least as long as the index value; the value is then set at its
  place in the list.  This means for an index value of zero, the list
  will be initialized to ``[None]`` before setting the given value,
  and for an index value of five, the list will be initialized to
  ``[None, None, None, None, None]`` before setting the fifth element
  to the given value.   Note that an existing list is **not** extended
  in place to receive a value.

* for an :class:`.index_property` that is given any other kind of index
  value (e.g. strings usually), a Python dictionary is used as the
  default data structure.

* The default data structure can be set to any Python callable using the
  :paramref:`.index_property.datatype` parameter, overriding the previous
  rules.


Subclassing
===========

:class:`.index_property` can be subclassed, in particular for the common
use case of providing coercion of values or SQL expressions as they are
accessed.  Below is a common recipe for use with a PostgreSQL JSON type,
where we want to also include automatic casting plus ``astext()``::

    class pg_json_property(index_property):
        def __init__(self, attr_name, index, cast_type):
            super(pg_json_property, self).__init__(attr_name, index)
            self.cast_type = cast_type

        def expr(self, model):
            expr = super(pg_json_property, self).expr(model)
            return expr.astext.cast(self.cast_type)

The above subclass can be used with the PostgreSQL-specific
version of :class:`.postgresql.JSON`::

    from sqlalchemy import Column, Integer
    from sqlalchemy.ext.declarative import declarative_base
    from sqlalchemy.dialects.postgresql import JSON

    Base = declarative_base()

    class Person(Base):
        __tablename__ = 'person'

        id = Column(Integer, primary_key=True)
        data = Column(JSON)

        age = pg_json_property('data', 'age', Integer)

The ``age`` attribute at the instance level works as before; however
when rendering SQL, PostgreSQL's ``->>`` operator will be used
for indexed access, instead of the usual index operator of ``->``::

    >>> query = session.query(Person).filter(Person.age < 20)

The above query will render::

    SELECT person.id, person.data
    FROM person
    WHERE CAST(person.data ->> %(data_1)s AS INTEGER) < %(param_1)s

i(tabsolute_import(tinspecti(thybrid_property(t
flag_modifiedtindex_propertycB@sYeZdZe�Zedeed�Zd�Zd�Z	d�Z
d�Zd�ZRS(s�A property generator. The generated property describes an object
    attribute that corresponds to an :class:`~.types.Indexable`
    column.

    .. versionadded:: 1.1

    .. seealso::

        :mod:`sqlalchemy.ext.indexable`

    c@s�|r4tt|�j|j|j|j|j�n%tt|�j|jdd|j�||_�|_	||_
t�t�}|o�|}|dk	r�||_
n$|r��fd�|_
n	t|_
||_dS(s}Create a new :class:`.index_property`.

        :param attr_name:
            An attribute name of an `Indexable` typed column, or other
            attribute that returns an indexable structure.
        :param index:
            The index to be used for getting and setting this value.  This
            should be the Python-side index value for integers.
        :param default:
            A value which will be returned instead of `AttributeError`
            when there is not a value at given index.
        :param datatype: default datatype to use when the field is empty.
            By default, this is derived from the type of index used; a
            Python list for an integer index, or a Python dictionary for
            any other style of index.   For a list, the list will be
            initialized to a list of None values that is at least
            ``index`` elements long.
        :param mutable: if False, writes and deletes to the attribute will
            be disallowed.
        :param onebased: assume the SQL representation of this value is
            one-based; that is, the first index in SQL is 1, not zero.
        c@s!gt�d�D]}d^qS(Ni(trangetNone(tx(tindex(sK/opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/ext/indexable.pyt<lambda>+tN(tsuperRt__init__tfgettfsettfdeltexprRt	attr_nameRtdefaultt
isinstancetinttdatatypetdicttonebased(tselfRRRRtmutableRt
is_numeric((RsK/opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/ext/indexable.pyR�s  				cC@s/|j|jkr$t|j��n|jSdS(N(Rt_NO_DEFAULT_ARGUMENTtAttributeErrorR(R((sK/opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/ext/indexable.pyt
_fget_default0scC@sh|j}t||�}|dkr.|j�Sy||j}Wnttfk
r_|j�SX|SdS(N(RtgetattrRRRtKeyErrort
IndexError(RtinstanceRtcolumn_valuetvalue((sK/opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/ext/indexable.pyR
6s	
cC@s�|j}t||d�}|dkrF|j�}t|||�n|||j<t|||�|t|�jjkr�t	||�ndS(N(
RRRRtsetattrRRtmappertattrsR(RR!R#RR"((sK/opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/ext/indexable.pyRBs	
cC@s�|j}t||�}|dkr6t|j��ny||j=Wn tk
rft|j��nXt|||�t||�dS(N(RRRRRRR$R(RR!RR"((sK/opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/ext/indexable.pyRMs	
cC@s9t||j�}|j}|jr1|d7}n||S(Ni(RRRR(RtmodeltcolumnR((sK/opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/ext/indexable.pyRZs
		
N(
t__name__t
__module__t__doc__tobjectRRtTrueRRR
RRR(((sK/opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/ext/indexable.pyR�s	0				
N(R+t
__future__Rt
sqlalchemyRt
ext.hybridRtorm.attributesRt__all__R(((sK/opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/ext/indexable.pyt<module>�s