mirror of
https://github.com/psycopg/psycopg2.git
synced 2024-11-23 09:23:43 +03:00
b96dcef8a2
We mangle the encoding names a little bit before asking it to the backend: be sure to be able to find the equivalent Python code back or decoding (unicode cast or Py3) will barf.
140 lines
5.0 KiB
Python
140 lines
5.0 KiB
Python
"""psycopg extensions to the DBAPI-2.0
|
|
|
|
This module holds all the extensions to the DBAPI-2.0 provided by psycopg.
|
|
|
|
- `connection` -- the new-type inheritable connection class
|
|
- `cursor` -- the new-type inheritable cursor class
|
|
- `lobject` -- the new-type inheritable large object class
|
|
- `adapt()` -- exposes the PEP-246_ compatible adapting mechanism used
|
|
by psycopg to adapt Python types to PostgreSQL ones
|
|
|
|
.. _PEP-246: http://www.python.org/peps/pep-0246.html
|
|
"""
|
|
# psycopg/extensions.py - DBAPI-2.0 extensions specific to psycopg
|
|
#
|
|
# Copyright (C) 2003-2010 Federico Di Gregorio <fog@debian.org>
|
|
#
|
|
# psycopg2 is free software: you can redistribute it and/or modify it
|
|
# under the terms of the GNU Lesser General Public License as published
|
|
# by the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# In addition, as a special exception, the copyright holders give
|
|
# permission to link this program with the OpenSSL library (or with
|
|
# modified versions of OpenSSL that use the same license as OpenSSL),
|
|
# and distribute linked combinations including the two.
|
|
#
|
|
# You must obey the GNU Lesser General Public License in all respects for
|
|
# all of the code used other than OpenSSL.
|
|
#
|
|
# psycopg2 is distributed in the hope that it will be useful, but WITHOUT
|
|
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
|
|
# License for more details.
|
|
|
|
from _psycopg import UNICODE, INTEGER, LONGINTEGER, BOOLEAN, FLOAT
|
|
from _psycopg import TIME, DATE, INTERVAL, DECIMAL
|
|
from _psycopg import BINARYARRAY, BOOLEANARRAY, DATEARRAY, DATETIMEARRAY
|
|
from _psycopg import DECIMALARRAY, FLOATARRAY, INTEGERARRAY, INTERVALARRAY
|
|
from _psycopg import LONGINTEGERARRAY, ROWIDARRAY, STRINGARRAY, TIMEARRAY
|
|
from _psycopg import UNICODEARRAY
|
|
|
|
from _psycopg import Binary, Boolean, Float, QuotedString, AsIs
|
|
try:
|
|
from _psycopg import MXDATE, MXDATETIME, MXINTERVAL, MXTIME
|
|
from _psycopg import MXDATEARRAY, MXDATETIMEARRAY, MXINTERVALARRAY, MXTIMEARRAY
|
|
from _psycopg import DateFromMx, TimeFromMx, TimestampFromMx
|
|
from _psycopg import IntervalFromMx
|
|
except:
|
|
pass
|
|
|
|
try:
|
|
from _psycopg import PYDATE, PYDATETIME, PYINTERVAL, PYTIME
|
|
from _psycopg import PYDATEARRAY, PYDATETIMEARRAY, PYINTERVALARRAY, PYTIMEARRAY
|
|
from _psycopg import DateFromPy, TimeFromPy, TimestampFromPy
|
|
from _psycopg import IntervalFromPy
|
|
except:
|
|
pass
|
|
|
|
from _psycopg import adapt, adapters, encodings, connection, cursor, lobject, Xid
|
|
from _psycopg import string_types, binary_types, new_type, register_type
|
|
from _psycopg import ISQLQuote, Notify
|
|
|
|
from _psycopg import QueryCanceledError, TransactionRollbackError
|
|
|
|
try:
|
|
from _psycopg import set_wait_callback, get_wait_callback
|
|
except ImportError:
|
|
pass
|
|
|
|
"""Isolation level values."""
|
|
ISOLATION_LEVEL_AUTOCOMMIT = 0
|
|
ISOLATION_LEVEL_READ_COMMITTED = 1
|
|
ISOLATION_LEVEL_SERIALIZABLE = 2
|
|
|
|
# PostgreSQL maps the the other standard values to already defined levels
|
|
ISOLATION_LEVEL_REPEATABLE_READ = ISOLATION_LEVEL_SERIALIZABLE
|
|
ISOLATION_LEVEL_READ_UNCOMMITTED = ISOLATION_LEVEL_READ_COMMITTED
|
|
|
|
"""psycopg connection status values."""
|
|
STATUS_SETUP = 0
|
|
STATUS_READY = 1
|
|
STATUS_BEGIN = 2
|
|
STATUS_SYNC = 3 # currently unused
|
|
STATUS_ASYNC = 4 # currently unused
|
|
STATUS_PREPARED = 5
|
|
|
|
# This is a usefull mnemonic to check if the connection is in a transaction
|
|
STATUS_IN_TRANSACTION = STATUS_BEGIN
|
|
|
|
"""psycopg asynchronous connection polling values"""
|
|
POLL_OK = 0
|
|
POLL_READ = 1
|
|
POLL_WRITE = 2
|
|
POLL_ERROR = 3
|
|
|
|
"""Backend transaction status values."""
|
|
TRANSACTION_STATUS_IDLE = 0
|
|
TRANSACTION_STATUS_ACTIVE = 1
|
|
TRANSACTION_STATUS_INTRANS = 2
|
|
TRANSACTION_STATUS_INERROR = 3
|
|
TRANSACTION_STATUS_UNKNOWN = 4
|
|
|
|
def register_adapter(typ, callable):
|
|
"""Register 'callable' as an ISQLQuote adapter for type 'typ'."""
|
|
adapters[(typ, ISQLQuote)] = callable
|
|
|
|
|
|
# The SQL_IN class is the official adapter for tuples starting from 2.0.6.
|
|
class SQL_IN(object):
|
|
"""Adapt any iterable to an SQL quotable object."""
|
|
|
|
def __init__(self, seq):
|
|
self._seq = seq
|
|
|
|
def prepare(self, conn):
|
|
self._conn = conn
|
|
|
|
def getquoted(self):
|
|
# this is the important line: note how every object in the
|
|
# list is adapted and then how getquoted() is called on it
|
|
pobjs = [adapt(o) for o in self._seq]
|
|
for obj in pobjs:
|
|
if hasattr(obj, 'prepare'):
|
|
obj.prepare(self._conn)
|
|
qobjs = [str(o.getquoted()) for o in pobjs]
|
|
return '(' + ', '.join(qobjs) + ')'
|
|
|
|
__str__ = getquoted
|
|
|
|
|
|
# Add the "cleaned" version of the encodings to the key.
|
|
# When the encoding is set its name is cleaned up from - and _ and turned
|
|
# uppercase, so an encoding not respecting these rules wouldn't be found in the
|
|
# encodings keys and would raise an exception with the unicode typecaster
|
|
for k, v in encodings.items():
|
|
k = k.replace('_', '').replace('-', '').upper()
|
|
encodings[k] = v
|
|
|
|
__all__ = filter(lambda k: not k.startswith('_'), locals().keys())
|