Showing preview only (288K chars total). Download the full file or copy to clipboard to get everything.
Repository: mfenniak/pg8000
Branch: master
Commit: 412eace07451
Files: 27
Total size: 276.6 KB
Directory structure:
gitextract_bn8c_oc_/
├── .gitattributes
├── .gitignore
├── .travis.yml
├── LICENSE
├── MANIFEST.in
├── README.adoc
├── multi
├── pg8000/
│ ├── __init__.py
│ ├── _version.py
│ └── core.py
├── setup.cfg
├── setup.py
├── tests/
│ ├── connection_settings.py
│ ├── dbapi20.py
│ ├── performance.py
│ ├── stress.py
│ ├── test_connection.py
│ ├── test_copy.py
│ ├── test_dbapi.py
│ ├── test_error_recovery.py
│ ├── test_paramstyle.py
│ ├── test_pg8000_dbapi20.py
│ ├── test_query.py
│ ├── test_typeconversion.py
│ └── test_typeobjects.py
├── tox.ini
└── versioneer.py
================================================
FILE CONTENTS
================================================
================================================
FILE: .gitattributes
================================================
pg8000/_version.py export-subst
================================================
FILE: .gitignore
================================================
*.py[co]
*.swp
*.orig
*.class
build
pg8000.egg-info
tmp
dist
.tox
MANIFEST
venv
.cache
================================================
FILE: .travis.yml
================================================
sudo: required
language: python
python:
- "2.7"
- "3.5"
- "3.6"
- "pypy3.5"
env:
- DB="9.5"
- DB="9.6"
services:
- postgresql
addons:
postgresql: "9.5"
postgresql: "9.6"
before_install:
- sudo service postgresql stop
- cd /etc/postgresql/$DB/main
- sudo chmod ugo+rw pg_hba.conf
- sudo cp pg_hba.conf old_pg_hba.conf
- sudo echo "host pg8000_md5 all 127.0.0.1/32 md5" > pg_hba.conf
- sudo echo "host pg8000_gss all 127.0.0.1/32 gss" >> pg_hba.conf
- sudo echo "host pg8000_password all 127.0.0.1/32 password" >> pg_hba.conf
- cat old_pg_hba.conf >> pg_hba.conf
- sudo service postgresql start $DB
- psql -U postgres -tc 'create extension hstore;'
- psql -U postgres -tc 'show server_version;'
- psql -U postgres -tc "alter user postgres with password 'pw';"
- psql -U postgres -tc "alter system set client_min_messages = notice;"
- sudo service postgresql reload $DB
- psql -U postgres -tc 'show client_min_messages;'
- cd $TRAVIS_BUILD_DIR
install:
- pip install nose
- pip install pytz
script:
- nosetests
================================================
FILE: LICENSE
================================================
Copyright (c) 2007-2009, Mathieu Fenniak
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* The name of the author may not be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
================================================
FILE: MANIFEST.in
================================================
include README.creole
include versioneer.py
include pg8000/_version.py
include LICENSE
include doc/*
================================================
FILE: README.adoc
================================================
= pg8000
Hello, the pg8000 repository has moved to https://github.com/tlocke/pg8000.
================================================
FILE: multi
================================================
#!/bin/bash
# set postgres share memory to minimum to trigger unpinned buffer errors.
for i in {1..100}
do
python -m pg8000.tests.stress &
done
wait
echo "All processes done!"
================================================
FILE: pg8000/__init__.py
================================================
from pg8000.core import (
Warning, Bytea, DataError, DatabaseError, InterfaceError, ProgrammingError,
Error, OperationalError, IntegrityError, InternalError, NotSupportedError,
ArrayContentNotHomogenousError, ArrayDimensionsNotConsistentError,
ArrayContentNotSupportedError, utc, Connection, Cursor, Binary, Date,
DateFromTicks, Time, TimeFromTicks, Timestamp, TimestampFromTicks, BINARY,
Interval, PGEnum, PGJson, PGJsonb, PGTsvector, PGText, PGVarchar)
from ._version import get_versions
__version__ = get_versions()['version']
del get_versions
# Copyright (c) 2007-2009, Mathieu Fenniak
# Copyright (c) The Contributors
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
# * The name of the author may not be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
__author__ = "Mathieu Fenniak"
def connect(
user, host='localhost', unix_sock=None, port=5432, database=None,
password=None, ssl=False, timeout=None, application_name=None,
max_prepared_statements=1000):
"""Creates a connection to a PostgreSQL database.
This function is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_; however, the arguments of the
function are not defined by the specification.
:param user:
The username to connect to the PostgreSQL server with.
If your server character encoding is not ``ascii`` or ``utf8``, then
you need to provide ``user`` as bytes, eg.
``"my_name".encode('EUC-JP')``.
:keyword host:
The hostname of the PostgreSQL server to connect with. Providing this
parameter is necessary for TCP/IP connections. One of either ``host``
or ``unix_sock`` must be provided. The default is ``localhost``.
:keyword unix_sock:
The path to the UNIX socket to access the database through, for
example, ``'/tmp/.s.PGSQL.5432'``. One of either ``host`` or
``unix_sock`` must be provided.
:keyword port:
The TCP/IP port of the PostgreSQL server instance. This parameter
defaults to ``5432``, the registered common port of PostgreSQL TCP/IP
servers.
:keyword database:
The name of the database instance to connect with. This parameter is
optional; if omitted, the PostgreSQL server will assume the database
name is the same as the username.
If your server character encoding is not ``ascii`` or ``utf8``, then
you need to provide ``database`` as bytes, eg.
``"my_db".encode('EUC-JP')``.
:keyword password:
The user password to connect to the server with. This parameter is
optional; if omitted and the database server requests password-based
authentication, the connection will fail to open. If this parameter
is provided but not requested by the server, no error will occur.
If your server character encoding is not ``ascii`` or ``utf8``, then
you need to provide ``user`` as bytes, eg.
``"my_password".encode('EUC-JP')``.
:keyword application_name:
The name will be displayed in the pg_stat_activity view.
This parameter is optional.
:keyword ssl:
Use SSL encryption for TCP/IP sockets if ``True``. Defaults to
``False``.
:keyword timeout:
Only used with Python 3, this is the time in seconds before the
connection to the database will time out. The default is ``None`` which
means no timeout.
:rtype:
A :class:`Connection` object.
"""
return Connection(
user, host, unix_sock, port, database, password, ssl, timeout,
application_name, max_prepared_statements)
apilevel = "2.0"
"""The DBAPI level supported, currently "2.0".
This property is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
threadsafety = 1
"""Integer constant stating the level of thread safety the DBAPI interface
supports. This DBAPI module supports sharing of the module only. Connections
and cursors my not be shared between threads. This gives pg8000 a threadsafety
value of 1.
This property is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
paramstyle = 'format'
max_prepared_statements = 1000
# I have no idea what this would be used for by a client app. Should it be
# TEXT, VARCHAR, CHAR? It will only compare against row_description's
# type_code if it is this one type. It is the varchar type oid for now, this
# appears to match expectations in the DB API 2.0 compliance test suite.
STRING = 1043
"""String type oid."""
NUMBER = 1700
"""Numeric type oid"""
DATETIME = 1114
"""Timestamp type oid"""
ROWID = 26
"""ROWID type oid"""
__all__ = [
Warning, Bytea, DataError, DatabaseError, connect, InterfaceError,
ProgrammingError, Error, OperationalError, IntegrityError, InternalError,
NotSupportedError, ArrayContentNotHomogenousError,
ArrayDimensionsNotConsistentError, ArrayContentNotSupportedError, utc,
Connection, Cursor, Binary, Date, DateFromTicks, Time, TimeFromTicks,
Timestamp, TimestampFromTicks, BINARY, Interval, PGEnum, PGJson, PGJsonb,
PGTsvector, PGText, PGVarchar]
"""Version string for pg8000.
.. versionadded:: 1.9.11
"""
================================================
FILE: pg8000/_version.py
================================================
# This file helps to compute a version number in source trees obtained from
# git-archive tarball (such as those provided by githubs download-from-tag
# feature). Distribution tarballs (built by setup.py sdist) and build
# directories (produced by setup.py build) will contain a much shorter file
# that just contains the computed version number.
# This file is released into the public domain. Generated by
# versioneer-0.15 (https://github.com/warner/python-versioneer)
import errno
import os
import re
import subprocess
import sys
def get_keywords():
# these strings will be replaced by git during git-archive.
# setup.py/versioneer.py will grep for the variable names, so they must
# each be defined on a line of their own. _version.py will just call
# get_keywords().
git_refnames = "$Format:%d$"
git_full = "$Format:%H$"
keywords = {"refnames": git_refnames, "full": git_full}
return keywords
class VersioneerConfig:
pass
def get_config():
# these strings are filled in when 'setup.py versioneer' creates
# _version.py
cfg = VersioneerConfig()
cfg.VCS = "git"
cfg.style = "pep440"
cfg.tag_prefix = ""
cfg.parentdir_prefix = "pg8000-"
cfg.versionfile_source = "pg8000/_version.py"
cfg.verbose = False
return cfg
class NotThisMethod(Exception):
pass
LONG_VERSION_PY = {}
HANDLERS = {}
def register_vcs_handler(vcs, method): # decorator
def decorate(f):
if vcs not in HANDLERS:
HANDLERS[vcs] = {}
HANDLERS[vcs][method] = f
return f
return decorate
def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False):
assert isinstance(commands, list)
p = None
for c in commands:
try:
dispcmd = str([c] + args)
# remember shell=False, so use git.cmd on windows, not just git
p = subprocess.Popen([c] + args, cwd=cwd, stdout=subprocess.PIPE,
stderr=(subprocess.PIPE if hide_stderr
else None))
break
except EnvironmentError:
e = sys.exc_info()[1]
if e.errno == errno.ENOENT:
continue
if verbose:
print("unable to run %s" % dispcmd)
print(e)
return None
else:
if verbose:
print("unable to find command, tried %s" % (commands,))
return None
stdout = p.communicate()[0].strip()
if sys.version_info[0] >= 3:
stdout = stdout.decode()
if p.returncode != 0:
if verbose:
print("unable to run %s (error)" % dispcmd)
return None
return stdout
def versions_from_parentdir(parentdir_prefix, root, verbose):
# Source tarballs conventionally unpack into a directory that includes
# both the project name and a version string.
dirname = os.path.basename(root)
if not dirname.startswith(parentdir_prefix):
if verbose:
print("guessing rootdir is '%s', but '%s' doesn't start with "
"prefix '%s'" % (root, dirname, parentdir_prefix))
raise NotThisMethod("rootdir doesn't start with parentdir_prefix")
return {"version": dirname[len(parentdir_prefix):],
"full-revisionid": None,
"dirty": False, "error": None}
@register_vcs_handler("git", "get_keywords")
def git_get_keywords(versionfile_abs):
# the code embedded in _version.py can just fetch the value of these
# keywords. When used from setup.py, we don't want to import _version.py,
# so we do it with a regexp instead. This function is not used from
# _version.py.
keywords = {}
try:
f = open(versionfile_abs, "r")
for line in f.readlines():
if line.strip().startswith("git_refnames ="):
mo = re.search(r'=\s*"(.*)"', line)
if mo:
keywords["refnames"] = mo.group(1)
if line.strip().startswith("git_full ="):
mo = re.search(r'=\s*"(.*)"', line)
if mo:
keywords["full"] = mo.group(1)
f.close()
except EnvironmentError:
pass
return keywords
@register_vcs_handler("git", "keywords")
def git_versions_from_keywords(keywords, tag_prefix, verbose):
if not keywords:
raise NotThisMethod("no keywords at all, weird")
refnames = keywords["refnames"].strip()
if refnames.startswith("$Format"):
if verbose:
print("keywords are unexpanded, not using")
raise NotThisMethod("unexpanded keywords, not a git-archive tarball")
refs = set([r.strip() for r in refnames.strip("()").split(",")])
# starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of
# just "foo-1.0". If we see a "tag: " prefix, prefer those.
TAG = "tag: "
tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)])
if not tags:
# Either we're using git < 1.8.3, or there really are no tags. We use
# a heuristic: assume all version tags have a digit. The old git %d
# expansion behaves like git log --decorate=short and strips out the
# refs/heads/ and refs/tags/ prefixes that would let us distinguish
# between branches and tags. By ignoring refnames without digits, we
# filter out many common branch names like "release" and
# "stabilization", as well as "HEAD" and "master".
tags = set([r for r in refs if re.search(r'\d', r)])
if verbose:
print("discarding '%s', no digits" % ",".join(refs-tags))
if verbose:
print("likely tags: %s" % ",".join(sorted(tags)))
for ref in sorted(tags):
# sorting will prefer e.g. "2.0" over "2.0rc1"
if ref.startswith(tag_prefix):
r = ref[len(tag_prefix):]
if verbose:
print("picking %s" % r)
return {"version": r,
"full-revisionid": keywords["full"].strip(),
"dirty": False, "error": None
}
# no suitable tags, so version is "0+unknown", but full hex is still there
if verbose:
print("no suitable tags, using unknown + full revision id")
return {"version": "0+unknown",
"full-revisionid": keywords["full"].strip(),
"dirty": False, "error": "no suitable tags"}
@register_vcs_handler("git", "pieces_from_vcs")
def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
# this runs 'git' from the root of the source tree. This only gets called
# if the git-archive 'subst' keywords were *not* expanded, and
# _version.py hasn't already been rewritten with a short version string,
# meaning we're inside a checked out source tree.
if not os.path.exists(os.path.join(root, ".git")):
if verbose:
print("no .git in %s" % root)
raise NotThisMethod("no .git directory")
GITS = ["git"]
if sys.platform == "win32":
GITS = ["git.cmd", "git.exe"]
# if there is a tag, this yields TAG-NUM-gHEX[-dirty]
# if there are no tags, this yields HEX[-dirty] (no NUM)
describe_out = run_command(GITS, ["describe", "--tags", "--dirty",
"--always", "--long"],
cwd=root)
# --long was added in git-1.5.5
if describe_out is None:
raise NotThisMethod("'git describe' failed")
describe_out = describe_out.strip()
full_out = run_command(GITS, ["rev-parse", "HEAD"], cwd=root)
if full_out is None:
raise NotThisMethod("'git rev-parse' failed")
full_out = full_out.strip()
pieces = {}
pieces["long"] = full_out
pieces["short"] = full_out[:7] # maybe improved later
pieces["error"] = None
# parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty]
# TAG might have hyphens.
git_describe = describe_out
# look for -dirty suffix
dirty = git_describe.endswith("-dirty")
pieces["dirty"] = dirty
if dirty:
git_describe = git_describe[:git_describe.rindex("-dirty")]
# now we have TAG-NUM-gHEX or HEX
if "-" in git_describe:
# TAG-NUM-gHEX
mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe)
if not mo:
# unparseable. Maybe git-describe is misbehaving?
pieces["error"] = ("unable to parse git-describe output: '%s'"
% describe_out)
return pieces
# tag
full_tag = mo.group(1)
if not full_tag.startswith(tag_prefix):
if verbose:
fmt = "tag '%s' doesn't start with prefix '%s'"
print(fmt % (full_tag, tag_prefix))
pieces["error"] = ("tag '%s' doesn't start with prefix '%s'"
% (full_tag, tag_prefix))
return pieces
pieces["closest-tag"] = full_tag[len(tag_prefix):]
# distance: number of commits since tag
pieces["distance"] = int(mo.group(2))
# commit: short hex revision ID
pieces["short"] = mo.group(3)
else:
# HEX: no tags
pieces["closest-tag"] = None
count_out = run_command(GITS, ["rev-list", "HEAD", "--count"],
cwd=root)
pieces["distance"] = int(count_out) # total number of commits
return pieces
def plus_or_dot(pieces):
if "+" in pieces.get("closest-tag", ""):
return "."
return "+"
def render_pep440(pieces):
# now build up version string, with post-release "local version
# identifier". Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you
# get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty
# exceptions:
# 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty]
if pieces["closest-tag"]:
rendered = pieces["closest-tag"]
if pieces["distance"] or pieces["dirty"]:
rendered += plus_or_dot(pieces)
rendered += "%d.g%s" % (pieces["distance"], pieces["short"])
if pieces["dirty"]:
rendered += ".dirty"
else:
# exception #1
rendered = "0+untagged.%d.g%s" % (pieces["distance"],
pieces["short"])
if pieces["dirty"]:
rendered += ".dirty"
return rendered
def render_pep440_pre(pieces):
# TAG[.post.devDISTANCE] . No -dirty
# exceptions:
# 1: no tags. 0.post.devDISTANCE
if pieces["closest-tag"]:
rendered = pieces["closest-tag"]
if pieces["distance"]:
rendered += ".post.dev%d" % pieces["distance"]
else:
# exception #1
rendered = "0.post.dev%d" % pieces["distance"]
return rendered
def render_pep440_post(pieces):
# TAG[.postDISTANCE[.dev0]+gHEX] . The ".dev0" means dirty. Note that
# .dev0 sorts backwards (a dirty tree will appear "older" than the
# corresponding clean one), but you shouldn't be releasing software with
# -dirty anyways.
# exceptions:
# 1: no tags. 0.postDISTANCE[.dev0]
if pieces["closest-tag"]:
rendered = pieces["closest-tag"]
if pieces["distance"] or pieces["dirty"]:
rendered += ".post%d" % pieces["distance"]
if pieces["dirty"]:
rendered += ".dev0"
rendered += plus_or_dot(pieces)
rendered += "g%s" % pieces["short"]
else:
# exception #1
rendered = "0.post%d" % pieces["distance"]
if pieces["dirty"]:
rendered += ".dev0"
rendered += "+g%s" % pieces["short"]
return rendered
def render_pep440_old(pieces):
# TAG[.postDISTANCE[.dev0]] . The ".dev0" means dirty.
# exceptions:
# 1: no tags. 0.postDISTANCE[.dev0]
if pieces["closest-tag"]:
rendered = pieces["closest-tag"]
if pieces["distance"] or pieces["dirty"]:
rendered += ".post%d" % pieces["distance"]
if pieces["dirty"]:
rendered += ".dev0"
else:
# exception #1
rendered = "0.post%d" % pieces["distance"]
if pieces["dirty"]:
rendered += ".dev0"
return rendered
def render_git_describe(pieces):
# TAG[-DISTANCE-gHEX][-dirty], like 'git describe --tags --dirty
# --always'
# exceptions:
# 1: no tags. HEX[-dirty] (note: no 'g' prefix)
if pieces["closest-tag"]:
rendered = pieces["closest-tag"]
if pieces["distance"]:
rendered += "-%d-g%s" % (pieces["distance"], pieces["short"])
else:
# exception #1
rendered = pieces["short"]
if pieces["dirty"]:
rendered += "-dirty"
return rendered
def render_git_describe_long(pieces):
# TAG-DISTANCE-gHEX[-dirty], like 'git describe --tags --dirty
# --always -long'. The distance/hash is unconditional.
# exceptions:
# 1: no tags. HEX[-dirty] (note: no 'g' prefix)
if pieces["closest-tag"]:
rendered = pieces["closest-tag"]
rendered += "-%d-g%s" % (pieces["distance"], pieces["short"])
else:
# exception #1
rendered = pieces["short"]
if pieces["dirty"]:
rendered += "-dirty"
return rendered
def render(pieces, style):
if pieces["error"]:
return {"version": "unknown",
"full-revisionid": pieces.get("long"),
"dirty": None,
"error": pieces["error"]}
if not style or style == "default":
style = "pep440" # the default
if style == "pep440":
rendered = render_pep440(pieces)
elif style == "pep440-pre":
rendered = render_pep440_pre(pieces)
elif style == "pep440-post":
rendered = render_pep440_post(pieces)
elif style == "pep440-old":
rendered = render_pep440_old(pieces)
elif style == "git-describe":
rendered = render_git_describe(pieces)
elif style == "git-describe-long":
rendered = render_git_describe_long(pieces)
else:
raise ValueError("unknown style '%s'" % style)
return {"version": rendered, "full-revisionid": pieces["long"],
"dirty": pieces["dirty"], "error": None}
def get_versions():
# I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have
# __file__, we can work backwards from there to the root. Some
# py2exe/bbfreeze/non-CPython implementations don't do __file__, in which
# case we can only use expanded keywords.
cfg = get_config()
verbose = cfg.verbose
try:
return git_versions_from_keywords(get_keywords(), cfg.tag_prefix,
verbose)
except NotThisMethod:
pass
try:
root = os.path.realpath(__file__)
# versionfile_source is the relative path from the top of the source
# tree (where the .git directory might live) to this file. Invert
# this to find the root from __file__.
for i in cfg.versionfile_source.split('/'):
root = os.path.dirname(root)
except NameError:
return {"version": "0+unknown", "full-revisionid": None,
"dirty": None,
"error": "unable to find root of source tree"}
try:
pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose)
return render(pieces, cfg.style)
except NotThisMethod:
pass
try:
if cfg.parentdir_prefix:
return versions_from_parentdir(cfg.parentdir_prefix, root, verbose)
except NotThisMethod:
pass
return {"version": "0+unknown", "full-revisionid": None,
"dirty": None,
"error": "unable to compute version"}
================================================
FILE: pg8000/core.py
================================================
from datetime import (
timedelta as Timedelta, datetime as Datetime, tzinfo, date, time)
from warnings import warn
import socket
from struct import pack
from hashlib import md5
from decimal import Decimal
from collections import deque, defaultdict
from itertools import count, islice
from six.moves import map
from six import (
b, PY2, integer_types, next, text_type, u, binary_type, itervalues,
iteritems)
from uuid import UUID
from copy import deepcopy
from calendar import timegm
from distutils.version import LooseVersion
from struct import Struct
from time import localtime
import pg8000
from json import loads, dumps
from os import getpid
# Copyright (c) 2007-2009, Mathieu Fenniak
# Copyright (c) The Contributors
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
# * The name of the author may not be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
__author__ = "Mathieu Fenniak"
ZERO = Timedelta(0)
class UTC(tzinfo):
def utcoffset(self, dt):
return ZERO
def tzname(self, dt):
return "UTC"
def dst(self, dt):
return ZERO
utc = UTC()
class Interval(object):
"""An Interval represents a measurement of time. In PostgreSQL, an
interval is defined in the measure of months, days, and microseconds; as
such, the pg8000 interval type represents the same information.
Note that values of the :attr:`microseconds`, :attr:`days` and
:attr:`months` properties are independently measured and cannot be
converted to each other. A month may be 28, 29, 30, or 31 days, and a day
may occasionally be lengthened slightly by a leap second.
.. attribute:: microseconds
Measure of microseconds in the interval.
The microseconds value is constrained to fit into a signed 64-bit
integer. Any attempt to set a value too large or too small will result
in an OverflowError being raised.
.. attribute:: days
Measure of days in the interval.
The days value is constrained to fit into a signed 32-bit integer.
Any attempt to set a value too large or too small will result in an
OverflowError being raised.
.. attribute:: months
Measure of months in the interval.
The months value is constrained to fit into a signed 32-bit integer.
Any attempt to set a value too large or too small will result in an
OverflowError being raised.
"""
def __init__(self, microseconds=0, days=0, months=0):
self.microseconds = microseconds
self.days = days
self.months = months
def _setMicroseconds(self, value):
if not isinstance(value, integer_types):
raise TypeError("microseconds must be an integer type")
elif not (min_int8 < value < max_int8):
raise OverflowError(
"microseconds must be representable as a 64-bit integer")
else:
self._microseconds = value
def _setDays(self, value):
if not isinstance(value, integer_types):
raise TypeError("days must be an integer type")
elif not (min_int4 < value < max_int4):
raise OverflowError(
"days must be representable as a 32-bit integer")
else:
self._days = value
def _setMonths(self, value):
if not isinstance(value, integer_types):
raise TypeError("months must be an integer type")
elif not (min_int4 < value < max_int4):
raise OverflowError(
"months must be representable as a 32-bit integer")
else:
self._months = value
microseconds = property(lambda self: self._microseconds, _setMicroseconds)
days = property(lambda self: self._days, _setDays)
months = property(lambda self: self._months, _setMonths)
def __repr__(self):
return "<Interval %s months %s days %s microseconds>" % (
self.months, self.days, self.microseconds)
def __eq__(self, other):
return other is not None and isinstance(other, Interval) and \
self.months == other.months and self.days == other.days and \
self.microseconds == other.microseconds
def __neq__(self, other):
return not self.__eq__(other)
class PGType(object):
def __init__(self, value):
self.value = value
def encode(self, encoding):
return str(self.value).encode(encoding)
class PGEnum(PGType):
def __init__(self, value):
if isinstance(value, str):
self.value = value
else:
self.value = value.value
class PGJson(PGType):
def encode(self, encoding):
return dumps(self.value).encode(encoding)
class PGJsonb(PGType):
def encode(self, encoding):
return dumps(self.value).encode(encoding)
class PGTsvector(PGType):
pass
class PGVarchar(str):
pass
class PGText(str):
pass
def pack_funcs(fmt):
struc = Struct('!' + fmt)
return struc.pack, struc.unpack_from
i_pack, i_unpack = pack_funcs('i')
h_pack, h_unpack = pack_funcs('h')
q_pack, q_unpack = pack_funcs('q')
d_pack, d_unpack = pack_funcs('d')
f_pack, f_unpack = pack_funcs('f')
iii_pack, iii_unpack = pack_funcs('iii')
ii_pack, ii_unpack = pack_funcs('ii')
qii_pack, qii_unpack = pack_funcs('qii')
dii_pack, dii_unpack = pack_funcs('dii')
ihihih_pack, ihihih_unpack = pack_funcs('ihihih')
ci_pack, ci_unpack = pack_funcs('ci')
bh_pack, bh_unpack = pack_funcs('bh')
cccc_pack, cccc_unpack = pack_funcs('cccc')
min_int2, max_int2 = -2 ** 15, 2 ** 15
min_int4, max_int4 = -2 ** 31, 2 ** 31
min_int8, max_int8 = -2 ** 63, 2 ** 63
class Warning(Exception):
"""Generic exception raised for important database warnings like data
truncations. This exception is not currently used by pg8000.
This exception is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
pass
class Error(Exception):
"""Generic exception that is the base exception of all other error
exceptions.
This exception is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
pass
class InterfaceError(Error):
"""Generic exception raised for errors that are related to the database
interface rather than the database itself. For example, if the interface
attempts to use an SSL connection but the server refuses, an InterfaceError
will be raised.
This exception is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
pass
class DatabaseError(Error):
"""Generic exception raised for errors that are related to the database.
This exception is currently never raised by pg8000.
This exception is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
pass
class DataError(DatabaseError):
"""Generic exception raised for errors that are due to problems with the
processed data. This exception is not currently raised by pg8000.
This exception is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
pass
class OperationalError(DatabaseError):
"""
Generic exception raised for errors that are related to the database's
operation and not necessarily under the control of the programmer. This
exception is currently never raised by pg8000.
This exception is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
pass
class IntegrityError(DatabaseError):
"""
Generic exception raised when the relational integrity of the database is
affected. This exception is not currently raised by pg8000.
This exception is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
pass
class InternalError(DatabaseError):
"""Generic exception raised when the database encounters an internal error.
This is currently only raised when unexpected state occurs in the pg8000
interface itself, and is typically the result of a interface bug.
This exception is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
pass
class ProgrammingError(DatabaseError):
"""Generic exception raised for programming errors. For example, this
exception is raised if more parameter fields are in a query string than
there are available parameters.
This exception is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
pass
class NotSupportedError(DatabaseError):
"""Generic exception raised in case a method or database API was used which
is not supported by the database.
This exception is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
pass
class ArrayContentNotSupportedError(NotSupportedError):
"""
Raised when attempting to transmit an array where the base type is not
supported for binary data transfer by the interface.
"""
pass
class ArrayContentNotHomogenousError(ProgrammingError):
"""
Raised when attempting to transmit an array that doesn't contain only a
single type of object.
"""
pass
class ArrayDimensionsNotConsistentError(ProgrammingError):
"""
Raised when attempting to transmit an array that has inconsistent
multi-dimension sizes.
"""
pass
class Bytea(binary_type):
"""Bytea is a str-derived class that is mapped to a PostgreSQL byte array.
This class is only used in Python 2, the built-in ``bytes`` type is used in
Python 3.
"""
pass
def Date(year, month, day):
"""Constuct an object holding a date value.
This function is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
:rtype: :class:`datetime.date`
"""
return date(year, month, day)
def Time(hour, minute, second):
"""Construct an object holding a time value.
This function is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
:rtype: :class:`datetime.time`
"""
return time(hour, minute, second)
def Timestamp(year, month, day, hour, minute, second):
"""Construct an object holding a timestamp value.
This function is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
:rtype: :class:`datetime.datetime`
"""
return Datetime(year, month, day, hour, minute, second)
def DateFromTicks(ticks):
"""Construct an object holding a date value from the given ticks value
(number of seconds since the epoch).
This function is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
:rtype: :class:`datetime.date`
"""
return Date(*localtime(ticks)[:3])
def TimeFromTicks(ticks):
"""Construct an objet holding a time value from the given ticks value
(number of seconds since the epoch).
This function is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
:rtype: :class:`datetime.time`
"""
return Time(*localtime(ticks)[3:6])
def TimestampFromTicks(ticks):
"""Construct an object holding a timestamp value from the given ticks value
(number of seconds since the epoch).
This function is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
:rtype: :class:`datetime.datetime`
"""
return Timestamp(*localtime(ticks)[:6])
def Binary(value):
"""Construct an object holding binary data.
This function is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
:rtype: :class:`pg8000.types.Bytea` for Python 2, otherwise :class:`bytes`
"""
if PY2:
return Bytea(value)
else:
return value
if PY2:
BINARY = Bytea
else:
BINARY = bytes
FC_TEXT = 0
FC_BINARY = 1
BINARY_SPACE = b(" ")
DDL_COMMANDS = b("ALTER"), b("CREATE")
def convert_paramstyle(style, query):
# I don't see any way to avoid scanning the query string char by char,
# so we might as well take that careful approach and create a
# state-based scanner. We'll use int variables for the state.
OUTSIDE = 0 # outside quoted string
INSIDE_SQ = 1 # inside single-quote string '...'
INSIDE_QI = 2 # inside quoted identifier "..."
INSIDE_ES = 3 # inside escaped single-quote string, E'...'
INSIDE_PN = 4 # inside parameter name eg. :name
INSIDE_CO = 5 # inside inline comment eg. --
in_quote_escape = False
in_param_escape = False
placeholders = []
output_query = []
param_idx = map(lambda x: "$" + str(x), count(1))
state = OUTSIDE
prev_c = None
for i, c in enumerate(query):
if i + 1 < len(query):
next_c = query[i + 1]
else:
next_c = None
if state == OUTSIDE:
if c == "'":
output_query.append(c)
if prev_c == 'E':
state = INSIDE_ES
else:
state = INSIDE_SQ
elif c == '"':
output_query.append(c)
state = INSIDE_QI
elif c == '-':
output_query.append(c)
if prev_c == '-':
state = INSIDE_CO
elif style == "qmark" and c == "?":
output_query.append(next(param_idx))
elif style == "numeric" and c == ":":
output_query.append("$")
elif style == "named" and c == ":":
state = INSIDE_PN
placeholders.append('')
elif style == "pyformat" and c == '%' and next_c == "(":
state = INSIDE_PN
placeholders.append('')
elif style in ("format", "pyformat") and c == "%":
style = "format"
if in_param_escape:
in_param_escape = False
output_query.append(c)
else:
if next_c == "%":
in_param_escape = True
elif next_c == "s":
state = INSIDE_PN
output_query.append(next(param_idx))
else:
raise InterfaceError(
"Only %s and %% are supported in the query.")
else:
output_query.append(c)
elif state == INSIDE_SQ:
if c == "'":
if in_quote_escape:
in_quote_escape = False
else:
if next_c == "'":
in_quote_escape = True
else:
state = OUTSIDE
output_query.append(c)
elif state == INSIDE_QI:
if c == '"':
state = OUTSIDE
output_query.append(c)
elif state == INSIDE_ES:
if c == "'" and prev_c != "\\":
# check for escaped single-quote
state = OUTSIDE
output_query.append(c)
elif state == INSIDE_PN:
if style == 'named':
placeholders[-1] += c
if next_c is None or (not next_c.isalnum() and next_c != '_'):
state = OUTSIDE
try:
pidx = placeholders.index(placeholders[-1], 0, -1)
output_query.append("$" + str(pidx + 1))
del placeholders[-1]
except ValueError:
output_query.append("$" + str(len(placeholders)))
elif style == 'pyformat':
if prev_c == ')' and c == "s":
state = OUTSIDE
try:
pidx = placeholders.index(placeholders[-1], 0, -1)
output_query.append("$" + str(pidx + 1))
del placeholders[-1]
except ValueError:
output_query.append("$" + str(len(placeholders)))
elif c in "()":
pass
else:
placeholders[-1] += c
elif style == 'format':
state = OUTSIDE
elif state == INSIDE_CO:
output_query.append(c)
if c == '\n':
state = OUTSIDE
prev_c = c
if style in ('numeric', 'qmark', 'format'):
def make_args(vals):
return vals
else:
def make_args(vals):
return tuple(vals[p] for p in placeholders)
return ''.join(output_query), make_args
EPOCH = Datetime(2000, 1, 1)
EPOCH_TZ = EPOCH.replace(tzinfo=utc)
EPOCH_SECONDS = timegm(EPOCH.timetuple())
INFINITY_MICROSECONDS = 2 ** 63 - 1
MINUS_INFINITY_MICROSECONDS = -1 * INFINITY_MICROSECONDS - 1
# data is 64-bit integer representing microseconds since 2000-01-01
def timestamp_recv_integer(data, offset, length):
micros = q_unpack(data, offset)[0]
try:
return EPOCH + Timedelta(microseconds=micros)
except OverflowError:
if micros == INFINITY_MICROSECONDS:
return 'infinity'
elif micros == MINUS_INFINITY_MICROSECONDS:
return '-infinity'
else:
return micros
# data is double-precision float representing seconds since 2000-01-01
def timestamp_recv_float(data, offset, length):
return Datetime.utcfromtimestamp(EPOCH_SECONDS + d_unpack(data, offset)[0])
# data is 64-bit integer representing microseconds since 2000-01-01
def timestamp_send_integer(v):
return q_pack(
int((timegm(v.timetuple()) - EPOCH_SECONDS) * 1e6) + v.microsecond)
# data is double-precision float representing seconds since 2000-01-01
def timestamp_send_float(v):
return d_pack(timegm(v.timetuple()) + v.microsecond / 1e6 - EPOCH_SECONDS)
def timestamptz_send_integer(v):
# timestamps should be sent as UTC. If they have zone info,
# convert them.
return timestamp_send_integer(v.astimezone(utc).replace(tzinfo=None))
def timestamptz_send_float(v):
# timestamps should be sent as UTC. If they have zone info,
# convert them.
return timestamp_send_float(v.astimezone(utc).replace(tzinfo=None))
# return a timezone-aware datetime instance if we're reading from a
# "timestamp with timezone" type. The timezone returned will always be
# UTC, but providing that additional information can permit conversion
# to local.
def timestamptz_recv_integer(data, offset, length):
micros = q_unpack(data, offset)[0]
try:
return EPOCH_TZ + Timedelta(microseconds=micros)
except OverflowError:
if micros == INFINITY_MICROSECONDS:
return 'infinity'
elif micros == MINUS_INFINITY_MICROSECONDS:
return '-infinity'
else:
return micros
def timestamptz_recv_float(data, offset, length):
return timestamp_recv_float(data, offset, length).replace(tzinfo=utc)
def interval_send_integer(v):
microseconds = v.microseconds
try:
microseconds += int(v.seconds * 1e6)
except AttributeError:
pass
try:
months = v.months
except AttributeError:
months = 0
return qii_pack(microseconds, v.days, months)
def interval_send_float(v):
seconds = v.microseconds / 1000.0 / 1000.0
try:
seconds += v.seconds
except AttributeError:
pass
try:
months = v.months
except AttributeError:
months = 0
return dii_pack(seconds, v.days, months)
def interval_recv_integer(data, offset, length):
microseconds, days, months = qii_unpack(data, offset)
if months == 0:
seconds, micros = divmod(microseconds, 1e6)
return Timedelta(days, seconds, micros)
else:
return Interval(microseconds, days, months)
def interval_recv_float(data, offset, length):
seconds, days, months = dii_unpack(data, offset)
if months == 0:
secs, microseconds = divmod(seconds, 1e6)
return Timedelta(days, secs, microseconds)
else:
return Interval(int(seconds * 1000 * 1000), days, months)
def int8_recv(data, offset, length):
return q_unpack(data, offset)[0]
def int2_recv(data, offset, length):
return h_unpack(data, offset)[0]
def int4_recv(data, offset, length):
return i_unpack(data, offset)[0]
def float4_recv(data, offset, length):
return f_unpack(data, offset)[0]
def float8_recv(data, offset, length):
return d_unpack(data, offset)[0]
def bytea_send(v):
return v
# bytea
if PY2:
def bytea_recv(data, offset, length):
return Bytea(data[offset:offset + length])
else:
def bytea_recv(data, offset, length):
return data[offset:offset + length]
def uuid_send(v):
return v.bytes
def uuid_recv(data, offset, length):
return UUID(bytes=data[offset:offset+length])
TRUE = b("\x01")
FALSE = b("\x00")
def bool_send(v):
return TRUE if v else FALSE
NULL = i_pack(-1)
NULL_BYTE = b('\x00')
def null_send(v):
return NULL
def int_in(data, offset, length):
return int(data[offset: offset + length])
class Cursor():
"""A cursor object is returned by the :meth:`~Connection.cursor` method of
a connection. It has the following attributes and methods:
.. attribute:: arraysize
This read/write attribute specifies the number of rows to fetch at a
time with :meth:`fetchmany`. It defaults to 1.
.. attribute:: connection
This read-only attribute contains a reference to the connection object
(an instance of :class:`Connection`) on which the cursor was
created.
This attribute is part of a DBAPI 2.0 extension. Accessing this
attribute will generate the following warning: ``DB-API extension
cursor.connection used``.
.. attribute:: rowcount
This read-only attribute contains the number of rows that the last
``execute()`` or ``executemany()`` method produced (for query
statements like ``SELECT``) or affected (for modification statements
like ``UPDATE``).
The value is -1 if:
- No ``execute()`` or ``executemany()`` method has been performed yet
on the cursor.
- There was no rowcount associated with the last ``execute()``.
- At least one of the statements executed as part of an
``executemany()`` had no row count associated with it.
- Using a ``SELECT`` query statement on PostgreSQL server older than
version 9.
- Using a ``COPY`` query statement on PostgreSQL server version 8.1 or
older.
This attribute is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
.. attribute:: description
This read-only attribute is a sequence of 7-item sequences. Each value
contains information describing one result column. The 7 items
returned for each column are (name, type_code, display_size,
internal_size, precision, scale, null_ok). Only the first two values
are provided by the current implementation.
This attribute is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
def __init__(self, connection):
self._c = connection
self.arraysize = 1
self.ps = None
self._row_count = -1
self._cached_rows = deque()
def __enter__(self):
return self
def __exit__(self, exc_type, exc_value, traceback):
self.close()
@property
def connection(self):
warn("DB-API extension cursor.connection used", stacklevel=3)
return self._c
@property
def rowcount(self):
return self._row_count
description = property(lambda self: self._getDescription())
def _getDescription(self):
if self.ps is None:
return None
row_desc = self.ps['row_desc']
if len(row_desc) == 0:
return None
columns = []
for col in row_desc:
columns.append(
(col["name"], col["type_oid"], None, None, None, None, None))
return columns
##
# Executes a database operation. Parameters may be provided as a sequence
# or mapping and will be bound to variables in the operation.
# <p>
# Stability: Part of the DBAPI 2.0 specification.
def execute(self, operation, args=None, stream=None):
"""Executes a database operation. Parameters may be provided as a
sequence, or as a mapping, depending upon the value of
:data:`pg8000.paramstyle`.
This method is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
:param operation:
The SQL statement to execute.
:param args:
If :data:`paramstyle` is ``qmark``, ``numeric``, or ``format``,
this argument should be an array of parameters to bind into the
statement. If :data:`paramstyle` is ``named``, the argument should
be a dict mapping of parameters. If the :data:`paramstyle` is
``pyformat``, the argument value may be either an array or a
mapping.
:param stream: This is a pg8000 extension for use with the PostgreSQL
`COPY
<http://www.postgresql.org/docs/current/static/sql-copy.html>`_
command. For a COPY FROM the parameter must be a readable file-like
object, and for COPY TO it must be writable.
.. versionadded:: 1.9.11
"""
try:
self.stream = stream
if not self._c.in_transaction and not self._c.autocommit:
self._c.execute(self, "begin transaction", None)
self._c.execute(self, operation, args)
except AttributeError as e:
if self._c is None:
raise InterfaceError("Cursor closed")
elif self._c._sock is None:
raise InterfaceError("connection is closed")
else:
raise e
def executemany(self, operation, param_sets):
"""Prepare a database operation, and then execute it against all
parameter sequences or mappings provided.
This method is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
:param operation:
The SQL statement to execute
:param parameter_sets:
A sequence of parameters to execute the statement with. The values
in the sequence should be sequences or mappings of parameters, the
same as the args argument of the :meth:`execute` method.
"""
rowcounts = []
for parameters in param_sets:
self.execute(operation, parameters)
rowcounts.append(self._row_count)
self._row_count = -1 if -1 in rowcounts else sum(rowcounts)
def fetchone(self):
"""Fetch the next row of a query result set.
This method is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
:returns:
A row as a sequence of field values, or ``None`` if no more rows
are available.
"""
try:
return next(self)
except StopIteration:
return None
except TypeError:
raise ProgrammingError("attempting to use unexecuted cursor")
except AttributeError:
raise ProgrammingError("attempting to use unexecuted cursor")
def fetchmany(self, num=None):
"""Fetches the next set of rows of a query result.
This method is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
:param size:
The number of rows to fetch when called. If not provided, the
:attr:`arraysize` attribute value is used instead.
:returns:
A sequence, each entry of which is a sequence of field values
making up a row. If no more rows are available, an empty sequence
will be returned.
"""
try:
return tuple(
islice(self, self.arraysize if num is None else num))
except TypeError:
raise ProgrammingError("attempting to use unexecuted cursor")
def fetchall(self):
"""Fetches all remaining rows of a query result.
This method is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
:returns:
A sequence, each entry of which is a sequence of field values
making up a row.
"""
try:
return tuple(self)
except TypeError:
raise ProgrammingError("attempting to use unexecuted cursor")
def close(self):
"""Closes the cursor.
This method is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
self._c = None
def __iter__(self):
"""A cursor object is iterable to retrieve the rows from a query.
This is a DBAPI 2.0 extension.
"""
return self
def setinputsizes(self, sizes):
"""This method is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_, however, it is not
implemented by pg8000.
"""
pass
def setoutputsize(self, size, column=None):
"""This method is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_, however, it is not
implemented by pg8000.
"""
pass
def __next__(self):
try:
return self._cached_rows.popleft()
except IndexError:
if self.ps is None:
raise ProgrammingError("A query hasn't been issued.")
elif len(self.ps['row_desc']) == 0:
raise ProgrammingError("no result set")
else:
raise StopIteration()
if PY2:
Cursor.next = Cursor.__next__
# Message codes
NOTICE_RESPONSE = b("N")
AUTHENTICATION_REQUEST = b("R")
PARAMETER_STATUS = b("S")
BACKEND_KEY_DATA = b("K")
READY_FOR_QUERY = b("Z")
ROW_DESCRIPTION = b("T")
ERROR_RESPONSE = b("E")
DATA_ROW = b("D")
COMMAND_COMPLETE = b("C")
PARSE_COMPLETE = b("1")
BIND_COMPLETE = b("2")
CLOSE_COMPLETE = b("3")
PORTAL_SUSPENDED = b("s")
NO_DATA = b("n")
PARAMETER_DESCRIPTION = b("t")
NOTIFICATION_RESPONSE = b("A")
COPY_DONE = b("c")
COPY_DATA = b("d")
COPY_IN_RESPONSE = b("G")
COPY_OUT_RESPONSE = b("H")
EMPTY_QUERY_RESPONSE = b("I")
BIND = b("B")
PARSE = b("P")
EXECUTE = b("E")
FLUSH = b('H')
SYNC = b('S')
PASSWORD = b('p')
DESCRIBE = b('D')
TERMINATE = b('X')
CLOSE = b('C')
def create_message(code, data=b('')):
return code + i_pack(len(data) + 4) + data
FLUSH_MSG = create_message(FLUSH)
SYNC_MSG = create_message(SYNC)
TERMINATE_MSG = create_message(TERMINATE)
COPY_DONE_MSG = create_message(COPY_DONE)
EXECUTE_MSG = create_message(EXECUTE, NULL_BYTE + i_pack(0))
# DESCRIBE constants
STATEMENT = b('S')
PORTAL = b('P')
# ErrorResponse codes
RESPONSE_SEVERITY = "S" # always present
RESPONSE_SEVERITY = "V" # always present
RESPONSE_CODE = "C" # always present
RESPONSE_MSG = "M" # always present
RESPONSE_DETAIL = "D"
RESPONSE_HINT = "H"
RESPONSE_POSITION = "P"
RESPONSE__POSITION = "p"
RESPONSE__QUERY = "q"
RESPONSE_WHERE = "W"
RESPONSE_FILE = "F"
RESPONSE_LINE = "L"
RESPONSE_ROUTINE = "R"
IDLE = b("I")
IDLE_IN_TRANSACTION = b("T")
IDLE_IN_FAILED_TRANSACTION = b("E")
arr_trans = dict(zip(map(ord, u("[] 'u")), list(u('{}')) + [None] * 3))
class Connection(object):
# DBAPI Extension: supply exceptions as attributes on the connection
Warning = property(lambda self: self._getError(Warning))
Error = property(lambda self: self._getError(Error))
InterfaceError = property(lambda self: self._getError(InterfaceError))
DatabaseError = property(lambda self: self._getError(DatabaseError))
OperationalError = property(lambda self: self._getError(OperationalError))
IntegrityError = property(lambda self: self._getError(IntegrityError))
InternalError = property(lambda self: self._getError(InternalError))
ProgrammingError = property(lambda self: self._getError(ProgrammingError))
NotSupportedError = property(
lambda self: self._getError(NotSupportedError))
def _getError(self, error):
warn(
"DB-API extension connection.%s used" %
error.__name__, stacklevel=3)
return error
def __init__(
self, user, host, unix_sock, port, database, password, ssl,
timeout, application_name, max_prepared_statements):
self._client_encoding = "utf8"
self._commands_with_count = (
b("INSERT"), b("DELETE"), b("UPDATE"), b("MOVE"),
b("FETCH"), b("COPY"), b("SELECT"))
self.notifications = deque(maxlen=100)
self.notices = deque(maxlen=100)
self.parameter_statuses = deque(maxlen=100)
self.max_prepared_statements = int(max_prepared_statements)
if user is None:
raise InterfaceError(
"The 'user' connection parameter cannot be None")
if isinstance(user, text_type):
self.user = user.encode('utf8')
else:
self.user = user
if isinstance(password, text_type):
self.password = password.encode('utf8')
else:
self.password = password
self.autocommit = False
self._xid = None
self._caches = {}
try:
if unix_sock is None and host is not None:
self._usock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
elif unix_sock is not None:
if not hasattr(socket, "AF_UNIX"):
raise InterfaceError(
"attempt to connect to unix socket on unsupported "
"platform")
self._usock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
else:
raise ProgrammingError(
"one of host or unix_sock must be provided")
if not PY2 and timeout is not None:
self._usock.settimeout(timeout)
if unix_sock is None and host is not None:
self._usock.connect((host, port))
elif unix_sock is not None:
self._usock.connect(unix_sock)
if ssl:
try:
import ssl as sslmodule
# Int32(8) - Message length, including self.
# Int32(80877103) - The SSL request code.
self._usock.sendall(ii_pack(8, 80877103))
resp = self._usock.recv(1)
if resp == b('S'):
self._usock = sslmodule.wrap_socket(self._usock)
else:
raise InterfaceError("Server refuses SSL")
except ImportError:
raise InterfaceError(
"SSL required but ssl module not available in "
"this python installation")
self._sock = self._usock.makefile(mode="rwb")
except socket.error as e:
self._usock.close()
raise InterfaceError("communication error", e)
self._flush = self._sock.flush
self._read = self._sock.read
self._write = self._sock.write
self._backend_key_data = None
def text_out(v):
return v.encode(self._client_encoding)
def enum_out(v):
return str(v.value).encode(self._client_encoding)
def time_out(v):
return v.isoformat().encode(self._client_encoding)
def date_out(v):
return v.isoformat().encode(self._client_encoding)
def unknown_out(v):
return str(v).encode(self._client_encoding)
trans_tab = dict(zip(map(ord, u('{}')), u('[]')))
glbls = {'Decimal': Decimal}
def array_in(data, idx, length):
arr = []
prev_c = None
for c in data[idx:idx+length].decode(
self._client_encoding).translate(
trans_tab).replace(u('NULL'), u('None')):
if c not in ('[', ']', ',', 'N') and prev_c in ('[', ','):
arr.extend("Decimal('")
elif c in (']', ',') and prev_c not in ('[', ']', ',', 'e'):
arr.extend("')")
arr.append(c)
prev_c = c
return eval(''.join(arr), glbls)
def array_recv(data, idx, length):
final_idx = idx + length
dim, hasnull, typeoid = iii_unpack(data, idx)
idx += 12
# get type conversion method for typeoid
conversion = self.pg_types[typeoid][1]
# Read dimension info
dim_lengths = []
for i in range(dim):
dim_lengths.append(ii_unpack(data, idx)[0])
idx += 8
# Read all array values
values = []
while idx < final_idx:
element_len, = i_unpack(data, idx)
idx += 4
if element_len == -1:
values.append(None)
else:
values.append(conversion(data, idx, element_len))
idx += element_len
# at this point, {{1,2,3},{4,5,6}}::int[][] looks like
# [1,2,3,4,5,6]. go through the dimensions and fix up the array
# contents to match expected dimensions
for length in reversed(dim_lengths[1:]):
values = list(map(list, zip(*[iter(values)] * length)))
return values
def vector_in(data, idx, length):
return eval('[' + data[idx:idx+length].decode(
self._client_encoding).replace(' ', ',') + ']')
if PY2:
def text_recv(data, offset, length):
return unicode( # noqa
data[offset: offset + length], self._client_encoding)
def bool_recv(d, o, l):
return d[o] == "\x01"
def json_in(data, offset, length):
return loads(unicode( # noqa
data[offset: offset + length], self._client_encoding))
else:
def text_recv(data, offset, length):
return str(
data[offset: offset + length], self._client_encoding)
def bool_recv(data, offset, length):
return data[offset] == 1
def json_in(data, offset, length):
return loads(
str(data[offset: offset + length], self._client_encoding))
def time_in(data, offset, length):
hour = int(data[offset:offset + 2])
minute = int(data[offset + 3:offset + 5])
sec = Decimal(
data[offset + 6:offset + length].decode(self._client_encoding))
return time(
hour, minute, int(sec), int((sec - int(sec)) * 1000000))
def date_in(data, offset, length):
d = data[offset:offset+length].decode(self._client_encoding)
try:
return date(int(d[:4]), int(d[5:7]), int(d[8:10]))
except ValueError:
return d
def numeric_in(data, offset, length):
return Decimal(
data[offset: offset + length].decode(self._client_encoding))
def numeric_out(d):
return str(d).encode(self._client_encoding)
self.pg_types = defaultdict(
lambda: (FC_TEXT, text_recv), {
16: (FC_BINARY, bool_recv), # boolean
17: (FC_BINARY, bytea_recv), # bytea
19: (FC_BINARY, text_recv), # name type
20: (FC_BINARY, int8_recv), # int8
21: (FC_BINARY, int2_recv), # int2
22: (FC_TEXT, vector_in), # int2vector
23: (FC_BINARY, int4_recv), # int4
25: (FC_BINARY, text_recv), # TEXT type
26: (FC_TEXT, int_in), # oid
28: (FC_TEXT, int_in), # xid
114: (FC_TEXT, json_in), # json
700: (FC_BINARY, float4_recv), # float4
701: (FC_BINARY, float8_recv), # float8
705: (FC_BINARY, text_recv), # unknown
829: (FC_TEXT, text_recv), # MACADDR type
1000: (FC_BINARY, array_recv), # BOOL[]
1003: (FC_BINARY, array_recv), # NAME[]
1005: (FC_BINARY, array_recv), # INT2[]
1007: (FC_BINARY, array_recv), # INT4[]
1009: (FC_BINARY, array_recv), # TEXT[]
1014: (FC_BINARY, array_recv), # CHAR[]
1015: (FC_BINARY, array_recv), # VARCHAR[]
1016: (FC_BINARY, array_recv), # INT8[]
1021: (FC_BINARY, array_recv), # FLOAT4[]
1022: (FC_BINARY, array_recv), # FLOAT8[]
1042: (FC_BINARY, text_recv), # CHAR type
1043: (FC_BINARY, text_recv), # VARCHAR type
1082: (FC_TEXT, date_in), # date
1083: (FC_TEXT, time_in),
1114: (FC_BINARY, timestamp_recv_float), # timestamp w/ tz
1184: (FC_BINARY, timestamptz_recv_float),
1186: (FC_BINARY, interval_recv_integer),
1231: (FC_TEXT, array_in), # NUMERIC[]
1263: (FC_BINARY, array_recv), # cstring[]
1700: (FC_TEXT, numeric_in), # NUMERIC
2275: (FC_BINARY, text_recv), # cstring
2950: (FC_BINARY, uuid_recv), # uuid
3802: (FC_TEXT, json_in), # jsonb
})
self.py_types = {
type(None): (-1, FC_BINARY, null_send), # null
bool: (16, FC_BINARY, bool_send),
bytearray: (17, FC_BINARY, bytea_send), # bytea
20: (20, FC_BINARY, q_pack), # int8
21: (21, FC_BINARY, h_pack), # int2
23: (23, FC_BINARY, i_pack), # int4
PGText: (25, FC_TEXT, text_out), # text
float: (701, FC_BINARY, d_pack), # float8
PGEnum: (705, FC_TEXT, enum_out),
date: (1082, FC_TEXT, date_out), # date
time: (1083, FC_TEXT, time_out), # time
1114: (1114, FC_BINARY, timestamp_send_integer), # timestamp
# timestamp w/ tz
PGVarchar: (1043, FC_TEXT, text_out), # varchar
1184: (1184, FC_BINARY, timestamptz_send_integer),
PGJson: (114, FC_TEXT, text_out),
PGJsonb: (3802, FC_TEXT, text_out),
Timedelta: (1186, FC_BINARY, interval_send_integer),
Interval: (1186, FC_BINARY, interval_send_integer),
Decimal: (1700, FC_TEXT, numeric_out), # Decimal
PGTsvector: (3614, FC_TEXT, text_out),
UUID: (2950, FC_BINARY, uuid_send)} # uuid
self.inspect_funcs = {
Datetime: self.inspect_datetime,
list: self.array_inspect,
tuple: self.array_inspect,
int: self.inspect_int}
if PY2:
self.py_types[Bytea] = (17, FC_BINARY, bytea_send) # bytea
self.py_types[text_type] = (705, FC_TEXT, text_out) # unknown
self.py_types[str] = (705, FC_TEXT, bytea_send) # unknown
self.inspect_funcs[long] = self.inspect_int # noqa
else:
self.py_types[bytes] = (17, FC_BINARY, bytea_send) # bytea
self.py_types[str] = (705, FC_TEXT, text_out) # unknown
try:
import enum
self.py_types[enum.Enum] = (705, FC_TEXT, enum_out)
except ImportError:
pass
try:
from ipaddress import (
ip_address, IPv4Address, IPv6Address, ip_network, IPv4Network,
IPv6Network)
def inet_out(v):
return str(v).encode(self._client_encoding)
def inet_in(data, offset, length):
inet_str = data[offset: offset + length].decode(
self._client_encoding)
if '/' in inet_str:
return ip_network(inet_str, False)
else:
return ip_address(inet_str)
self.py_types[IPv4Address] = (869, FC_TEXT, inet_out) # inet
self.py_types[IPv6Address] = (869, FC_TEXT, inet_out) # inet
self.py_types[IPv4Network] = (869, FC_TEXT, inet_out) # inet
self.py_types[IPv6Network] = (869, FC_TEXT, inet_out) # inet
self.pg_types[869] = (FC_TEXT, inet_in) # inet
except ImportError:
pass
self.message_types = {
NOTICE_RESPONSE: self.handle_NOTICE_RESPONSE,
AUTHENTICATION_REQUEST: self.handle_AUTHENTICATION_REQUEST,
PARAMETER_STATUS: self.handle_PARAMETER_STATUS,
BACKEND_KEY_DATA: self.handle_BACKEND_KEY_DATA,
READY_FOR_QUERY: self.handle_READY_FOR_QUERY,
ROW_DESCRIPTION: self.handle_ROW_DESCRIPTION,
ERROR_RESPONSE: self.handle_ERROR_RESPONSE,
EMPTY_QUERY_RESPONSE: self.handle_EMPTY_QUERY_RESPONSE,
DATA_ROW: self.handle_DATA_ROW,
COMMAND_COMPLETE: self.handle_COMMAND_COMPLETE,
PARSE_COMPLETE: self.handle_PARSE_COMPLETE,
BIND_COMPLETE: self.handle_BIND_COMPLETE,
CLOSE_COMPLETE: self.handle_CLOSE_COMPLETE,
PORTAL_SUSPENDED: self.handle_PORTAL_SUSPENDED,
NO_DATA: self.handle_NO_DATA,
PARAMETER_DESCRIPTION: self.handle_PARAMETER_DESCRIPTION,
NOTIFICATION_RESPONSE: self.handle_NOTIFICATION_RESPONSE,
COPY_DONE: self.handle_COPY_DONE,
COPY_DATA: self.handle_COPY_DATA,
COPY_IN_RESPONSE: self.handle_COPY_IN_RESPONSE,
COPY_OUT_RESPONSE: self.handle_COPY_OUT_RESPONSE}
# Int32 - Message length, including self.
# Int32(196608) - Protocol version number. Version 3.0.
# Any number of key/value pairs, terminated by a zero byte:
# String - A parameter name (user, database, or options)
# String - Parameter value
protocol = 196608
val = bytearray(
i_pack(protocol) + b("user\x00") + self.user + NULL_BYTE)
if database is not None:
if isinstance(database, text_type):
database = database.encode('utf8')
val.extend(b("database\x00") + database + NULL_BYTE)
if application_name is not None:
if isinstance(application_name, text_type):
application_name = application_name.encode('utf8')
val.extend(
b("application_name\x00") + application_name + NULL_BYTE)
val.append(0)
self._write(i_pack(len(val) + 4))
self._write(val)
self._flush()
self._cursor = self.cursor()
code = self.error = None
while code not in (READY_FOR_QUERY, ERROR_RESPONSE):
code, data_len = ci_unpack(self._read(5))
self.message_types[code](self._read(data_len - 4), None)
if self.error is not None:
raise self.error
self.in_transaction = False
def handle_ERROR_RESPONSE(self, data, ps):
msg = dict(
(
s[:1].decode(self._client_encoding),
s[1:].decode(self._client_encoding)) for s in
data.split(NULL_BYTE) if s != b(''))
response_code = msg[RESPONSE_CODE]
if response_code == '28000':
cls = InterfaceError
elif response_code == '23505':
cls = IntegrityError
else:
cls = ProgrammingError
self.error = cls(msg)
def handle_EMPTY_QUERY_RESPONSE(self, data, ps):
self.error = ProgrammingError("query was empty")
def handle_CLOSE_COMPLETE(self, data, ps):
pass
def handle_PARSE_COMPLETE(self, data, ps):
# Byte1('1') - Identifier.
# Int32(4) - Message length, including self.
pass
def handle_BIND_COMPLETE(self, data, ps):
pass
def handle_PORTAL_SUSPENDED(self, data, cursor):
pass
def handle_PARAMETER_DESCRIPTION(self, data, ps):
# Well, we don't really care -- we're going to send whatever we
# want and let the database deal with it. But thanks anyways!
# count = h_unpack(data)[0]
# type_oids = unpack_from("!" + "i" * count, data, 2)
pass
def handle_COPY_DONE(self, data, ps):
self._copy_done = True
def handle_COPY_OUT_RESPONSE(self, data, ps):
# Int8(1) - 0 textual, 1 binary
# Int16(2) - Number of columns
# Int16(N) - Format codes for each column (0 text, 1 binary)
is_binary, num_cols = bh_unpack(data)
# column_formats = unpack_from('!' + 'h' * num_cols, data, 3)
if ps.stream is None:
raise InterfaceError(
"An output stream is required for the COPY OUT response.")
def handle_COPY_DATA(self, data, ps):
ps.stream.write(data)
def handle_COPY_IN_RESPONSE(self, data, ps):
# Int16(2) - Number of columns
# Int16(N) - Format codes for each column (0 text, 1 binary)
is_binary, num_cols = bh_unpack(data)
# column_formats = unpack_from('!' + 'h' * num_cols, data, 3)
if ps.stream is None:
raise InterfaceError(
"An input stream is required for the COPY IN response.")
if PY2:
while True:
data = ps.stream.read(8192)
if not data:
break
self._write(COPY_DATA + i_pack(len(data) + 4))
self._write(data)
self._flush()
else:
bffr = bytearray(8192)
while True:
bytes_read = ps.stream.readinto(bffr)
if bytes_read == 0:
break
self._write(COPY_DATA + i_pack(bytes_read + 4))
self._write(bffr[:bytes_read])
self._flush()
# Send CopyDone
# Byte1('c') - Identifier.
# Int32(4) - Message length, including self.
self._write(COPY_DONE_MSG)
self._write(SYNC_MSG)
self._flush()
def handle_NOTIFICATION_RESPONSE(self, data, ps):
##
# A message sent if this connection receives a NOTIFY that it was
# LISTENing for.
# <p>
# Stability: Added in pg8000 v1.03. When limited to accessing
# properties from a notification event dispatch, stability is
# guaranteed for v1.xx.
backend_pid = i_unpack(data)[0]
idx = 4
null = data.find(NULL_BYTE, idx) - idx
condition = data[idx:idx + null].decode("ascii")
idx += null + 1
null = data.find(NULL_BYTE, idx) - idx
# additional_info = data[idx:idx + null]
self.notifications.append((backend_pid, condition))
def cursor(self):
"""Creates a :class:`Cursor` object bound to this
connection.
This function is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
return Cursor(self)
def commit(self):
"""Commits the current database transaction.
This function is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
self.execute(self._cursor, "commit", None)
def rollback(self):
"""Rolls back the current database transaction.
This function is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
if not self.in_transaction:
return
self.execute(self._cursor, "rollback", None)
def close(self):
"""Closes the database connection.
This function is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
try:
# Byte1('X') - Identifies the message as a terminate message.
# Int32(4) - Message length, including self.
self._write(TERMINATE_MSG)
self._flush()
self._sock.close()
except AttributeError:
raise InterfaceError("connection is closed")
except ValueError:
raise InterfaceError("connection is closed")
except socket.error:
pass
finally:
self._usock.close()
self._sock = None
def handle_AUTHENTICATION_REQUEST(self, data, cursor):
# Int32 - An authentication code that represents different
# authentication messages:
# 0 = AuthenticationOk
# 5 = MD5 pwd
# 2 = Kerberos v5 (not supported by pg8000)
# 3 = Cleartext pwd
# 4 = crypt() pwd (not supported by pg8000)
# 6 = SCM credential (not supported by pg8000)
# 7 = GSSAPI (not supported by pg8000)
# 8 = GSSAPI data (not supported by pg8000)
# 9 = SSPI (not supported by pg8000)
# Some authentication messages have additional data following the
# authentication code. That data is documented in the appropriate
# class.
auth_code = i_unpack(data)[0]
if auth_code == 0:
pass
elif auth_code == 3:
if self.password is None:
raise InterfaceError(
"server requesting password authentication, but no "
"password was provided")
self._send_message(PASSWORD, self.password + NULL_BYTE)
self._flush()
elif auth_code == 5:
##
# A message representing the backend requesting an MD5 hashed
# password response. The response will be sent as
# md5(md5(pwd + login) + salt).
# Additional message data:
# Byte4 - Hash salt.
salt = b("").join(cccc_unpack(data, 4))
if self.password is None:
raise InterfaceError(
"server requesting MD5 password authentication, but no "
"password was provided")
pwd = b("md5") + md5(
md5(self.password + self.user).hexdigest().encode("ascii") +
salt).hexdigest().encode("ascii")
# Byte1('p') - Identifies the message as a password message.
# Int32 - Message length including self.
# String - The password. Password may be encrypted.
self._send_message(PASSWORD, pwd + NULL_BYTE)
self._flush()
elif auth_code in (2, 4, 6, 7, 8, 9):
raise InterfaceError(
"Authentication method " + str(auth_code) +
" not supported by pg8000.")
else:
raise InterfaceError(
"Authentication method " + str(auth_code) +
" not recognized by pg8000.")
def handle_READY_FOR_QUERY(self, data, ps):
# Byte1 - Status indicator.
self.in_transaction = data != IDLE
def handle_BACKEND_KEY_DATA(self, data, ps):
self._backend_key_data = data
def inspect_datetime(self, value):
if value.tzinfo is None:
return self.py_types[1114] # timestamp
else:
return self.py_types[1184] # send as timestamptz
def inspect_int(self, value):
if min_int2 < value < max_int2:
return self.py_types[21]
if min_int4 < value < max_int4:
return self.py_types[23]
if min_int8 < value < max_int8:
return self.py_types[20]
def make_params(self, values):
params = []
for value in values:
typ = type(value)
try:
params.append(self.py_types[typ])
except KeyError:
try:
params.append(self.inspect_funcs[typ](value))
except KeyError as e:
param = None
for k, v in iteritems(self.py_types):
try:
if isinstance(value, k):
param = v
break
except TypeError:
pass
if param is None:
for k, v in iteritems(self.inspect_funcs):
try:
if isinstance(value, k):
param = v(value)
break
except TypeError:
pass
except KeyError:
pass
if param is None:
raise NotSupportedError(
"type " + str(e) + " not mapped to pg type")
else:
params.append(param)
return tuple(params)
def handle_ROW_DESCRIPTION(self, data, cursor):
count = h_unpack(data)[0]
idx = 2
for i in range(count):
name = data[idx:data.find(NULL_BYTE, idx)]
idx += len(name) + 1
field = dict(
zip((
"table_oid", "column_attrnum", "type_oid", "type_size",
"type_modifier", "format"), ihihih_unpack(data, idx)))
field['name'] = name
idx += 18
cursor.ps['row_desc'].append(field)
field['pg8000_fc'], field['func'] = \
self.pg_types[field['type_oid']]
def execute(self, cursor, operation, vals):
if vals is None:
vals = ()
paramstyle = pg8000.paramstyle
pid = getpid()
try:
cache = self._caches[paramstyle][pid]
except KeyError:
try:
param_cache = self._caches[paramstyle]
except KeyError:
param_cache = self._caches[paramstyle] = {}
try:
cache = param_cache[pid]
except KeyError:
cache = param_cache[pid] = {'statement': {}, 'ps': {}}
try:
statement, make_args = cache['statement'][operation]
except KeyError:
statement, make_args = cache['statement'][operation] = \
convert_paramstyle(paramstyle, operation)
args = make_args(vals)
params = self.make_params(args)
key = operation, params
try:
ps = cache['ps'][key]
cursor.ps = ps
except KeyError:
statement_nums = [0]
for style_cache in itervalues(self._caches):
try:
pid_cache = style_cache[pid]
for csh in itervalues(pid_cache['ps']):
statement_nums.append(csh['statement_num'])
except KeyError:
pass
statement_num = sorted(statement_nums)[-1] + 1
statement_name = '_'.join(
("pg8000", "statement", str(pid), str(statement_num)))
statement_name_bin = statement_name.encode('ascii') + NULL_BYTE
ps = {
'statement_name_bin': statement_name_bin,
'pid': pid,
'statement_num': statement_num,
'row_desc': [],
'param_funcs': tuple(x[2] for x in params)}
cursor.ps = ps
param_fcs = tuple(x[1] for x in params)
# Byte1('P') - Identifies the message as a Parse command.
# Int32 - Message length, including self.
# String - Prepared statement name. An empty string selects the
# unnamed prepared statement.
# String - The query string.
# Int16 - Number of parameter data types specified (can be zero).
# For each parameter:
# Int32 - The OID of the parameter data type.
val = bytearray(statement_name_bin)
val.extend(statement.encode(self._client_encoding) + NULL_BYTE)
val.extend(h_pack(len(params)))
for oid, fc, send_func in params:
# Parse message doesn't seem to handle the -1 type_oid for NULL
# values that other messages handle. So we'll provide type_oid
# 705, the PG "unknown" type.
val.extend(i_pack(705 if oid == -1 else oid))
# Byte1('D') - Identifies the message as a describe command.
# Int32 - Message length, including self.
# Byte1 - 'S' for prepared statement, 'P' for portal.
# String - The name of the item to describe.
self._send_message(PARSE, val)
self._send_message(DESCRIBE, STATEMENT + statement_name_bin)
self._write(SYNC_MSG)
try:
self._flush()
except AttributeError as e:
if self._sock is None:
raise InterfaceError("connection is closed")
else:
raise e
self.handle_messages(cursor)
# We've got row_desc that allows us to identify what we're
# going to get back from this statement.
output_fc = tuple(
self.pg_types[f['type_oid']][0] for f in ps['row_desc'])
ps['input_funcs'] = tuple(f['func'] for f in ps['row_desc'])
# Byte1('B') - Identifies the Bind command.
# Int32 - Message length, including self.
# String - Name of the destination portal.
# String - Name of the source prepared statement.
# Int16 - Number of parameter format codes.
# For each parameter format code:
# Int16 - The parameter format code.
# Int16 - Number of parameter values.
# For each parameter value:
# Int32 - The length of the parameter value, in bytes, not
# including this length. -1 indicates a NULL parameter
# value, in which no value bytes follow.
# Byte[n] - Value of the parameter.
# Int16 - The number of result-column format codes.
# For each result-column format code:
# Int16 - The format code.
ps['bind_1'] = NULL_BYTE + statement_name_bin + \
h_pack(len(params)) + \
pack("!" + "h" * len(param_fcs), *param_fcs) + \
h_pack(len(params))
ps['bind_2'] = h_pack(len(output_fc)) + \
pack("!" + "h" * len(output_fc), *output_fc)
if len(cache['ps']) > self.max_prepared_statements:
for p in itervalues(cache['ps']):
self.close_prepared_statement(p['statement_name_bin'])
cache['ps'].clear()
cache['ps'][key] = ps
cursor._cached_rows.clear()
cursor._row_count = -1
# Byte1('B') - Identifies the Bind command.
# Int32 - Message length, including self.
# String - Name of the destination portal.
# String - Name of the source prepared statement.
# Int16 - Number of parameter format codes.
# For each parameter format code:
# Int16 - The parameter format code.
# Int16 - Number of parameter values.
# For each parameter value:
# Int32 - The length of the parameter value, in bytes, not
# including this length. -1 indicates a NULL parameter
# value, in which no value bytes follow.
# Byte[n] - Value of the parameter.
# Int16 - The number of result-column format codes.
# For each result-column format code:
# Int16 - The format code.
retval = bytearray(ps['bind_1'])
for value, send_func in zip(args, ps['param_funcs']):
if value is None:
val = NULL
else:
val = send_func(value)
retval.extend(i_pack(len(val)))
retval.extend(val)
retval.extend(ps['bind_2'])
self._send_message(BIND, retval)
self.send_EXECUTE(cursor)
self._write(SYNC_MSG)
self._flush()
self.handle_messages(cursor)
def _send_message(self, code, data):
try:
self._write(code)
self._write(i_pack(len(data) + 4))
self._write(data)
self._write(FLUSH_MSG)
except ValueError as e:
if str(e) == "write to closed file":
raise InterfaceError("connection is closed")
else:
raise e
except AttributeError:
raise InterfaceError("connection is closed")
def send_EXECUTE(self, cursor):
# Byte1('E') - Identifies the message as an execute message.
# Int32 - Message length, including self.
# String - The name of the portal to execute.
# Int32 - Maximum number of rows to return, if portal
# contains a query # that returns rows.
# 0 = no limit.
self._write(EXECUTE_MSG)
self._write(FLUSH_MSG)
def handle_NO_DATA(self, msg, ps):
pass
def handle_COMMAND_COMPLETE(self, data, cursor):
values = data[:-1].split(BINARY_SPACE)
command = values[0]
if command in self._commands_with_count:
row_count = int(values[-1])
if cursor._row_count == -1:
cursor._row_count = row_count
else:
cursor._row_count += row_count
if command in DDL_COMMANDS:
for scache in itervalues(self._caches):
for pcache in itervalues(scache):
for ps in itervalues(pcache['ps']):
self.close_prepared_statement(ps['statement_name_bin'])
pcache['ps'].clear()
def handle_DATA_ROW(self, data, cursor):
data_idx = 2
row = []
for func in cursor.ps['input_funcs']:
vlen = i_unpack(data, data_idx)[0]
data_idx += 4
if vlen == -1:
row.append(None)
else:
row.append(func(data, data_idx, vlen))
data_idx += vlen
cursor._cached_rows.append(row)
def handle_messages(self, cursor):
code = self.error = None
while code != READY_FOR_QUERY:
code, data_len = ci_unpack(self._read(5))
self.message_types[code](self._read(data_len - 4), cursor)
if self.error is not None:
raise self.error
# Byte1('C') - Identifies the message as a close command.
# Int32 - Message length, including self.
# Byte1 - 'S' for prepared statement, 'P' for portal.
# String - The name of the item to close.
def close_prepared_statement(self, statement_name_bin):
self._send_message(CLOSE, STATEMENT + statement_name_bin)
self._write(SYNC_MSG)
self._flush()
self.handle_messages(self._cursor)
# Byte1('N') - Identifier
# Int32 - Message length
# Any number of these, followed by a zero byte:
# Byte1 - code identifying the field type (see responseKeys)
# String - field value
def handle_NOTICE_RESPONSE(self, data, ps):
self.notices.append(
dict((s[0:1], s[1:]) for s in data.split(NULL_BYTE)))
def handle_PARAMETER_STATUS(self, data, ps):
pos = data.find(NULL_BYTE)
key, value = data[:pos], data[pos + 1:-1]
self.parameter_statuses.append((key, value))
if key == b("client_encoding"):
encoding = value.decode("ascii").lower()
self._client_encoding = pg_to_py_encodings.get(encoding, encoding)
elif key == b("integer_datetimes"):
if value == b('on'):
self.py_types[1114] = (1114, FC_BINARY, timestamp_send_integer)
self.pg_types[1114] = (FC_BINARY, timestamp_recv_integer)
self.py_types[1184] = (
1184, FC_BINARY, timestamptz_send_integer)
self.pg_types[1184] = (FC_BINARY, timestamptz_recv_integer)
self.py_types[Interval] = (
1186, FC_BINARY, interval_send_integer)
self.py_types[Timedelta] = (
1186, FC_BINARY, interval_send_integer)
self.pg_types[1186] = (FC_BINARY, interval_recv_integer)
else:
self.py_types[1114] = (1114, FC_BINARY, timestamp_send_float)
self.pg_types[1114] = (FC_BINARY, timestamp_recv_float)
self.py_types[1184] = (1184, FC_BINARY, timestamptz_send_float)
self.pg_types[1184] = (FC_BINARY, timestamptz_recv_float)
self.py_types[Interval] = (
1186, FC_BINARY, interval_send_float)
self.py_types[Timedelta] = (
1186, FC_BINARY, interval_send_float)
self.pg_types[1186] = (FC_BINARY, interval_recv_float)
elif key == b("server_version"):
self._server_version = LooseVersion(value.decode('ascii'))
if self._server_version < LooseVersion('8.2.0'):
self._commands_with_count = (
b("INSERT"), b("DELETE"), b("UPDATE"), b("MOVE"),
b("FETCH"))
elif self._server_version < LooseVersion('9.0.0'):
self._commands_with_count = (
b("INSERT"), b("DELETE"), b("UPDATE"), b("MOVE"),
b("FETCH"), b("COPY"))
def array_inspect(self, value):
# Check if array has any values. If empty, we can just assume it's an
# array of strings
first_element = array_find_first_element(value)
if first_element is None:
oid = 25
# Use binary ARRAY format to avoid having to properly
# escape text in the array literals
fc = FC_BINARY
array_oid = pg_array_types[oid]
else:
# supported array output
typ = type(first_element)
if issubclass(typ, integer_types):
# special int array support -- send as smallest possible array
# type
typ = integer_types
int2_ok, int4_ok, int8_ok = True, True, True
for v in array_flatten(value):
if v is None:
continue
if min_int2 < v < max_int2:
continue
int2_ok = False
if min_int4 < v < max_int4:
continue
int4_ok = False
if min_int8 < v < max_int8:
continue
int8_ok = False
if int2_ok:
array_oid = 1005 # INT2[]
oid, fc, send_func = (21, FC_BINARY, h_pack)
elif int4_ok:
array_oid = 1007 # INT4[]
oid, fc, send_func = (23, FC_BINARY, i_pack)
elif int8_ok:
array_oid = 1016 # INT8[]
oid, fc, send_func = (20, FC_BINARY, q_pack)
else:
raise ArrayContentNotSupportedError(
"numeric not supported as array contents")
else:
try:
oid, fc, send_func = self.make_params((first_element,))[0]
# If unknown or string, assume it's a string array
if oid in (705, 1043, 25):
oid = 25
# Use binary ARRAY format to avoid having to properly
# escape text in the array literals
fc = FC_BINARY
array_oid = pg_array_types[oid]
except KeyError:
raise ArrayContentNotSupportedError(
"oid " + str(oid) + " not supported as array contents")
except NotSupportedError:
raise ArrayContentNotSupportedError(
"type " + str(typ) +
" not supported as array contents")
if fc == FC_BINARY:
def send_array(arr):
# check that all array dimensions are consistent
array_check_dimensions(arr)
has_null = array_has_null(arr)
dim_lengths = array_dim_lengths(arr)
data = bytearray(iii_pack(len(dim_lengths), has_null, oid))
for i in dim_lengths:
data.extend(ii_pack(i, 1))
for v in array_flatten(arr):
if v is None:
data += i_pack(-1)
elif isinstance(v, typ):
inner_data = send_func(v)
data += i_pack(len(inner_data))
data += inner_data
else:
raise ArrayContentNotHomogenousError(
"not all array elements are of type " + str(typ))
return data
else:
def send_array(arr):
array_check_dimensions(arr)
ar = deepcopy(arr)
for a, i, v in walk_array(ar):
if v is None:
a[i] = 'NULL'
elif isinstance(v, typ):
a[i] = send_func(v).decode('ascii')
else:
raise ArrayContentNotHomogenousError(
"not all array elements are of type " + str(typ))
return u(str(ar)).translate(arr_trans).encode('ascii')
return (array_oid, fc, send_array)
def xid(self, format_id, global_transaction_id, branch_qualifier):
"""Create a Transaction IDs (only global_transaction_id is used in pg)
format_id and branch_qualifier are not used in postgres
global_transaction_id may be any string identifier supported by
postgres returns a tuple
(format_id, global_transaction_id, branch_qualifier)"""
return (format_id, global_transaction_id, branch_qualifier)
def tpc_begin(self, xid):
"""Begins a TPC transaction with the given transaction ID xid.
This method should be called outside of a transaction (i.e. nothing may
have executed since the last .commit() or .rollback()).
Furthermore, it is an error to call .commit() or .rollback() within the
TPC transaction. A ProgrammingError is raised, if the application calls
.commit() or .rollback() during an active TPC transaction.
This function is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
self._xid = xid
if self.autocommit:
self.execute(self._cursor, "begin transaction", None)
def tpc_prepare(self):
"""Performs the first phase of a transaction started with .tpc_begin().
A ProgrammingError is be raised if this method is called outside of a
TPC transaction.
After calling .tpc_prepare(), no statements can be executed until
.tpc_commit() or .tpc_rollback() have been called.
This function is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
q = "PREPARE TRANSACTION '%s';" % (self._xid[1],)
self.execute(self._cursor, q, None)
def tpc_commit(self, xid=None):
"""When called with no arguments, .tpc_commit() commits a TPC
transaction previously prepared with .tpc_prepare().
If .tpc_commit() is called prior to .tpc_prepare(), a single phase
commit is performed. A transaction manager may choose to do this if
only a single resource is participating in the global transaction.
When called with a transaction ID xid, the database commits the given
transaction. If an invalid transaction ID is provided, a
ProgrammingError will be raised. This form should be called outside of
a transaction, and is intended for use in recovery.
On return, the TPC transaction is ended.
This function is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
if xid is None:
xid = self._xid
if xid is None:
raise ProgrammingError(
"Cannot tpc_commit() without a TPC transaction!")
try:
previous_autocommit_mode = self.autocommit
self.autocommit = True
if xid in self.tpc_recover():
self.execute(
self._cursor, "COMMIT PREPARED '%s';" % (xid[1], ),
None)
else:
# a single-phase commit
self.commit()
finally:
self.autocommit = previous_autocommit_mode
self._xid = None
def tpc_rollback(self, xid=None):
"""When called with no arguments, .tpc_rollback() rolls back a TPC
transaction. It may be called before or after .tpc_prepare().
When called with a transaction ID xid, it rolls back the given
transaction. If an invalid transaction ID is provided, a
ProgrammingError is raised. This form should be called outside of a
transaction, and is intended for use in recovery.
On return, the TPC transaction is ended.
This function is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
if xid is None:
xid = self._xid
if xid is None:
raise ProgrammingError(
"Cannot tpc_rollback() without a TPC prepared transaction!")
try:
previous_autocommit_mode = self.autocommit
self.autocommit = True
if xid in self.tpc_recover():
# a two-phase rollback
self.execute(
self._cursor, "ROLLBACK PREPARED '%s';" % (xid[1],),
None)
else:
# a single-phase rollback
self.rollback()
finally:
self.autocommit = previous_autocommit_mode
self._xid = None
def tpc_recover(self):
"""Returns a list of pending transaction IDs suitable for use with
.tpc_commit(xid) or .tpc_rollback(xid).
This function is part of the `DBAPI 2.0 specification
<http://www.python.org/dev/peps/pep-0249/>`_.
"""
try:
previous_autocommit_mode = self.autocommit
self.autocommit = True
curs = self.cursor()
curs.execute("select gid FROM pg_prepared_xacts")
return [self.xid(0, row[0], '') for row in curs]
finally:
self.autocommit = previous_autocommit_mode
# pg element oid -> pg array typeoid
pg_array_types = {
16: 1000,
25: 1009, # TEXT[]
701: 1022,
1043: 1009,
1700: 1231, # NUMERIC[]
}
# PostgreSQL encodings:
# http://www.postgresql.org/docs/8.3/interactive/multibyte.html
# Python encodings:
# http://www.python.org/doc/2.4/lib/standard-encodings.html
#
# Commented out encodings don't require a name change between PostgreSQL and
# Python. If the py side is None, then the encoding isn't supported.
pg_to_py_encodings = {
# Not supported:
"mule_internal": None,
"euc_tw": None,
# Name fine as-is:
# "euc_jp",
# "euc_jis_2004",
# "euc_kr",
# "gb18030",
# "gbk",
# "johab",
# "sjis",
# "shift_jis_2004",
# "uhc",
# "utf8",
# Different name:
"euc_cn": "gb2312",
"iso_8859_5": "is8859_5",
"iso_8859_6": "is8859_6",
"iso_8859_7": "is8859_7",
"iso_8859_8": "is8859_8",
"koi8": "koi8_r",
"latin1": "iso8859-1",
"latin2": "iso8859_2",
"latin3": "iso8859_3",
"latin4": "iso8859_4",
"latin5": "iso8859_9",
"latin6": "iso8859_10",
"latin7": "iso8859_13",
"latin8": "iso8859_14",
"latin9": "iso8859_15",
"sql_ascii": "ascii",
"win866": "cp886",
"win874": "cp874",
"win1250": "cp1250",
"win1251": "cp1251",
"win1252": "cp1252",
"win1253": "cp1253",
"win1254": "cp1254",
"win1255": "cp1255",
"win1256": "cp1256",
"win1257": "cp1257",
"win1258": "cp1258",
"unicode": "utf-8", # Needed for Amazon Redshift
}
def walk_array(arr):
for i, v in enumerate(arr):
if isinstance(v, list):
for a, i2, v2 in walk_array(v):
yield a, i2, v2
else:
yield arr, i, v
def array_find_first_element(arr):
for v in array_flatten(arr):
if v is not None:
return v
return None
def array_flatten(arr):
for v in arr:
if isinstance(v, list):
for v2 in array_flatten(v):
yield v2
else:
yield v
def array_check_dimensions(arr):
if len(arr) > 0:
v0 = arr[0]
if isinstance(v0, list):
req_len = len(v0)
req_inner_lengths = array_check_dimensions(v0)
for v in arr:
inner_lengths = array_check_dimensions(v)
if len(v) != req_len or inner_lengths != req_inner_lengths:
raise ArrayDimensionsNotConsistentError(
"array dimensions not consistent")
retval = [req_len]
retval.extend(req_inner_lengths)
return retval
else:
# make sure nothing else at this level is a list
for v in arr:
if isinstance(v, list):
raise ArrayDimensionsNotConsistentError(
"array dimensions not consistent")
return []
def array_has_null(arr):
for v in array_flatten(arr):
if v is None:
return True
return False
def array_dim_lengths(arr):
len_arr = len(arr)
if len_arr > 0:
v0 = arr[0]
if isinstance(v0, list):
retval = [len(v0)]
retval.extend(array_dim_lengths(v0))
return retval
return [len_arr]
================================================
FILE: setup.cfg
================================================
[upload_docs]
upload-dir = build/sphinx/html
[bdist_wheel]
universal=1
[versioneer]
VCS = git
style = pep440
versionfile_source = pg8000/_version.py
versionfile_build = pg8000/_version.py
tag_prefix =
parentdir_prefix = pg8000-
================================================
FILE: setup.py
================================================
#!/usr/bin/env python
import versioneer
from setuptools import setup
long_description = """\
pg8000
------
pg8000 is a Pure-Python interface to the PostgreSQL database engine. It is \
one of many PostgreSQL interfaces for the Python programming language. pg8000 \
is somewhat distinctive in that it is written entirely in Python and does not \
rely on any external libraries (such as a compiled python module, or \
PostgreSQL's libpq library). pg8000 supports the standard Python DB-API \
version 2.0.
pg8000's name comes from the belief that it is probably about the 8000th \
PostgreSQL interface for Python."""
cmdclass = dict(versioneer.get_cmdclass())
version = versioneer.get_version()
setup(
name="pg8000",
version=version,
cmdclass=cmdclass,
description="PostgreSQL interface library",
long_description=long_description,
author="Mathieu Fenniak",
author_email="biziqe@mathieu.fenniak.net",
url="https://github.com/mfenniak/pg8000",
license="BSD",
install_requires=[
"six>=1.10.0",
],
classifiers=[
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"License :: OSI Approved :: BSD License",
"Programming Language :: Python",
"Programming Language :: Python :: 2",
"Programming Language :: Python :: 2.7",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.3",
"Programming Language :: Python :: 3.4",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: Implementation",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: Jython",
"Programming Language :: Python :: Implementation :: PyPy",
"Operating System :: OS Independent",
"Topic :: Database :: Front-Ends",
"Topic :: Software Development :: Libraries :: Python Modules",
],
keywords="postgresql dbapi",
packages=("pg8000",),
command_options={
'build_sphinx': {
'version': ('setup.py', version),
'release': ('setup.py', version)}},
)
================================================
FILE: tests/connection_settings.py
================================================
db_connect = {
'user': 'postgres',
'password': 'pw',
'port': 5432}
================================================
FILE: tests/dbapi20.py
================================================
#!/usr/bin/env python
import unittest
import time
import warnings
from six import b
''' Python DB API 2.0 driver compliance unit test suite.
This software is Public Domain and may be used without restrictions.
"Now we have booze and barflies entering the discussion, plus rumours of
DBAs on drugs... and I won't tell you what flashes through my mind each
time I read the subject line with 'Anal Compliance' in it. All around
this is turning out to be a thoroughly unwholesome unit test."
-- Ian Bicking
'''
__rcs_id__ = '$Id: dbapi20.py,v 1.10 2003/10/09 03:14:14 zenzen Exp $'
__version__ = '$Revision: 1.10 $'[11:-2]
__author__ = 'Stuart Bishop <zen@shangri-la.dropbear.id.au>'
# $Log: dbapi20.py,v $
# Revision 1.10 2003/10/09 03:14:14 zenzen
# Add test for DB API 2.0 optional extension, where database exceptions
# are exposed as attributes on the Connection object.
#
# Revision 1.9 2003/08/13 01:16:36 zenzen
# Minor tweak from Stefan Fleiter
#
# Revision 1.8 2003/04/10 00:13:25 zenzen
# Changes, as per suggestions by M.-A. Lemburg
# - Add a table prefix, to ensure namespace collisions can always be avoided
#
# Revision 1.7 2003/02/26 23:33:37 zenzen
# Break out DDL into helper functions, as per request by David Rushby
#
# Revision 1.6 2003/02/21 03:04:33 zenzen
# Stuff from Henrik Ekelund:
# added test_None
# added test_nextset & hooks
#
# Revision 1.5 2003/02/17 22:08:43 zenzen
# Implement suggestions and code from Henrik Eklund - test that
# cursor.arraysize defaults to 1 & generic cursor.callproc test added
#
# Revision 1.4 2003/02/15 00:16:33 zenzen
# Changes, as per suggestions and bug reports by M.-A. Lemburg,
# Matthew T. Kromer, Federico Di Gregorio and Daniel Dittmar
# - Class renamed
# - Now a subclass of TestCase, to avoid requiring the driver stub
# to use multiple inheritance
# - Reversed the polarity of buggy test in test_description
# - Test exception heirarchy correctly
# - self.populate is now self._populate(), so if a driver stub
# overrides self.ddl1 this change propogates
# - VARCHAR columns now have a width, which will hopefully make the
# DDL even more portible (this will be reversed if it causes more problems)
# - cursor.rowcount being checked after various execute and fetchXXX methods
# - Check for fetchall and fetchmany returning empty lists after results
# are exhausted (already checking for empty lists if select retrieved
# nothing
# - Fix bugs in test_setoutputsize_basic and test_setinputsizes
#
class DatabaseAPI20Test(unittest.TestCase):
''' Test a database self.driver for DB API 2.0 compatibility.
This implementation tests Gadfly, but the TestCase
is structured so that other self.drivers can subclass this
test case to ensure compiliance with the DB-API. It is
expected that this TestCase may be expanded in the future
if ambiguities or edge conditions are discovered.
The 'Optional Extensions' are not yet being tested.
self.drivers should subclass this test, overriding setUp, tearDown,
self.driver, connect_args and connect_kw_args. Class specification
should be as follows:
import dbapi20
class mytest(dbapi20.DatabaseAPI20Test):
[...]
Don't 'import DatabaseAPI20Test from dbapi20', or you will
confuse the unit tester - just 'import dbapi20'.
'''
# The self.driver module. This should be the module where the 'connect'
# method is to be found
driver = None
connect_args = () # List of arguments to pass to connect
connect_kw_args = {} # Keyword arguments for connect
table_prefix = 'dbapi20test_' # If you need to specify a prefix for tables
ddl1 = 'create table %sbooze (name varchar(20))' % table_prefix
ddl2 = 'create table %sbarflys (name varchar(20))' % table_prefix
xddl1 = 'drop table %sbooze' % table_prefix
xddl2 = 'drop table %sbarflys' % table_prefix
# Name of stored procedure to convert
# string->lowercase
lowerfunc = 'lower'
# Some drivers may need to override these helpers, for example adding
# a 'commit' after the execute.
def executeDDL1(self, cursor):
cursor.execute(self.ddl1)
def executeDDL2(self, cursor):
cursor.execute(self.ddl2)
def setUp(self):
''' self.drivers should override this method to perform required setup
if any is necessary, such as creating the database.
'''
pass
def tearDown(self):
''' self.drivers should override this method to perform required
cleanup if any is necessary, such as deleting the test database.
The default drops the tables that may be created.
'''
con = self._connect()
try:
cur = con.cursor()
for ddl in (self.xddl1, self.xddl2):
try:
cur.execute(ddl)
con.commit()
except self.driver.Error:
# Assume table didn't exist. Other tests will check if
# execute is busted.
pass
finally:
con.close()
def _connect(self):
try:
return self.driver.connect(
*self.connect_args, **self.connect_kw_args)
except AttributeError:
self.fail("No connect method found in self.driver module")
def test_connect(self):
con = self._connect()
con.close()
def test_apilevel(self):
try:
# Must exist
apilevel = self.driver.apilevel
# Must equal 2.0
self.assertEqual(apilevel, '2.0')
except AttributeError:
self.fail("Driver doesn't define apilevel")
def test_threadsafety(self):
try:
# Must exist
threadsafety = self.driver.threadsafety
# Must be a valid value
self.assertEqual(threadsafety in (0, 1, 2, 3), True)
except AttributeError:
self.fail("Driver doesn't define threadsafety")
def test_paramstyle(self):
try:
# Must exist
paramstyle = self.driver.paramstyle
# Must be a valid value
self.assertEqual(
paramstyle in (
'qmark', 'numeric', 'named', 'format', 'pyformat'), True)
except AttributeError:
self.fail("Driver doesn't define paramstyle")
def test_Exceptions(self):
# Make sure required exceptions exist, and are in the
# defined heirarchy.
self.assertEqual(issubclass(self.driver.Warning, Exception), True)
self.assertEqual(issubclass(self.driver.Error, Exception), True)
self.assertEqual(
issubclass(self.driver.InterfaceError, self.driver.Error), True)
self.assertEqual(
issubclass(self.driver.DatabaseError, self.driver.Error), True)
self.assertEqual(
issubclass(self.driver.OperationalError, self.driver.Error), True)
self.assertEqual(
issubclass(self.driver.IntegrityError, self.driver.Error), True)
self.assertEqual(
issubclass(self.driver.InternalError, self.driver.Error), True)
self.assertEqual(
issubclass(self.driver.ProgrammingError, self.driver.Error), True)
self.assertEqual(
issubclass(self.driver.NotSupportedError, self.driver.Error), True)
def test_ExceptionsAsConnectionAttributes(self):
# OPTIONAL EXTENSION
# Test for the optional DB API 2.0 extension, where the exceptions
# are exposed as attributes on the Connection object
# I figure this optional extension will be implemented by any
# driver author who is using this test suite, so it is enabled
# by default.
warnings.simplefilter("ignore")
con = self._connect()
drv = self.driver
self.assertEqual(con.Warning is drv.Warning, True)
self.assertEqual(con.Error is drv.Error, True)
self.assertEqual(con.InterfaceError is drv.InterfaceError, True)
self.assertEqual(con.DatabaseError is drv.DatabaseError, True)
self.assertEqual(con.OperationalError is drv.OperationalError, True)
self.assertEqual(con.IntegrityError is drv.IntegrityError, True)
self.assertEqual(con.InternalError is drv.InternalError, True)
self.assertEqual(con.ProgrammingError is drv.ProgrammingError, True)
self.assertEqual(con.NotSupportedError is drv.NotSupportedError, True)
warnings.resetwarnings()
con.close()
def test_commit(self):
con = self._connect()
try:
# Commit must work, even if it doesn't do anything
con.commit()
finally:
con.close()
def test_rollback(self):
con = self._connect()
# If rollback is defined, it should either work or throw
# the documented exception
if hasattr(con, 'rollback'):
try:
con.rollback()
except self.driver.NotSupportedError:
pass
con.close()
def test_cursor(self):
con = self._connect()
try:
con.cursor()
finally:
con.close()
def test_cursor_isolation(self):
con = self._connect()
try:
# Make sure cursors created from the same connection have
# the documented transaction isolation level
cur1 = con.cursor()
cur2 = con.cursor()
self.executeDDL1(cur1)
cur1.execute(
"insert into %sbooze values ('Victoria Bitter')" % (
self.table_prefix))
cur2.execute("select name from %sbooze" % self.table_prefix)
booze = cur2.fetchall()
self.assertEqual(len(booze), 1)
self.assertEqual(len(booze[0]), 1)
self.assertEqual(booze[0][0], 'Victoria Bitter')
finally:
con.close()
def test_description(self):
con = self._connect()
try:
cur = con.cursor()
self.executeDDL1(cur)
self.assertEqual(
cur.description, None,
'cursor.description should be none after executing a '
'statement that can return no rows (such as DDL)')
cur.execute('select name from %sbooze' % self.table_prefix)
self.assertEqual(
len(cur.description), 1,
'cursor.description describes too many columns')
self.assertEqual(
len(cur.description[0]), 7,
'cursor.description[x] tuples must have 7 elements')
self.assertEqual(
cur.description[0][0].lower(), b('name'),
'cursor.description[x][0] must return column name')
self.assertEqual(
cur.description[0][1], self.driver.STRING,
'cursor.description[x][1] must return column type. Got %r'
% cur.description[0][1])
# Make sure self.description gets reset
self.executeDDL2(cur)
self.assertEqual(
cur.description, None,
'cursor.description not being set to None when executing '
'no-result statements (eg. DDL)')
finally:
con.close()
def test_rowcount(self):
con = self._connect()
try:
cur = con.cursor()
self.executeDDL1(cur)
self.assertEqual(
cur.rowcount, -1,
'cursor.rowcount should be -1 after executing no-result '
'statements')
cur.execute(
"insert into %sbooze values ('Victoria Bitter')" % (
self.table_prefix))
self.assertEqual(
cur.rowcount in (-1, 1), True,
'cursor.rowcount should == number or rows inserted, or '
'set to -1 after executing an insert statement')
cur.execute("select name from %sbooze" % self.table_prefix)
self.assertEqual(
cur.rowcount in (-1, 1), True,
'cursor.rowcount should == number of rows returned, or '
'set to -1 after executing a select statement')
self.executeDDL2(cur)
self.assertEqual(
cur.rowcount, -1,
'cursor.rowcount not being reset to -1 after executing '
'no-result statements')
finally:
con.close()
lower_func = 'lower'
def test_callproc(self):
con = self._connect()
try:
cur = con.cursor()
if self.lower_func and hasattr(cur, 'callproc'):
r = cur.callproc(self.lower_func, ('FOO',))
self.assertEqual(len(r), 1)
self.assertEqual(r[0], 'FOO')
r = cur.fetchall()
self.assertEqual(len(r), 1, 'callproc produced no result set')
self.assertEqual(
len(r[0]), 1, 'callproc produced invalid result set')
self.assertEqual(
r[0][0], 'foo', 'callproc produced invalid results')
finally:
con.close()
def test_close(self):
con = self._connect()
try:
cur = con.cursor()
finally:
con.close()
# cursor.execute should raise an Error if called after connection
# closed
self.assertRaises(self.driver.Error, self.executeDDL1, cur)
# connection.commit should raise an Error if called after connection'
# closed.'
self.assertRaises(self.driver.Error, con.commit)
# connection.close should raise an Error if called more than once
self.assertRaises(self.driver.Error, con.close)
def test_execute(self):
con = self._connect()
try:
cur = con.cursor()
self._paraminsert(cur)
finally:
con.close()
def _paraminsert(self, cur):
self.executeDDL1(cur)
cur.execute("insert into %sbooze values ('Victoria Bitter')" % (
self.table_prefix))
self.assertEqual(cur.rowcount in (-1, 1), True)
if self.driver.paramstyle == 'qmark':
cur.execute(
'insert into %sbooze values (?)' % self.table_prefix,
("Cooper's",))
elif self.driver.paramstyle == 'numeric':
cur.execute(
'insert into %sbooze values (:1)' % self.table_prefix,
("Cooper's",))
elif self.driver.paramstyle == 'named':
cur.execute(
'insert into %sbooze values (:beer)' % self.table_prefix,
{'beer': "Cooper's"})
elif self.driver.paramstyle == 'format':
cur.execute(
'insert into %sbooze values (%%s)' % self.table_prefix,
("Cooper's",))
elif self.driver.paramstyle == 'pyformat':
cur.execute(
'insert into %sbooze values (%%(beer)s)' % self.table_prefix,
{'beer': "Cooper's"})
else:
self.fail('Invalid paramstyle')
self.assertEqual(cur.rowcount in (-1, 1), True)
cur.execute('select name from %sbooze' % self.table_prefix)
res = cur.fetchall()
self.assertEqual(
len(res), 2, 'cursor.fetchall returned too few rows')
beers = [res[0][0], res[1][0]]
beers.sort()
self.assertEqual(
beers[0], "Cooper's",
'cursor.fetchall retrieved incorrect data, or data inserted '
'incorrectly')
self.assertEqual(
beers[1], "Victoria Bitter",
'cursor.fetchall retrieved incorrect data, or data inserted '
'incorrectly')
def test_executemany(self):
con = self._connect()
try:
cur = con.cursor()
self.executeDDL1(cur)
largs = [("Cooper's",), ("Boag's",)]
margs = [{'beer': "Cooper's"}, {'beer': "Boag's"}]
if self.driver.paramstyle == 'qmark':
cur.executemany(
'insert into %sbooze values (?)' % self.table_prefix,
largs
)
elif self.driver.paramstyle == 'numeric':
cur.executemany(
'insert into %sbooze values (:1)' % self.table_prefix,
largs
)
elif self.driver.paramstyle == 'named':
cur.executemany(
'insert into %sbooze values (:beer)' % self.table_prefix,
margs
)
elif self.driver.paramstyle == 'format':
cur.executemany(
'insert into %sbooze values (%%s)' % self.table_prefix,
largs
)
elif self.driver.paramstyle == 'pyformat':
cur.executemany(
'insert into %sbooze values (%%(beer)s)' % (
self.table_prefix), margs)
else:
self.fail('Unknown paramstyle')
self.assertEqual(
cur.rowcount in (-1, 2), True,
'insert using cursor.executemany set cursor.rowcount to '
'incorrect value %r' % cur.rowcount)
cur.execute('select name from %sbooze' % self.table_prefix)
res = cur.fetchall()
self.assertEqual(
len(res), 2,
'cursor.fetchall retrieved incorrect number of rows')
beers = [res[0][0], res[1][0]]
beers.sort()
self.assertEqual(beers[0], "Boag's", 'incorrect data retrieved')
self.assertEqual(beers[1], "Cooper's", 'incorrect data retrieved')
finally:
con.close()
def test_fetchone(self):
con = self._connect()
try:
cur = con.cursor()
# cursor.fetchone should raise an Error if called before
# executing a select-type query
self.assertRaises(self.driver.Error, cur.fetchone)
# cursor.fetchone should raise an Error if called after
# executing a query that cannnot return rows
self.executeDDL1(cur)
self.assertRaises(self.driver.Error, cur.fetchone)
cur.execute('select name from %sbooze' % self.table_prefix)
self.assertEqual(
cur.fetchone(), None,
'cursor.fetchone should return None if a query retrieves '
'no rows')
self.assertEqual(cur.rowcount in (-1, 0), True)
# cursor.fetchone should raise an Error if called after
# executing a query that cannnot return rows
cur.execute(
"insert into %sbooze values ('Victoria Bitter')" % (
self.table_prefix))
self.assertRaises(self.driver.Error, cur.fetchone)
cur.execute('select name from %sbooze' % self.table_prefix)
r = cur.fetchone()
self.assertEqual(
len(r), 1,
'cursor.fetchone should have retrieved a single row')
self.assertEqual(
r[0], 'Victoria Bitter',
'cursor.fetchone retrieved incorrect data')
self.assertEqual(
cur.fetchone(), None,
'cursor.fetchone should return None if no more rows available')
self.assertEqual(cur.rowcount in (-1, 1), True)
finally:
con.close()
samples = [
'Carlton Cold',
'Carlton Draft',
'Mountain Goat',
'Redback',
'Victoria Bitter',
'XXXX'
]
def _populate(self):
''' Return a list of sql commands to setup the DB for the fetch
tests.
'''
populate = [
"insert into %sbooze values ('%s')" % (self.table_prefix, s)
for s in self.samples]
return populate
def test_fetchmany(self):
con = self._connect()
try:
cur = con.cursor()
# cursor.fetchmany should raise an Error if called without
# issuing a query
self.assertRaises(self.driver.Error, cur.fetchmany, 4)
self.executeDDL1(cur)
for sql in self._populate():
cur.execute(sql)
cur.execute('select name from %sbooze' % self.table_prefix)
r = cur.fetchmany()
self.assertEqual(
len(r), 1,
'cursor.fetchmany retrieved incorrect number of rows, '
'default of arraysize is one.')
cur.arraysize = 10
r = cur.fetchmany(3) # Should get 3 rows
self.assertEqual(
len(r), 3,
'cursor.fetchmany retrieved incorrect number of rows')
r = cur.fetchmany(4) # Should get 2 more
self.assertEqual(
len(r), 2,
'cursor.fetchmany retrieved incorrect number of rows')
r = cur.fetchmany(4) # Should be an empty sequence
self.assertEqual(
len(r), 0,
'cursor.fetchmany should return an empty sequence after '
'results are exhausted')
self.assertEqual(cur.rowcount in (-1, 6), True)
# Same as above, using cursor.arraysize
cur.arraysize = 4
cur.execute('select name from %sbooze' % self.table_prefix)
r = cur.fetchmany() # Should get 4 rows
self.assertEqual(
len(r), 4,
'cursor.arraysize not being honoured by fetchmany')
r = cur.fetchmany() # Should get 2 more
self.assertEqual(len(r), 2)
r = cur.fetchmany() # Should be an empty sequence
self.assertEqual(len(r), 0)
self.assertEqual(cur.rowcount in (-1, 6), True)
cur.arraysize = 6
cur.execute('select name from %sbooze' % self.table_prefix)
rows = cur.fetchmany() # Should get all rows
self.assertEqual(cur.rowcount in (-1, 6), True)
self.assertEqual(len(rows), 6)
self.assertEqual(len(rows), 6)
rows = [row[0] for row in rows]
rows.sort()
# Make sure we get the right data back out
for i in range(0, 6):
self.assertEqual(
rows[i], self.samples[i],
'incorrect data retrieved by cursor.fetchmany')
rows = cur.fetchmany() # Should return an empty list
self.assertEqual(
len(rows), 0,
'cursor.fetchmany should return an empty sequence if '
'called after the whole result set has been fetched')
self.assertEqual(cur.rowcount in (-1, 6), True)
self.executeDDL2(cur)
cur.execute('select name from %sbarflys' % self.table_prefix)
r = cur.fetchmany() # Should get empty sequence
self.assertEqual(
len(r), 0,
'cursor.fetchmany should return an empty sequence if '
'query retrieved no rows')
self.assertEqual(cur.rowcount in (-1, 0), True)
finally:
con.close()
def test_fetchall(self):
con = self._connect()
try:
cur = con.cursor()
# cursor.fetchall should raise an Error if called
# without executing a query that may return rows (such
# as a select)
self.assertRaises(self.driver.Error, cur.fetchall)
self.executeDDL1(cur)
for sql in self._populate():
cur.execute(sql)
# cursor.fetchall should raise an Error if called
# after executing a a statement that cannot return rows
self.assertRaises(self.driver.Error, cur.fetchall)
cur.execute('select name from %sbooze' % self.table_prefix)
rows = cur.fetchall()
self.assertEqual(cur.rowcount in (-1, len(self.samples)), True)
self.assertEqual(
len(rows), len(self.samples),
'cursor.fetchall did not retrieve all rows')
rows = [r[0] for r in rows]
rows.sort()
for i in range(0, len(self.samples)):
self.assertEqual(
rows[i], self.samples[i],
'cursor.fetchall retrieved incorrect rows')
rows = cur.fetchall()
self.assertEqual(
len(rows), 0,
'cursor.fetchall should return an empty list if called '
'after the whole result set has been fetched')
self.assertEqual(cur.rowcount in (-1, len(self.samples)), True)
self.executeDDL2(cur)
cur.execute('select name from %sbarflys' % self.table_prefix)
rows = cur.fetchall()
self.assertEqual(cur.rowcount in (-1, 0), True)
self.assertEqual(
len(rows), 0,
'cursor.fetchall should return an empty list if '
'a select query returns no rows')
finally:
con.close()
def test_mixedfetch(self):
con = self._connect()
try:
cur = con.cursor()
self.executeDDL1(cur)
for sql in self._populate():
cur.execute(sql)
cur.execute('select name from %sbooze' % self.table_prefix)
rows1 = cur.fetchone()
rows23 = cur.fetchmany(2)
rows4 = cur.fetchone()
rows56 = cur.fetchall()
self.assertEqual(cur.rowcount in (-1, 6), True)
self.assertEqual(
len(rows23), 2, 'fetchmany returned incorrect number of rows')
self.assertEqual(
len(rows56), 2, 'fetchall returned incorrect number of rows')
rows = [rows1[0]]
rows.extend([rows23[0][0], rows23[1][0]])
rows.append(rows4[0])
rows.extend([rows56[0][0], rows56[1][0]])
rows.sort()
for i in range(0, len(self.samples)):
self.assertEqual(
rows[i], self.samples[i],
'incorrect data retrieved or inserted')
finally:
con.close()
def help_nextset_setUp(self, cur):
''' Should create a procedure called deleteme
that returns two result sets, first the
number of rows in booze then "name from booze"
'''
raise NotImplementedError('Helper not implemented')
def help_nextset_tearDown(self, cur):
'If cleaning up is needed after nextSetTest'
raise NotImplementedError('Helper not implemented')
def test_nextset(self):
con = self._connect()
try:
cur = con.cursor()
if not hasattr(cur, 'nextset'):
return
try:
self.executeDDL1(cur)
sql = self._populate()
for sql in self._populate():
cur.execute(sql)
self.help_nextset_setUp(cur)
cur.callproc('deleteme')
numberofrows = cur.fetchone()
assert numberofrows[0] == len(self.samples)
assert cur.nextset()
names = cur.fetchall()
assert len(names) == len(self.samples)
s = cur.nextset()
assert s is None, 'No more return sets, should return None'
finally:
self.help_nextset_tearDown(cur)
finally:
con.close()
'''
def test_nextset(self):
raise NotImplementedError('Drivers need to override this test')
'''
def test_arraysize(self):
# Not much here - rest of the tests for this are in test_fetchmany
con = self._connect()
try:
cur = con.cursor()
self.assertEqual(
hasattr(cur, 'arraysize'), True,
'cursor.arraysize must be defined')
finally:
con.close()
def test_setinputsizes(self):
con = self._connect()
try:
cur = con.cursor()
cur.setinputsizes((25,))
self._paraminsert(cur) # Make sure cursor still works
finally:
con.close()
def test_setoutputsize_basic(self):
# Basic test is to make sure setoutputsize doesn't blow up
con = self._connect()
try:
cur = con.cursor()
cur.setoutputsize(1000)
cur.setoutputsize(2000, 0)
self._paraminsert(cur) # Make sure the cursor still works
finally:
con.close()
def test_setoutputsize(self):
# Real test for setoutputsize is driver dependant
raise NotImplementedError('Driver need to override this test')
def test_None(self):
con = self._connect()
try:
cur = con.cursor()
self.executeDDL1(cur)
cur.execute(
'insert into %sbooze values (NULL)' % self.table_prefix)
cur.execute('select name from %sbooze' % self.table_prefix)
r = cur.fetchall()
self.assertEqual(len(r), 1)
self.assertEqual(len(r[0]), 1)
self.assertEqual(r[0][0], None, 'NULL value not returned as None')
finally:
con.close()
def test_Date(self):
self.driver.Date(2002, 12, 25)
self.driver.DateFromTicks(
time.mktime((2002, 12, 25, 0, 0, 0, 0, 0, 0)))
# Can we assume this? API doesn't specify, but it seems implied
# self.assertEqual(str(d1),str(d2))
def test_Time(self):
self.driver.Time(13, 45, 30)
self.driver.TimeFromTicks(
time.mktime((2001, 1, 1, 13, 45, 30, 0, 0, 0)))
# Can we assume this? API doesn't specify, but it seems implied
# self.assertEqual(str(t1),str(t2))
def test_Timestamp(self):
self.driver.Timestamp(2002, 12, 25, 13, 45, 30)
self.driver.TimestampFromTicks(
time.mktime((2002, 12, 25, 13, 45, 30, 0, 0, 0)))
# Can we assume this? API doesn't specify, but it seems implied
# self.assertEqual(str(t1),str(t2))
def test_Binary(self):
self.driver.Binary(b('Something'))
self.driver.Binary(b(''))
def test_STRING(self):
self.assertEqual(
hasattr(self.driver, 'STRING'), True,
'module.STRING must be defined')
def test_BINARY(self):
self.assertEqual(
hasattr(self.driver, 'BINARY'), True,
'module.BINARY must be defined.')
def test_NUMBER(self):
self.assertTrue(
hasattr(self.driver, 'NUMBER'), 'module.NUMBER must be defined.')
def test_DATETIME(self):
self.assertEqual(
hasattr(self.driver, 'DATETIME'), True,
'module.DATETIME must be defined.')
def test_ROWID(self):
self.assertEqual(
hasattr(self.driver, 'ROWID'), True,
'module.ROWID must be defined.')
================================================
FILE: tests/performance.py
================================================
import pg8000
from pg8000.tests.connection_settings import db_connect
import time
import warnings
from contextlib import closing
from decimal import Decimal
whole_begin_time = time.time()
tests = (
("cast(id / 100 as int2)", 'int2'),
("cast(id as int4)", 'int4'),
("cast(id * 100 as int8)", 'int8'),
("(id %% 2) = 0", 'bool'),
("N'Static text string'", 'txt'),
("cast(id / 100 as float4)", 'float4'),
("cast(id / 100 as float8)", 'float8'),
("cast(id / 100 as numeric)", 'numeric'),
("timestamp '2001-09-28' + id * interval '1 second'", 'timestamp'),
)
with warnings.catch_warnings(), closing(pg8000.connect(**db_connect)) as db:
for txt, name in tests:
query = """SELECT {0} AS column1, {0} AS column2, {0} AS column3,
{0} AS column4, {0} AS column5, {0} AS column6, {0} AS column7
FROM (SELECT generate_series(1, 10000) AS id) AS tbl""".format(txt)
cursor = db.cursor()
print("Beginning %s test..." % name)
for i in range(1, 5):
begin_time = time.time()
cursor.execute(query)
for row in cursor:
pass
end_time = time.time()
print("Attempt %s - %s seconds." % (i, end_time - begin_time))
db.commit()
cursor = db.cursor()
cursor.execute(
"CREATE TEMPORARY TABLE t1 (f1 serial primary key, "
"f2 bigint not null, f3 varchar(50) null, f4 bool)")
db.commit()
params = [(Decimal('7.4009'), 'season of mists...', True)] * 1000
print("Beginning executemany test...")
for i in range(1, 5):
begin_time = time.time()
cursor.executemany(
"insert into t1 (f2, f3, f4) values (%s, %s, %s)", params)
db.commit()
end_time = time.time()
print("Attempt {0} took {1} seconds.".format(i, end_time - begin_time))
print("Beginning reuse statements test...")
begin_time = time.time()
for i in range(2000):
cursor.execute("select count(*) from t1")
cursor.fetchall()
print("Took {0} seconds.".format(time.time() - begin_time))
print("Whole time - %s seconds." % (time.time() - whole_begin_time))
================================================
FILE: tests/stress.py
================================================
import pg8000
from pg8000.tests.connection_settings import db_connect
from contextlib import closing
with closing(pg8000.connect(**db_connect)) as db:
for i in range(100):
cursor = db.cursor()
cursor.execute("""
SELECT n.nspname as "Schema",
pg_catalog.format_type(t.oid, NULL) AS "Name",
pg_catalog.obj_description(t.oid, 'pg_type') as "Description"
FROM pg_catalog.pg_type t
LEFT JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace
left join pg_catalog.pg_namespace kj on n.oid = t.typnamespace
WHERE (t.typrelid = 0
OR (SELECT c.relkind = 'c'
FROM pg_catalog.pg_class c WHERE c.oid = t.typrelid))
AND NOT EXISTS(
SELECT 1 FROM pg_catalog.pg_type el
WHERE el.oid = t.typelem AND el.typarray = t.oid)
AND pg_catalog.pg_type_is_visible(t.oid)
ORDER BY 1, 2;""")
================================================
FILE: tests/test_connection.py
================================================
import unittest
import pg8000
from connection_settings import db_connect
from six import PY2, u
import sys
from distutils.version import LooseVersion
import socket
import struct
# Check if running in Jython
if 'java' in sys.platform:
from javax.net.ssl import TrustManager, X509TrustManager
from jarray import array
from javax.net.ssl import SSLContext
class TrustAllX509TrustManager(X509TrustManager):
'''Define a custom TrustManager which will blindly accept all
certificates'''
def checkClientTrusted(self, chain, auth):
pass
def checkServerTrusted(self, chain, auth):
pass
def getAcceptedIssuers(self):
return None
# Create a static reference to an SSLContext which will use
# our custom TrustManager
trust_managers = array([TrustAllX509TrustManager()], TrustManager)
TRUST_ALL_CONTEXT = SSLContext.getInstance("SSL")
TRUST_ALL_CONTEXT.init(None, trust_managers, None)
# Keep a static reference to the JVM's default SSLContext for restoring
# at a later time
DEFAULT_CONTEXT = SSLContext.getDefault()
def trust_all_certificates(f):
'''Decorator function that will make it so the context of the decorated
method will run with our TrustManager that accepts all certificates'''
def wrapped(*args, **kwargs):
# Only do this if running under Jython
if 'java' in sys.platform:
from javax.net.ssl import SSLContext
SSLContext.setDefault(TRUST_ALL_CONTEXT)
try:
res = f(*args, **kwargs)
return res
finally:
SSLContext.setDefault(DEFAULT_CONTEXT)
else:
return f(*args, **kwargs)
return wrapped
# Tests related to connecting to a database.
class Tests(unittest.TestCase):
def testSocketMissing(self):
conn_params = {
'unix_sock': "/file-does-not-exist",
'user': "doesn't-matter"}
self.assertRaises(pg8000.InterfaceError, pg8000.connect, **conn_params)
def testDatabaseMissing(self):
data = db_connect.copy()
data["database"] = "missing-db"
self.assertRaises(pg8000.ProgrammingError, pg8000.connect, **data)
def testNotify(self):
try:
db = pg8000.connect(**db_connect)
self.assertEqual(list(db.notifications), [])
cursor = db.cursor()
cursor.execute("LISTEN test")
cursor.execute("NOTIFY test")
db.commit()
cursor.execute("VALUES (1, 2), (3, 4), (5, 6)")
self.assertEqual(len(db.notifications), 1)
self.assertEqual(db.notifications[0][1], "test")
finally:
cursor.close()
db.close()
# This requires a line in pg_hba.conf that requires md5 for the database
# pg8000_md5
def testMd5(self):
data = db_connect.copy()
data["database"] = "pg8000_md5"
# Should only raise an exception saying db doesn't exist
if PY2:
self.assertRaises(
pg8000.ProgrammingError, pg8000.connect, **data)
else:
self.assertRaisesRegex(
pg8000.ProgrammingError, '3D000', pg8000.connect, **data)
# This requires a line in pg_hba.conf that requires gss for the database
# pg8000_gss
def testGss(self):
data = db_connect.copy()
data["database"] = "pg8000_gss"
# Should raise an exception saying gss isn't supported
if PY2:
self.assertRaises(pg8000.InterfaceError, pg8000.connect, **data)
else:
self.assertRaisesRegex(
pg8000.InterfaceError,
"Authentication method 7 not supported by pg8000.",
pg8000.connect, **data)
@trust_all_certificates
def testSsl(self):
data = db_connect.copy()
data["ssl"] = True
db = pg8000.connect(**data)
db.close()
# This requires a line in pg_hba.conf that requires 'password' for the
# database pg8000_password
def testPassword(self):
data = db_connect.copy()
data["database"] = "pg8000_password"
# Should only raise an exception saying db doesn't exist
if PY2:
self.assertRaises(
pg8000.ProgrammingError, pg8000.connect, **data)
else:
self.assertRaisesRegex(
pg8000.ProgrammingError, '3D000', pg8000.connect, **data)
def testUnicodeDatabaseName(self):
data = db_connect.copy()
data["database"] = "pg8000_sn\uFF6Fw"
# Should only raise an exception saying db doesn't exist
if PY2:
self.assertRaises(
pg8000.ProgrammingError, pg8000.connect, **data)
else:
self.assertRaisesRegex(
pg8000.ProgrammingError, '3D000', pg8000.connect, **data)
def testBytesDatabaseName(self):
data = db_connect.copy()
# Should only raise an exception saying db doesn't exist
if PY2:
data["database"] = "pg8000_sn\uFF6Fw"
self.assertRaises(
pg8000.ProgrammingError, pg8000.connect, **data)
else:
data["database"] = bytes("pg8000_sn\uFF6Fw", 'utf8')
self.assertRaisesRegex(
pg8000.ProgrammingError, '3D000', pg8000.connect, **data)
def testBytesPassword(self):
db = pg8000.connect(**db_connect)
# Create user
username = 'boltzmann'
password = u('cha\uFF6Fs')
cur = db.cursor()
# Delete user if left over from previous run
try:
cur.execute("drop role " + username)
except pg8000.ProgrammingError:
cur.execute("rollback")
cur.execute(
"create user " + username + " with password '" + password + "';")
cur.execute('commit;')
db.close()
data = db_connect.copy()
data['user'] = username
data['password'] = password.encode('utf8')
data['database'] = 'pg8000_md5'
if PY2:
self.assertRaises(
pg8000.ProgrammingError, pg8000.connect, **data)
else:
self.assertRaisesRegex(
pg8000.ProgrammingError, '3D000', pg8000.connect, **data)
db = pg8000.connect(**db_connect)
cur = db.cursor()
cur.execute("drop role " + username)
cur.execute("commit;")
db.close()
def testBrokenPipe(self):
db1 = pg8000.connect(**db_connect)
db2 = pg8000.connect(**db_connect)
try:
cur1 = db1.cursor()
cur2 = db2.cursor()
cur1.execute("select pg_backend_pid()")
pid1 = cur1.fetchone()[0]
cur2.execute("select pg_terminate_backend(%s)", (pid1,))
try:
cur1.execute("select 1")
except Exception as e:
self.assertTrue(isinstance(e, (socket.error, struct.error)))
cur2.close()
finally:
db1.close()
db2.close()
def testApplicatioName(self):
params = db_connect.copy()
params['application_name'] = 'my test application name'
db = pg8000.connect(**params)
cur = db.cursor()
if db._server_version >= LooseVersion('9.2'):
cur.execute('select application_name from pg_stat_activity '
' where pid = pg_backend_pid()')
else:
# for pg9.1 and earlier, procpod field rather than pid
cur.execute('select application_name from pg_stat_activity '
' where procpid = pg_backend_pid()')
application_name = cur.fetchone()[0]
self.assertEqual(application_name, 'my test application name')
if __name__ == "__main__":
unittest.main()
================================================
FILE: tests/test_copy.py
================================================
import unittest
import pg8000
from connection_settings import db_connect
from six import b, BytesIO, u, iteritems
from sys import exc_info
class Tests(unittest.TestCase):
def setUp(self):
self.db = pg8000.connect(**db_connect)
try:
cursor = self.db.cursor()
try:
cursor = self.db.cursor()
cursor.execute("DROP TABLE t1")
except pg8000.DatabaseError:
e = exc_info()[1]
# the only acceptable error is:
msg = e.args[0]
code = msg['C']
self.assertEqual(
code, '42P01', # table does not exist
"incorrect error for drop table: " + str(msg))
self.db.rollback()
cursor.execute(
"CREATE TEMPORARY TABLE t1 (f1 int primary key, "
"f2 int not null, f3 varchar(50) null)")
finally:
cursor.close()
def tearDown(self):
self.db.close()
def testCopyToWithTable(self):
try:
cursor = self.db.cursor()
cursor.execute(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)", (1, 1, 1))
cursor.execute(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)", (2, 2, 2))
cursor.execute(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)", (3, 3, 3))
stream = BytesIO()
cursor.execute("copy t1 to stdout", stream=stream)
self.assertEqual(
stream.getvalue(), b("1\t1\t1\n2\t2\t2\n3\t3\t3\n"))
self.assertEqual(cursor.rowcount, 3)
self.db.commit()
finally:
cursor.close()
def testCopyToWithQuery(self):
try:
cursor = self.db.cursor()
stream = BytesIO()
cursor.execute(
"COPY (SELECT 1 as One, 2 as Two) TO STDOUT WITH DELIMITER "
"'X' CSV HEADER QUOTE AS 'Y' FORCE QUOTE Two", stream=stream)
self.assertEqual(stream.getvalue(), b('oneXtwo\n1XY2Y\n'))
self.assertEqual(cursor.rowcount, 1)
self.db.rollback()
finally:
cursor.close()
def testCopyFromWithTable(self):
try:
cursor = self.db.cursor()
stream = BytesIO(b("1\t1\t1\n2\t2\t2\n3\t3\t3\n"))
cursor.execute("copy t1 from STDIN", stream=stream)
self.assertEqual(cursor.rowcount, 3)
cursor.execute("SELECT * FROM t1 ORDER BY f1")
retval = cursor.fetchall()
self.assertEqual(retval, ([1, 1, '1'], [2, 2, '2'], [3, 3, '3']))
self.db.rollback()
finally:
cursor.close()
def testCopyFromWithQuery(self):
try:
cursor = self.db.cursor()
stream = BytesIO(b("f1Xf2\n1XY1Y\n"))
cursor.execute(
"COPY t1 (f1, f2) FROM STDIN WITH DELIMITER 'X' CSV HEADER "
"QUOTE AS 'Y' FORCE NOT NULL f1", stream=stream)
self.assertEqual(cursor.rowcount, 1)
cursor.execute("SELECT * FROM t1 ORDER BY f1")
retval = cursor.fetchall()
self.assertEqual(retval, ([1, 1, None],))
self.db.commit()
finally:
cursor.close()
def testCopyFromWithError(self):
try:
cursor = self.db.cursor()
stream = BytesIO(b("f1Xf2\n\n1XY1Y\n"))
cursor.execute(
"COPY t1 (f1, f2) FROM STDIN WITH DELIMITER 'X' CSV HEADER "
"QUOTE AS 'Y' FORCE NOT NULL f1", stream=stream)
self.assertTrue(False, "Should have raised an exception")
except:
args_dict = {
'S': u('ERROR'),
'C': u('22P02'),
'M': u('invalid input syntax for integer: ""'),
'W': u('COPY t1, line 2, column f1: ""'),
'F': u('numutils.c'),
'R': u('pg_atoi')
}
args = exc_info()[1].args[0]
for k, v in iteritems(args_dict):
self.assertEqual(args[k], v)
finally:
cursor.close()
if __name__ == "__main__":
unittest.main()
================================================
FILE: tests/test_dbapi.py
================================================
import unittest
import os
import time
import pg8000
import datetime
from connection_settings import db_connect
from sys import exc_info
from six import b
from distutils.version import LooseVersion
# DBAPI compatible interface tests
class Tests(unittest.TestCase):
def setUp(self):
self.db = pg8000.connect(**db_connect)
# Neither Windows nor Jython 2.5.3 have a time.tzset() so skip
if hasattr(time, 'tzset'):
os.environ['TZ'] = "UTC"
time.tzset()
self.HAS_TZSET = True
else:
self.HAS_TZSET = False
try:
c = self.db.cursor()
try:
c = self.db.cursor()
c.execute("DROP TABLE t1")
except pg8000.DatabaseError:
e = exc_info()[1]
# the only acceptable error is table does not exist
self.assertEqual(e.args[0]['C'], '42P01')
self.db.rollback()
c.execute(
"CREATE TEMPORARY TABLE t1 "
"(f1 int primary key, f2 int not null, f3 varchar(50) null)")
c.execute(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)",
(1, 1, None))
c.execute(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)",
(2, 10, None))
c.execute(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)",
(3, 100, None))
c.execute(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)",
(4, 1000, None))
c.execute(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)",
(5, 10000, None))
self.db.commit()
finally:
c.close()
def tearDown(self):
self.db.close()
def testParallelQueries(self):
try:
c1 = self.db.cursor()
c2 = self.db.cursor()
c1.execute("SELECT f1, f2, f3 FROM t1")
while 1:
row = c1.fetchone()
if row is None:
break
f1, f2, f3 = row
c2.execute("SELECT f1, f2, f3 FROM t1 WHERE f1 > %s", (f1,))
while 1:
row = c2.fetchone()
if row is None:
break
f1, f2, f3 = row
finally:
c1.close()
c2.close()
self.db.rollback()
def testQmark(self):
orig_paramstyle = pg8000.paramstyle
try:
pg8000.paramstyle = "qmark"
c1 = self.db.cursor()
c1.execute("SELECT f1, f2, f3 FROM t1 WHERE f1 > ?", (3,))
while 1:
row = c1.fetchone()
if row is None:
break
f1, f2, f3 = row
self.db.rollback()
finally:
pg8000.paramstyle = orig_paramstyle
c1.close()
def testNumeric(self):
orig_paramstyle = pg8000.paramstyle
try:
pg8000.paramstyle = "numeric"
c1 = self.db.cursor()
c1.execute("SELECT f1, f2, f3 FROM t1 WHERE f1 > :1", (3,))
while 1:
row = c1.fetchone()
if row is None:
break
f1, f2, f3 = row
self.db.rollback()
finally:
pg8000.paramstyle = orig_paramstyle
c1.close()
def testNamed(self):
orig_paramstyle = pg8000.paramstyle
try:
pg8000.paramstyle = "named"
c1 = self.db.cursor()
c1.execute(
"SELECT f1, f2, f3 FROM t1 WHERE f1 > :f1", {"f1": 3})
while 1:
row = c1.fetchone()
if row is None:
break
f1, f2, f3 = row
self.db.rollback()
finally:
pg8000.paramstyle = orig_paramstyle
c1.close()
def testFormat(self):
orig_paramstyle = pg8000.paramstyle
try:
pg8000.paramstyle = "format"
c1 = self.db.cursor()
c1.execute("SELECT f1, f2, f3 FROM t1 WHERE f1 > %s", (3,))
while 1:
row = c1.fetchone()
if row is None:
break
f1, f2, f3 = row
self.db.commit()
finally:
pg8000.paramstyle = orig_paramstyle
c1.close()
def testPyformat(self):
orig_paramstyle = pg8000.paramstyle
try:
pg8000.paramstyle = "pyformat"
c1 = self.db.cursor()
c1.execute(
"SELECT f1, f2, f3 FROM t1 WHERE f1 > %(f1)s", {"f1": 3})
while 1:
row = c1.fetchone()
if row is None:
break
f1, f2, f3 = row
self.db.commit()
finally:
pg8000.paramstyle = orig_paramstyle
c1.close()
def testArraysize(self):
try:
c1 = self.db.cursor()
c1.arraysize = 3
c1.execute("SELECT * FROM t1")
retval = c1.fetchmany()
self.assertEqual(len(retval), c1.arraysize)
finally:
c1.close()
self.db.commit()
def testDate(self):
val = pg8000.Date(2001, 2, 3)
self.assertEqual(val, datetime.date(2001, 2, 3))
def testTime(self):
val = pg8000.Time(4, 5, 6)
self.assertEqual(val, datetime.time(4, 5, 6))
def testTimestamp(self):
val = pg8000.Timestamp(2001, 2, 3, 4, 5, 6)
self.assertEqual(val, datetime.datetime(2001, 2, 3, 4, 5, 6))
def testDateFromTicks(self):
if self.HAS_TZSET:
val = pg8000.DateFromTicks(1173804319)
self.assertEqual(val, datetime.date(2007, 3, 13))
def testTimeFromTicks(self):
if self.HAS_TZSET:
val = pg8000.TimeFromTicks(1173804319)
self.assertEqual(val, datetime.time(16, 45, 19))
def testTimestampFromTicks(self):
if self.HAS_TZSET:
val = pg8000.TimestampFromTicks(1173804319)
self.assertEqual(val, datetime.datetime(2007, 3, 13, 16, 45, 19))
def testBinary(self):
v = pg8000.Binary(b("\x00\x01\x02\x03\x02\x01\x00"))
self.assertEqual(v, b("\x00\x01\x02\x03\x02\x01\x00"))
self.assertTrue(isinstance(v, pg8000.BINARY))
def testRowCount(self):
try:
c1 = self.db.cursor()
c1.execute("SELECT * FROM t1")
# Before PostgreSQL 9 we don't know the row count for a select
if self.db._server_version > LooseVersion('8.0.0'):
self.assertEqual(5, c1.rowcount)
c1.execute("UPDATE t1 SET f3 = %s WHERE f2 > 101", ("Hello!",))
self.assertEqual(2, c1.rowcount)
c1.execute("DELETE FROM t1")
self.assertEqual(5, c1.rowcount)
finally:
c1.close()
self.db.commit()
def testFetchMany(self):
try:
cursor = self.db.cursor()
cursor.arraysize = 2
cursor.execute("SELECT * FROM t1")
self.assertEqual(2, len(cursor.fetchmany()))
self.assertEqual(2, len(cursor.fetchmany()))
self.assertEqual(1, len(cursor.fetchmany()))
self.assertEqual(0, len(cursor.fetchmany()))
finally:
cursor.close()
self.db.commit()
def testIterator(self):
from warnings import filterwarnings
filterwarnings("ignore", "DB-API extension cursor.next()")
filterwarnings("ignore", "DB-API extension cursor.__iter__()")
try:
cursor = self.db.cursor()
cursor.execute("SELECT * FROM t1 ORDER BY f1")
f1 = 0
for row in cursor:
next_f1 = row[0]
assert next_f1 > f1
f1 = next_f1
except:
cursor.close()
self.db.commit()
# Vacuum can't be run inside a transaction, so we need to turn
# autocommit on.
def testVacuum(self):
self.db.autocommit = True
try:
cursor = self.db.cursor()
cursor.execute("vacuum")
finally:
cursor.close()
def testPreparedStatement(self):
cursor = self.db.cursor()
cursor.execute(
'PREPARE gen_series AS SELECT generate_series(1, 10);')
cursor.execute('EXECUTE gen_series')
if __name__ == "__main__":
unittest.main()
================================================
FILE: tests/test_error_recovery.py
================================================
import unittest
import pg8000
from connection_settings import db_connect
import warnings
import datetime
from sys import exc_info
class TestException(Exception):
pass
class Tests(unittest.TestCase):
def setUp(self):
self.db = pg8000.connect(**db_connect)
def tearDown(self):
self.db.close()
def raiseException(self, value):
raise TestException("oh noes!")
def testPyValueFail(self):
# Ensure that if types.py_value throws an exception, the original
# exception is raised (TestException), and the connection is
# still usable after the error.
orig = self.db.py_types[datetime.time]
self.db.py_types[datetime.time] = (
orig[0], orig[1], self.raiseException)
try:
c = self.db.cursor()
try:
try:
c.execute("SELECT %s as f1", (datetime.time(10, 30),))
c.fetchall()
# shouldn't get here, exception should be thrown
self.fail()
except TestException:
# should be TestException type, this is OK!
self.db.rollback()
finally:
self.db.py_types[datetime.time] = orig
# ensure that the connection is still usable for a new query
c.execute("VALUES ('hw3'::text)")
self.assertEqual(c.fetchone()[0], "hw3")
finally:
c.close()
def testNoDataErrorRecovery(self):
for i in range(1, 4):
try:
try:
cursor = self.db.cursor()
cursor.execute("DROP TABLE t1")
finally:
cursor.close()
except pg8000.DatabaseError:
e = exc_info()[1]
# the only acceptable error is 'table does not exist'
self.assertEqual(e.args[0]['C'], '42P01')
self.db.rollback()
def testClosedConnection(self):
warnings.simplefilter("ignore")
my_db = pg8000.connect(**db_connect)
cursor = my_db.cursor()
my_db.close()
try:
cursor.execute("VALUES ('hw1'::text)")
self.fail("Should have raised an exception")
except:
e = exc_info()[1]
self.assertTrue(isinstance(e, self.db.InterfaceError))
self.assertEqual(str(e), 'connection is closed')
warnings.resetwarnings()
if __name__ == "__main__":
unittest.main()
================================================
FILE: tests/test_paramstyle.py
================================================
import unittest
import pg8000
# Tests of the convert_paramstyle function.
class Tests(unittest.TestCase):
def testQmark(self):
new_query, make_args = pg8000.core.convert_paramstyle(
"qmark", "SELECT ?, ?, \"field_?\" FROM t "
"WHERE a='say ''what?''' AND b=? AND c=E'?\\'test\\'?'")
self.assertEqual(
new_query, "SELECT $1, $2, \"field_?\" FROM t WHERE "
"a='say ''what?''' AND b=$3 AND c=E'?\\'test\\'?'")
self.assertEqual(make_args((1, 2, 3)), (1, 2, 3))
def testQmark2(self):
new_query, make_args = pg8000.core.convert_paramstyle(
"qmark", "SELECT ?, ?, * FROM t WHERE a=? AND b='are you ''sure?'")
self.assertEqual(
new_query,
"SELECT $1, $2, * FROM t WHERE a=$3 AND b='are you ''sure?'")
self.assertEqual(make_args((1, 2, 3)), (1, 2, 3))
def testNumeric(self):
new_query, make_args = pg8000.core.convert_paramstyle(
"numeric", "SELECT :2, :1, * FROM t WHERE a=:3")
self.assertEqual(new_query, "SELECT $2, $1, * FROM t WHERE a=$3")
self.assertEqual(make_args((1, 2, 3)), (1, 2, 3))
def testNamed(self):
new_query, make_args = pg8000.core.convert_paramstyle(
"named", "SELECT :f_2, :f1 FROM t WHERE a=:f_2")
self.assertEqual(new_query, "SELECT $1, $2 FROM t WHERE a=$1")
self.assertEqual(make_args({"f_2": 1, "f1": 2}), (1, 2))
def testFormat(self):
new_query, make_args = pg8000.core.convert_paramstyle(
"format", "SELECT %s, %s, \"f1_%%\", E'txt_%%' "
"FROM t WHERE a=%s AND b='75%%' AND c = '%' -- Comment with %")
self.assertEqual(
new_query,
"SELECT $1, $2, \"f1_%%\", E'txt_%%' FROM t WHERE a=$3 AND "
"b='75%%' AND c = '%' -- Comment with %")
self.assertEqual(make_args((1, 2, 3)), (1, 2, 3))
sql = r"""COMMENT ON TABLE test_schema.comment_test """ \
r"""IS 'the test % '' " \ table comment'"""
new_query, make_args = pg8000.core.convert_paramstyle("format", sql)
self.assertEqual(new_query, sql)
def testFormatMultiline(self):
new_query, make_args = pg8000.core.convert_paramstyle(
"format", "SELECT -- Comment\n%s FROM t")
self.assertEqual(
new_query,
"SELECT -- Comment\n$1 FROM t")
def testPyformat(self):
new_query, make_args = pg8000.core.convert_paramstyle(
"pyformat", "SELECT %(f2)s, %(f1)s, \"f1_%%\", E'txt_%%' "
"FROM t WHERE a=%(f2)s AND b='75%%'")
self.assertEqual(
new_query,
"SELECT $1, $2, \"f1_%%\", E'txt_%%' FROM t WHERE a=$1 AND "
"b='75%%'")
self.assertEqual(make_args({"f2": 1, "f1": 2, "f3": 3}), (1, 2))
# pyformat should support %s and an array, too:
new_query, make_args = pg8000.core.convert_paramstyle(
"pyformat", "SELECT %s, %s, \"f1_%%\", E'txt_%%' "
"FROM t WHERE a=%s AND b='75%%'")
self.assertEqual(
new_query,
"SELECT $1, $2, \"f1_%%\", E'txt_%%' FROM t WHERE a=$3 AND "
"b='75%%'")
self.assertEqual(make_args((1, 2, 3)), (1, 2, 3))
if __name__ == "__main__":
unittest.main()
================================================
FILE: tests/test_pg8000_dbapi20.py
================================================
#!/usr/bin/env python
import dbapi20
import unittest
import pg8000
from connection_settings import db_connect
class Tests(dbapi20.DatabaseAPI20Test):
driver = pg8000
connect_args = ()
connect_kw_args = db_connect
lower_func = 'lower' # For stored procedure test
def test_nextset(self):
pass
def test_setoutputsize(self):
pass
if __name__ == '__main__':
unittest.main()
================================================
FILE: tests/test_query.py
================================================
import unittest
import pg8000
from connection_settings import db_connect
from six import u
from sys import exc_info
import datetime
from distutils.version import LooseVersion
from warnings import filterwarnings
# Tests relating to the basic operation of the database driver, driven by the
# pg8000 custom interface.
class Tests(unittest.TestCase):
def setUp(self):
self.db = pg8000.connect(**db_connect)
filterwarnings("ignore", "DB-API extension cursor.next()")
filterwarnings("ignore", "DB-API extension cursor.__iter__()")
self.db.paramstyle = 'format'
try:
cursor = self.db.cursor()
try:
cursor.execute("DROP TABLE t1")
except pg8000.DatabaseError:
e = exc_info()[1]
# the only acceptable error is 'table does not exist'
self.assertEqual(e.args[0]['C'], '42P01')
self.db.rollback()
cursor.execute(
"CREATE TEMPORARY TABLE t1 (f1 int primary key, "
"f2 bigint not null, f3 varchar(50) null)")
finally:
cursor.close()
self.db.commit()
def tearDown(self):
self.db.close()
def testDatabaseError(self):
try:
cursor = self.db.cursor()
self.assertRaises(
pg8000.ProgrammingError, cursor.execute,
"INSERT INTO t99 VALUES (1, 2, 3)")
finally:
cursor.close()
self.db.rollback()
def testParallelQueries(self):
try:
cursor = self.db.cursor()
cursor.execute(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)",
(1, 1, None))
cursor.execute(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)",
(2, 10, None))
cursor.execute(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)",
(3, 100, None))
cursor.execute(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)",
(4, 1000, None))
cursor.execute(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)",
(5, 10000, None))
try:
c1 = self.db.cursor()
c2 = self.db.cursor()
c1.execute("SELECT f1, f2, f3 FROM t1")
for row in c1:
f1, f2, f3 = row
c2.execute(
"SELECT f1, f2, f3 FROM t1 WHERE f1 > %s", (f1,))
for row in c2:
f1, f2, f3 = row
finally:
c1.close()
c2.close()
finally:
cursor.close()
self.db.rollback()
def testParallelOpenPortals(self):
try:
c1, c2 = self.db.cursor(), self.db.cursor()
c1count, c2count = 0, 0
q = "select * from generate_series(1, %s)"
params = (100,)
c1.execute(q, params)
c2.execute(q, params)
for c2row in c2:
c2count += 1
for c1row in c1:
c1count += 1
finally:
c1.close()
c2.close()
self.db.rollback()
self.assertEqual(c1count, c2count)
# Run a query on a table, alter the structure of the table, then run the
# original query again.
def testAlter(self):
try:
cursor = self.db.cursor()
cursor.execute("select * from t1")
cursor.execute("alter table t1 drop column f3")
cursor.execute("select * from t1")
finally:
cursor.close()
self.db.rollback()
# Run a query on a table, drop then re-create the table, then run the
# original query again.
def testCreate(self):
try:
cursor = self.db.cursor()
cursor.execute("select * from t1")
cursor.execute("drop table t1")
cursor.execute("create temporary table t1 (f1 int primary key)")
cursor.execute("select * from t1")
finally:
cursor.close()
self.db.rollback()
def testInsertReturning(self):
try:
cursor = self.db.cursor()
cursor.execute("CREATE TABLE t2 (id serial, data text)")
# Test INSERT ... RETURNING with one row...
cursor.execute(
"INSERT INTO t2 (data) VALUES (%s) RETURNING id",
("test1",))
row_id = cursor.fetchone()[0]
cursor.execute("SELECT data FROM t2 WHERE id = %s", (row_id,))
self.assertEqual("test1", cursor.fetchone()[0])
# Before PostgreSQL 9 we don't know the row count for a select
if self.db._server_version > LooseVersion('8.0.0'):
self.assertEqual(cursor.rowcount, 1)
# Test with multiple rows...
cursor.execute(
"INSERT INTO t2 (data) VALUES (%s), (%s), (%s) "
"RETURNING id", ("test2", "test3", "test4"))
self.assertEqual(cursor.rowcount, 3)
ids = tuple([x[0] for x in cursor])
self.assertEqual(len(ids), 3)
finally:
cursor.close()
self.db.rollback()
def testRowCount(self):
# Before PostgreSQL 9 we don't know the row count for a select
if self.db._server_version > LooseVersion('8.0.0'):
try:
cursor = self.db.cursor()
expected_count = 57
cursor.executemany(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)",
tuple((i, i, None) for i in range(expected_count)))
# Check rowcount after executemany
self.assertEqual(expected_count, cursor.rowcount)
self.db.commit()
cursor.execute("SELECT * FROM t1")
# Check row_count without doing any reading first...
self.assertEqual(expected_count, cursor.rowcount)
# Check rowcount after reading some rows, make sure it still
# works...
for i in range(expected_count // 2):
cursor.fetchone()
self.assertEqual(expected_count, cursor.rowcount)
finally:
cursor.close()
self.db.commit()
try:
cursor = self.db.cursor()
# Restart the cursor, read a few rows, and then check rowcount
# again...
cursor = self.db.cursor()
cursor.execute("SELECT * FROM t1")
for i in range(expected_count // 3):
cursor.fetchone()
self.assertEqual(expected_count, cursor.rowcount)
self.db.rollback()
# Should be -1 for a command with no results
cursor.execute("DROP TABLE t1")
self.assertEqual(-1, cursor.rowcount)
finally:
cursor.close()
self.db.commit()
def testRowCountUpdate(self):
try:
cursor = self.db.cursor()
cursor.execute(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)",
(1, 1, None))
cursor.execute(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)",
(2, 10, None))
cursor.execute(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)",
(3, 100, None))
cursor.execute(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)",
(4, 1000, None))
cursor.execute(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)",
(5, 10000, None))
cursor.execute("UPDATE t1 SET f3 = %s WHERE f2 > 101", ("Hello!",))
self.assertEqual(cursor.rowcount, 2)
finally:
cursor.close()
self.db.commit()
def testIntOid(self):
try:
cursor = self.db.cursor()
# https://bugs.launchpad.net/pg8000/+bug/230796
cursor.execute(
"SELECT typname FROM pg_type WHERE oid = %s", (100,))
finally:
cursor.close()
self.db.rollback()
def testUnicodeQuery(self):
try:
cursor = self.db.cursor()
cursor.execute(
u(
"CREATE TEMPORARY TABLE \u043c\u0435\u0441\u0442\u043e "
"(\u0438\u043c\u044f VARCHAR(50), "
"\u0430\u0434\u0440\u0435\u0441 VARCHAR(250))"))
finally:
cursor.close()
self.db.commit()
def testExecutemany(self):
try:
cursor = self.db.cursor()
cursor.executemany(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)",
((1, 1, 'Avast ye!'), (2, 1, None)))
cursor.executemany(
"select %s",
(
(datetime.datetime(2014, 5, 7, tzinfo=pg8000.core.utc), ),
(datetime.datetime(2014, 5, 7),)))
finally:
cursor.close()
self.db.commit()
# Check that autocommit stays off
# We keep track of whether we're in a transaction or not by using the
# READY_FOR_QUERY message.
def testTransactions(self):
try:
cursor = self.db.cursor()
cursor.execute("commit")
cursor.execute(
"INSERT INTO t1 (f1, f2, f3) VALUES (%s, %s, %s)",
(1, 1, "Zombie"))
cursor.execute("rollback")
cursor.execute("select * from t1")
# Before PostgreSQL 9 we don't know the row count for a select
if self.db._server_version > LooseVersion('8.0.0'):
self.assertEqual(cursor.rowcount, 0)
finally:
cursor.close()
self.db.commit()
def testIn(self):
try:
cursor = self.db.cursor()
cursor.execute(
"SELECT typname FROM pg_type WHERE oid = any(%s)", ([16, 23],))
ret = cursor.fetchall()
self.assertEqual(ret[0][0], 'bool')
finally:
cursor.close()
def test_no_previous_tpc(self):
try:
self.db.tpc_begin('Stacey')
cursor = self.db.cursor()
cursor.execute("SELECT * FROM pg_type")
self.db.tpc_commit()
finally:
cursor.close()
# Check that tpc_recover() doesn't start a transaction
def test_tpc_recover(self):
try:
self.db.tpc_recover()
cursor = self.db.cursor()
self.db.autocommit = True
# If tpc_recover() has started a transaction, this will fail
cursor.execute("VACUUM")
finally:
cursor.close()
# An empty query should raise a ProgrammingError
def test_empty_query(self):
try:
cursor = self.db.cursor()
self.assertRaises(pg8000.ProgrammingError, cursor.execute, "")
finally:
cursor.close()
# rolling back when not in a transaction doesn't generate a warning
def test_rollback_no_transaction(self):
try:
# Remove any existing notices
self.db.notices.clear()
cursor = self.db.cursor()
# First, verify that a raw rollback does produce a notice
self.db.execute(cursor, "rollback", None)
self.assertEqual(1, len(self.db.notices))
# 25P01 is the code for no_active_sql_tronsaction. It has
# a message and severity name, but those might be
# localized/depend on the server version.
self.assertEqual(self.db.notices.pop().get(b'C'), b'25P01')
# Now going through the rollback method doesn't produce
# any notices because it knows we're not in a transaction.
self.db.rollback()
self.assertEqual(0, len(self.db.notices))
finally:
cursor.close()
def test_context_manager_class(self):
self.assertTrue('__enter__' in pg8000.core.Cursor.__dict__)
self.assertTrue('__exit__' in pg8000.core.Cursor.__dict__)
with self.db.cursor() as cursor:
cursor.execute('select 1')
def test_deallocate_prepared_statements(self):
try:
cursor = self.db.cursor()
cursor.execute("select * from t1")
cursor.execute("alter table t1 drop column f3")
cursor.execute("select count(*) from pg_prepared_statements")
res = cursor.fetchall()
self.assertEqual(res[0][0], 1)
finally:
cursor.close()
self.db.rollback()
if __name__ == "__main__":
unittest.main()
================================================
FILE: tests/test_typeconversion.py
================================================
import unittest
import pg8000
from pg8000 import PGJsonb, PGEnum
import datetime
import decimal
import struct
from connection_settings import db_connect
from six import b, PY2, u
import uuid
import os
import time
from distutils.version import LooseVersion
import sys
import json
import pytz
from collections import OrderedDict
IS_JYTHON = sys.platform.lower().count('java') > 0
# Type conversion tests
class Tests(unittest.TestCase):
def setUp(self):
self.db = pg8000.connect(**db_connect)
self.cursor = self.db.cursor()
def tearDown(self):
self.cursor.close()
self.cursor = None
self.db.close()
def testTimeRoundtrip(self):
self.cursor.execute("SELECT %s as f1", (datetime.time(4, 5, 6),))
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], datetime.time(4, 5, 6))
def testDateRoundtrip(self):
v = datetime.date(2001, 2, 3)
self.cursor.execute("SELECT %s as f1", (v,))
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], v)
def testBoolRoundtrip(self):
self.cursor.execute("SELECT %s as f1", (True,))
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], True)
def testNullRoundtrip(self):
# We can't just "SELECT %s" and set None as the parameter, since it has
# no type. That would result in a PG error, "could not determine data
# type of parameter %s". So we create a temporary table, insert null
# values, and read them back.
self.cursor.execute(
"CREATE TEMPORARY TABLE TestNullWrite "
"(f1 int4, f2 timestamp, f3 varchar)")
self.cursor.execute(
"INSERT INTO TestNullWrite VALUES (%s, %s, %s)",
(None, None, None,))
self.cursor.execute("SELECT * FROM TestNullWrite")
retval = self.cursor.fetchone()
self.assertEqual(retval, [None, None, None])
def testNullSelectFailure(self):
# See comment in TestNullRoundtrip. This test is here to ensure that
# this behaviour is documented and doesn't mysteriously change.
self.assertRaises(
pg8000.ProgrammingError, self.cursor.execute,
"SELECT %s as f1", (None,))
self.db.rollback()
def testDecimalRoundtrip(self):
values = (
"1.1", "-1.1", "10000", "20000", "-1000000000.123456789", "1.0",
"12.44")
for v in values:
self.cursor.execute("SELECT %s as f1", (decimal.Decimal(v),))
retval = self.cursor.fetchall()
self.assertEqual(str(retval[0][0]), v)
def testFloatRoundtrip(self):
# This test ensures that the binary float value doesn't change in a
# roundtrip to the server. That could happen if the value was
# converted to text and got rounded by a decimal place somewhere.
val = 1.756e-12
bin_orig = struct.pack("!d", val)
self.cursor.execute("SELECT %s as f1", (val,))
retval = self.cursor.fetchall()
bin_new = struct.pack("!d", retval[0][0])
self.assertEqual(bin_new, bin_orig)
def test_float_plus_infinity_roundtrip(self):
v = float('inf')
self.cursor.execute("SELECT %s as f1", (v,))
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], v)
def testStrRoundtrip(self):
v = "hello world"
self.cursor.execute(
"create temporary table test_str (f character varying(255))")
self.cursor.execute("INSERT INTO test_str VALUES (%s)", (v,))
self.cursor.execute("SELECT * from test_str")
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], v)
if PY2:
v = "hello \xce\x94 world"
self.cursor.execute("SELECT cast(%s as varchar) as f1", (v,))
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], v.decode('utf8'))
def test_str_then_int(self):
v1 = "hello world"
self.cursor.execute("SELECT cast(%s as varchar) as f1", (v1,))
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], v1)
v2 = 1
self.cursor.execute("SELECT cast(%s as varchar) as f1", (v2,))
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], str(v2))
def testUnicodeRoundtrip(self):
v = u("hello \u0173 world")
self.cursor.execute("SELECT cast(%s as varchar) as f1", (v,))
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], v)
def testLongRoundtrip(self):
self.cursor.execute(
"SELECT %s", (50000000000000,))
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], 50000000000000)
def testIntExecuteMany(self):
self.cursor.executemany("SELECT %s", ((1,), (40000,)))
self.cursor.fetchall()
v = ([None], [4])
self.cursor.execute(
"create temporary table test_int (f integer)")
self.cursor.executemany("INSERT INTO test_int VALUES (%s)", v)
self.cursor.execute("SELECT * from test_int")
retval = self.cursor.fetchall()
self.assertEqual(retval, v)
def testIntRoundtrip(self):
int2 = 21
int4 = 23
int8 = 20
test_values = [
(0, int2),
(-32767, int2),
(-32768, int4),
(+32767, int2),
(+32768, int4),
(-2147483647, int4),
(-2147483648, int8),
(+2147483647, int4),
(+2147483648, int8),
(-9223372036854775807, int8),
(+9223372036854775807, int8)]
for value, typoid in test_values:
self.cursor.execute("SELECT %s", (value,))
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], value)
column_name, column_typeoid = self.cursor.description[0][0:2]
self.assertEqual(column_typeoid, typoid)
def testByteaRoundtrip(self):
self.cursor.execute(
"SELECT %s as f1",
(pg8000.Binary(b("\x00\x01\x02\x03\x02\x01\x00")),))
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], b("\x00\x01\x02\x03\x02\x01\x00"))
def test_bytearray_round_trip(self):
binary = b'\x00\x01\x02\x03\x02\x01\x00'
self.cursor.execute("SELECT %s as f1", (bytearray(binary),))
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], binary)
def test_bytearray_subclass_round_trip(self):
class BClass(bytearray):
pass
binary = b'\x00\x01\x02\x03\x02\x01\x00'
self.cursor.execute("SELECT %s as f1", (BClass(binary),))
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], binary)
def testTimestampRoundtrip(self):
v = datetime.datetime(2001, 2, 3, 4, 5, 6, 170000)
self.cursor.execute("SELECT %s as f1", (v,))
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], v)
# Test that time zone doesn't affect it
# Jython 2.5.3 doesn't have a time.tzset() so skip
if not IS_JYTHON:
orig_tz = os.environ.get('TZ')
os.environ['TZ'] = "America/Edmonton"
time.tzset()
self.cursor.execute("SELECT %s as f1", (v,))
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], v)
if orig_tz is None:
del os.environ['TZ']
else:
os.environ['TZ'] = orig_tz
time.tzset()
def testIntervalRoundtrip(self):
v = pg8000.Interval(microseconds=123456789, days=2, months=24)
self.cursor.execute("SELECT %s as f1", (v,))
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], v)
v = datetime.timedelta(seconds=30)
self.cursor.execute("SELECT %s as f1", (v,))
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], v)
def test_enum_str_round_trip(self):
try:
self.cursor.execute(
"create type lepton as enum ('electron', 'muon', 'tau')")
except pg8000.ProgrammingError:
self.db.rollback()
v = 'muon'
self.cursor.execute("SELECT cast(%s as lepton) as f1", (v,))
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], v)
self.cursor.execute(
"CREATE TEMPORARY TABLE testenum "
"(f1 lepton)")
self.cursor.execute(
"INSERT INTO testenum VALUES (cast(%s as lepton))", ('electron',))
self.cursor.execute("drop table testenum")
self.cursor.execute("drop type lepton")
self.db.commit()
def test_enum_custom_round_trip(self):
class Lepton(object):
# Implements PEP 435 in the minimal fashion needed
__members__ = OrderedDict()
def __init__(self, name, value, alias=None):
self.name = name
self.value = value
self.__members__[name] = self
setattr(self.__class__, name, self)
if alias:
self.__members__[alias] = self
setattr(self.__class__, alias, self)
try:
self.cursor.execute(
"create type lepton as enum ('1', '2', '3')")
except pg8000.ProgrammingError:
self.db.rollback()
v = Lepton('muon', '2')
self.cursor.execute(
"SELECT cast(%s as lepton) as f1", (PGEnum(v),))
retval = self.cursor.fetchall()
self.assertEqual(retval[0][0], v.value)
self.cursor.execute("drop type lepton")
self.db.commit()
def test_enum_py_round_trip(self):
try:
from enum import Enum
class Lepton(Enum):
electron = '1'
muon = '2'
tau = '3'
try:
self.cursor.execute(
"create type lepton as enum ('1', '2', '3')")
except pg8000.ProgrammingError:
gitextract_bn8c_oc_/ ├── .gitattributes ├── .gitignore ├── .travis.yml ├── LICENSE ├── MANIFEST.in ├── README.adoc ├── multi ├── pg8000/ │ ├── __init__.py │ ├── _version.py │ └── core.py ├── setup.cfg ├── setup.py ├── tests/ │ ├── connection_settings.py │ ├── dbapi20.py │ ├── performance.py │ ├── stress.py │ ├── test_connection.py │ ├── test_copy.py │ ├── test_dbapi.py │ ├── test_error_recovery.py │ ├── test_paramstyle.py │ ├── test_pg8000_dbapi20.py │ ├── test_query.py │ ├── test_typeconversion.py │ └── test_typeobjects.py ├── tox.ini └── versioneer.py
SYMBOL INDEX (408 symbols across 14 files)
FILE: pg8000/__init__.py
function connect (line 43) | def connect(
FILE: pg8000/_version.py
function get_keywords (line 18) | def get_keywords():
class VersioneerConfig (line 29) | class VersioneerConfig:
function get_config (line 33) | def get_config():
class NotThisMethod (line 46) | class NotThisMethod(Exception):
function register_vcs_handler (line 54) | def register_vcs_handler(vcs, method): # decorator
function run_command (line 63) | def run_command(commands, args, cwd=None, verbose=False, hide_stderr=Fal...
function versions_from_parentdir (line 96) | def versions_from_parentdir(parentdir_prefix, root, verbose):
function git_get_keywords (line 111) | def git_get_keywords(versionfile_abs):
function git_versions_from_keywords (line 135) | def git_versions_from_keywords(keywords, tag_prefix, verbose):
function git_pieces_from_vcs (line 180) | def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_comma...
function plus_or_dot (line 261) | def plus_or_dot(pieces):
function render_pep440 (line 267) | def render_pep440(pieces):
function render_pep440_pre (line 291) | def render_pep440_pre(pieces):
function render_pep440_post (line 307) | def render_pep440_post(pieces):
function render_pep440_old (line 333) | def render_pep440_old(pieces):
function render_git_describe (line 353) | def render_git_describe(pieces):
function render_git_describe_long (line 372) | def render_git_describe_long(pieces):
function render (line 390) | def render(pieces, style):
function get_versions (line 419) | def get_versions():
FILE: pg8000/core.py
class UTC (line 59) | class UTC(tzinfo):
method utcoffset (line 61) | def utcoffset(self, dt):
method tzname (line 64) | def tzname(self, dt):
method dst (line 67) | def dst(self, dt):
class Interval (line 74) | class Interval(object):
method __init__ (line 109) | def __init__(self, microseconds=0, days=0, months=0):
method _setMicroseconds (line 114) | def _setMicroseconds(self, value):
method _setDays (line 123) | def _setDays(self, value):
method _setMonths (line 132) | def _setMonths(self, value):
method __repr__ (line 145) | def __repr__(self):
method __eq__ (line 149) | def __eq__(self, other):
method __neq__ (line 154) | def __neq__(self, other):
class PGType (line 158) | class PGType(object):
method __init__ (line 159) | def __init__(self, value):
method encode (line 162) | def encode(self, encoding):
class PGEnum (line 166) | class PGEnum(PGType):
method __init__ (line 167) | def __init__(self, value):
class PGJson (line 174) | class PGJson(PGType):
method encode (line 175) | def encode(self, encoding):
class PGJsonb (line 179) | class PGJsonb(PGType):
method encode (line 180) | def encode(self, encoding):
class PGTsvector (line 184) | class PGTsvector(PGType):
class PGVarchar (line 188) | class PGVarchar(str):
class PGText (line 192) | class PGText(str):
function pack_funcs (line 196) | def pack_funcs(fmt):
class Warning (line 221) | class Warning(Exception):
class Error (line 231) | class Error(Exception):
class InterfaceError (line 241) | class InterfaceError(Error):
class DatabaseError (line 253) | class DatabaseError(Error):
class DataError (line 263) | class DataError(DatabaseError):
class OperationalError (line 273) | class OperationalError(DatabaseError):
class IntegrityError (line 285) | class IntegrityError(DatabaseError):
class InternalError (line 296) | class InternalError(DatabaseError):
class ProgrammingError (line 307) | class ProgrammingError(DatabaseError):
class NotSupportedError (line 318) | class NotSupportedError(DatabaseError):
class ArrayContentNotSupportedError (line 328) | class ArrayContentNotSupportedError(NotSupportedError):
class ArrayContentNotHomogenousError (line 336) | class ArrayContentNotHomogenousError(ProgrammingError):
class ArrayDimensionsNotConsistentError (line 344) | class ArrayDimensionsNotConsistentError(ProgrammingError):
class Bytea (line 352) | class Bytea(binary_type):
function Date (line 360) | def Date(year, month, day):
function Time (line 371) | def Time(hour, minute, second):
function Timestamp (line 382) | def Timestamp(year, month, day, hour, minute, second):
function DateFromTicks (line 393) | def DateFromTicks(ticks):
function TimeFromTicks (line 405) | def TimeFromTicks(ticks):
function TimestampFromTicks (line 417) | def TimestampFromTicks(ticks):
function Binary (line 429) | def Binary(value):
function convert_paramstyle (line 455) | def convert_paramstyle(style, query):
function timestamp_recv_integer (line 594) | def timestamp_recv_integer(data, offset, length):
function timestamp_recv_float (line 608) | def timestamp_recv_float(data, offset, length):
function timestamp_send_integer (line 613) | def timestamp_send_integer(v):
function timestamp_send_float (line 619) | def timestamp_send_float(v):
function timestamptz_send_integer (line 623) | def timestamptz_send_integer(v):
function timestamptz_send_float (line 629) | def timestamptz_send_float(v):
function timestamptz_recv_integer (line 639) | def timestamptz_recv_integer(data, offset, length):
function timestamptz_recv_float (line 652) | def timestamptz_recv_float(data, offset, length):
function interval_send_integer (line 656) | def interval_send_integer(v):
function interval_send_float (line 671) | def interval_send_float(v):
function interval_recv_integer (line 686) | def interval_recv_integer(data, offset, length):
function interval_recv_float (line 695) | def interval_recv_float(data, offset, length):
function int8_recv (line 704) | def int8_recv(data, offset, length):
function int2_recv (line 708) | def int2_recv(data, offset, length):
function int4_recv (line 712) | def int4_recv(data, offset, length):
function float4_recv (line 716) | def float4_recv(data, offset, length):
function float8_recv (line 720) | def float8_recv(data, offset, length):
function bytea_send (line 724) | def bytea_send(v):
function bytea_recv (line 730) | def bytea_recv(data, offset, length):
function bytea_recv (line 733) | def bytea_recv(data, offset, length):
function uuid_send (line 737) | def uuid_send(v):
function uuid_recv (line 741) | def uuid_recv(data, offset, length):
function bool_send (line 749) | def bool_send(v):
function null_send (line 758) | def null_send(v):
function int_in (line 762) | def int_in(data, offset, length):
class Cursor (line 766) | class Cursor():
method __init__ (line 819) | def __init__(self, connection):
method __enter__ (line 826) | def __enter__(self):
method __exit__ (line 829) | def __exit__(self, exc_type, exc_value, traceback):
method connection (line 833) | def connection(self):
method rowcount (line 838) | def rowcount(self):
method _getDescription (line 843) | def _getDescription(self):
method execute (line 860) | def execute(self, operation, args=None, stream=None):
method executemany (line 901) | def executemany(self, operation, param_sets):
method fetchone (line 922) | def fetchone(self):
method fetchmany (line 941) | def fetchmany(self, num=None):
method fetchall (line 964) | def fetchall(self):
method close (line 980) | def close(self):
method __iter__ (line 988) | def __iter__(self):
method setinputsizes (line 995) | def setinputsizes(self, sizes):
method setoutputsize (line 1002) | def setoutputsize(self, size, column=None):
method __next__ (line 1009) | def __next__(self):
function create_message (line 1058) | def create_message(code, data=b('')):
class Connection (line 1095) | class Connection(object):
method _getError (line 1109) | def _getError(self, error):
method __init__ (line 1115) | def __init__(
method handle_ERROR_RESPONSE (line 1474) | def handle_ERROR_RESPONSE(self, data, ps):
method handle_EMPTY_QUERY_RESPONSE (line 1491) | def handle_EMPTY_QUERY_RESPONSE(self, data, ps):
method handle_CLOSE_COMPLETE (line 1494) | def handle_CLOSE_COMPLETE(self, data, ps):
method handle_PARSE_COMPLETE (line 1497) | def handle_PARSE_COMPLETE(self, data, ps):
method handle_BIND_COMPLETE (line 1502) | def handle_BIND_COMPLETE(self, data, ps):
method handle_PORTAL_SUSPENDED (line 1505) | def handle_PORTAL_SUSPENDED(self, data, cursor):
method handle_PARAMETER_DESCRIPTION (line 1508) | def handle_PARAMETER_DESCRIPTION(self, data, ps):
method handle_COPY_DONE (line 1516) | def handle_COPY_DONE(self, data, ps):
method handle_COPY_OUT_RESPONSE (line 1519) | def handle_COPY_OUT_RESPONSE(self, data, ps):
method handle_COPY_DATA (line 1530) | def handle_COPY_DATA(self, data, ps):
method handle_COPY_IN_RESPONSE (line 1533) | def handle_COPY_IN_RESPONSE(self, data, ps):
method handle_NOTIFICATION_RESPONSE (line 1567) | def handle_NOTIFICATION_RESPONSE(self, data, ps):
method cursor (line 1585) | def cursor(self):
method commit (line 1594) | def commit(self):
method rollback (line 1602) | def rollback(self):
method close (line 1612) | def close(self):
method handle_AUTHENTICATION_REQUEST (line 1634) | def handle_AUTHENTICATION_REQUEST(self, data, cursor):
method handle_READY_FOR_QUERY (line 1690) | def handle_READY_FOR_QUERY(self, data, ps):
method handle_BACKEND_KEY_DATA (line 1694) | def handle_BACKEND_KEY_DATA(self, data, ps):
method inspect_datetime (line 1697) | def inspect_datetime(self, value):
method inspect_int (line 1703) | def inspect_int(self, value):
method make_params (line 1711) | def make_params(self, values):
method handle_ROW_DESCRIPTION (line 1749) | def handle_ROW_DESCRIPTION(self, data, cursor):
method execute (line 1765) | def execute(self, cursor, operation, vals):
method _send_message (line 1928) | def _send_message(self, code, data):
method send_EXECUTE (line 1942) | def send_EXECUTE(self, cursor):
method handle_NO_DATA (line 1952) | def handle_NO_DATA(self, msg, ps):
method handle_COMMAND_COMPLETE (line 1955) | def handle_COMMAND_COMPLETE(self, data, cursor):
method handle_DATA_ROW (line 1972) | def handle_DATA_ROW(self, data, cursor):
method handle_messages (line 1985) | def handle_messages(self, cursor):
method close_prepared_statement (line 1999) | def close_prepared_statement(self, statement_name_bin):
method handle_NOTICE_RESPONSE (line 2010) | def handle_NOTICE_RESPONSE(self, data, ps):
method handle_PARAMETER_STATUS (line 2014) | def handle_PARAMETER_STATUS(self, data, ps):
method array_inspect (line 2060) | def array_inspect(self, value):
method xid (line 2158) | def xid(self, format_id, global_transaction_id, branch_qualifier):
method tpc_begin (line 2166) | def tpc_begin(self, xid):
method tpc_prepare (line 2183) | def tpc_prepare(self):
method tpc_commit (line 2197) | def tpc_commit(self, xid=None):
method tpc_rollback (line 2236) | def tpc_rollback(self, xid=None):
method tpc_recover (line 2272) | def tpc_recover(self):
function walk_array (line 2355) | def walk_array(arr):
function array_find_first_element (line 2364) | def array_find_first_element(arr):
function array_flatten (line 2371) | def array_flatten(arr):
function array_check_dimensions (line 2380) | def array_check_dimensions(arr):
function array_has_null (line 2403) | def array_has_null(arr):
function array_dim_lengths (line 2410) | def array_dim_lengths(arr):
FILE: tests/dbapi20.py
class DatabaseAPI20Test (line 67) | class DatabaseAPI20Test(unittest.TestCase):
method executeDDL1 (line 107) | def executeDDL1(self, cursor):
method executeDDL2 (line 110) | def executeDDL2(self, cursor):
method setUp (line 113) | def setUp(self):
method tearDown (line 119) | def tearDown(self):
method _connect (line 138) | def _connect(self):
method test_connect (line 145) | def test_connect(self):
method test_apilevel (line 149) | def test_apilevel(self):
method test_threadsafety (line 158) | def test_threadsafety(self):
method test_paramstyle (line 167) | def test_paramstyle(self):
method test_Exceptions (line 178) | def test_Exceptions(self):
method test_ExceptionsAsConnectionAttributes (line 198) | def test_ExceptionsAsConnectionAttributes(self):
method test_commit (line 220) | def test_commit(self):
method test_rollback (line 228) | def test_rollback(self):
method test_cursor (line 239) | def test_cursor(self):
method test_cursor_isolation (line 246) | def test_cursor_isolation(self):
method test_description (line 265) | def test_description(self):
method test_rowcount (line 298) | def test_rowcount(self):
method test_callproc (line 329) | def test_callproc(self):
method test_close (line 346) | def test_close(self):
method test_execute (line 364) | def test_execute(self):
method _paraminsert (line 372) | def _paraminsert(self, cur):
method test_executemany (line 417) | def test_executemany(self):
method test_fetchone (line 466) | def test_fetchone(self):
method _populate (line 518) | def _populate(self):
method test_fetchmany (line 527) | def test_fetchmany(self):
method test_fetchall (line 609) | def test_fetchall(self):
method test_mixedfetch (line 657) | def test_mixedfetch(self):
method help_nextset_setUp (line 688) | def help_nextset_setUp(self, cur):
method help_nextset_tearDown (line 695) | def help_nextset_tearDown(self, cur):
method test_nextset (line 699) | def test_nextset(self):
method test_arraysize (line 733) | def test_arraysize(self):
method test_setinputsizes (line 744) | def test_setinputsizes(self):
method test_setoutputsize_basic (line 753) | def test_setoutputsize_basic(self):
method test_setoutputsize (line 764) | def test_setoutputsize(self):
method test_None (line 768) | def test_None(self):
method test_Date (line 783) | def test_Date(self):
method test_Time (line 790) | def test_Time(self):
method test_Timestamp (line 797) | def test_Timestamp(self):
method test_Binary (line 804) | def test_Binary(self):
method test_STRING (line 808) | def test_STRING(self):
method test_BINARY (line 813) | def test_BINARY(self):
method test_NUMBER (line 818) | def test_NUMBER(self):
method test_DATETIME (line 822) | def test_DATETIME(self):
method test_ROWID (line 827) | def test_ROWID(self):
FILE: tests/test_connection.py
class TrustAllX509TrustManager (line 17) | class TrustAllX509TrustManager(X509TrustManager):
method checkClientTrusted (line 21) | def checkClientTrusted(self, chain, auth):
method checkServerTrusted (line 24) | def checkServerTrusted(self, chain, auth):
method getAcceptedIssuers (line 27) | def getAcceptedIssuers(self):
function trust_all_certificates (line 39) | def trust_all_certificates(f):
class Tests (line 58) | class Tests(unittest.TestCase):
method testSocketMissing (line 59) | def testSocketMissing(self):
method testDatabaseMissing (line 65) | def testDatabaseMissing(self):
method testNotify (line 70) | def testNotify(self):
method testMd5 (line 90) | def testMd5(self):
method testGss (line 105) | def testGss(self):
method testSsl (line 119) | def testSsl(self):
method testPassword (line 128) | def testPassword(self):
method testUnicodeDatabaseName (line 140) | def testUnicodeDatabaseName(self):
method testBytesDatabaseName (line 152) | def testBytesDatabaseName(self):
method testBytesPassword (line 165) | def testBytesPassword(self):
method testBrokenPipe (line 200) | def testBrokenPipe(self):
method testApplicatioName (line 222) | def testApplicatioName(self):
FILE: tests/test_copy.py
class Tests (line 8) | class Tests(unittest.TestCase):
method setUp (line 9) | def setUp(self):
method tearDown (line 31) | def tearDown(self):
method testCopyToWithTable (line 34) | def testCopyToWithTable(self):
method testCopyToWithQuery (line 53) | def testCopyToWithQuery(self):
method testCopyFromWithTable (line 66) | def testCopyFromWithTable(self):
method testCopyFromWithQuery (line 80) | def testCopyFromWithQuery(self):
method testCopyFromWithError (line 96) | def testCopyFromWithError(self):
FILE: tests/test_dbapi.py
class Tests (line 13) | class Tests(unittest.TestCase):
method setUp (line 14) | def setUp(self):
method tearDown (line 57) | def tearDown(self):
method testParallelQueries (line 60) | def testParallelQueries(self):
method testQmark (line 83) | def testQmark(self):
method testNumeric (line 99) | def testNumeric(self):
method testNamed (line 115) | def testNamed(self):
method testFormat (line 132) | def testFormat(self):
method testPyformat (line 148) | def testPyformat(self):
method testArraysize (line 165) | def testArraysize(self):
method testDate (line 176) | def testDate(self):
method testTime (line 180) | def testTime(self):
method testTimestamp (line 184) | def testTimestamp(self):
method testDateFromTicks (line 188) | def testDateFromTicks(self):
method testTimeFromTicks (line 193) | def testTimeFromTicks(self):
method testTimestampFromTicks (line 198) | def testTimestampFromTicks(self):
method testBinary (line 203) | def testBinary(self):
method testRowCount (line 208) | def testRowCount(self):
method testFetchMany (line 226) | def testFetchMany(self):
method testIterator (line 239) | def testIterator(self):
method testVacuum (line 259) | def testVacuum(self):
method testPreparedStatement (line 267) | def testPreparedStatement(self):
FILE: tests/test_error_recovery.py
class TestException (line 9) | class TestException(Exception):
class Tests (line 13) | class Tests(unittest.TestCase):
method setUp (line 14) | def setUp(self):
method tearDown (line 17) | def tearDown(self):
method raiseException (line 20) | def raiseException(self, value):
method testPyValueFail (line 23) | def testPyValueFail(self):
method testNoDataErrorRecovery (line 51) | def testNoDataErrorRecovery(self):
method testClosedConnection (line 65) | def testClosedConnection(self):
FILE: tests/test_paramstyle.py
class Tests (line 6) | class Tests(unittest.TestCase):
method testQmark (line 7) | def testQmark(self):
method testQmark2 (line 16) | def testQmark2(self):
method testNumeric (line 24) | def testNumeric(self):
method testNamed (line 30) | def testNamed(self):
method testFormat (line 36) | def testFormat(self):
method testFormatMultiline (line 51) | def testFormatMultiline(self):
method testPyformat (line 58) | def testPyformat(self):
FILE: tests/test_pg8000_dbapi20.py
class Tests (line 8) | class Tests(dbapi20.DatabaseAPI20Test):
method test_nextset (line 15) | def test_nextset(self):
method test_setoutputsize (line 18) | def test_setoutputsize(self):
FILE: tests/test_query.py
class Tests (line 14) | class Tests(unittest.TestCase):
method setUp (line 15) | def setUp(self):
method tearDown (line 37) | def tearDown(self):
method testDatabaseError (line 40) | def testDatabaseError(self):
method testParallelQueries (line 51) | def testParallelQueries(self):
method testParallelOpenPortals (line 86) | def testParallelOpenPortals(self):
method testAlter (line 108) | def testAlter(self):
method testCreate (line 121) | def testCreate(self):
method testInsertReturning (line 132) | def testInsertReturning(self):
method testRowCount (line 160) | def testRowCount(self):
method testRowCountUpdate (line 206) | def testRowCountUpdate(self):
method testIntOid (line 230) | def testIntOid(self):
method testUnicodeQuery (line 240) | def testUnicodeQuery(self):
method testExecutemany (line 252) | def testExecutemany(self):
method testTransactions (line 271) | def testTransactions(self):
method testIn (line 288) | def testIn(self):
method test_no_previous_tpc (line 298) | def test_no_previous_tpc(self):
method test_tpc_recover (line 308) | def test_tpc_recover(self):
method test_empty_query (line 320) | def test_empty_query(self):
method test_rollback_no_transaction (line 328) | def test_rollback_no_transaction(self):
method test_context_manager_class (line 353) | def test_context_manager_class(self):
method test_deallocate_prepared_statements (line 360) | def test_deallocate_prepared_statements(self):
FILE: tests/test_typeconversion.py
class Tests (line 23) | class Tests(unittest.TestCase):
method setUp (line 24) | def setUp(self):
method tearDown (line 28) | def tearDown(self):
method testTimeRoundtrip (line 33) | def testTimeRoundtrip(self):
method testDateRoundtrip (line 38) | def testDateRoundtrip(self):
method testBoolRoundtrip (line 44) | def testBoolRoundtrip(self):
method testNullRoundtrip (line 49) | def testNullRoundtrip(self):
method testNullSelectFailure (line 64) | def testNullSelectFailure(self):
method testDecimalRoundtrip (line 72) | def testDecimalRoundtrip(self):
method testFloatRoundtrip (line 81) | def testFloatRoundtrip(self):
method test_float_plus_infinity_roundtrip (line 92) | def test_float_plus_infinity_roundtrip(self):
method testStrRoundtrip (line 98) | def testStrRoundtrip(self):
method test_str_then_int (line 113) | def test_str_then_int(self):
method testUnicodeRoundtrip (line 124) | def testUnicodeRoundtrip(self):
method testLongRoundtrip (line 130) | def testLongRoundtrip(self):
method testIntExecuteMany (line 136) | def testIntExecuteMany(self):
method testIntRoundtrip (line 148) | def testIntRoundtrip(self):
method testByteaRoundtrip (line 173) | def testByteaRoundtrip(self):
method test_bytearray_round_trip (line 180) | def test_bytearray_round_trip(self):
method test_bytearray_subclass_round_trip (line 186) | def test_bytearray_subclass_round_trip(self):
method testTimestampRoundtrip (line 194) | def testTimestampRoundtrip(self):
method testIntervalRoundtrip (line 217) | def testIntervalRoundtrip(self):
method test_enum_str_round_trip (line 228) | def test_enum_str_round_trip(self):
method test_enum_custom_round_trip (line 248) | def test_enum_custom_round_trip(self):
method test_enum_py_round_trip (line 276) | def test_enum_py_round_trip(self):
method testXmlRoundtrip (line 308) | def testXmlRoundtrip(self):
method testUuidRoundtrip (line 314) | def testUuidRoundtrip(self):
method testInetRoundtrip (line 320) | def testInetRoundtrip(self):
method testXidRoundtrip (line 341) | def testXidRoundtrip(self):
method testInt2VectorIn (line 353) | def testInt2VectorIn(self):
method testTimestampTzOut (line 362) | def testTimestampTzOut(self):
method testTimestampTzRoundtrip (line 374) | def testTimestampTzRoundtrip(self):
method testTimestampMismatch (line 384) | def testTimestampMismatch(self):
method testNameOut (line 424) | def testNameOut(self):
method testOidOut (line 430) | def testOidOut(self):
method testBooleanOut (line 435) | def testBooleanOut(self):
method testNumericOut (line 440) | def testNumericOut(self):
method testInt2Out (line 446) | def testInt2Out(self):
method testInt4Out (line 451) | def testInt4Out(self):
method testInt8Out (line 456) | def testInt8Out(self):
method testFloat4Out (line 461) | def testFloat4Out(self):
method testFloat8Out (line 466) | def testFloat8Out(self):
method testVarcharOut (line 471) | def testVarcharOut(self):
method testCharOut (line 476) | def testCharOut(self):
method testTextOut (line 481) | def testTextOut(self):
method testIntervalOut (line 486) | def testIntervalOut(self):
method testTimestampOut (line 507) | def testTimestampOut(self):
method testBinaryOutputMethods (line 515) | def testBinaryOutputMethods(self):
method testInt4ArrayOut (line 527) | def testInt4ArrayOut(self):
method testInt2ArrayOut (line 537) | def testInt2ArrayOut(self):
method testInt8ArrayOut (line 547) | def testInt8ArrayOut(self):
method testBoolArrayOut (line 557) | def testBoolArrayOut(self):
method testFloat4ArrayOut (line 570) | def testFloat4ArrayOut(self):
method testFloat8ArrayOut (line 580) | def testFloat8ArrayOut(self):
method testIntArrayRoundtrip (line 590) | def testIntArrayRoundtrip(self):
method testIntArrayWithNullRoundtrip (line 623) | def testIntArrayWithNullRoundtrip(self):
method testFloatArrayRoundtrip (line 628) | def testFloatArrayRoundtrip(self):
method testBoolArrayRoundtrip (line 633) | def testBoolArrayRoundtrip(self):
method testStringArrayOut (line 638) | def testStringArrayOut(self):
method testNumericArrayOut (line 654) | def testNumericArrayOut(self):
method testNumericArrayRoundtrip (line 661) | def testNumericArrayRoundtrip(self):
method testStringArrayRoundtrip (line 667) | def testStringArrayRoundtrip(self):
method testUnicodeArrayRoundtrip (line 676) | def testUnicodeArrayRoundtrip(self):
method testEmptyArray (line 683) | def testEmptyArray(self):
method testArrayContentNotSupported (line 689) | def testArrayContentNotSupported(self):
method testArrayDimensions (line 697) | def testArrayDimensions(self):
method testArrayHomogenous (line 710) | def testArrayHomogenous(self):
method testArrayInspect (line 717) | def testArrayInspect(self):
method testMacaddr (line 722) | def testMacaddr(self):
method testTsvectorRoundtrip (line 727) | def testTsvectorRoundtrip(self):
method testHstoreRoundtrip (line 735) | def testHstoreRoundtrip(self):
method testJsonRoundtrip (line 741) | def testJsonRoundtrip(self):
method testJsonbRoundtrip (line 749) | def testJsonbRoundtrip(self):
method test_json_access_object (line 757) | def test_json_access_object(self):
method test_jsonb_access_object (line 765) | def test_jsonb_access_object(self):
method test_json_access_array (line 773) | def test_json_access_array(self):
method testJsonbAccessArray (line 781) | def testJsonbAccessArray(self):
method test_jsonb_access_path (line 789) | def test_jsonb_access_path(self):
method test_timestamp_send_float (line 801) | def test_timestamp_send_float(self):
method test_infinity_timestamp_roundtrip (line 806) | def test_infinity_timestamp_roundtrip(self):
FILE: tests/test_typeobjects.py
class Tests (line 6) | class Tests(unittest.TestCase):
method setUp (line 7) | def setUp(self):
method tearDown (line 10) | def tearDown(self):
method testIntervalConstructor (line 13) | def testIntervalConstructor(self):
method intervalRangeTest (line 19) | def intervalRangeTest(self, parameter, in_range, out_of_range):
method testIntervalDaysRange (line 29) | def testIntervalDaysRange(self):
method testIntervalMonthsRange (line 34) | def testIntervalMonthsRange(self):
method testIntervalMicrosecondsRange (line 39) | def testIntervalMicrosecondsRange(self):
FILE: versioneer.py
class VersioneerConfig (line 355) | class VersioneerConfig:
function get_root (line 359) | def get_root():
function get_config_from_root (line 393) | def get_config_from_root(root):
class NotThisMethod (line 419) | class NotThisMethod(Exception):
function register_vcs_handler (line 427) | def register_vcs_handler(vcs, method): # decorator
function run_command (line 436) | def run_command(commands, args, cwd=None, verbose=False, hide_stderr=Fal...
function git_get_keywords (line 931) | def git_get_keywords(versionfile_abs):
function git_versions_from_keywords (line 955) | def git_versions_from_keywords(keywords, tag_prefix, verbose):
function git_pieces_from_vcs (line 1000) | def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_comma...
function do_vcs_install (line 1081) | def do_vcs_install(manifest_in, versionfile_source, ipy):
function versions_from_parentdir (line 1114) | def versions_from_parentdir(parentdir_prefix, root, verbose):
function versions_from_file (line 1146) | def versions_from_file(filename):
function write_to_version_file (line 1159) | def write_to_version_file(filename, versions):
function plus_or_dot (line 1169) | def plus_or_dot(pieces):
function render_pep440 (line 1175) | def render_pep440(pieces):
function render_pep440_pre (line 1199) | def render_pep440_pre(pieces):
function render_pep440_post (line 1215) | def render_pep440_post(pieces):
function render_pep440_old (line 1241) | def render_pep440_old(pieces):
function render_git_describe (line 1261) | def render_git_describe(pieces):
function render_git_describe_long (line 1280) | def render_git_describe_long(pieces):
function render (line 1298) | def render(pieces, style):
class VersioneerBadRootError (line 1327) | class VersioneerBadRootError(Exception):
function get_versions (line 1331) | def get_versions(verbose=False):
function get_version (line 1404) | def get_version():
function get_cmdclass (line 1408) | def get_cmdclass():
function do_setup (line 1577) | def do_setup():
function scan_setup_py (line 1658) | def scan_setup_py():
Condensed preview — 27 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (296K chars).
[
{
"path": ".gitattributes",
"chars": 32,
"preview": "pg8000/_version.py export-subst\n"
},
{
"path": ".gitignore",
"chars": 87,
"preview": "*.py[co]\n*.swp\n*.orig\n*.class\nbuild\npg8000.egg-info\ntmp\ndist\n.tox\nMANIFEST\nvenv\n.cache\n"
},
{
"path": ".travis.yml",
"chars": 1069,
"preview": "sudo: required\nlanguage: python\npython:\n - \"2.7\"\n - \"3.5\"\n - \"3.6\"\n - \"pypy3.5\"\n\nenv:\n - DB=\"9.5\"\n - DB=\"9.6\"\n\nser"
},
{
"path": "LICENSE",
"chars": 1438,
"preview": "Copyright (c) 2007-2009, Mathieu Fenniak\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with o"
},
{
"path": "MANIFEST.in",
"chars": 101,
"preview": "include README.creole\ninclude versioneer.py\ninclude pg8000/_version.py\ninclude LICENSE\ninclude doc/*\n"
},
{
"path": "README.adoc",
"chars": 86,
"preview": "= pg8000\n\nHello, the pg8000 repository has moved to https://github.com/tlocke/pg8000.\n"
},
{
"path": "multi",
"chars": 179,
"preview": "#!/bin/bash\n\n# set postgres share memory to minimum to trigger unpinned buffer errors.\n\nfor i in {1..100}\ndo\n\tpython -m "
},
{
"path": "pg8000/__init__.py",
"chars": 6592,
"preview": "from pg8000.core import (\n Warning, Bytea, DataError, DatabaseError, InterfaceError, ProgrammingError,\n Error, Ope"
},
{
"path": "pg8000/_version.py",
"chars": 15763,
"preview": "\n# This file helps to compute a version number in source trees obtained from\n# git-archive tarball (such as those provid"
},
{
"path": "pg8000/core.py",
"chars": 84419,
"preview": "from datetime import (\n timedelta as Timedelta, datetime as Datetime, tzinfo, date, time)\nfrom warnings import warn\ni"
},
{
"path": "setup.cfg",
"chars": 230,
"preview": "[upload_docs]\nupload-dir = build/sphinx/html\n\n[bdist_wheel]\nuniversal=1\n\n[versioneer]\nVCS = git\nstyle = pep440\nversionfi"
},
{
"path": "setup.py",
"chars": 2176,
"preview": "#!/usr/bin/env python\n\nimport versioneer\nfrom setuptools import setup\n\nlong_description = \"\"\"\\\n\npg8000\n------\n\npg8000 is"
},
{
"path": "tests/connection_settings.py",
"chars": 79,
"preview": "db_connect = {\n 'user': 'postgres',\n 'password': 'pw',\n 'port': 5432}\n"
},
{
"path": "tests/dbapi20.py",
"chars": 31386,
"preview": "#!/usr/bin/env python\nimport unittest\nimport time\nimport warnings\nfrom six import b\n''' Python DB API 2.0 driver complia"
},
{
"path": "tests/performance.py",
"chars": 2215,
"preview": "import pg8000\nfrom pg8000.tests.connection_settings import db_connect\nimport time\nimport warnings\nfrom contextlib import"
},
{
"path": "tests/stress.py",
"chars": 1036,
"preview": "import pg8000\nfrom pg8000.tests.connection_settings import db_connect\nfrom contextlib import closing\n\n\nwith closing(pg80"
},
{
"path": "tests/test_connection.py",
"chars": 7887,
"preview": "import unittest\nimport pg8000\nfrom connection_settings import db_connect\nfrom six import PY2, u\nimport sys\nfrom distutil"
},
{
"path": "tests/test_copy.py",
"chars": 4265,
"preview": "import unittest\nimport pg8000\nfrom connection_settings import db_connect\nfrom six import b, BytesIO, u, iteritems\nfrom s"
},
{
"path": "tests/test_dbapi.py",
"chars": 8591,
"preview": "import unittest\nimport os\nimport time\nimport pg8000\nimport datetime\nfrom connection_settings import db_connect\nfrom sys "
},
{
"path": "tests/test_error_recovery.py",
"chars": 2540,
"preview": "import unittest\nimport pg8000\nfrom connection_settings import db_connect\nimport warnings\nimport datetime\nfrom sys import"
},
{
"path": "tests/test_paramstyle.py",
"chars": 3318,
"preview": "import unittest\nimport pg8000\n\n\n# Tests of the convert_paramstyle function.\nclass Tests(unittest.TestCase):\n def test"
},
{
"path": "tests/test_pg8000_dbapi20.py",
"chars": 421,
"preview": "#!/usr/bin/env python\nimport dbapi20\nimport unittest\nimport pg8000\nfrom connection_settings import db_connect\n\n\nclass Te"
},
{
"path": "tests/test_query.py",
"chars": 12955,
"preview": "import unittest\nimport pg8000\nfrom connection_settings import db_connect\nfrom six import u\nfrom sys import exc_info\nimpo"
},
{
"path": "tests/test_typeconversion.py",
"chars": 31962,
"preview": "import unittest\nimport pg8000\nfrom pg8000 import PGJsonb, PGEnum\nimport datetime\nimport decimal\nimport struct\nfrom conne"
},
{
"path": "tests/test_typeobjects.py",
"chars": 1535,
"preview": "import unittest\nfrom pg8000 import Interval\n\n\n# Type conversion tests\nclass Tests(unittest.TestCase):\n def setUp(self"
},
{
"path": "tox.ini",
"chars": 434,
"preview": "# Tox (http://tox.testrun.org/) is a tool for running tests\n# in multiple virtualenvs. This configuration file will run "
},
{
"path": "versioneer.py",
"chars": 62474,
"preview": "\n# Version: 0.15\n\n\"\"\"\nThe Versioneer\n==============\n\n* like a rocketeer, but for versions!\n* https://github.com/warner/p"
}
]
About this extraction
This page contains the full source code of the mfenniak/pg8000 GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 27 files (276.6 KB), approximately 68.4k tokens, and a symbol index with 408 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.