Datasets:

CarperAI

/

github-diffs-deduped

like 3

Follow

CarperAI 142

1500

<NME> session.py <BEF> """The Session class allows for a unified (and simplified) view of interfacing with a PostgreSQL database server. Connection details are passed in as a PostgreSQL URI and connections are pooled by default, allowing for reuse of connections across modules in the Python runtime without having to pass around the object handle. While you can still access the raw `psycopg2` connection and cursor objects to provide ultimate flexibility in how you use the queries.Session object, there are convenience methods designed to simplify the interaction with PostgreSQL. For `psycopg2` functionality outside of what is exposed in Session, simply use the Session.connection or Session.cursor properties to gain access to either object just as you would in a program using psycopg2 directly. Example usage: .. code:: python import queries with queries.Session('pgsql://postgres@localhost/postgres') as session: for row in session.Query('SELECT * FROM table'): print row """ import hashlib import logging import psycopg2 from psycopg2 import extensions, extras from queries import pool, results, utils LOGGER = logging.getLogger(__name__) DEFAULT_ENCODING = 'UTF8' DEFAULT_URI = 'postgresql://localhost:5432' class Session(object): """The Session class allows for a unified (and simplified) view of interfacing with a PostgreSQL database server. The Session object can act as a context manager, providing automated cleanup and simple, Pythonic way of interacting with the object. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ _conn = None _cursor = None _tpc_id = None _uri = None # Connection status constants INTRANS = extensions.STATUS_IN_TRANSACTION PREPARED = extensions.STATUS_PREPARED READY = extensions.STATUS_READY SETUP = extensions.STATUS_SETUP # Transaction status constants TX_ACTIVE = extensions.TRANSACTION_STATUS_ACTIVE TX_IDLE = extensions.TRANSACTION_STATUS_IDLE TX_INERROR = extensions.TRANSACTION_STATUS_INERROR TX_INTRANS = extensions.TRANSACTION_STATUS_INTRANS TX_UNKNOWN = extensions.TRANSACTION_STATUS_UNKNOWN def __init__(self, uri=DEFAULT_URI, cursor_factory=extras.RealDictCursor, pool_idle_ttl=pool.DEFAULT_IDLE_TTL, pool_max_size=pool.DEFAULT_MAX_SIZE): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ self._pool_manager = pool.PoolManager.instance() self._uri = uri # Ensure the pool exists in the pool manager if self.pid not in self._pool_manager: self._pool_manager.create(self.pid, pool_idle_ttl, pool_max_size) self._conn = self._connect() self._cursor_factory = cursor_factory self._cursor = self._get_cursor(self._conn) self._autocommit() @property def backend_pid(self): """Return the backend process ID of the PostgreSQL server that this session is connected to. :rtype: int """ return self._conn.get_backend_pid() def callproc(self, name, args=None): """Call a stored procedure on the server, returning the results in a :py:class:`queries.Results` instance. :param str name: The procedure name :param list args: The list of arguments to pass in :rtype: queries.Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ try: self._cursor.callproc(name, args) except psycopg2.Error as err: self._incr_exceptions() raise err finally: self._incr_executions() return results.Results(self._cursor) def close(self): """Explicitly close the connection and remove it from the connection pool if pooling is enabled. If the connection is already closed :raises: psycopg2.InterfaceError """ if not self._conn: raise psycopg2.InterfaceError('Connection not open') LOGGER.info('Closing connection %r in %s', self._conn, self.pid) self._pool_manager.free(self.pid, self._conn) self._pool_manager.remove_connection(self.pid, self._conn) # Un-assign the connection and cursor self._conn, self._cursor = None, None @property def connection(self): """Return the current open connection to PostgreSQL. :rtype: psycopg2.extensions.connection """ return self._conn @property def cursor(self): """Return the current, active cursor for the open connection. :rtype: psycopg2.extensions.cursor """ return self._cursor @property def encoding(self): """Return the current client encoding value. :rtype: str """ return self._conn.encoding @property def notices(self): """Return a list of up to the last 50 server notices sent to the client. :rtype: list """ return self._conn.notices @property def pid(self): """Return the pool ID used for connection pooling. :rtype: str """ return hashlib.md5(':'.join([self.__class__.__name__, self._uri]).encode('utf-8')).hexdigest() def query(self, sql, parameters=None): """A generator to issue a query on the server, mogrifying the parameters against the sql statement. Results are returned as a :py:class:`queries.Results` object which can act as an iterator and has multiple ways to access the result data. :param str sql: The SQL statement :param dict parameters: A dictionary of query parameters :rtype: queries.Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ try: self._cursor.execute(sql, parameters) except psycopg2.Error as err: self._incr_exceptions() raise err finally: self._incr_executions() return results.Results(self._cursor) def set_encoding(self, value=DEFAULT_ENCODING): """Set the client encoding for the session if the value specified is different than the current client encoding. :param str value: The encoding value to use """ if self._conn.encoding != value: self._conn.set_client_encoding(value) def __del__(self): """When deleting the context, ensure the instance is removed from caches, etc. """ self._cleanup() def __enter__(self): """For use as a context manager, return a handle to this object instance. :rtype: Session """ return self def __exit__(self, exc_type, exc_val, exc_tb): """When leaving the context, ensure the instance is removed from caches, etc. """ self._cleanup() def _autocommit(self): """Set the isolation level automatically to commit after every query""" self._conn.autocommit = True def _cleanup(self): """Remove the connection from the stack, closing out the cursor""" def _cleanup(self): """Remove the connection from the stack, closing out the cursor""" if self._cursor: LOGGER.debug('Closing the cursor on %s', self.pid) self._cursor.close() self._cursor = None if self._conn: LOGGER.debug('Freeing %s in the pool', self.pid) try: pool.PoolManager.instance().free(self.pid, self._conn) except pool.ConnectionNotFoundError: pass self._conn = None def _connect(self): """Connect to PostgreSQL, either by reusing a connection from the pool if possible, or by creating the new connection. :rtype: psycopg2.extensions.connection :raises: pool.NoIdleConnectionsError """ # Attempt to get a cached connection from the connection pool try: connection = self._pool_manager.get(self.pid, self) LOGGER.debug("Re-using connection for %s", self.pid) except pool.NoIdleConnectionsError: if self._pool_manager.is_full(self.pid): raise # Create a new PostgreSQL connection kwargs = utils.uri_to_kwargs(self._uri) LOGGER.debug("Creating a new connection for %s", self.pid) connection = self._psycopg2_connect(kwargs) self._pool_manager.add(self.pid, connection) self._pool_manager.lock(self.pid, connection, self) # Added in because psycopg2ct connects and leaves the connection in # a weird state: consts.STATUS_DATESTYLE, returning from # Connection._setup without setting the state as const.STATUS_OK if utils.PYPY: connection.reset() # Register the custom data types self._register_unicode(connection) self._register_uuid(connection) return connection def _get_cursor(self, connection, name=None): """Return a cursor for the given cursor_factory. Specify a name to use server-side cursors. :param connection: The connection to create a cursor on :type connection: psycopg2.extensions.connection :param str name: A cursor name for a server side cursor :rtype: psycopg2.extensions.cursor """ cursor = connection.cursor(name=name, cursor_factory=self._cursor_factory) if name is not None: cursor.scrollable = True cursor.withhold = True return cursor def _incr_exceptions(self): """Increment the number of exceptions for the current connection.""" self._pool_manager.get_connection(self.pid, self._conn).exceptions += 1 def _incr_executions(self): """Increment the number of executions for the current connection.""" self._pool_manager.get_connection(self.pid, self._conn).executions += 1 def _psycopg2_connect(self, kwargs): """Return a psycopg2 connection for the specified kwargs. Extend for use in async session adapters. :param dict kwargs: Keyword connection args :rtype: psycopg2.extensions.connection """ return psycopg2.connect(**kwargs) @staticmethod def _register_unicode(connection): """Register the cursor to be able to receive Unicode string. :type connection: psycopg2.extensions.connection :param connection: Where to register things """ psycopg2.extensions.register_type(psycopg2.extensions.UNICODE, connection) psycopg2.extensions.register_type(psycopg2.extensions.UNICODEARRAY, connection) @staticmethod def _register_uuid(connection): """Register the UUID extension from the psycopg2.extra module :type connection: psycopg2.extensions.connection :param connection: Where to register things """ psycopg2.extras.register_uuid(conn_or_curs=connection) @property def _status(self): """Return the current connection status as an integer value. The status should match one of the following constants: - queries.Session.INTRANS: Connection established, in transaction - queries.Session.PREPARED: Prepared for second phase of transaction - queries.Session.READY: Connected, no active transaction :rtype: int """ if self._conn.status == psycopg2.extensions.STATUS_BEGIN: return self.READY return self._conn.status <MSG> Add ability to override autocommit option for the session. There could be cases when someone wants to execute multiple write queries and run it entirely as a transaction (as opposed to each query being committed). In its current implementation, you cannot override the session's autocommit policy without having to access private attributes. <DFF> @@ -70,7 +70,8 @@ class Session(object): def __init__(self, uri=DEFAULT_URI, cursor_factory=extras.RealDictCursor, pool_idle_ttl=pool.DEFAULT_IDLE_TTL, - pool_max_size=pool.DEFAULT_MAX_SIZE): + pool_max_size=pool.DEFAULT_MAX_SIZE + autocommit=True): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. @@ -90,7 +91,7 @@ class Session(object): self._conn = self._connect() self._cursor_factory = cursor_factory self._cursor = self._get_cursor(self._conn) - self._autocommit() + self._autocommit(autocommit) @property def backend_pid(self): @@ -251,9 +252,9 @@ class Session(object): """ self._cleanup() - def _autocommit(self): + def _autocommit(self, autocommit): """Set the isolation level automatically to commit after every query""" - self._conn.autocommit = True + self._conn.autocommit = autocommit def _cleanup(self): """Remove the connection from the stack, closing out the cursor"""

Add ability to override autocommit option for the session.

.py

py

bsd-3-clause

gmr/queries

1501

<NME> setup.py <BEF> import os import platform import setuptools # PYPY vs cpython if platform.python_implementation() == 'PyPy': install_requires = ['psycopg2cffi>=2.7.2,<3'] else: install_requires = ['psycopg2>=2.5.1,<3'] # Install tornado if generating docs on readthedocs if os.environ.get('READTHEDOCS', None) == 'True': install_requires.append('tornado') setuptools.setup( name='queries', version='2.1.0', description='Simplified PostgreSQL client built upon Psycopg2', long_description=open('README.rst').read(), maintainer='Gavin M. Roy', maintainer_email='gavinmroy@gmail.com', url='https://github.com/gmr/queries', install_requires=install_requires, extras_require={'tornado': 'tornado<6'}, license='BSD', package_data={'': ['LICENSE', 'README.rst']}, packages=['queries'], classifiers=[ 'Topic :: Software Development :: Libraries'] setup(name='queries', version='1.6.0', description="Simplified PostgreSQL client built upon Psycopg2", maintainer="Gavin M. Roy", maintainer_email="gavinmroy@gmail.com", 'Programming Language :: Python :: 3.4', 'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3.8', 'Programming Language :: Python :: Implementation :: CPython', 'Programming Language :: Python :: Implementation :: PyPy', 'Topic :: Database', 'Topic :: Software Development :: Libraries'], zip_safe=True) <MSG> Bump rev, dates <DFF> @@ -30,7 +30,7 @@ classifiers = ['Development Status :: 5 - Production/Stable', 'Topic :: Software Development :: Libraries'] setup(name='queries', - version='1.6.0', + version='1.6.1', description="Simplified PostgreSQL client built upon Psycopg2", maintainer="Gavin M. Roy", maintainer_email="gavinmroy@gmail.com",

Bump rev, dates

.py

py

bsd-3-clause

gmr/queries

1502

<NME> setup.py <BEF> import os import platform import setuptools # PYPY vs cpython if platform.python_implementation() == 'PyPy': install_requires = ['psycopg2cffi>=2.7.2,<3'] else: install_requires = ['psycopg2>=2.5.1,<3'] # Install tornado if generating docs on readthedocs if os.environ.get('READTHEDOCS', None) == 'True': install_requires.append('tornado') setuptools.setup( name='queries', version='2.1.0', description='Simplified PostgreSQL client built upon Psycopg2', long_description=open('README.rst').read(), maintainer='Gavin M. Roy', maintainer_email='gavinmroy@gmail.com', url='https://github.com/gmr/queries', install_requires=install_requires, extras_require={'tornado': 'tornado<6'}, license='BSD', package_data={'': ['LICENSE', 'README.rst']}, packages=['queries'], classifiers=[ 'Topic :: Software Development :: Libraries'] setup(name='queries', version='1.6.0', description="Simplified PostgreSQL client built upon Psycopg2", maintainer="Gavin M. Roy", maintainer_email="gavinmroy@gmail.com", 'Programming Language :: Python :: 3.4', 'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3.8', 'Programming Language :: Python :: Implementation :: CPython', 'Programming Language :: Python :: Implementation :: PyPy', 'Topic :: Database', 'Topic :: Software Development :: Libraries'], zip_safe=True) <MSG> Bump rev, dates <DFF> @@ -30,7 +30,7 @@ classifiers = ['Development Status :: 5 - Production/Stable', 'Topic :: Software Development :: Libraries'] setup(name='queries', - version='1.6.0', + version='1.6.1', description="Simplified PostgreSQL client built upon Psycopg2", maintainer="Gavin M. Roy", maintainer_email="gavinmroy@gmail.com",

Bump rev, dates

.py

py

bsd-3-clause

gmr/queries

1503

<NME> __init__.py <BEF> """ Queries: PostgreSQL database access simplified Queries is an opinionated wrapper for interfacing with PostgreSQL that offers caching of connections and support for PyPy via psycopg2ct. The core `queries.Queries` class will automatically register support for UUIDs, Unicode and Unicode arrays. """ import logging import sys try: import psycopg2cffi import psycopg2cffi.extras import psycopg2cffi.extensions except ImportError: pass else: sys.modules['psycopg2'] = psycopg2cffi sys.modules['psycopg2.extras'] = psycopg2cffi.extras sys.modules['psycopg2.extensions'] = psycopg2cffi.extensions from queries.results import Results from queries.session import Session try: from queries.tornado_session import TornadoSession except ImportError: # pragma: nocover TornadoSession = None from queries.utils import uri # For ease of access to different cursor types from psycopg2.extras import DictCursor from psycopg2.extras import NamedTupleCursor from psycopg2.extras import RealDictCursor from psycopg2.extras import LoggingCursor from psycopg2.extras import MinTimeLoggingCursor logging.getLogger('queries').addHandler(NullHandler()) # Defaults DEFAULT_URI = 'pgsql://postgres:localhost:5432/postgres' # Mappings to queries classes and methods from queries.session import Session from queries.simple import execute from queries.simple import uri # Expose exceptions so clients do not need to import psycopg2 too from psycopg2 import DataError from psycopg2 import DatabaseError logging.getLogger('queries').addHandler(logging.NullHandler()) <MSG> Updates to defaults and what is imported into the queries namespace <DFF> @@ -39,13 +39,19 @@ except ImportError: logging.getLogger('queries').addHandler(NullHandler()) # Defaults -DEFAULT_URI = 'pgsql://postgres:localhost:5432/postgres' +DEFAULT_URI = 'pgsql://localhost:5432' # Mappings to queries classes and methods from queries.session import Session -from queries.simple import execute +from queries.simple import callproc +from queries.simple import query from queries.simple import uri +# For ease of access to different cursor types +from psycopg2.extras import DictCursor +from psycopg2.extras import NamedTupleCursor +from psycopg2.extras import RealDictCursor + # Expose exceptions so clients do not need to import psycopg2 too from psycopg2 import DataError from psycopg2 import DatabaseError

Updates to defaults and what is imported into the queries namespace

.py

py

bsd-3-clause

gmr/queries

1504

<NME> __init__.py <BEF> """ Queries: PostgreSQL database access simplified Queries is an opinionated wrapper for interfacing with PostgreSQL that offers caching of connections and support for PyPy via psycopg2ct. The core `queries.Queries` class will automatically register support for UUIDs, Unicode and Unicode arrays. """ import logging import sys try: import psycopg2cffi import psycopg2cffi.extras import psycopg2cffi.extensions except ImportError: pass else: sys.modules['psycopg2'] = psycopg2cffi sys.modules['psycopg2.extras'] = psycopg2cffi.extras sys.modules['psycopg2.extensions'] = psycopg2cffi.extensions from queries.results import Results from queries.session import Session try: from queries.tornado_session import TornadoSession except ImportError: # pragma: nocover TornadoSession = None from queries.utils import uri # For ease of access to different cursor types from psycopg2.extras import DictCursor from psycopg2.extras import NamedTupleCursor from psycopg2.extras import RealDictCursor from psycopg2.extras import LoggingCursor from psycopg2.extras import MinTimeLoggingCursor logging.getLogger('queries').addHandler(NullHandler()) # Defaults DEFAULT_URI = 'pgsql://postgres:localhost:5432/postgres' # Mappings to queries classes and methods from queries.session import Session from queries.simple import execute from queries.simple import uri # Expose exceptions so clients do not need to import psycopg2 too from psycopg2 import DataError from psycopg2 import DatabaseError logging.getLogger('queries').addHandler(logging.NullHandler()) <MSG> Updates to defaults and what is imported into the queries namespace <DFF> @@ -39,13 +39,19 @@ except ImportError: logging.getLogger('queries').addHandler(NullHandler()) # Defaults -DEFAULT_URI = 'pgsql://postgres:localhost:5432/postgres' +DEFAULT_URI = 'pgsql://localhost:5432' # Mappings to queries classes and methods from queries.session import Session -from queries.simple import execute +from queries.simple import callproc +from queries.simple import query from queries.simple import uri +# For ease of access to different cursor types +from psycopg2.extras import DictCursor +from psycopg2.extras import NamedTupleCursor +from psycopg2.extras import RealDictCursor + # Expose exceptions so clients do not need to import psycopg2 too from psycopg2 import DataError from psycopg2 import DatabaseError

Updates to defaults and what is imported into the queries namespace

.py

py

bsd-3-clause

gmr/queries

1505

<NME> LICENSE <BEF> Copyright (c) 2014 - 2018 Gavin M. Roy 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. * Neither the name of the queries nor the names of its contributors may 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 HOLDER 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. <MSG> Bump the year in the license <DFF> @@ -1,4 +1,4 @@ -Copyright (c) 2014 - 2018 Gavin M. Roy +Copyright (c) 2014 - 2019 Gavin M. Roy All rights reserved. Redistribution and use in source and binary forms, with or without modification,

Bump the year in the license

LICENSE

bsd-3-clause

gmr/queries

1506

<NME> LICENSE <BEF> Copyright (c) 2014 - 2018 Gavin M. Roy 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. * Neither the name of the queries nor the names of its contributors may 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 HOLDER 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. <MSG> Bump the year in the license <DFF> @@ -1,4 +1,4 @@ -Copyright (c) 2014 - 2018 Gavin M. Roy +Copyright (c) 2014 - 2019 Gavin M. Roy All rights reserved. Redistribution and use in source and binary forms, with or without modification,

Bump the year in the license

LICENSE

bsd-3-clause

gmr/queries

1507

<NME> pool_tests.py <BEF> """ Tests for functionality in the pool module """ import time import unittest import unittest2 as unittest except ImportError: import unittest from queries import pool def test_add_when_pool_is_full_raises(self): obj = pool.Pool(str(uuid.uuid4()), max_size=1) obj.add(mock.Mock()) mock_conn = mock.Mock() self.assertRaises(pool.PoolFullError, obj.add, mock_conn) def test_closed_conn_invokes_remove_on_clean(self): psycopg2_conn = mock.Mock() psycopg2_conn.closed = True obj = pool.Pool(str(uuid.uuid4())) obj.remove = mock.Mock() obj.add(psycopg2_conn) obj.clean() obj.remove.assert_called_once_with(psycopg2_conn) def test_clean_closes_all_when_idle(self): obj = pool.Pool(str(uuid.uuid4()), idle_ttl=10) obj.idle_start = time.time() - 20 obj.close = mock.Mock() obj.clean() obj.close.assert_called_once_with() def test_close_close_removes_all(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) obj.remove = mock.Mock() psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] obj.close() psycopg2_calls = [mock.call(c) for c in psycopg2_conns] obj.remove.assert_has_calls(psycopg2_calls) def test_free_invokes_connection_free(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) self._connection = obj.connection_handle conn = self._connection(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conn) conn.free.assert_called_once_with() def test_free_raises_not_found_exception(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) conn = obj.connection_handle(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conn) conn.free.assert_called_once_with() def test_free_resets_idle_start(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): [obj.add(conn) for conn in psycopg2_conns] for psycopg2_conn in psycopg2_conns: conn = obj.connection_handle(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conns[1]) self.assertAlmostEqual(int(obj.idle_start), int(time.time())) def test_free_raises_on_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.free, mock.Mock()) def test_get_returns_first_psycopg2_conn(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] session = mock.Mock() self.assertEqual(obj.get(session), psycopg2_conns[0]) def test_get_locks_first_psycopg2_conn(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] lock = mock.Mock() with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False, lock=lock): session = mock.Mock() obj.get(session) lock.assert_called_once_with(session) def test_get_resets_idle_start_to_none(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): session = mock.Mock() obj.idle_start = time.time() obj.get(session) self.assertIsNone(obj.idle_start) def test_get_raises_when_no_idle_connections(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] session = mock.Mock() self.assertRaises(pool.NoIdleConnectionsError, obj.get, session) def test_idle_connections(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): self.assertListEqual([c.handle for c in obj.idle_connections], psycopg2_conns) def test_idle_duration_when_none(self): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = None self.assertEqual(obj.idle_duration, 0) def test_idle_duration_when_set(self): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = time.time() - 5 self.assertAlmostEqual(int(obj.idle_duration), 5) def test_is_full_property_when_full(self): obj = pool.Pool(str(uuid.uuid4()), max_size=2) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] self.assertTrue(obj.is_full) def test_is_full_property_when_not_full(self): obj = pool.Pool(str(uuid.uuid4()), max_size=3) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] self.assertFalse(obj.is_full) def test_connection_lock_is_called_when_lock_is(self): with mock.patch('queries.pool.Connection.lock') as lock: obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) session = mock.Mock() obj.lock(psycopg2_conn, session) lock.assert_called_once_with(session) def test_locks_raises_when_connection_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.lock, mock.Mock(), mock.Mock()) def test_lock_resets_idle_start(self): with mock.patch('queries.pool.Connection.lock'): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = time.time() psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.lock(psycopg2_conn, mock.Mock()) self.assertIsNone(obj.idle_start) def test_remove_removes_connection(self): with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.remove(psycopg2_conn) self.assertNotIn(psycopg2_conn, obj) def test_remove_closes_connection(self): close_method = mock.Mock() with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False, close=close_method): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.remove(psycopg2_conn) close_method.assert_called_once_with() def test_remove_raises_when_connection_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.remove, mock.Mock()) def test_remove_raises_when_connection_is_busy(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() psycopg2_conn.closed = False obj.add(psycopg2_conn) self.assertRaises(pool.ConnectionBusyError, obj.remove, psycopg2_conn) def test__connection_returns_handle(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) self.assertEqual( obj.connection_handle(psycopg2_conn).handle, psycopg2_conn) def test_shutdown_raises_when_executing(self): psycopg2_conn = mock_connection() psycopg2_conn.isexecuting.return_value = True obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertRaises(pool.ConnectionBusyError, obj.shutdown) <MSG> Test coverage of pool.Connection <DFF> @@ -7,7 +7,80 @@ try: import unittest2 as unittest except ImportError: import unittest +import weakref from queries import pool +class ConnectionTests(unittest.TestCase): + + def setUp(self): + self.handle = mock.Mock() + self.handle.close = mock.Mock() + self.handle.closed = True + self.handle.isexecuting = mock.Mock(return_value=False) + self.connection = pool.Connection(self.handle) + self.connection.used_by = None + + def test_handle_should_match(self): + self.assertEqual(self.handle, self.connection.handle) + + def test_busy_isexecuting_is_false(self): + self.assertFalse(self.connection.busy) + + def test_busy_isexecuting_is_true(self): + self.handle.isexecuting.return_value = True + self.assertTrue(self.connection.busy) + + def test_busy_is_used(self): + self.handle.isexecuting.return_value = False + self.connection.used_by = mock.Mock() + self.assertTrue(self.connection.busy) + + def test_closed_is_true(self): + self.handle.closed = True + self.assertTrue(self.connection.closed) + + def test_closed_is_false(self): + self.handle.closed = False + self.assertFalse(self.connection.closed) + + def test_close_raises_when_busy(self): + self.handle.isexecuting.return_value = True + self.assertRaises(pool.ConnectionBusyError, self.connection.close) + + def test_close_invokes_handle_close(self): + self.handle.isexecuting.return_value = False + self.connection.used_by = None + self.connection.close() + self.handle.close.assertCalledOnce() + + def test_free_raises_when_busy(self): + self.handle.isexecuting.return_value = True + self.assertRaises(pool.ConnectionBusyError, self.connection.free) + + def test_free_resets_used_by(self): + self.handle.isexecuting.return_value = False + self.connection.used_by = mock.Mock() + self.connection.free() + self.assertIsNone(self.connection.used_by) + + def test_id_value_matches(self): + self.assertEqual(id(self.handle), self.connection.id) + + def test_lock_raises_when_busy(self): + self.connection.used_by = mock.Mock() + self.assertRaises(pool.ConnectionBusyError, + self.connection.lock, mock.Mock()) + + def test_lock_session_used_by(self): + session = mock.Mock() + self.connection.lock(session) + self.assertIn(self.connection.used_by, + weakref.getweakrefs(session)) + + +class PoolTests(unittest.TestCase): + + def setup(self): + self.handle = mock.Mock(spec=pool.Connection)

Test coverage of pool.Connection

.py

py

bsd-3-clause

gmr/queries

1508

<NME> pool_tests.py <BEF> """ Tests for functionality in the pool module """ import time import unittest import unittest2 as unittest except ImportError: import unittest from queries import pool def test_add_when_pool_is_full_raises(self): obj = pool.Pool(str(uuid.uuid4()), max_size=1) obj.add(mock.Mock()) mock_conn = mock.Mock() self.assertRaises(pool.PoolFullError, obj.add, mock_conn) def test_closed_conn_invokes_remove_on_clean(self): psycopg2_conn = mock.Mock() psycopg2_conn.closed = True obj = pool.Pool(str(uuid.uuid4())) obj.remove = mock.Mock() obj.add(psycopg2_conn) obj.clean() obj.remove.assert_called_once_with(psycopg2_conn) def test_clean_closes_all_when_idle(self): obj = pool.Pool(str(uuid.uuid4()), idle_ttl=10) obj.idle_start = time.time() - 20 obj.close = mock.Mock() obj.clean() obj.close.assert_called_once_with() def test_close_close_removes_all(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) obj.remove = mock.Mock() psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] obj.close() psycopg2_calls = [mock.call(c) for c in psycopg2_conns] obj.remove.assert_has_calls(psycopg2_calls) def test_free_invokes_connection_free(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) self._connection = obj.connection_handle conn = self._connection(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conn) conn.free.assert_called_once_with() def test_free_raises_not_found_exception(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) conn = obj.connection_handle(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conn) conn.free.assert_called_once_with() def test_free_resets_idle_start(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): [obj.add(conn) for conn in psycopg2_conns] for psycopg2_conn in psycopg2_conns: conn = obj.connection_handle(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conns[1]) self.assertAlmostEqual(int(obj.idle_start), int(time.time())) def test_free_raises_on_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.free, mock.Mock()) def test_get_returns_first_psycopg2_conn(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] session = mock.Mock() self.assertEqual(obj.get(session), psycopg2_conns[0]) def test_get_locks_first_psycopg2_conn(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] lock = mock.Mock() with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False, lock=lock): session = mock.Mock() obj.get(session) lock.assert_called_once_with(session) def test_get_resets_idle_start_to_none(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): session = mock.Mock() obj.idle_start = time.time() obj.get(session) self.assertIsNone(obj.idle_start) def test_get_raises_when_no_idle_connections(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] session = mock.Mock() self.assertRaises(pool.NoIdleConnectionsError, obj.get, session) def test_idle_connections(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): self.assertListEqual([c.handle for c in obj.idle_connections], psycopg2_conns) def test_idle_duration_when_none(self): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = None self.assertEqual(obj.idle_duration, 0) def test_idle_duration_when_set(self): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = time.time() - 5 self.assertAlmostEqual(int(obj.idle_duration), 5) def test_is_full_property_when_full(self): obj = pool.Pool(str(uuid.uuid4()), max_size=2) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] self.assertTrue(obj.is_full) def test_is_full_property_when_not_full(self): obj = pool.Pool(str(uuid.uuid4()), max_size=3) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] self.assertFalse(obj.is_full) def test_connection_lock_is_called_when_lock_is(self): with mock.patch('queries.pool.Connection.lock') as lock: obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) session = mock.Mock() obj.lock(psycopg2_conn, session) lock.assert_called_once_with(session) def test_locks_raises_when_connection_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.lock, mock.Mock(), mock.Mock()) def test_lock_resets_idle_start(self): with mock.patch('queries.pool.Connection.lock'): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = time.time() psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.lock(psycopg2_conn, mock.Mock()) self.assertIsNone(obj.idle_start) def test_remove_removes_connection(self): with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.remove(psycopg2_conn) self.assertNotIn(psycopg2_conn, obj) def test_remove_closes_connection(self): close_method = mock.Mock() with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False, close=close_method): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.remove(psycopg2_conn) close_method.assert_called_once_with() def test_remove_raises_when_connection_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.remove, mock.Mock()) def test_remove_raises_when_connection_is_busy(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() psycopg2_conn.closed = False obj.add(psycopg2_conn) self.assertRaises(pool.ConnectionBusyError, obj.remove, psycopg2_conn) def test__connection_returns_handle(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) self.assertEqual( obj.connection_handle(psycopg2_conn).handle, psycopg2_conn) def test_shutdown_raises_when_executing(self): psycopg2_conn = mock_connection() psycopg2_conn.isexecuting.return_value = True obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertRaises(pool.ConnectionBusyError, obj.shutdown) <MSG> Test coverage of pool.Connection <DFF> @@ -7,7 +7,80 @@ try: import unittest2 as unittest except ImportError: import unittest +import weakref from queries import pool +class ConnectionTests(unittest.TestCase): + + def setUp(self): + self.handle = mock.Mock() + self.handle.close = mock.Mock() + self.handle.closed = True + self.handle.isexecuting = mock.Mock(return_value=False) + self.connection = pool.Connection(self.handle) + self.connection.used_by = None + + def test_handle_should_match(self): + self.assertEqual(self.handle, self.connection.handle) + + def test_busy_isexecuting_is_false(self): + self.assertFalse(self.connection.busy) + + def test_busy_isexecuting_is_true(self): + self.handle.isexecuting.return_value = True + self.assertTrue(self.connection.busy) + + def test_busy_is_used(self): + self.handle.isexecuting.return_value = False + self.connection.used_by = mock.Mock() + self.assertTrue(self.connection.busy) + + def test_closed_is_true(self): + self.handle.closed = True + self.assertTrue(self.connection.closed) + + def test_closed_is_false(self): + self.handle.closed = False + self.assertFalse(self.connection.closed) + + def test_close_raises_when_busy(self): + self.handle.isexecuting.return_value = True + self.assertRaises(pool.ConnectionBusyError, self.connection.close) + + def test_close_invokes_handle_close(self): + self.handle.isexecuting.return_value = False + self.connection.used_by = None + self.connection.close() + self.handle.close.assertCalledOnce() + + def test_free_raises_when_busy(self): + self.handle.isexecuting.return_value = True + self.assertRaises(pool.ConnectionBusyError, self.connection.free) + + def test_free_resets_used_by(self): + self.handle.isexecuting.return_value = False + self.connection.used_by = mock.Mock() + self.connection.free() + self.assertIsNone(self.connection.used_by) + + def test_id_value_matches(self): + self.assertEqual(id(self.handle), self.connection.id) + + def test_lock_raises_when_busy(self): + self.connection.used_by = mock.Mock() + self.assertRaises(pool.ConnectionBusyError, + self.connection.lock, mock.Mock()) + + def test_lock_session_used_by(self): + session = mock.Mock() + self.connection.lock(session) + self.assertIn(self.connection.used_by, + weakref.getweakrefs(session)) + + +class PoolTests(unittest.TestCase): + + def setup(self): + self.handle = mock.Mock(spec=pool.Connection)

Test coverage of pool.Connection

.py

py

bsd-3-clause

gmr/queries

1509

<NME> tornado_session_tests.py <BEF> """ Tests for functionality in the tornado_session module """ import mock import unittest try: from psycopg2cffi import extras except ImportError: from psycopg2 import extras from tornado import concurrent from tornado import gen from tornado import ioloop from tornado import testing from queries import pool from queries import tornado_session class ResultsTests(unittest.TestCase): class ResultsTests(unittest.TestCase): def setUp(self): self.cursor = mock.Mock() self.fd = 10 self.cleanup = mock.Mock() self.obj = tornado_session.Results(self.cursor, self.cleanup, self.fd) def test_cursor_is_assigned(self): self.assertEqual(self.obj.cursor, self.cursor) def test_fd_is_assigned(self): self.assertEqual(self.obj._fd, self.fd) def test_cleanup_is_assigned(self): self.assertEqual(self.obj._cleanup, self.cleanup) @gen.coroutine def test_free_invokes_cleanup(self): yield self.obj.free() self.cleanup.assert_called_once_with(self.cursor, self.fd) class SessionInitTests(unittest.TestCase): def setUp(self): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): self.assertDictEqual(self.obj._futures, {}) def test_creates_empty_connections_dict(self): self.assertDictEqual(self.obj._connections, {}) def test_sets_default_cursor_factory(self): self.assertEqual(self.obj._cursor_factory, extras.RealDictCursor) def test_sets_tornado_ioloop_instance(self): self.assertEqual(self.obj._ioloop, ioloop.IOLoop.instance()) def test_sets_poolmananger_instance(self): self.assertEqual(self.obj._pool_manager, pool.PoolManager.instance()) def test_sets_uri(self): self.assertEqual(self.obj._uri, tornado_session.session.DEFAULT_URI) def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) def test_connection_is_none(self): self.assertIsNone(self.obj.connection) def test_cursor_is_none(self): self.assertIsNone(self.obj.cursor) class SessionConnectTests(testing.AsyncTestCase): def setUp(self): super(SessionConnectTests, self).setUp() self.conn = mock.Mock() self.conn.fileno = mock.Mock(return_value=10) self.obj = tornado_session.TornadoSession(io_loop=self.io_loop) def create_connection(future): future.set_result(self.conn) self.obj._create_connection = create_connection @testing.gen_test def test_connect_returns_new_connection(self): conn = yield self.obj._connect() self.assertEqual(conn, self.conn) @testing.gen_test def test_connect_returns_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) second_result = yield self.obj._connect() self.assertEqual(second_result, conn) @testing.gen_test def test_connect_gets_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: with mock.patch.object(self.io_loop, 'add_handler'): yield self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) @testing.gen_test def test_connect_pooled_connection_invokes_add_handler(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: get.return_value = self.conn with mock.patch.object(self.io_loop, 'add_handler') as add_handler: yield self.obj._connect() add_handler.assert_called_once_with(self.conn.fileno(), self.obj._on_io_events, ioloop.IOLoop.WRITE) def test_psycopg2_connect_invokes_psycopg2_connect(self): with mock.patch('psycopg2.connect') as connect: self.obj._psycopg2_connect({}) connect.assert_called_once_with(**{'async': True}) def test_on_io_events_returns_if_fd_not_present(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_not_called() def test_on_io_events_calls_poll_connection(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._connections[1337] = True self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_called_once_with(1337) def test_exec_cleanup_closes_cursor(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() cursor = mock.Mock() cursor.close = mock.Mock() self.obj._exec_cleanup(cursor, 14) cursor.close.assert_called_once_with() def test_exec_cleanup_frees_connection(self): with mock.patch.object(self.obj._pool_manager, 'free') as pm_free: with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = conn = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) pm_free.assert_called_once_with(self.obj.pid, conn) def test_exec_cleanup_remove_handler_invoked(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler') as rh: self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) rh.assert_called_once_with(14) def test_exec_removes_connection(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._connections) def test_exec_removes_future(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._futures[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._futures) def test_pool_manager_add_failures_are_propagated(self): futures = [] def add_future(future, callback): futures.append((future, callback)) obj = tornado_session.TornadoSession() obj._ioloop = mock.Mock() obj._ioloop.add_future = add_future future = concurrent.Future() with mock.patch.object(obj._pool_manager, 'add') as add_method: add_method.side_effect = pool.PoolFullError(mock.Mock()) obj._create_connection(future) self.assertEqual(len(futures), 1) connected_future, callback = futures.pop() connected_future.set_result(True) callback(connected_future) self.assertIs(future.exception(), add_method.side_effect) class SessionPublicMethodTests(testing.AsyncTestCase): @testing.gen_test def test_callproc_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.callproc('foo', ['bar']) _execute.assert_called_once_with('callproc', 'foo', ['bar']) @testing.gen_test def test_query_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) """ @testing.gen_test def test_query_error_key_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): yield obj.query('SELECT * FROM foo WHERE bar=%(baz)s', {}) @testing.gen_test def test_query_error_index_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): r = yield obj.query('SELECT * FROM foo WHERE bar=%s', []) """ <MSG> Clean up imports and import order <DFF> @@ -5,18 +5,11 @@ Tests for functionality in the tornado_session module import mock import unittest -try: - from psycopg2cffi import extras -except ImportError: - from psycopg2 import extras - -from tornado import concurrent -from tornado import gen -from tornado import ioloop -from tornado import testing - -from queries import pool -from queries import tornado_session +# Out of order import to ensure psycopg2cffi is registered +from queries import pool, tornado_session + +from psycopg2 import extras +from tornado import concurrent, gen, ioloop, testing class ResultsTests(unittest.TestCase):

Clean up imports and import order

.py

py

bsd-3-clause

gmr/queries

1510

<NME> tornado_session_tests.py <BEF> """ Tests for functionality in the tornado_session module """ import mock import unittest try: from psycopg2cffi import extras except ImportError: from psycopg2 import extras from tornado import concurrent from tornado import gen from tornado import ioloop from tornado import testing from queries import pool from queries import tornado_session class ResultsTests(unittest.TestCase): class ResultsTests(unittest.TestCase): def setUp(self): self.cursor = mock.Mock() self.fd = 10 self.cleanup = mock.Mock() self.obj = tornado_session.Results(self.cursor, self.cleanup, self.fd) def test_cursor_is_assigned(self): self.assertEqual(self.obj.cursor, self.cursor) def test_fd_is_assigned(self): self.assertEqual(self.obj._fd, self.fd) def test_cleanup_is_assigned(self): self.assertEqual(self.obj._cleanup, self.cleanup) @gen.coroutine def test_free_invokes_cleanup(self): yield self.obj.free() self.cleanup.assert_called_once_with(self.cursor, self.fd) class SessionInitTests(unittest.TestCase): def setUp(self): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): self.assertDictEqual(self.obj._futures, {}) def test_creates_empty_connections_dict(self): self.assertDictEqual(self.obj._connections, {}) def test_sets_default_cursor_factory(self): self.assertEqual(self.obj._cursor_factory, extras.RealDictCursor) def test_sets_tornado_ioloop_instance(self): self.assertEqual(self.obj._ioloop, ioloop.IOLoop.instance()) def test_sets_poolmananger_instance(self): self.assertEqual(self.obj._pool_manager, pool.PoolManager.instance()) def test_sets_uri(self): self.assertEqual(self.obj._uri, tornado_session.session.DEFAULT_URI) def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) def test_connection_is_none(self): self.assertIsNone(self.obj.connection) def test_cursor_is_none(self): self.assertIsNone(self.obj.cursor) class SessionConnectTests(testing.AsyncTestCase): def setUp(self): super(SessionConnectTests, self).setUp() self.conn = mock.Mock() self.conn.fileno = mock.Mock(return_value=10) self.obj = tornado_session.TornadoSession(io_loop=self.io_loop) def create_connection(future): future.set_result(self.conn) self.obj._create_connection = create_connection @testing.gen_test def test_connect_returns_new_connection(self): conn = yield self.obj._connect() self.assertEqual(conn, self.conn) @testing.gen_test def test_connect_returns_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) second_result = yield self.obj._connect() self.assertEqual(second_result, conn) @testing.gen_test def test_connect_gets_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: with mock.patch.object(self.io_loop, 'add_handler'): yield self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) @testing.gen_test def test_connect_pooled_connection_invokes_add_handler(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: get.return_value = self.conn with mock.patch.object(self.io_loop, 'add_handler') as add_handler: yield self.obj._connect() add_handler.assert_called_once_with(self.conn.fileno(), self.obj._on_io_events, ioloop.IOLoop.WRITE) def test_psycopg2_connect_invokes_psycopg2_connect(self): with mock.patch('psycopg2.connect') as connect: self.obj._psycopg2_connect({}) connect.assert_called_once_with(**{'async': True}) def test_on_io_events_returns_if_fd_not_present(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_not_called() def test_on_io_events_calls_poll_connection(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._connections[1337] = True self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_called_once_with(1337) def test_exec_cleanup_closes_cursor(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() cursor = mock.Mock() cursor.close = mock.Mock() self.obj._exec_cleanup(cursor, 14) cursor.close.assert_called_once_with() def test_exec_cleanup_frees_connection(self): with mock.patch.object(self.obj._pool_manager, 'free') as pm_free: with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = conn = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) pm_free.assert_called_once_with(self.obj.pid, conn) def test_exec_cleanup_remove_handler_invoked(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler') as rh: self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) rh.assert_called_once_with(14) def test_exec_removes_connection(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._connections) def test_exec_removes_future(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._futures[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._futures) def test_pool_manager_add_failures_are_propagated(self): futures = [] def add_future(future, callback): futures.append((future, callback)) obj = tornado_session.TornadoSession() obj._ioloop = mock.Mock() obj._ioloop.add_future = add_future future = concurrent.Future() with mock.patch.object(obj._pool_manager, 'add') as add_method: add_method.side_effect = pool.PoolFullError(mock.Mock()) obj._create_connection(future) self.assertEqual(len(futures), 1) connected_future, callback = futures.pop() connected_future.set_result(True) callback(connected_future) self.assertIs(future.exception(), add_method.side_effect) class SessionPublicMethodTests(testing.AsyncTestCase): @testing.gen_test def test_callproc_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.callproc('foo', ['bar']) _execute.assert_called_once_with('callproc', 'foo', ['bar']) @testing.gen_test def test_query_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) """ @testing.gen_test def test_query_error_key_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): yield obj.query('SELECT * FROM foo WHERE bar=%(baz)s', {}) @testing.gen_test def test_query_error_index_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): r = yield obj.query('SELECT * FROM foo WHERE bar=%s', []) """ <MSG> Clean up imports and import order <DFF> @@ -5,18 +5,11 @@ Tests for functionality in the tornado_session module import mock import unittest -try: - from psycopg2cffi import extras -except ImportError: - from psycopg2 import extras - -from tornado import concurrent -from tornado import gen -from tornado import ioloop -from tornado import testing - -from queries import pool -from queries import tornado_session +# Out of order import to ensure psycopg2cffi is registered +from queries import pool, tornado_session + +from psycopg2 import extras +from tornado import concurrent, gen, ioloop, testing class ResultsTests(unittest.TestCase):

Clean up imports and import order

.py

py

bsd-3-clause

gmr/queries

1511

<NME> session.py <BEF> """The Session class allows for a unified (and simplified) view of interfacing with a PostgreSQL database server. Connection details are passed in as a PostgreSQL URI and connections are pooled by default, allowing for reuse of connections across modules in the Python runtime without having to pass around the object handle. While you can still access the raw `psycopg2` connection and cursor objects to provide ultimate flexibility in how you use the queries.Session object, there are convenience methods designed to simplify the interaction with PostgreSQL. For `psycopg2` functionality outside of what is exposed in Session, simply use the Session.connection or Session.cursor properties to gain access to either object just as you would in a program using psycopg2 directly. Example usage: .. code:: python import queries with queries.Session('pgsql://postgres@localhost/postgres') as session: for row in session.Query('SELECT * FROM table'): print row """ import hashlib import logging import psycopg2 from psycopg2 import extensions, extras from queries import pool, results, utils LOGGER = logging.getLogger(__name__) DEFAULT_ENCODING = 'UTF8' DEFAULT_URI = 'postgresql://localhost:5432' class Session(object): """The Session class allows for a unified (and simplified) view of interfacing with a PostgreSQL database server. The Session object can act as a context manager, providing automated cleanup and simple, Pythonic way of interacting with the object. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ _conn = None _cursor = None _tpc_id = None _uri = None # Connection status constants INTRANS = extensions.STATUS_IN_TRANSACTION PREPARED = extensions.STATUS_PREPARED READY = extensions.STATUS_READY SETUP = extensions.STATUS_SETUP # Transaction status constants TX_ACTIVE = extensions.TRANSACTION_STATUS_ACTIVE TX_IDLE = extensions.TRANSACTION_STATUS_IDLE TX_INERROR = extensions.TRANSACTION_STATUS_INERROR TX_INTRANS = extensions.TRANSACTION_STATUS_INTRANS TX_UNKNOWN = extensions.TRANSACTION_STATUS_UNKNOWN def __init__(self, uri=DEFAULT_URI, cursor_factory=extras.RealDictCursor, pool_idle_ttl=pool.DEFAULT_IDLE_TTL, pool_max_size=pool.DEFAULT_MAX_SIZE autocommit=True): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ self._pool_manager = pool.PoolManager.instance() self._uri = uri # Ensure the pool exists in the pool manager if self.pid not in self._pool_manager: self._pool_manager.create(self.pid, pool_idle_ttl, pool_max_size) self._conn = self._connect() self._cursor_factory = cursor_factory self._cursor = self._get_cursor(self._conn) self._autocommit(autocommit) @property def backend_pid(self): """Return the backend process ID of the PostgreSQL server that this session is connected to. :rtype: int """ return self._conn.get_backend_pid() def callproc(self, name, args=None): """Call a stored procedure on the server, returning the results in a :py:class:`queries.Results` instance. :param str name: The procedure name :param list args: The list of arguments to pass in :rtype: queries.Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ try: self._cursor.callproc(name, args) except psycopg2.Error as err: self._incr_exceptions() raise err finally: self._incr_executions() return results.Results(self._cursor) def close(self): """Explicitly close the connection and remove it from the connection pool if pooling is enabled. If the connection is already closed :raises: psycopg2.InterfaceError """ if not self._conn: raise psycopg2.InterfaceError('Connection not open') LOGGER.info('Closing connection %r in %s', self._conn, self.pid) self._pool_manager.free(self.pid, self._conn) self._pool_manager.remove_connection(self.pid, self._conn) # Un-assign the connection and cursor self._conn, self._cursor = None, None @property def connection(self): """Return the current open connection to PostgreSQL. :rtype: psycopg2.extensions.connection """ return self._conn @property def cursor(self): """Return the current, active cursor for the open connection. :rtype: psycopg2.extensions.cursor """ return self._cursor @property def encoding(self): """Return the current client encoding value. :rtype: str """ return self._conn.encoding @property def notices(self): """Return a list of up to the last 50 server notices sent to the client. :rtype: list """ return self._conn.notices @property def pid(self): """Return the pool ID used for connection pooling. :rtype: str """ return hashlib.md5(':'.join([self.__class__.__name__, self._uri]).encode('utf-8')).hexdigest() def query(self, sql, parameters=None): """A generator to issue a query on the server, mogrifying the parameters against the sql statement. Results are returned as a :py:class:`queries.Results` object which can act as an iterator and has multiple ways to access the result data. :param str sql: The SQL statement :param dict parameters: A dictionary of query parameters :rtype: queries.Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ try: self._cursor.execute(sql, parameters) except psycopg2.Error as err: self._incr_exceptions() raise err finally: self._incr_executions() return results.Results(self._cursor) def set_encoding(self, value=DEFAULT_ENCODING): """Set the client encoding for the session if the value specified is different than the current client encoding. :param str value: The encoding value to use """ if self._conn.encoding != value: self._conn.set_client_encoding(value) def __del__(self): """When deleting the context, ensure the instance is removed from caches, etc. """ self._cleanup() def __enter__(self): """For use as a context manager, return a handle to this object instance. :rtype: Session """ return self def __exit__(self, exc_type, exc_val, exc_tb): """When leaving the context, ensure the instance is removed from caches, etc. """ self._cleanup() def _autocommit(self, autocommit): """Set the isolation level automatically to commit or not after every query :param autocommit: Boolean (Default - True) """ self._conn.autocommit = autocommit def _cleanup(self): """Remove the connection from the stack, closing out the cursor""" if self._cursor: LOGGER.debug('Closing the cursor on %s', self.pid) self._cursor.close() self._cursor = None if self._conn: LOGGER.debug('Freeing %s in the pool', self.pid) try: pool.PoolManager.instance().free(self.pid, self._conn) except pool.ConnectionNotFoundError: pass self._conn = None def _connect(self): """Connect to PostgreSQL, either by reusing a connection from the pool if possible, or by creating the new connection. :rtype: psycopg2.extensions.connection :raises: pool.NoIdleConnectionsError """ # Attempt to get a cached connection from the connection pool try: connection = self._pool_manager.get(self.pid, self) LOGGER.debug("Re-using connection for %s", self.pid) except pool.NoIdleConnectionsError: if self._pool_manager.is_full(self.pid): raise # Create a new PostgreSQL connection kwargs = utils.uri_to_kwargs(self._uri) LOGGER.debug("Creating a new connection for %s", self.pid) connection = self._psycopg2_connect(kwargs) self._pool_manager.add(self.pid, connection) self._pool_manager.lock(self.pid, connection, self) # Added in because psycopg2ct connects and leaves the connection in # a weird state: consts.STATUS_DATESTYLE, returning from # Connection._setup without setting the state as const.STATUS_OK if utils.PYPY: connection.reset() # Register the custom data types self._register_unicode(connection) self._register_uuid(connection) return connection def _get_cursor(self, connection, name=None): """Return a cursor for the given cursor_factory. Specify a name to use server-side cursors. :param connection: The connection to create a cursor on :type connection: psycopg2.extensions.connection :param str name: A cursor name for a server side cursor :rtype: psycopg2.extensions.cursor """ cursor = connection.cursor(name=name, cursor_factory=self._cursor_factory) if name is not None: cursor.scrollable = True cursor.withhold = True return cursor def _incr_exceptions(self): """Increment the number of exceptions for the current connection.""" self._pool_manager.get_connection(self.pid, self._conn).exceptions += 1 def _incr_executions(self): """Increment the number of executions for the current connection.""" self._pool_manager.get_connection(self.pid, self._conn).executions += 1 def _psycopg2_connect(self, kwargs): """Return a psycopg2 connection for the specified kwargs. Extend for use in async session adapters. :param dict kwargs: Keyword connection args :rtype: psycopg2.extensions.connection """ return psycopg2.connect(**kwargs) @staticmethod def _register_unicode(connection): """Register the cursor to be able to receive Unicode string. :type connection: psycopg2.extensions.connection :param connection: Where to register things """ psycopg2.extensions.register_type(psycopg2.extensions.UNICODE, connection) psycopg2.extensions.register_type(psycopg2.extensions.UNICODEARRAY, connection) @staticmethod def _register_uuid(connection): """Register the UUID extension from the psycopg2.extra module :type connection: psycopg2.extensions.connection :param connection: Where to register things """ psycopg2.extras.register_uuid(conn_or_curs=connection) @property def _status(self): """Return the current connection status as an integer value. The status should match one of the following constants: - queries.Session.INTRANS: Connection established, in transaction - queries.Session.PREPARED: Prepared for second phase of transaction - queries.Session.READY: Connected, no active transaction :rtype: int """ if self._conn.status == psycopg2.extensions.STATUS_BEGIN: return self.READY return self._conn.status <MSG> add missing comma <DFF> @@ -70,7 +70,7 @@ class Session(object): def __init__(self, uri=DEFAULT_URI, cursor_factory=extras.RealDictCursor, pool_idle_ttl=pool.DEFAULT_IDLE_TTL, - pool_max_size=pool.DEFAULT_MAX_SIZE + pool_max_size=pool.DEFAULT_MAX_SIZE, autocommit=True): """Connect to a PostgreSQL server using the module wide connection and set the isolation level.

add missing comma

.py

py

bsd-3-clause

gmr/queries

1512

<NME> session.py <BEF> """The Session class allows for a unified (and simplified) view of interfacing with a PostgreSQL database server. Connection details are passed in as a PostgreSQL URI and connections are pooled by default, allowing for reuse of connections across modules in the Python runtime without having to pass around the object handle. While you can still access the raw `psycopg2` connection and cursor objects to provide ultimate flexibility in how you use the queries.Session object, there are convenience methods designed to simplify the interaction with PostgreSQL. For `psycopg2` functionality outside of what is exposed in Session, simply use the Session.connection or Session.cursor properties to gain access to either object just as you would in a program using psycopg2 directly. Example usage: .. code:: python import queries with queries.Session('pgsql://postgres@localhost/postgres') as session: for row in session.Query('SELECT * FROM table'): print row """ import hashlib import logging import psycopg2 from psycopg2 import extensions, extras from queries import pool, results, utils LOGGER = logging.getLogger(__name__) DEFAULT_ENCODING = 'UTF8' DEFAULT_URI = 'postgresql://localhost:5432' class Session(object): """The Session class allows for a unified (and simplified) view of interfacing with a PostgreSQL database server. The Session object can act as a context manager, providing automated cleanup and simple, Pythonic way of interacting with the object. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ _conn = None _cursor = None _tpc_id = None _uri = None # Connection status constants INTRANS = extensions.STATUS_IN_TRANSACTION PREPARED = extensions.STATUS_PREPARED READY = extensions.STATUS_READY SETUP = extensions.STATUS_SETUP # Transaction status constants TX_ACTIVE = extensions.TRANSACTION_STATUS_ACTIVE TX_IDLE = extensions.TRANSACTION_STATUS_IDLE TX_INERROR = extensions.TRANSACTION_STATUS_INERROR TX_INTRANS = extensions.TRANSACTION_STATUS_INTRANS TX_UNKNOWN = extensions.TRANSACTION_STATUS_UNKNOWN def __init__(self, uri=DEFAULT_URI, cursor_factory=extras.RealDictCursor, pool_idle_ttl=pool.DEFAULT_IDLE_TTL, pool_max_size=pool.DEFAULT_MAX_SIZE autocommit=True): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ self._pool_manager = pool.PoolManager.instance() self._uri = uri # Ensure the pool exists in the pool manager if self.pid not in self._pool_manager: self._pool_manager.create(self.pid, pool_idle_ttl, pool_max_size) self._conn = self._connect() self._cursor_factory = cursor_factory self._cursor = self._get_cursor(self._conn) self._autocommit(autocommit) @property def backend_pid(self): """Return the backend process ID of the PostgreSQL server that this session is connected to. :rtype: int """ return self._conn.get_backend_pid() def callproc(self, name, args=None): """Call a stored procedure on the server, returning the results in a :py:class:`queries.Results` instance. :param str name: The procedure name :param list args: The list of arguments to pass in :rtype: queries.Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ try: self._cursor.callproc(name, args) except psycopg2.Error as err: self._incr_exceptions() raise err finally: self._incr_executions() return results.Results(self._cursor) def close(self): """Explicitly close the connection and remove it from the connection pool if pooling is enabled. If the connection is already closed :raises: psycopg2.InterfaceError """ if not self._conn: raise psycopg2.InterfaceError('Connection not open') LOGGER.info('Closing connection %r in %s', self._conn, self.pid) self._pool_manager.free(self.pid, self._conn) self._pool_manager.remove_connection(self.pid, self._conn) # Un-assign the connection and cursor self._conn, self._cursor = None, None @property def connection(self): """Return the current open connection to PostgreSQL. :rtype: psycopg2.extensions.connection """ return self._conn @property def cursor(self): """Return the current, active cursor for the open connection. :rtype: psycopg2.extensions.cursor """ return self._cursor @property def encoding(self): """Return the current client encoding value. :rtype: str """ return self._conn.encoding @property def notices(self): """Return a list of up to the last 50 server notices sent to the client. :rtype: list """ return self._conn.notices @property def pid(self): """Return the pool ID used for connection pooling. :rtype: str """ return hashlib.md5(':'.join([self.__class__.__name__, self._uri]).encode('utf-8')).hexdigest() def query(self, sql, parameters=None): """A generator to issue a query on the server, mogrifying the parameters against the sql statement. Results are returned as a :py:class:`queries.Results` object which can act as an iterator and has multiple ways to access the result data. :param str sql: The SQL statement :param dict parameters: A dictionary of query parameters :rtype: queries.Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ try: self._cursor.execute(sql, parameters) except psycopg2.Error as err: self._incr_exceptions() raise err finally: self._incr_executions() return results.Results(self._cursor) def set_encoding(self, value=DEFAULT_ENCODING): """Set the client encoding for the session if the value specified is different than the current client encoding. :param str value: The encoding value to use """ if self._conn.encoding != value: self._conn.set_client_encoding(value) def __del__(self): """When deleting the context, ensure the instance is removed from caches, etc. """ self._cleanup() def __enter__(self): """For use as a context manager, return a handle to this object instance. :rtype: Session """ return self def __exit__(self, exc_type, exc_val, exc_tb): """When leaving the context, ensure the instance is removed from caches, etc. """ self._cleanup() def _autocommit(self, autocommit): """Set the isolation level automatically to commit or not after every query :param autocommit: Boolean (Default - True) """ self._conn.autocommit = autocommit def _cleanup(self): """Remove the connection from the stack, closing out the cursor""" if self._cursor: LOGGER.debug('Closing the cursor on %s', self.pid) self._cursor.close() self._cursor = None if self._conn: LOGGER.debug('Freeing %s in the pool', self.pid) try: pool.PoolManager.instance().free(self.pid, self._conn) except pool.ConnectionNotFoundError: pass self._conn = None def _connect(self): """Connect to PostgreSQL, either by reusing a connection from the pool if possible, or by creating the new connection. :rtype: psycopg2.extensions.connection :raises: pool.NoIdleConnectionsError """ # Attempt to get a cached connection from the connection pool try: connection = self._pool_manager.get(self.pid, self) LOGGER.debug("Re-using connection for %s", self.pid) except pool.NoIdleConnectionsError: if self._pool_manager.is_full(self.pid): raise # Create a new PostgreSQL connection kwargs = utils.uri_to_kwargs(self._uri) LOGGER.debug("Creating a new connection for %s", self.pid) connection = self._psycopg2_connect(kwargs) self._pool_manager.add(self.pid, connection) self._pool_manager.lock(self.pid, connection, self) # Added in because psycopg2ct connects and leaves the connection in # a weird state: consts.STATUS_DATESTYLE, returning from # Connection._setup without setting the state as const.STATUS_OK if utils.PYPY: connection.reset() # Register the custom data types self._register_unicode(connection) self._register_uuid(connection) return connection def _get_cursor(self, connection, name=None): """Return a cursor for the given cursor_factory. Specify a name to use server-side cursors. :param connection: The connection to create a cursor on :type connection: psycopg2.extensions.connection :param str name: A cursor name for a server side cursor :rtype: psycopg2.extensions.cursor """ cursor = connection.cursor(name=name, cursor_factory=self._cursor_factory) if name is not None: cursor.scrollable = True cursor.withhold = True return cursor def _incr_exceptions(self): """Increment the number of exceptions for the current connection.""" self._pool_manager.get_connection(self.pid, self._conn).exceptions += 1 def _incr_executions(self): """Increment the number of executions for the current connection.""" self._pool_manager.get_connection(self.pid, self._conn).executions += 1 def _psycopg2_connect(self, kwargs): """Return a psycopg2 connection for the specified kwargs. Extend for use in async session adapters. :param dict kwargs: Keyword connection args :rtype: psycopg2.extensions.connection """ return psycopg2.connect(**kwargs) @staticmethod def _register_unicode(connection): """Register the cursor to be able to receive Unicode string. :type connection: psycopg2.extensions.connection :param connection: Where to register things """ psycopg2.extensions.register_type(psycopg2.extensions.UNICODE, connection) psycopg2.extensions.register_type(psycopg2.extensions.UNICODEARRAY, connection) @staticmethod def _register_uuid(connection): """Register the UUID extension from the psycopg2.extra module :type connection: psycopg2.extensions.connection :param connection: Where to register things """ psycopg2.extras.register_uuid(conn_or_curs=connection) @property def _status(self): """Return the current connection status as an integer value. The status should match one of the following constants: - queries.Session.INTRANS: Connection established, in transaction - queries.Session.PREPARED: Prepared for second phase of transaction - queries.Session.READY: Connected, no active transaction :rtype: int """ if self._conn.status == psycopg2.extensions.STATUS_BEGIN: return self.READY return self._conn.status <MSG> add missing comma <DFF> @@ -70,7 +70,7 @@ class Session(object): def __init__(self, uri=DEFAULT_URI, cursor_factory=extras.RealDictCursor, pool_idle_ttl=pool.DEFAULT_IDLE_TTL, - pool_max_size=pool.DEFAULT_MAX_SIZE + pool_max_size=pool.DEFAULT_MAX_SIZE, autocommit=True): """Connect to a PostgreSQL server using the module wide connection and set the isolation level.

add missing comma

.py

py

bsd-3-clause

gmr/queries

1513

<NME> tornado_session.py <BEF> """ Tornado Session Adapter Use Queries asynchronously within the Tornado framework. Example Use: .. code:: python class NameListHandler(web.RequestHandler): def initialize(self): self.session = queries.TornadoSession(pool_max_size=60) @gen.coroutine def get(self): data = yield self.session.query('SELECT * FROM names') if data: self.finish({'names': data.items()}) data.free() else: self.set_status(500, 'Error querying the data') """ import logging import socket import warnings from tornado import concurrent, ioloop from psycopg2 import extras, extensions import psycopg2 from queries import pool, results, session, utils LOGGER = logging.getLogger(__name__) DEFAULT_MAX_POOL_SIZE = 25 class Results(results.Results): """A TornadoSession specific :py:class:`queries.Results` class that adds the :py:meth:`Results.free <queries.tornado_session.Results.free>` method. The :py:meth:`Results.free <queries.tornado_session.Results.free>` method **must** be called to free the connection that the results were generated on. `Results` objects that are not freed will cause the connections to remain locked and your application will eventually run out of connections in the pool. The following examples illustrate the various behaviors that the ::py:class:`queries.Results <queries.tornado_session.Requests>` class implements: **Using Results as an Iterator** .. code:: python results = yield session.query('SELECT * FROM foo') for row in results print row results.free() **Accessing an individual row by index** .. code:: python results = yield session.query('SELECT * FROM foo') print results[1] # Access the second row of the results results.free() **Casting single row results as a dict** .. code:: python results = yield session.query('SELECT * FROM foo LIMIT 1') print results.as_dict() results.free() **Checking to see if a query was successful** .. code:: python sql = "UPDATE foo SET bar='baz' WHERE qux='corgie'" results = yield session.query(sql) if results: print 'Success' results.free() **Checking the number of rows by using len(Results)** .. code:: python results = yield session.query('SELECT * FROM foo') print '%i rows' % len(results) results.free() """ def __init__(self, cursor, cleanup, fd): self.cursor = cursor self._cleanup = cleanup self._fd = fd self._freed = False def free(self): """Release the results and connection lock from the TornadoSession object. This **must** be called after you finish processing the results from :py:meth:`TornadoSession.query <queries.TornadoSession.query>` or self.cursor = cursor self._cleanup = cleanup self._fd = fd @gen.coroutine def free(self): def __del__(self): if not self._freed: LOGGER.warning('Auto-freeing result on deletion') self.free() requests. """ self._cleanup(self.cursor, self._fd) class TornadoSession(session.Session): """Session class for Tornado asynchronous applications. Uses :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ def __init__(self, uri=session.DEFAULT_URI, cursor_factory=extras.RealDictCursor, pool_idle_ttl=pool.DEFAULT_IDLE_TTL, pool_max_size=DEFAULT_MAX_POOL_SIZE, io_loop=None): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use :param tornado.ioloop.IOLoop io_loop: IOLoop instance to use """ self._connections = dict() self._cleanup_callback = None self._cursor_factory = cursor_factory self._futures = dict() self._ioloop = io_loop or ioloop.IOLoop.current() self._pool_manager = pool.PoolManager.instance() self._pool_max_size = pool_max_size self._pool_idle_ttl = pool_idle_ttl self._uri = uri self._ensure_pool_exists() def _ensure_pool_exists(self): """Create the pool in the pool manager if it does not exist.""" if self.pid not in self._pool_manager: self._pool_manager.create(self.pid, self._pool_idle_ttl, self._pool_max_size, self._ioloop.time) @property def connection(self): """Do not use this directly with Tornado applications :return: """ return None @property def cursor(self): return None def callproc(self, name, args=None): """Call a stored procedure asynchronously on the server, passing in the arguments to be passed to the stored procedure, yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. You **must** free the results that are returned by this method to unlock the connection used to perform the query. Failure to do so will cause your Tornado application to run out of connections. :param str name: The stored procedure name :param list args: An optional list of procedure arguments :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ return self._execute('callproc', name, args) def query(self, sql, parameters=None): """Issue a query asynchronously on the server, mogrifying the parameters against the sql statement and yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. You **must** free the results that are returned by this method to unlock the connection used to perform the query. Failure to do so will cause your Tornado application to run out of connections. :param str sql: The SQL statement :param dict parameters: A dictionary of query parameters :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ return self._execute('execute', sql, parameters) def validate(self): """Validate the session can connect or has open connections to PostgreSQL. As of ``1.10.3`` .. deprecated:: 1.10.3 As of 1.10.3, this method only warns about Deprecation :rtype: bool """ warnings.warn( 'All functionality removed from this method', DeprecationWarning) def _connect(self): """Connect to PostgreSQL, either by reusing a connection from the pool if possible, or by creating the new connection. :rtype: psycopg2.extensions.connection :raises: pool.NoIdleConnectionsError """ future = concurrent.Future() # Attempt to get a cached connection from the connection pool try: connection = self._pool_manager.get(self.pid, self) self._connections[connection.fileno()] = connection future.set_result(connection) # Add the connection to the IOLoop self._ioloop.add_handler(connection.fileno(), self._on_io_events, ioloop.IOLoop.WRITE) except pool.NoIdleConnectionsError: self._create_connection(future) return future def _create_connection(self, future): """Create a new PostgreSQL connection :param tornado.concurrent.Future future: future for new conn result """ LOGGER.debug('Creating a new connection for %s', self.pid) # Create a new PostgreSQL connection kwargs = utils.uri_to_kwargs(self._uri) try: connection = self._psycopg2_connect(kwargs) except (psycopg2.Error, OSError, socket.error) as error: future.set_exception(error) return # Add the connection for use in _poll_connection fd = connection.fileno() self._connections[fd] = connection def on_connected(cf): """Invoked by the IOLoop when the future is complete for the connection :param Future cf: The future for the initial connection """ if cf.exception(): self._cleanup_fd(fd, True) future.set_exception(cf.exception()) else: try: # Add the connection to the pool LOGGER.debug('Connection established for %s', self.pid) self._pool_manager.add(self.pid, connection) except (ValueError, pool.PoolException) as err: LOGGER.exception('Failed to add %r to the pool', self.pid) self._cleanup_fd(fd) future.set_exception(err) return self._pool_manager.lock(self.pid, connection, self) # Added in because psycopg2cffi connects and leaves the # connection in a weird state: consts.STATUS_DATESTYLE, # returning from Connection._setup without setting the state # as const.STATUS_OK if utils.PYPY: connection.status = extensions.STATUS_READY # Register the custom data types self._register_unicode(connection) self._register_uuid(connection) # Set the future result future.set_result(connection) # Add a future that fires once connected self._futures[fd] = concurrent.Future() self._ioloop.add_future(self._futures[fd], on_connected) # Add the connection to the IOLoop self._ioloop.add_handler(connection.fileno(), self._on_io_events, ioloop.IOLoop.WRITE) def _execute(self, method, query, parameters=None): """Issue a query asynchronously on the server, mogrifying the parameters against the sql statement and yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. This function reduces duplicate code for callproc and query by getting the class attribute for the method passed in as the function to call. :param str method: The method attribute to use :param str query: The SQL statement or Stored Procedure name :param list|dict parameters: A dictionary of query parameters :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ future = concurrent.Future() def on_connected(cf): """Invoked by the future returned by self._connect""" if cf.exception(): future.set_exception(cf.exception()) return # Get the psycopg2 connection object and cursor conn = cf.result() cursor = self._get_cursor(conn) def completed(qf): """Invoked by the IOLoop when the future has completed""" if qf.exception(): self._incr_exceptions(conn) err = qf.exception() LOGGER.debug('Cleaning cursor due to exception: %r', err) self._exec_cleanup(cursor, conn.fileno()) future.set_exception(err) else: self._incr_executions(conn) value = Results(cursor, self._exec_cleanup, conn.fileno()) future.set_result(value) # Setup a callback to wait on the query result self._futures[conn.fileno()] = concurrent.Future() # Add the future to the IOLoop self._ioloop.add_future(self._futures[conn.fileno()], completed) # Get the cursor, execute the query func = getattr(cursor, method) try: func(query, parameters) except Exception as error: future.set_exception(error) # Ensure the pool exists for the connection self._ensure_pool_exists() # Grab a connection to PostgreSQL self._ioloop.add_future(self._connect(), on_connected) # Return the future for the query result return future def _exec_cleanup(self, cursor, fd): """Close the cursor, remove any references to the fd in internal state and remove the fd from the ioloop. :param psycopg2.extensions.cursor cursor: The cursor to close :param int fd: The connection file descriptor """ LOGGER.debug('Closing cursor and cleaning %s', fd) try: cursor.close() except (psycopg2.Error, psycopg2.Warning) as error: LOGGER.debug('Error closing the cursor: %s', error) self._cleanup_fd(fd) # If the cleanup callback exists, remove it if self._cleanup_callback: self._ioloop.remove_timeout(self._cleanup_callback) # Create a new cleanup callback to clean the pool of idle connections self._cleanup_callback = self._ioloop.add_timeout( self._ioloop.time() + self._pool_idle_ttl + 1, self._pool_manager.clean, self.pid) def _cleanup_fd(self, fd, close=False): """Ensure the socket socket is removed from the IOLoop, the connection stack, and futures stack. :param int fd: The fd # to cleanup """ self._ioloop.remove_handler(fd) if fd in self._connections: try: self._pool_manager.free(self.pid, self._connections[fd]) except pool.ConnectionNotFoundError: pass if close: self._connections[fd].close() del self._connections[fd] if fd in self._futures: del self._futures[fd] def _incr_exceptions(self, conn): """Increment the number of exceptions for the current connection. :param psycopg2.extensions.connection conn: the psycopg2 connection """ self._pool_manager.get_connection(self.pid, conn).exceptions += 1 def _incr_executions(self, conn): """Increment the number of executions for the current connection. :param psycopg2.extensions.connection conn: the psycopg2 connection """ self._pool_manager.get_connection(self.pid, conn).executions += 1 def _on_io_events(self, fd=None, _events=None): """Invoked by Tornado's IOLoop when there are events for the fd :param int fd: The file descriptor for the event :param int _events: The events raised """ if fd not in self._connections: LOGGER.warning('Received IO event for non-existing connection') return self._poll_connection(fd) def _poll_connection(self, fd): """Check with psycopg2 to see what action to take. If the state is POLL_OK, we should have a pending callback for that fd. :param int fd: The socket fd for the postgresql connection """ try: state = self._connections[fd].poll() except (OSError, socket.error) as error: self._ioloop.remove_handler(fd) if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception( psycopg2.OperationalError('Connection error (%s)' % error) ) except (psycopg2.Error, psycopg2.Warning) as error: if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception(error) else: if state == extensions.POLL_OK: if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_result(True) elif state == extensions.POLL_WRITE: self._ioloop.update_handler(fd, ioloop.IOLoop.WRITE) elif state == extensions.POLL_READ: self._ioloop.update_handler(fd, ioloop.IOLoop.READ) elif state == extensions.POLL_ERROR: self._ioloop.remove_handler(fd) if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception( psycopg2.Error('Poll Error')) def _psycopg2_connect(self, kwargs): """Return a psycopg2 connection for the specified kwargs. Extend for use in async session adapters. :param dict kwargs: Keyword connection args :rtype: psycopg2.extensions.connection """ kwargs['async'] = True return psycopg2.connect(**kwargs) <MSG> Merge pull request #23 from dave-shawley/add-results-free-warning Log a warning when a result is leaked. <DFF> @@ -107,6 +107,7 @@ class Results(results.Results): self.cursor = cursor self._cleanup = cleanup self._fd = fd + self._freed = False @gen.coroutine def free(self): @@ -118,8 +119,13 @@ class Results(results.Results): requests. """ + self._freed = True self._cleanup(self.cursor, self._fd) + def __del__(self): + if not self._freed: + LOGGER.warning('%s not freed - %r', self.__class__.__name__, self) + class TornadoSession(session.Session): """Session class for Tornado asynchronous applications. Uses

Merge pull request #23 from dave-shawley/add-results-free-warning

.py

py

bsd-3-clause

gmr/queries

1514

<NME> tornado_session.py <BEF> """ Tornado Session Adapter Use Queries asynchronously within the Tornado framework. Example Use: .. code:: python class NameListHandler(web.RequestHandler): def initialize(self): self.session = queries.TornadoSession(pool_max_size=60) @gen.coroutine def get(self): data = yield self.session.query('SELECT * FROM names') if data: self.finish({'names': data.items()}) data.free() else: self.set_status(500, 'Error querying the data') """ import logging import socket import warnings from tornado import concurrent, ioloop from psycopg2 import extras, extensions import psycopg2 from queries import pool, results, session, utils LOGGER = logging.getLogger(__name__) DEFAULT_MAX_POOL_SIZE = 25 class Results(results.Results): """A TornadoSession specific :py:class:`queries.Results` class that adds the :py:meth:`Results.free <queries.tornado_session.Results.free>` method. The :py:meth:`Results.free <queries.tornado_session.Results.free>` method **must** be called to free the connection that the results were generated on. `Results` objects that are not freed will cause the connections to remain locked and your application will eventually run out of connections in the pool. The following examples illustrate the various behaviors that the ::py:class:`queries.Results <queries.tornado_session.Requests>` class implements: **Using Results as an Iterator** .. code:: python results = yield session.query('SELECT * FROM foo') for row in results print row results.free() **Accessing an individual row by index** .. code:: python results = yield session.query('SELECT * FROM foo') print results[1] # Access the second row of the results results.free() **Casting single row results as a dict** .. code:: python results = yield session.query('SELECT * FROM foo LIMIT 1') print results.as_dict() results.free() **Checking to see if a query was successful** .. code:: python sql = "UPDATE foo SET bar='baz' WHERE qux='corgie'" results = yield session.query(sql) if results: print 'Success' results.free() **Checking the number of rows by using len(Results)** .. code:: python results = yield session.query('SELECT * FROM foo') print '%i rows' % len(results) results.free() """ def __init__(self, cursor, cleanup, fd): self.cursor = cursor self._cleanup = cleanup self._fd = fd self._freed = False def free(self): """Release the results and connection lock from the TornadoSession object. This **must** be called after you finish processing the results from :py:meth:`TornadoSession.query <queries.TornadoSession.query>` or self.cursor = cursor self._cleanup = cleanup self._fd = fd @gen.coroutine def free(self): def __del__(self): if not self._freed: LOGGER.warning('Auto-freeing result on deletion') self.free() requests. """ self._cleanup(self.cursor, self._fd) class TornadoSession(session.Session): """Session class for Tornado asynchronous applications. Uses :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ def __init__(self, uri=session.DEFAULT_URI, cursor_factory=extras.RealDictCursor, pool_idle_ttl=pool.DEFAULT_IDLE_TTL, pool_max_size=DEFAULT_MAX_POOL_SIZE, io_loop=None): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use :param tornado.ioloop.IOLoop io_loop: IOLoop instance to use """ self._connections = dict() self._cleanup_callback = None self._cursor_factory = cursor_factory self._futures = dict() self._ioloop = io_loop or ioloop.IOLoop.current() self._pool_manager = pool.PoolManager.instance() self._pool_max_size = pool_max_size self._pool_idle_ttl = pool_idle_ttl self._uri = uri self._ensure_pool_exists() def _ensure_pool_exists(self): """Create the pool in the pool manager if it does not exist.""" if self.pid not in self._pool_manager: self._pool_manager.create(self.pid, self._pool_idle_ttl, self._pool_max_size, self._ioloop.time) @property def connection(self): """Do not use this directly with Tornado applications :return: """ return None @property def cursor(self): return None def callproc(self, name, args=None): """Call a stored procedure asynchronously on the server, passing in the arguments to be passed to the stored procedure, yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. You **must** free the results that are returned by this method to unlock the connection used to perform the query. Failure to do so will cause your Tornado application to run out of connections. :param str name: The stored procedure name :param list args: An optional list of procedure arguments :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ return self._execute('callproc', name, args) def query(self, sql, parameters=None): """Issue a query asynchronously on the server, mogrifying the parameters against the sql statement and yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. You **must** free the results that are returned by this method to unlock the connection used to perform the query. Failure to do so will cause your Tornado application to run out of connections. :param str sql: The SQL statement :param dict parameters: A dictionary of query parameters :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ return self._execute('execute', sql, parameters) def validate(self): """Validate the session can connect or has open connections to PostgreSQL. As of ``1.10.3`` .. deprecated:: 1.10.3 As of 1.10.3, this method only warns about Deprecation :rtype: bool """ warnings.warn( 'All functionality removed from this method', DeprecationWarning) def _connect(self): """Connect to PostgreSQL, either by reusing a connection from the pool if possible, or by creating the new connection. :rtype: psycopg2.extensions.connection :raises: pool.NoIdleConnectionsError """ future = concurrent.Future() # Attempt to get a cached connection from the connection pool try: connection = self._pool_manager.get(self.pid, self) self._connections[connection.fileno()] = connection future.set_result(connection) # Add the connection to the IOLoop self._ioloop.add_handler(connection.fileno(), self._on_io_events, ioloop.IOLoop.WRITE) except pool.NoIdleConnectionsError: self._create_connection(future) return future def _create_connection(self, future): """Create a new PostgreSQL connection :param tornado.concurrent.Future future: future for new conn result """ LOGGER.debug('Creating a new connection for %s', self.pid) # Create a new PostgreSQL connection kwargs = utils.uri_to_kwargs(self._uri) try: connection = self._psycopg2_connect(kwargs) except (psycopg2.Error, OSError, socket.error) as error: future.set_exception(error) return # Add the connection for use in _poll_connection fd = connection.fileno() self._connections[fd] = connection def on_connected(cf): """Invoked by the IOLoop when the future is complete for the connection :param Future cf: The future for the initial connection """ if cf.exception(): self._cleanup_fd(fd, True) future.set_exception(cf.exception()) else: try: # Add the connection to the pool LOGGER.debug('Connection established for %s', self.pid) self._pool_manager.add(self.pid, connection) except (ValueError, pool.PoolException) as err: LOGGER.exception('Failed to add %r to the pool', self.pid) self._cleanup_fd(fd) future.set_exception(err) return self._pool_manager.lock(self.pid, connection, self) # Added in because psycopg2cffi connects and leaves the # connection in a weird state: consts.STATUS_DATESTYLE, # returning from Connection._setup without setting the state # as const.STATUS_OK if utils.PYPY: connection.status = extensions.STATUS_READY # Register the custom data types self._register_unicode(connection) self._register_uuid(connection) # Set the future result future.set_result(connection) # Add a future that fires once connected self._futures[fd] = concurrent.Future() self._ioloop.add_future(self._futures[fd], on_connected) # Add the connection to the IOLoop self._ioloop.add_handler(connection.fileno(), self._on_io_events, ioloop.IOLoop.WRITE) def _execute(self, method, query, parameters=None): """Issue a query asynchronously on the server, mogrifying the parameters against the sql statement and yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. This function reduces duplicate code for callproc and query by getting the class attribute for the method passed in as the function to call. :param str method: The method attribute to use :param str query: The SQL statement or Stored Procedure name :param list|dict parameters: A dictionary of query parameters :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ future = concurrent.Future() def on_connected(cf): """Invoked by the future returned by self._connect""" if cf.exception(): future.set_exception(cf.exception()) return # Get the psycopg2 connection object and cursor conn = cf.result() cursor = self._get_cursor(conn) def completed(qf): """Invoked by the IOLoop when the future has completed""" if qf.exception(): self._incr_exceptions(conn) err = qf.exception() LOGGER.debug('Cleaning cursor due to exception: %r', err) self._exec_cleanup(cursor, conn.fileno()) future.set_exception(err) else: self._incr_executions(conn) value = Results(cursor, self._exec_cleanup, conn.fileno()) future.set_result(value) # Setup a callback to wait on the query result self._futures[conn.fileno()] = concurrent.Future() # Add the future to the IOLoop self._ioloop.add_future(self._futures[conn.fileno()], completed) # Get the cursor, execute the query func = getattr(cursor, method) try: func(query, parameters) except Exception as error: future.set_exception(error) # Ensure the pool exists for the connection self._ensure_pool_exists() # Grab a connection to PostgreSQL self._ioloop.add_future(self._connect(), on_connected) # Return the future for the query result return future def _exec_cleanup(self, cursor, fd): """Close the cursor, remove any references to the fd in internal state and remove the fd from the ioloop. :param psycopg2.extensions.cursor cursor: The cursor to close :param int fd: The connection file descriptor """ LOGGER.debug('Closing cursor and cleaning %s', fd) try: cursor.close() except (psycopg2.Error, psycopg2.Warning) as error: LOGGER.debug('Error closing the cursor: %s', error) self._cleanup_fd(fd) # If the cleanup callback exists, remove it if self._cleanup_callback: self._ioloop.remove_timeout(self._cleanup_callback) # Create a new cleanup callback to clean the pool of idle connections self._cleanup_callback = self._ioloop.add_timeout( self._ioloop.time() + self._pool_idle_ttl + 1, self._pool_manager.clean, self.pid) def _cleanup_fd(self, fd, close=False): """Ensure the socket socket is removed from the IOLoop, the connection stack, and futures stack. :param int fd: The fd # to cleanup """ self._ioloop.remove_handler(fd) if fd in self._connections: try: self._pool_manager.free(self.pid, self._connections[fd]) except pool.ConnectionNotFoundError: pass if close: self._connections[fd].close() del self._connections[fd] if fd in self._futures: del self._futures[fd] def _incr_exceptions(self, conn): """Increment the number of exceptions for the current connection. :param psycopg2.extensions.connection conn: the psycopg2 connection """ self._pool_manager.get_connection(self.pid, conn).exceptions += 1 def _incr_executions(self, conn): """Increment the number of executions for the current connection. :param psycopg2.extensions.connection conn: the psycopg2 connection """ self._pool_manager.get_connection(self.pid, conn).executions += 1 def _on_io_events(self, fd=None, _events=None): """Invoked by Tornado's IOLoop when there are events for the fd :param int fd: The file descriptor for the event :param int _events: The events raised """ if fd not in self._connections: LOGGER.warning('Received IO event for non-existing connection') return self._poll_connection(fd) def _poll_connection(self, fd): """Check with psycopg2 to see what action to take. If the state is POLL_OK, we should have a pending callback for that fd. :param int fd: The socket fd for the postgresql connection """ try: state = self._connections[fd].poll() except (OSError, socket.error) as error: self._ioloop.remove_handler(fd) if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception( psycopg2.OperationalError('Connection error (%s)' % error) ) except (psycopg2.Error, psycopg2.Warning) as error: if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception(error) else: if state == extensions.POLL_OK: if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_result(True) elif state == extensions.POLL_WRITE: self._ioloop.update_handler(fd, ioloop.IOLoop.WRITE) elif state == extensions.POLL_READ: self._ioloop.update_handler(fd, ioloop.IOLoop.READ) elif state == extensions.POLL_ERROR: self._ioloop.remove_handler(fd) if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception( psycopg2.Error('Poll Error')) def _psycopg2_connect(self, kwargs): """Return a psycopg2 connection for the specified kwargs. Extend for use in async session adapters. :param dict kwargs: Keyword connection args :rtype: psycopg2.extensions.connection """ kwargs['async'] = True return psycopg2.connect(**kwargs) <MSG> Merge pull request #23 from dave-shawley/add-results-free-warning Log a warning when a result is leaked. <DFF> @@ -107,6 +107,7 @@ class Results(results.Results): self.cursor = cursor self._cleanup = cleanup self._fd = fd + self._freed = False @gen.coroutine def free(self): @@ -118,8 +119,13 @@ class Results(results.Results): requests. """ + self._freed = True self._cleanup(self.cursor, self._fd) + def __del__(self): + if not self._freed: + LOGGER.warning('%s not freed - %r', self.__class__.__name__, self) + class TornadoSession(session.Session): """Session class for Tornado asynchronous applications. Uses

Merge pull request #23 from dave-shawley/add-results-free-warning

.py

py

bsd-3-clause

gmr/queries

1515

<NME> utils_tests.py <BEF> ADDFILE <MSG> Add utils tests <DFF> @@ -0,0 +1,84 @@ +""" +Tests for functionality in the utils module + +""" +import mock +try: + import unittest2 as unittest +except ImportError: + import unittest + +from queries import utils + + +class GetCurrentUserTests(unittest.TestCase): + + @mock.patch('pwd.getpwuid') + def test_get_current_user(self, getpwuid): + """get_current_user returns value from pwd.getpwuid""" + getpwuid.return_value = ['mocky'] + self.assertEqual(utils.get_current_user(), 'mocky') + + +class URLParseTestCase(unittest.TestCase): + + URI = 'pgsql://foo:bar@baz:5444/qux' + + def test_urlparse_hostname(self): + """hostname should match expectation""" + self.assertEqual(utils.urlparse(self.URI).hostname, 'baz') + + def test_urlparse_port(self): + """port should match expectation""" + self.assertEqual(utils.urlparse(self.URI).port, 5444) + + def test_urlparse_path(self): + """path should match expectation""" + self.assertEqual(utils.urlparse(self.URI).path, '/qux') + + def test_urlparse_username(self): + """username should match expectation""" + self.assertEqual(utils.urlparse(self.URI).username, 'foo') + + def test_urlparse_password(self): + """password should match expectation""" + self.assertEqual(utils.urlparse(self.URI).password, 'bar') + + +class URIToKWargsTestCase(unittest.TestCase): + + URI = ('pgsql://foo:bar@baz:5444/qux?options=foo&options=bar&keepalives=1&' + 'invalid=true') + + def test_uri_to_kwargs_host(self): + """hostname should match expectation""" + self.assertEqual(utils.uri_to_kwargs(self.URI)['host'], 'baz') + + def test_uri_to_kwargs_port(self): + """port should match expectation""" + self.assertEqual(utils.uri_to_kwargs(self.URI)['port'], 5444) + + def test_uri_to_kwargs_dbname(self): + """dbname should match expectation""" + self.assertEqual(utils.uri_to_kwargs(self.URI)['dbname'], 'qux') + + def test_uri_to_kwargs_username(self): + """user should match expectation""" + self.assertEqual(utils.uri_to_kwargs(self.URI)['user'], 'foo') + + def test_uri_to_kwargs_password(self): + """password should match expectation""" + self.assertEqual(utils.uri_to_kwargs(self.URI)['password'], 'bar') + + def test_uri_to_kwargs_options(self): + """options should match expectation""" + self.assertEqual(utils.uri_to_kwargs(self.URI)['options'], + ['foo', 'bar']) + + def test_uri_to_kwargs_keepalive(self): + """keepalive should match expectation""" + self.assertEqual(utils.uri_to_kwargs(self.URI)['keepalives'], 1) + + def test_uri_to_kwargs_invalid(self): + """invalid query argument should not be in kwargs""" + self.assertNotIn('invaid', utils.uri_to_kwargs(self.URI))

Add utils tests

.py

py

bsd-3-clause

gmr/queries

1516

<NME> utils_tests.py <BEF> ADDFILE <MSG> Add utils tests <DFF> @@ -0,0 +1,84 @@ +""" +Tests for functionality in the utils module + +""" +import mock +try: + import unittest2 as unittest +except ImportError: + import unittest + +from queries import utils + + +class GetCurrentUserTests(unittest.TestCase): + + @mock.patch('pwd.getpwuid') + def test_get_current_user(self, getpwuid): + """get_current_user returns value from pwd.getpwuid""" + getpwuid.return_value = ['mocky'] + self.assertEqual(utils.get_current_user(), 'mocky') + + +class URLParseTestCase(unittest.TestCase): + + URI = 'pgsql://foo:bar@baz:5444/qux' + + def test_urlparse_hostname(self): + """hostname should match expectation""" + self.assertEqual(utils.urlparse(self.URI).hostname, 'baz') + + def test_urlparse_port(self): + """port should match expectation""" + self.assertEqual(utils.urlparse(self.URI).port, 5444) + + def test_urlparse_path(self): + """path should match expectation""" + self.assertEqual(utils.urlparse(self.URI).path, '/qux') + + def test_urlparse_username(self): + """username should match expectation""" + self.assertEqual(utils.urlparse(self.URI).username, 'foo') + + def test_urlparse_password(self): + """password should match expectation""" + self.assertEqual(utils.urlparse(self.URI).password, 'bar') + + +class URIToKWargsTestCase(unittest.TestCase): + + URI = ('pgsql://foo:bar@baz:5444/qux?options=foo&options=bar&keepalives=1&' + 'invalid=true') + + def test_uri_to_kwargs_host(self): + """hostname should match expectation""" + self.assertEqual(utils.uri_to_kwargs(self.URI)['host'], 'baz') + + def test_uri_to_kwargs_port(self): + """port should match expectation""" + self.assertEqual(utils.uri_to_kwargs(self.URI)['port'], 5444) + + def test_uri_to_kwargs_dbname(self): + """dbname should match expectation""" + self.assertEqual(utils.uri_to_kwargs(self.URI)['dbname'], 'qux') + + def test_uri_to_kwargs_username(self): + """user should match expectation""" + self.assertEqual(utils.uri_to_kwargs(self.URI)['user'], 'foo') + + def test_uri_to_kwargs_password(self): + """password should match expectation""" + self.assertEqual(utils.uri_to_kwargs(self.URI)['password'], 'bar') + + def test_uri_to_kwargs_options(self): + """options should match expectation""" + self.assertEqual(utils.uri_to_kwargs(self.URI)['options'], + ['foo', 'bar']) + + def test_uri_to_kwargs_keepalive(self): + """keepalive should match expectation""" + self.assertEqual(utils.uri_to_kwargs(self.URI)['keepalives'], 1) + + def test_uri_to_kwargs_invalid(self): + """invalid query argument should not be in kwargs""" + self.assertNotIn('invaid', utils.uri_to_kwargs(self.URI))

Add utils tests

.py

py

bsd-3-clause

gmr/queries

1517

<NME> tornado_session_tests.py <BEF> """ Tests for functionality in the tornado_session module """ import unittest import mock # Out of order import to ensure psycopg2cffi is registered from queries import pool, tornado_session from psycopg2 import extras from tornado import concurrent, gen, ioloop, testing class ResultsTests(unittest.TestCase): def setUp(self): self.cursor = mock.Mock() self.fd = 10 self.cleanup = mock.Mock() self.obj = tornado_session.Results(self.cursor, self.cleanup, self.fd) def test_cursor_is_assigned(self): self.assertEqual(self.obj.cursor, self.cursor) def test_fd_is_assigned(self): self.assertEqual(self.obj._fd, self.fd) def test_cleanup_is_assigned(self): self.assertEqual(self.obj._cleanup, self.cleanup) @gen.coroutine def test_free_invokes_cleanup(self): yield self.obj.free() self.cleanup.assert_called_once_with(self.cursor, self.fd) class SessionInitTests(unittest.TestCase): def setUp(self): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): self.assertDictEqual(self.obj._futures, {}) def setUp(self): self.obj = tornado_session.TornadoSession() #def test_creates_empty_callback_dict(self): # self.assertDictEqual(self.obj._futures, {}) # def test_creates_empty_connections_dict(self): # self.assertDictEqual(self.obj._connections, {}) def test_sets_default_cursor_factory(self): self.assertEqual(self.obj._cursor_factory, extras.RealDictCursor) def test_sets_uri(self): self.assertEqual(self.obj._uri, tornado_session.session.DEFAULT_URI) def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) def test_connection_is_none(self): self.assertIsNone(self.obj.connection) def test_cursor_is_none(self): self.assertIsNone(self.obj.cursor) class SessionConnectTests(testing.AsyncTestCase): def setUp(self): super(SessionConnectTests, self).setUp() self.conn = mock.Mock() self.conn.fileno = mock.Mock(return_value=10) self.obj = tornado_session.TornadoSession(io_loop=self.io_loop) def create_connection(future): future.set_result(self.conn) self.obj._create_connection = create_connection @testing.gen_test def test_connect_returns_new_connection(self): conn = yield self.obj._connect() self.assertEqual(conn, self.conn) @testing.gen_test def test_connect_returns_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) second_result = yield self.obj._connect() self.assertEqual(second_result, conn) @testing.gen_test def test_connect_gets_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: with mock.patch.object(self.io_loop, 'add_handler'): yield self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: with mock.patch.object(self.io_loop, 'add_handler') as add_handler: second_result = yield self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) @testing.gen_test yield self.obj._connect() add_handler.assert_called_once_with(self.conn.fileno(), self.obj._on_io_events, with mock.patch.object(self.obj._pool_manager, 'get') as get: get.return_value = self.conn with mock.patch.object(self.io_loop, 'add_handler') as add_handler: second_result = yield self.obj._connect() add_handler.assert_called_once_with(self.conn.fileno(), self.obj._on_io_events, ioloop.IOLoop.WRITE) def test_on_io_events_returns_if_fd_not_present(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_not_called() def test_on_io_events_calls_poll_connection(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._connections[1337] = True self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_called_once_with(1337) def test_exec_cleanup_closes_cursor(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() cursor = mock.Mock() cursor.close = mock.Mock() self.obj._exec_cleanup(cursor, 14) cursor.close.assert_called_once_with() def test_exec_cleanup_frees_connection(self): with mock.patch.object(self.obj._pool_manager, 'free') as pm_free: with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = conn = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) pm_free.assert_called_once_with(self.obj.pid, conn) def test_exec_cleanup_remove_handler_invoked(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler') as rh: self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) rh.assert_called_once_with(14) def test_exec_removes_connection(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._connections) def test_exec_removes_future(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._futures[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._futures) def test_pool_manager_add_failures_are_propagated(self): futures = [] def add_future(future, callback): futures.append((future, callback)) obj = tornado_session.TornadoSession() obj._ioloop = mock.Mock() obj._ioloop.add_future = add_future future = concurrent.Future() with mock.patch.object(obj._pool_manager, 'add') as add_method: add_method.side_effect = pool.PoolFullError(mock.Mock()) obj._create_connection(future) self.assertEqual(len(futures), 1) connected_future, callback = futures.pop() connected_future.set_result(True) callback(connected_future) self.assertIs(future.exception(), add_method.side_effect) class SessionPublicMethodTests(testing.AsyncTestCase): @testing.gen_test def test_callproc_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.callproc('foo', ['bar']) _execute.assert_called_once_with('callproc', 'foo', ['bar']) @testing.gen_test def test_query_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) """ @testing.gen_test def test_query_error_key_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): yield obj.query('SELECT * FROM foo WHERE bar=%(baz)s', {}) @testing.gen_test def test_query_error_index_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): r = yield obj.query('SELECT * FROM foo WHERE bar=%s', []) """ future.set_result(connection) _connect.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) result = yield obj.validate() _connect.assert_called_once_with() <MSG> Merge pull request #25 from gmr/autoclean Autoclean <DFF> @@ -47,11 +47,11 @@ class SessionInitTests(unittest.TestCase): def setUp(self): self.obj = tornado_session.TornadoSession() - #def test_creates_empty_callback_dict(self): - # self.assertDictEqual(self.obj._futures, {}) + def test_creates_empty_callback_dict(self): + self.assertDictEqual(self.obj._futures, {}) - # def test_creates_empty_connections_dict(self): - # self.assertDictEqual(self.obj._connections, {}) + def test_creates_empty_connections_dict(self): + self.assertDictEqual(self.obj._connections, {}) def test_sets_default_cursor_factory(self): self.assertEqual(self.obj._cursor_factory, extras.RealDictCursor) @@ -105,8 +105,8 @@ class SessionConnectTests(testing.AsyncTestCase): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: - with mock.patch.object(self.io_loop, 'add_handler') as add_handler: - second_result = yield self.obj._connect() + with mock.patch.object(self.io_loop, 'add_handler'): + yield self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) @testing.gen_test @@ -116,7 +116,7 @@ class SessionConnectTests(testing.AsyncTestCase): with mock.patch.object(self.obj._pool_manager, 'get') as get: get.return_value = self.conn with mock.patch.object(self.io_loop, 'add_handler') as add_handler: - second_result = yield self.obj._connect() + yield self.obj._connect() add_handler.assert_called_once_with(self.conn.fileno(), self.obj._on_io_events, ioloop.IOLoop.WRITE) @@ -232,5 +232,5 @@ class SessionPublicMethodTests(testing.AsyncTestCase): future.set_result(connection) _connect.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) - result = yield obj.validate() + yield obj.validate() _connect.assert_called_once_with()

Merge pull request #25 from gmr/autoclean

.py

py

bsd-3-clause

gmr/queries

1518

<NME> tornado_session_tests.py <BEF> """ Tests for functionality in the tornado_session module """ import unittest import mock # Out of order import to ensure psycopg2cffi is registered from queries import pool, tornado_session from psycopg2 import extras from tornado import concurrent, gen, ioloop, testing class ResultsTests(unittest.TestCase): def setUp(self): self.cursor = mock.Mock() self.fd = 10 self.cleanup = mock.Mock() self.obj = tornado_session.Results(self.cursor, self.cleanup, self.fd) def test_cursor_is_assigned(self): self.assertEqual(self.obj.cursor, self.cursor) def test_fd_is_assigned(self): self.assertEqual(self.obj._fd, self.fd) def test_cleanup_is_assigned(self): self.assertEqual(self.obj._cleanup, self.cleanup) @gen.coroutine def test_free_invokes_cleanup(self): yield self.obj.free() self.cleanup.assert_called_once_with(self.cursor, self.fd) class SessionInitTests(unittest.TestCase): def setUp(self): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): self.assertDictEqual(self.obj._futures, {}) def setUp(self): self.obj = tornado_session.TornadoSession() #def test_creates_empty_callback_dict(self): # self.assertDictEqual(self.obj._futures, {}) # def test_creates_empty_connections_dict(self): # self.assertDictEqual(self.obj._connections, {}) def test_sets_default_cursor_factory(self): self.assertEqual(self.obj._cursor_factory, extras.RealDictCursor) def test_sets_uri(self): self.assertEqual(self.obj._uri, tornado_session.session.DEFAULT_URI) def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) def test_connection_is_none(self): self.assertIsNone(self.obj.connection) def test_cursor_is_none(self): self.assertIsNone(self.obj.cursor) class SessionConnectTests(testing.AsyncTestCase): def setUp(self): super(SessionConnectTests, self).setUp() self.conn = mock.Mock() self.conn.fileno = mock.Mock(return_value=10) self.obj = tornado_session.TornadoSession(io_loop=self.io_loop) def create_connection(future): future.set_result(self.conn) self.obj._create_connection = create_connection @testing.gen_test def test_connect_returns_new_connection(self): conn = yield self.obj._connect() self.assertEqual(conn, self.conn) @testing.gen_test def test_connect_returns_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) second_result = yield self.obj._connect() self.assertEqual(second_result, conn) @testing.gen_test def test_connect_gets_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: with mock.patch.object(self.io_loop, 'add_handler'): yield self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: with mock.patch.object(self.io_loop, 'add_handler') as add_handler: second_result = yield self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) @testing.gen_test yield self.obj._connect() add_handler.assert_called_once_with(self.conn.fileno(), self.obj._on_io_events, with mock.patch.object(self.obj._pool_manager, 'get') as get: get.return_value = self.conn with mock.patch.object(self.io_loop, 'add_handler') as add_handler: second_result = yield self.obj._connect() add_handler.assert_called_once_with(self.conn.fileno(), self.obj._on_io_events, ioloop.IOLoop.WRITE) def test_on_io_events_returns_if_fd_not_present(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_not_called() def test_on_io_events_calls_poll_connection(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._connections[1337] = True self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_called_once_with(1337) def test_exec_cleanup_closes_cursor(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() cursor = mock.Mock() cursor.close = mock.Mock() self.obj._exec_cleanup(cursor, 14) cursor.close.assert_called_once_with() def test_exec_cleanup_frees_connection(self): with mock.patch.object(self.obj._pool_manager, 'free') as pm_free: with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = conn = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) pm_free.assert_called_once_with(self.obj.pid, conn) def test_exec_cleanup_remove_handler_invoked(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler') as rh: self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) rh.assert_called_once_with(14) def test_exec_removes_connection(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._connections) def test_exec_removes_future(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._futures[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._futures) def test_pool_manager_add_failures_are_propagated(self): futures = [] def add_future(future, callback): futures.append((future, callback)) obj = tornado_session.TornadoSession() obj._ioloop = mock.Mock() obj._ioloop.add_future = add_future future = concurrent.Future() with mock.patch.object(obj._pool_manager, 'add') as add_method: add_method.side_effect = pool.PoolFullError(mock.Mock()) obj._create_connection(future) self.assertEqual(len(futures), 1) connected_future, callback = futures.pop() connected_future.set_result(True) callback(connected_future) self.assertIs(future.exception(), add_method.side_effect) class SessionPublicMethodTests(testing.AsyncTestCase): @testing.gen_test def test_callproc_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.callproc('foo', ['bar']) _execute.assert_called_once_with('callproc', 'foo', ['bar']) @testing.gen_test def test_query_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) """ @testing.gen_test def test_query_error_key_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): yield obj.query('SELECT * FROM foo WHERE bar=%(baz)s', {}) @testing.gen_test def test_query_error_index_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): r = yield obj.query('SELECT * FROM foo WHERE bar=%s', []) """ future.set_result(connection) _connect.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) result = yield obj.validate() _connect.assert_called_once_with() <MSG> Merge pull request #25 from gmr/autoclean Autoclean <DFF> @@ -47,11 +47,11 @@ class SessionInitTests(unittest.TestCase): def setUp(self): self.obj = tornado_session.TornadoSession() - #def test_creates_empty_callback_dict(self): - # self.assertDictEqual(self.obj._futures, {}) + def test_creates_empty_callback_dict(self): + self.assertDictEqual(self.obj._futures, {}) - # def test_creates_empty_connections_dict(self): - # self.assertDictEqual(self.obj._connections, {}) + def test_creates_empty_connections_dict(self): + self.assertDictEqual(self.obj._connections, {}) def test_sets_default_cursor_factory(self): self.assertEqual(self.obj._cursor_factory, extras.RealDictCursor) @@ -105,8 +105,8 @@ class SessionConnectTests(testing.AsyncTestCase): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: - with mock.patch.object(self.io_loop, 'add_handler') as add_handler: - second_result = yield self.obj._connect() + with mock.patch.object(self.io_loop, 'add_handler'): + yield self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) @testing.gen_test @@ -116,7 +116,7 @@ class SessionConnectTests(testing.AsyncTestCase): with mock.patch.object(self.obj._pool_manager, 'get') as get: get.return_value = self.conn with mock.patch.object(self.io_loop, 'add_handler') as add_handler: - second_result = yield self.obj._connect() + yield self.obj._connect() add_handler.assert_called_once_with(self.conn.fileno(), self.obj._on_io_events, ioloop.IOLoop.WRITE) @@ -232,5 +232,5 @@ class SessionPublicMethodTests(testing.AsyncTestCase): future.set_result(connection) _connect.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) - result = yield obj.validate() + yield obj.validate() _connect.assert_called_once_with()

Merge pull request #25 from gmr/autoclean

.py

py

bsd-3-clause

gmr/queries

1519

<NME> tornado_session.py <BEF> """ Tornado Session Adapter Use Queries asynchronously within the Tornado framework. Example Use: .. code:: python class NameListHandler(web.RequestHandler): def initialize(self): from tornado import stack_context import psycopg2 from queries import session from queries import DEFAULT_URI data.free() class TornadoSession(session.Session): def __init__(self, uri=DEFAULT_URI, cursor_factory=extras.RealDictCursor, use_pool=True): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. :param str uri: PostgreSQL connection URI :param psycopg2.cursor: The cursor type to use :param bool use_pool: Use the connection pool """ self._callbacks = dict() self._conn, self._cursor = None, None self._connections = dict() self._commands = dict() self._cursor_factory = cursor_factory **Using Results as an Iterator** .. code:: python results = yield session.query('SELECT * FROM foo') for row in results print row results.free() **Accessing an individual row by index** .. code:: python results = yield session.query('SELECT * FROM foo') print results[1] # Access the second row of the results results.free() **Casting single row results as a dict** .. code:: python results = yield session.query('SELECT * FROM foo LIMIT 1') print results.as_dict() results.free() **Checking to see if a query was successful** .. code:: python sql = "UPDATE foo SET bar='baz' WHERE qux='corgie'" results = yield session.query(sql) if results: print 'Success' results.free() **Checking the number of rows by using len(Results)** .. code:: python results = yield session.query('SELECT * FROM foo') print '%i rows' % len(results) results.free() """ def __init__(self, cursor, cleanup, fd): self.cursor = cursor self._cleanup = cleanup self._fd = fd self._freed = False def free(self): """Release the results and connection lock from the TornadoSession object. This **must** be called after you finish processing the results from :py:meth:`TornadoSession.query <queries.TornadoSession.query>` or :py:meth:`TornadoSession.callproc <queries.TornadoSession.callproc>` or the connection will not be able to be reused by other asynchronous requests. """ self._freed = True self._cleanup(self.cursor, self._fd) def __del__(self): if not self._freed: LOGGER.warning('Auto-freeing result on deletion') self.free() class TornadoSession(session.Session): """Session class for Tornado asynchronous applications. Uses :py:func:`tornado.gen.coroutine` to wrap API methods for use in Tornado. Utilizes connection pooling to ensure that multiple concurrent asynchronous queries do not block each other. Heavily trafficked services will require a higher ``max_pool_size`` to allow for greater connection concurrency. :py:meth:`TornadoSession.query <queries.TornadoSession.query>` and :py:meth:`TornadoSession.callproc <queries.TornadoSession.callproc>` must call :py:meth:`Results.free <queries.tornado_session.Results.free>` :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ def __init__(self, uri=session.DEFAULT_URI, cursor_factory=extras.RealDictCursor, pool_idle_ttl=pool.DEFAULT_IDLE_TTL, pool_max_size=DEFAULT_MAX_POOL_SIZE, io_loop=None): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use :param tornado.ioloop.IOLoop io_loop: IOLoop instance to use """ self._connections = dict() self._cleanup_callback = None self._cursor_factory = cursor_factory self._futures = dict() self._ioloop = io_loop or ioloop.IOLoop.current() self._pool_manager = pool.PoolManager.instance() self._pool_max_size = pool_max_size self._pool_idle_ttl = pool_idle_ttl self._uri = uri self._ensure_pool_exists() def _ensure_pool_exists(self): """Create the pool in the pool manager if it does not exist.""" if self.pid not in self._pool_manager: self._pool_manager.create(self.pid, self._pool_idle_ttl, self._pool_max_size, self._ioloop.time) @property def connection(self): """Do not use this directly with Tornado applications :return: """ return None @property def cursor(self): return None def callproc(self, name, args=None): """Call a stored procedure asynchronously on the server, passing in the arguments to be passed to the stored procedure, yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. You **must** free the results that are returned by this method to unlock the connection used to perform the query. Failure to do so will cause your Tornado application to run out of connections. :param str name: The stored procedure name :param list args: An optional list of procedure arguments :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ return self._execute('callproc', name, args) def query(self, sql, parameters=None): """Issue a query asynchronously on the server, mogrifying the parameters against the sql statement and yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. You **must** free the results that are returned by this method to unlock the connection used to perform the query. Failure to do so will cause your Tornado application to run out of connections. :param str sql: The SQL statement :param dict parameters: A dictionary of query parameters :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ return self._execute('execute', sql, parameters) def validate(self): """Validate the session can connect or has open connections to PostgreSQL. As of ``1.10.3`` .. deprecated:: 1.10.3 As of 1.10.3, this method only warns about Deprecation :rtype: bool """ warnings.warn( 'All functionality removed from this method', DeprecationWarning) def _connect(self): """Connect to PostgreSQL, either by reusing a connection from the pool if possible, or by creating the new connection. :rtype: psycopg2.extensions.connection :raises: pool.NoIdleConnectionsError """ future = concurrent.Future() # Attempt to get a cached connection from the connection pool try: connection = self._pool_manager.get(self.pid, self) self._connections[connection.fileno()] = connection future.set_result(connection) # Add the connection to the IOLoop self._ioloop.add_handler(connection.fileno(), self._on_io_events, ioloop.IOLoop.WRITE) except pool.NoIdleConnectionsError: self._create_connection(future) return future def _create_connection(self, future): """Create a new PostgreSQL connection :param tornado.concurrent.Future future: future for new conn result """ LOGGER.debug('Creating a new connection for %s', self.pid) # Create a new PostgreSQL connection kwargs = utils.uri_to_kwargs(self._uri) try: connection = self._psycopg2_connect(kwargs) except (psycopg2.Error, OSError, socket.error) as error: future.set_exception(error) return # Add the connection for use in _poll_connection fd = connection.fileno() self._connections[fd] = connection def on_connected(cf): """Invoked by the IOLoop when the future is complete for the connection :param Future cf: The future for the initial connection """ if cf.exception(): self._cleanup_fd(fd, True) future.set_exception(cf.exception()) else: try: # Add the connection to the pool LOGGER.debug('Connection established for %s', self.pid) self._pool_manager.add(self.pid, connection) except (ValueError, pool.PoolException) as err: LOGGER.exception('Failed to add %r to the pool', self.pid) self._cleanup_fd(fd) future.set_exception(err) return self._pool_manager.lock(self.pid, connection, self) # Added in because psycopg2cffi connects and leaves the # connection in a weird state: consts.STATUS_DATESTYLE, # returning from Connection._setup without setting the state # as const.STATUS_OK if utils.PYPY: connection.status = extensions.STATUS_READY # Register the custom data types self._register_unicode(connection) self._register_uuid(connection) # Set the future result future.set_result(connection) # Add a future that fires once connected self._futures[fd] = concurrent.Future() self._ioloop.add_future(self._futures[fd], on_connected) # Add the connection to the IOLoop self._ioloop.add_handler(connection.fileno(), self._on_io_events, ioloop.IOLoop.WRITE) def _execute(self, method, query, parameters=None): """Issue a query asynchronously on the server, mogrifying the parameters against the sql statement and yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. This function reduces duplicate code for callproc and query by getting the class attribute for the method passed in as the function to call. :param str method: The method attribute to use :param str query: The SQL statement or Stored Procedure name :param list|dict parameters: A dictionary of query parameters :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ future = concurrent.Future() def on_connected(cf): """Invoked by the future returned by self._connect""" if cf.exception(): future.set_exception(cf.exception()) return # Get the psycopg2 connection object and cursor conn = cf.result() cursor = self._get_cursor(conn) def completed(qf): """Invoked by the IOLoop when the future has completed""" if qf.exception(): self._incr_exceptions(conn) err = qf.exception() LOGGER.debug('Cleaning cursor due to exception: %r', err) self._exec_cleanup(cursor, conn.fileno()) future.set_exception(err) else: self._incr_executions(conn) value = Results(cursor, self._exec_cleanup, conn.fileno()) future.set_result(value) # Setup a callback to wait on the query result self._futures[conn.fileno()] = concurrent.Future() # Add the future to the IOLoop self._ioloop.add_future(self._futures[conn.fileno()], completed) # Get the cursor, execute the query func = getattr(cursor, method) try: func(query, parameters) except Exception as error: future.set_exception(error) # Ensure the pool exists for the connection self._ensure_pool_exists() # Grab a connection to PostgreSQL self._ioloop.add_future(self._connect(), on_connected) # Return the future for the query result return future def _exec_cleanup(self, cursor, fd): """Close the cursor, remove any references to the fd in internal state and remove the fd from the ioloop. :param psycopg2.extensions.cursor cursor: The cursor to close :param int fd: The connection file descriptor """ LOGGER.debug('Closing cursor and cleaning %s', fd) try: cursor.close() except (psycopg2.Error, psycopg2.Warning) as error: LOGGER.debug('Error closing the cursor: %s', error) self._cleanup_fd(fd) # If the cleanup callback exists, remove it if self._cleanup_callback: self._ioloop.remove_timeout(self._cleanup_callback) # Create a new cleanup callback to clean the pool of idle connections self._cleanup_callback = self._ioloop.add_timeout( self._ioloop.time() + self._pool_idle_ttl + 1, self._pool_manager.clean, self.pid) def _cleanup_fd(self, fd, close=False): """Ensure the socket socket is removed from the IOLoop, the connection stack, and futures stack. :param int fd: The fd # to cleanup """ self._ioloop.remove_handler(fd) if fd in self._connections: try: self._pool_manager.free(self.pid, self._connections[fd]) except pool.ConnectionNotFoundError: pass if close: self._connections[fd].close() del self._connections[fd] if fd in self._futures: del self._futures[fd] def _incr_exceptions(self, conn): """Increment the number of exceptions for the current connection. :param psycopg2.extensions.connection conn: the psycopg2 connection """ self._pool_manager.get_connection(self.pid, conn).exceptions += 1 def _incr_executions(self, conn): """Increment the number of executions for the current connection. :param psycopg2.extensions.connection conn: the psycopg2 connection """ self._pool_manager.get_connection(self.pid, conn).executions += 1 def _on_io_events(self, fd=None, _events=None): """Invoked by Tornado's IOLoop when there are events for the fd :param int fd: The file descriptor for the event :param int _events: The events raised """ if fd not in self._connections: LOGGER.warning('Received IO event for non-existing connection') return self._poll_connection(fd) def _poll_connection(self, fd): """Check with psycopg2 to see what action to take. If the state is POLL_OK, we should have a pending callback for that fd. :param int fd: The socket fd for the postgresql connection """ try: state = self._connections[fd].poll() except (OSError, socket.error) as error: self._ioloop.remove_handler(fd) if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception( psycopg2.OperationalError('Connection error (%s)' % error) ) except (psycopg2.Error, psycopg2.Warning) as error: if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception(error) else: if state == extensions.POLL_OK: if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_result(True) elif state == extensions.POLL_WRITE: self._ioloop.update_handler(fd, ioloop.IOLoop.WRITE) elif state == extensions.POLL_READ: self._ioloop.update_handler(fd, ioloop.IOLoop.READ) elif state == extensions.POLL_ERROR: self._ioloop.remove_handler(fd) if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception( psycopg2.Error('Poll Error')) def _psycopg2_connect(self, kwargs): """Return a psycopg2 connection for the specified kwargs. Extend for use in async session adapters. :param dict kwargs: Keyword connection args :rtype: psycopg2.extensions.connection """ kwargs['async'] = True return psycopg2.connect(**kwargs) <MSG> Add ability to pass in pool size into the constructor @TODO use value to set max pool size <DFF> @@ -13,6 +13,7 @@ from tornado import ioloop from tornado import stack_context import psycopg2 +from queries import pool from queries import session from queries import DEFAULT_URI @@ -20,21 +21,31 @@ LOGGER = logging.getLogger(__name__) class TornadoSession(session.Session): + """Session class for Tornado asynchronous applications. Using + + Unlike `queries.Session.query` and `queries.Session.callproc`, the + `TornadoSession.query` and `TornadoSession.callproc` methods are not + iterators and return the full result set + using `psycopg2.cursor.fetchall()`. + + + """ def __init__(self, uri=DEFAULT_URI, cursor_factory=extras.RealDictCursor, - use_pool=True): + use_pool=True, + max_pool_size=pool.MAX_SIZE): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. :param str uri: PostgreSQL connection URI :param psycopg2.cursor: The cursor type to use :param bool use_pool: Use the connection pool + :param int max_pool_size: Maximum number of connections for a single URI """ self._callbacks = dict() - self._conn, self._cursor = None, None self._connections = dict() self._commands = dict() self._cursor_factory = cursor_factory

Add ability to pass in pool size into the constructor

.py

py

bsd-3-clause

gmr/queries

1520

<NME> tornado_session.py <BEF> """ Tornado Session Adapter Use Queries asynchronously within the Tornado framework. Example Use: .. code:: python class NameListHandler(web.RequestHandler): def initialize(self): from tornado import stack_context import psycopg2 from queries import session from queries import DEFAULT_URI data.free() class TornadoSession(session.Session): def __init__(self, uri=DEFAULT_URI, cursor_factory=extras.RealDictCursor, use_pool=True): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. :param str uri: PostgreSQL connection URI :param psycopg2.cursor: The cursor type to use :param bool use_pool: Use the connection pool """ self._callbacks = dict() self._conn, self._cursor = None, None self._connections = dict() self._commands = dict() self._cursor_factory = cursor_factory **Using Results as an Iterator** .. code:: python results = yield session.query('SELECT * FROM foo') for row in results print row results.free() **Accessing an individual row by index** .. code:: python results = yield session.query('SELECT * FROM foo') print results[1] # Access the second row of the results results.free() **Casting single row results as a dict** .. code:: python results = yield session.query('SELECT * FROM foo LIMIT 1') print results.as_dict() results.free() **Checking to see if a query was successful** .. code:: python sql = "UPDATE foo SET bar='baz' WHERE qux='corgie'" results = yield session.query(sql) if results: print 'Success' results.free() **Checking the number of rows by using len(Results)** .. code:: python results = yield session.query('SELECT * FROM foo') print '%i rows' % len(results) results.free() """ def __init__(self, cursor, cleanup, fd): self.cursor = cursor self._cleanup = cleanup self._fd = fd self._freed = False def free(self): """Release the results and connection lock from the TornadoSession object. This **must** be called after you finish processing the results from :py:meth:`TornadoSession.query <queries.TornadoSession.query>` or :py:meth:`TornadoSession.callproc <queries.TornadoSession.callproc>` or the connection will not be able to be reused by other asynchronous requests. """ self._freed = True self._cleanup(self.cursor, self._fd) def __del__(self): if not self._freed: LOGGER.warning('Auto-freeing result on deletion') self.free() class TornadoSession(session.Session): """Session class for Tornado asynchronous applications. Uses :py:func:`tornado.gen.coroutine` to wrap API methods for use in Tornado. Utilizes connection pooling to ensure that multiple concurrent asynchronous queries do not block each other. Heavily trafficked services will require a higher ``max_pool_size`` to allow for greater connection concurrency. :py:meth:`TornadoSession.query <queries.TornadoSession.query>` and :py:meth:`TornadoSession.callproc <queries.TornadoSession.callproc>` must call :py:meth:`Results.free <queries.tornado_session.Results.free>` :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ def __init__(self, uri=session.DEFAULT_URI, cursor_factory=extras.RealDictCursor, pool_idle_ttl=pool.DEFAULT_IDLE_TTL, pool_max_size=DEFAULT_MAX_POOL_SIZE, io_loop=None): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use :param tornado.ioloop.IOLoop io_loop: IOLoop instance to use """ self._connections = dict() self._cleanup_callback = None self._cursor_factory = cursor_factory self._futures = dict() self._ioloop = io_loop or ioloop.IOLoop.current() self._pool_manager = pool.PoolManager.instance() self._pool_max_size = pool_max_size self._pool_idle_ttl = pool_idle_ttl self._uri = uri self._ensure_pool_exists() def _ensure_pool_exists(self): """Create the pool in the pool manager if it does not exist.""" if self.pid not in self._pool_manager: self._pool_manager.create(self.pid, self._pool_idle_ttl, self._pool_max_size, self._ioloop.time) @property def connection(self): """Do not use this directly with Tornado applications :return: """ return None @property def cursor(self): return None def callproc(self, name, args=None): """Call a stored procedure asynchronously on the server, passing in the arguments to be passed to the stored procedure, yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. You **must** free the results that are returned by this method to unlock the connection used to perform the query. Failure to do so will cause your Tornado application to run out of connections. :param str name: The stored procedure name :param list args: An optional list of procedure arguments :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ return self._execute('callproc', name, args) def query(self, sql, parameters=None): """Issue a query asynchronously on the server, mogrifying the parameters against the sql statement and yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. You **must** free the results that are returned by this method to unlock the connection used to perform the query. Failure to do so will cause your Tornado application to run out of connections. :param str sql: The SQL statement :param dict parameters: A dictionary of query parameters :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ return self._execute('execute', sql, parameters) def validate(self): """Validate the session can connect or has open connections to PostgreSQL. As of ``1.10.3`` .. deprecated:: 1.10.3 As of 1.10.3, this method only warns about Deprecation :rtype: bool """ warnings.warn( 'All functionality removed from this method', DeprecationWarning) def _connect(self): """Connect to PostgreSQL, either by reusing a connection from the pool if possible, or by creating the new connection. :rtype: psycopg2.extensions.connection :raises: pool.NoIdleConnectionsError """ future = concurrent.Future() # Attempt to get a cached connection from the connection pool try: connection = self._pool_manager.get(self.pid, self) self._connections[connection.fileno()] = connection future.set_result(connection) # Add the connection to the IOLoop self._ioloop.add_handler(connection.fileno(), self._on_io_events, ioloop.IOLoop.WRITE) except pool.NoIdleConnectionsError: self._create_connection(future) return future def _create_connection(self, future): """Create a new PostgreSQL connection :param tornado.concurrent.Future future: future for new conn result """ LOGGER.debug('Creating a new connection for %s', self.pid) # Create a new PostgreSQL connection kwargs = utils.uri_to_kwargs(self._uri) try: connection = self._psycopg2_connect(kwargs) except (psycopg2.Error, OSError, socket.error) as error: future.set_exception(error) return # Add the connection for use in _poll_connection fd = connection.fileno() self._connections[fd] = connection def on_connected(cf): """Invoked by the IOLoop when the future is complete for the connection :param Future cf: The future for the initial connection """ if cf.exception(): self._cleanup_fd(fd, True) future.set_exception(cf.exception()) else: try: # Add the connection to the pool LOGGER.debug('Connection established for %s', self.pid) self._pool_manager.add(self.pid, connection) except (ValueError, pool.PoolException) as err: LOGGER.exception('Failed to add %r to the pool', self.pid) self._cleanup_fd(fd) future.set_exception(err) return self._pool_manager.lock(self.pid, connection, self) # Added in because psycopg2cffi connects and leaves the # connection in a weird state: consts.STATUS_DATESTYLE, # returning from Connection._setup without setting the state # as const.STATUS_OK if utils.PYPY: connection.status = extensions.STATUS_READY # Register the custom data types self._register_unicode(connection) self._register_uuid(connection) # Set the future result future.set_result(connection) # Add a future that fires once connected self._futures[fd] = concurrent.Future() self._ioloop.add_future(self._futures[fd], on_connected) # Add the connection to the IOLoop self._ioloop.add_handler(connection.fileno(), self._on_io_events, ioloop.IOLoop.WRITE) def _execute(self, method, query, parameters=None): """Issue a query asynchronously on the server, mogrifying the parameters against the sql statement and yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. This function reduces duplicate code for callproc and query by getting the class attribute for the method passed in as the function to call. :param str method: The method attribute to use :param str query: The SQL statement or Stored Procedure name :param list|dict parameters: A dictionary of query parameters :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ future = concurrent.Future() def on_connected(cf): """Invoked by the future returned by self._connect""" if cf.exception(): future.set_exception(cf.exception()) return # Get the psycopg2 connection object and cursor conn = cf.result() cursor = self._get_cursor(conn) def completed(qf): """Invoked by the IOLoop when the future has completed""" if qf.exception(): self._incr_exceptions(conn) err = qf.exception() LOGGER.debug('Cleaning cursor due to exception: %r', err) self._exec_cleanup(cursor, conn.fileno()) future.set_exception(err) else: self._incr_executions(conn) value = Results(cursor, self._exec_cleanup, conn.fileno()) future.set_result(value) # Setup a callback to wait on the query result self._futures[conn.fileno()] = concurrent.Future() # Add the future to the IOLoop self._ioloop.add_future(self._futures[conn.fileno()], completed) # Get the cursor, execute the query func = getattr(cursor, method) try: func(query, parameters) except Exception as error: future.set_exception(error) # Ensure the pool exists for the connection self._ensure_pool_exists() # Grab a connection to PostgreSQL self._ioloop.add_future(self._connect(), on_connected) # Return the future for the query result return future def _exec_cleanup(self, cursor, fd): """Close the cursor, remove any references to the fd in internal state and remove the fd from the ioloop. :param psycopg2.extensions.cursor cursor: The cursor to close :param int fd: The connection file descriptor """ LOGGER.debug('Closing cursor and cleaning %s', fd) try: cursor.close() except (psycopg2.Error, psycopg2.Warning) as error: LOGGER.debug('Error closing the cursor: %s', error) self._cleanup_fd(fd) # If the cleanup callback exists, remove it if self._cleanup_callback: self._ioloop.remove_timeout(self._cleanup_callback) # Create a new cleanup callback to clean the pool of idle connections self._cleanup_callback = self._ioloop.add_timeout( self._ioloop.time() + self._pool_idle_ttl + 1, self._pool_manager.clean, self.pid) def _cleanup_fd(self, fd, close=False): """Ensure the socket socket is removed from the IOLoop, the connection stack, and futures stack. :param int fd: The fd # to cleanup """ self._ioloop.remove_handler(fd) if fd in self._connections: try: self._pool_manager.free(self.pid, self._connections[fd]) except pool.ConnectionNotFoundError: pass if close: self._connections[fd].close() del self._connections[fd] if fd in self._futures: del self._futures[fd] def _incr_exceptions(self, conn): """Increment the number of exceptions for the current connection. :param psycopg2.extensions.connection conn: the psycopg2 connection """ self._pool_manager.get_connection(self.pid, conn).exceptions += 1 def _incr_executions(self, conn): """Increment the number of executions for the current connection. :param psycopg2.extensions.connection conn: the psycopg2 connection """ self._pool_manager.get_connection(self.pid, conn).executions += 1 def _on_io_events(self, fd=None, _events=None): """Invoked by Tornado's IOLoop when there are events for the fd :param int fd: The file descriptor for the event :param int _events: The events raised """ if fd not in self._connections: LOGGER.warning('Received IO event for non-existing connection') return self._poll_connection(fd) def _poll_connection(self, fd): """Check with psycopg2 to see what action to take. If the state is POLL_OK, we should have a pending callback for that fd. :param int fd: The socket fd for the postgresql connection """ try: state = self._connections[fd].poll() except (OSError, socket.error) as error: self._ioloop.remove_handler(fd) if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception( psycopg2.OperationalError('Connection error (%s)' % error) ) except (psycopg2.Error, psycopg2.Warning) as error: if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception(error) else: if state == extensions.POLL_OK: if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_result(True) elif state == extensions.POLL_WRITE: self._ioloop.update_handler(fd, ioloop.IOLoop.WRITE) elif state == extensions.POLL_READ: self._ioloop.update_handler(fd, ioloop.IOLoop.READ) elif state == extensions.POLL_ERROR: self._ioloop.remove_handler(fd) if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception( psycopg2.Error('Poll Error')) def _psycopg2_connect(self, kwargs): """Return a psycopg2 connection for the specified kwargs. Extend for use in async session adapters. :param dict kwargs: Keyword connection args :rtype: psycopg2.extensions.connection """ kwargs['async'] = True return psycopg2.connect(**kwargs) <MSG> Add ability to pass in pool size into the constructor @TODO use value to set max pool size <DFF> @@ -13,6 +13,7 @@ from tornado import ioloop from tornado import stack_context import psycopg2 +from queries import pool from queries import session from queries import DEFAULT_URI @@ -20,21 +21,31 @@ LOGGER = logging.getLogger(__name__) class TornadoSession(session.Session): + """Session class for Tornado asynchronous applications. Using + + Unlike `queries.Session.query` and `queries.Session.callproc`, the + `TornadoSession.query` and `TornadoSession.callproc` methods are not + iterators and return the full result set + using `psycopg2.cursor.fetchall()`. + + + """ def __init__(self, uri=DEFAULT_URI, cursor_factory=extras.RealDictCursor, - use_pool=True): + use_pool=True, + max_pool_size=pool.MAX_SIZE): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. :param str uri: PostgreSQL connection URI :param psycopg2.cursor: The cursor type to use :param bool use_pool: Use the connection pool + :param int max_pool_size: Maximum number of connections for a single URI """ self._callbacks = dict() - self._conn, self._cursor = None, None self._connections = dict() self._commands = dict() self._cursor_factory = cursor_factory

Add ability to pass in pool size into the constructor

.py

py

bsd-3-clause

gmr/queries

1521

<NME> README.rst <BEF> Queries: PostgreSQL Simplified ============================== *Queries* is a BSD licensed opinionated wrapper of the psycopg2_ library for interacting with PostgreSQL. The popular psycopg2_ package is a full-featured python client. Unfortunately as a developer, you're often repeating the same steps to get started with your applications that use it. Queries aims to reduce the complexity of psycopg2 while adding additional features to make writing PostgreSQL client applications both fast and easy. Check out the `Usage`_ section below to see how easy it can be. Key features include: - Simplified API - Support of Python 2.7+ and 3.4+ - PyPy support via psycopg2cffi_ - Asynchronous support for Tornado_ - Connection information provided by URI - Query results delivered as a generator based iterators - Automatically registered data-type support for UUIDs, Unicode and Unicode Arrays - Ability to directly access psycopg2 ``connection`` and ``cursor`` objects - Internal connection pooling |Version| |Status| |Coverage| |License| Documentation ------------- Documentation is available at https://queries.readthedocs.org Installation ------------ Queries is available via pypi_ and can be installed with easy_install or pip: .. code:: bash pip install queries Usage ----- Queries provides both a session based API for interacting with PostgreSQL. Simply pass in the URI_ of the PostgreSQL server to connect to when creating a session: .. code:: python session = queries.Session("postgresql://postgres@localhost:5432/postgres") Queries built-in connection pooling will re-use connections when possible, lowering the overhead of connecting and reconnecting. When specifying a URI, if you omit the username and database name to connect with, Queries will use the current OS username for both. You can also omit the URI when connecting to connect to localhost on port 5432 as the current OS user, connecting to a database named for the current user. For example, if your username is ``fred`` and you omit the URI when issuing ``queries.query`` the URI that is constructed would be ``postgresql://fred@localhost:5432/fred``. If you'd rather use individual values for the connection, the queries.uri() method provides a quick and easy way to create a URI to pass into the various methods. .. code:: python >>> queries.uri("server-name", 5432, "dbname", "user", "pass") 'postgresql://user:pass@server-name:5432/dbname' Environment Variables ^^^^^^^^^^^^^^^^^^^^^ Currently Queries uses the following environment variables for tweaking various configuration values. The supported ones are: * ``QUERIES_MAX_POOL_SIZE`` - Modify the maximum size of the connection pool (default: 1) Using the queries.Session class ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ To execute queries or call stored procedures, you start by creating an instance of the ``queries.Session`` class. It can act as a context manager, meaning you can use it with the ``with`` keyword and it will take care of cleaning up after itself. For more information on the ``with`` keyword and context managers, see PEP343_. In addition to both the ``queries.Session.query`` and ``queries.Session.callproc`` methods that are similar to the simple API methods, the ``queries.Session`` class provides access to the psycopg2 connection and cursor objects. **Using queries.Session.query** The following example shows how a ``queries.Session`` object can be used as a context manager to query the database table: .. code:: python >>> import pprint >>> import queries >>> >>> with queries.Session() as session: ... for row in session.query('SELECT * FROM names'): ... pprint.pprint(row) ... {'id': 1, 'name': u'Jacob'} {'id': 2, 'name': u'Mason'} {'id': 3, 'name': u'Ethan'} **Using queries.Session.callproc** This example uses ``queries.Session.callproc`` to execute a stored procedure and then pretty-prints the single row results as a dictionary: .. code:: python >>> import pprint >>> import queries >>> with queries.Session() as session: ... results = session.callproc('chr', [65]) ... pprint.pprint(results.as_dict()) ... {'chr': u'A'} **Asynchronous Queries with Tornado** In addition to providing a Pythonic, synchronous client API for PostgreSQL, Queries provides a very similar asynchronous API for use with Tornado. The only major difference API difference between ``queries.TornadoSession`` and ``queries.Session`` is the ``TornadoSession.query`` and ``TornadoSession.callproc`` methods return the entire result set instead of acting as an iterator over the results. The following example uses ``TornadoSession.query`` in an asynchronous Tornado_ web application to send a JSON payload with the query result set. .. code:: python @gen.coroutine def get(self): results = yield self.session.query('SELECT * FROM names') self.finish({'data': data.items()}) results.free() application = web.Application([ @gen.coroutine def get(self): results = yield self.session.query('SELECT * FROM names') self.finish({'data': results.items()}) results.free() application = web.Application([ (r"/", MainHandler), ]) if __name__ == "__main__": application.listen(8888) ioloop.IOLoop.instance().start() Inspiration ----------- Queries is inspired by `Kenneth Reitz's <https://github.com/kennethreitz/>`_ awesome work on `requests <http://docs.python-requests.org/en/latest/>`_. History ------- Queries is a fork and enhancement of pgsql_wrapper_, which can be found in the main GitHub repository of Queries as tags prior to version 1.2.0. .. _pypi: https://pypi.python.org/pypi/queries .. _psycopg2: https://pypi.python.org/pypi/psycopg2 .. _documentation: https://queries.readthedocs.org .. _URI: http://www.postgresql.org/docs/9.3/static/libpq-connect.html#LIBPQ-CONNSTRING .. _pgsql_wrapper: https://pypi.python.org/pypi/pgsql_wrapper .. _Tornado: http://tornadoweb.org .. _PEP343: http://legacy.python.org/dev/peps/pep-0343/ .. _psycopg2cffi: https://pypi.python.org/pypi/psycopg2cffi .. |Version| image:: https://img.shields.io/pypi/v/queries.svg? :target: https://pypi.python.org/pypi/queries .. |Status| image:: https://img.shields.io/travis/gmr/queries.svg? :target: https://travis-ci.org/gmr/queries .. |Coverage| image:: https://img.shields.io/codecov/c/github/gmr/queries.svg? :target: https://codecov.io/github/gmr/queries?branch=master .. |License| image:: https://img.shields.io/github/license/gmr/queries.svg? :target: https://github.com/gmr/queries <MSG> Typos in README.rst <DFF> @@ -37,7 +37,7 @@ Queries is available via pypi_ and can be installed with easy_install or pip: Usage ----- -Queries provides both a session based API for interacting with PostgreSQL. +Queries provides a session based API for interacting with PostgreSQL. Simply pass in the URI_ of the PostgreSQL server to connect to when creating a session: @@ -132,7 +132,7 @@ Tornado_ web application to send a JSON payload with the query result set. @gen.coroutine def get(self): results = yield self.session.query('SELECT * FROM names') - self.finish({'data': data.items()}) + self.finish({'data': results.items()}) results.free() application = web.Application([

Typos in README.rst

.rst

rst

bsd-3-clause

gmr/queries

1522

<NME> README.rst <BEF> Queries: PostgreSQL Simplified ============================== *Queries* is a BSD licensed opinionated wrapper of the psycopg2_ library for interacting with PostgreSQL. The popular psycopg2_ package is a full-featured python client. Unfortunately as a developer, you're often repeating the same steps to get started with your applications that use it. Queries aims to reduce the complexity of psycopg2 while adding additional features to make writing PostgreSQL client applications both fast and easy. Check out the `Usage`_ section below to see how easy it can be. Key features include: - Simplified API - Support of Python 2.7+ and 3.4+ - PyPy support via psycopg2cffi_ - Asynchronous support for Tornado_ - Connection information provided by URI - Query results delivered as a generator based iterators - Automatically registered data-type support for UUIDs, Unicode and Unicode Arrays - Ability to directly access psycopg2 ``connection`` and ``cursor`` objects - Internal connection pooling |Version| |Status| |Coverage| |License| Documentation ------------- Documentation is available at https://queries.readthedocs.org Installation ------------ Queries is available via pypi_ and can be installed with easy_install or pip: .. code:: bash pip install queries Usage ----- Queries provides both a session based API for interacting with PostgreSQL. Simply pass in the URI_ of the PostgreSQL server to connect to when creating a session: .. code:: python session = queries.Session("postgresql://postgres@localhost:5432/postgres") Queries built-in connection pooling will re-use connections when possible, lowering the overhead of connecting and reconnecting. When specifying a URI, if you omit the username and database name to connect with, Queries will use the current OS username for both. You can also omit the URI when connecting to connect to localhost on port 5432 as the current OS user, connecting to a database named for the current user. For example, if your username is ``fred`` and you omit the URI when issuing ``queries.query`` the URI that is constructed would be ``postgresql://fred@localhost:5432/fred``. If you'd rather use individual values for the connection, the queries.uri() method provides a quick and easy way to create a URI to pass into the various methods. .. code:: python >>> queries.uri("server-name", 5432, "dbname", "user", "pass") 'postgresql://user:pass@server-name:5432/dbname' Environment Variables ^^^^^^^^^^^^^^^^^^^^^ Currently Queries uses the following environment variables for tweaking various configuration values. The supported ones are: * ``QUERIES_MAX_POOL_SIZE`` - Modify the maximum size of the connection pool (default: 1) Using the queries.Session class ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ To execute queries or call stored procedures, you start by creating an instance of the ``queries.Session`` class. It can act as a context manager, meaning you can use it with the ``with`` keyword and it will take care of cleaning up after itself. For more information on the ``with`` keyword and context managers, see PEP343_. In addition to both the ``queries.Session.query`` and ``queries.Session.callproc`` methods that are similar to the simple API methods, the ``queries.Session`` class provides access to the psycopg2 connection and cursor objects. **Using queries.Session.query** The following example shows how a ``queries.Session`` object can be used as a context manager to query the database table: .. code:: python >>> import pprint >>> import queries >>> >>> with queries.Session() as session: ... for row in session.query('SELECT * FROM names'): ... pprint.pprint(row) ... {'id': 1, 'name': u'Jacob'} {'id': 2, 'name': u'Mason'} {'id': 3, 'name': u'Ethan'} **Using queries.Session.callproc** This example uses ``queries.Session.callproc`` to execute a stored procedure and then pretty-prints the single row results as a dictionary: .. code:: python >>> import pprint >>> import queries >>> with queries.Session() as session: ... results = session.callproc('chr', [65]) ... pprint.pprint(results.as_dict()) ... {'chr': u'A'} **Asynchronous Queries with Tornado** In addition to providing a Pythonic, synchronous client API for PostgreSQL, Queries provides a very similar asynchronous API for use with Tornado. The only major difference API difference between ``queries.TornadoSession`` and ``queries.Session`` is the ``TornadoSession.query`` and ``TornadoSession.callproc`` methods return the entire result set instead of acting as an iterator over the results. The following example uses ``TornadoSession.query`` in an asynchronous Tornado_ web application to send a JSON payload with the query result set. .. code:: python @gen.coroutine def get(self): results = yield self.session.query('SELECT * FROM names') self.finish({'data': data.items()}) results.free() application = web.Application([ @gen.coroutine def get(self): results = yield self.session.query('SELECT * FROM names') self.finish({'data': results.items()}) results.free() application = web.Application([ (r"/", MainHandler), ]) if __name__ == "__main__": application.listen(8888) ioloop.IOLoop.instance().start() Inspiration ----------- Queries is inspired by `Kenneth Reitz's <https://github.com/kennethreitz/>`_ awesome work on `requests <http://docs.python-requests.org/en/latest/>`_. History ------- Queries is a fork and enhancement of pgsql_wrapper_, which can be found in the main GitHub repository of Queries as tags prior to version 1.2.0. .. _pypi: https://pypi.python.org/pypi/queries .. _psycopg2: https://pypi.python.org/pypi/psycopg2 .. _documentation: https://queries.readthedocs.org .. _URI: http://www.postgresql.org/docs/9.3/static/libpq-connect.html#LIBPQ-CONNSTRING .. _pgsql_wrapper: https://pypi.python.org/pypi/pgsql_wrapper .. _Tornado: http://tornadoweb.org .. _PEP343: http://legacy.python.org/dev/peps/pep-0343/ .. _psycopg2cffi: https://pypi.python.org/pypi/psycopg2cffi .. |Version| image:: https://img.shields.io/pypi/v/queries.svg? :target: https://pypi.python.org/pypi/queries .. |Status| image:: https://img.shields.io/travis/gmr/queries.svg? :target: https://travis-ci.org/gmr/queries .. |Coverage| image:: https://img.shields.io/codecov/c/github/gmr/queries.svg? :target: https://codecov.io/github/gmr/queries?branch=master .. |License| image:: https://img.shields.io/github/license/gmr/queries.svg? :target: https://github.com/gmr/queries <MSG> Typos in README.rst <DFF> @@ -37,7 +37,7 @@ Queries is available via pypi_ and can be installed with easy_install or pip: Usage ----- -Queries provides both a session based API for interacting with PostgreSQL. +Queries provides a session based API for interacting with PostgreSQL. Simply pass in the URI_ of the PostgreSQL server to connect to when creating a session: @@ -132,7 +132,7 @@ Tornado_ web application to send a JSON payload with the query result set. @gen.coroutine def get(self): results = yield self.session.query('SELECT * FROM names') - self.finish({'data': data.items()}) + self.finish({'data': results.items()}) results.free() application = web.Application([

Typos in README.rst

.rst

rst

bsd-3-clause

gmr/queries

1523

<NME> pool_exception_tests.py <BEF> """ Tests for Exceptions in queries.pool """ import unittest import uuid from queries import pool class ActivePoolErrorTestCase(unittest.TestCase): from queries import pool class ActiveConnectionErrorTestCase(unittest.TestCase): def setUp(self): self.pid = uuid.uuid4() self.connection = mock.Mock() self.connection.id = uuid.uuid4() self.exception = pool.ActiveConnectionError(self.pid, self.connection) def test_pid_is_assigned(self): self.assertEqual(self.exception.pid, self.pid) def test_cid_is_assigned(self): self.assertEqual(self.exception.cid, self.connection.id) def test_str_value(self): expectation = 'Connection %s in pool %s is active' % \ (self.connection.id, self.pid) self.assertEqual(str(self.exception), expectation) class ActivePoolErrorTestCase(unittest.TestCase): def setUp(self): self.assertEqual(self.exception.pid, self.pid) def test_str_value(self): expectation = 'Pool %s has at least one active connection' % self.pid self.assertEqual(str(self.exception), expectation) class ConnectionBusyErrorTestCase(unittest.TestCase): def setUp(self): self.cid = uuid.uuid4() self.exception = pool.ConnectionBusyError(self.cid) def test_cid_is_assigned(self): self.assertEqual(self.exception.cid, self.cid) def test_str_value(self): expectation = 'Connection %s is busy' % self.cid self.assertEqual(str(self.exception), expectation) class ConnectionNotFoundErrorTestCase(unittest.TestCase): def setUp(self): self.pid = uuid.uuid4() self.cid = uuid.uuid4() self.exception = pool.ConnectionNotFoundError(self.pid, self.cid) def test_cid_is_assigned(self): self.assertEqual(self.exception.cid, self.cid) def test_pid_is_assigned(self): self.assertEqual(self.exception.pid, self.pid) def test_str_value(self): expectation = 'Connection %s not found in pool %s' % (self.cid, self.pid) self.assertEqual(str(self.exception), expectation) class NoIdleConnectionsErrorTestCase(unittest.TestCase): def setUp(self): self.pid = uuid.uuid4() self.exception = pool.NoIdleConnectionsError(self.pid) def test_pid_is_assigned(self): self.assertEqual(self.exception.pid, self.pid) def test_str_value(self): expectation = 'Pool %s has no idle connections' % self.pid self.assertEqual(str(self.exception), expectation) class PoolFullErrorTestCase(unittest.TestCase): def setUp(self): self.pid = uuid.uuid4() self.exception = pool.PoolFullError(self.pid) def test_pid_is_assigned(self): self.assertEqual(self.exception.pid, self.pid) def test_str_value(self): expectation = 'Pool %s is at its maximum capacity' % self.pid self.assertEqual(str(self.exception), expectation) <MSG> Remove unused exception Remove duplicate code in exceptions <DFF> @@ -12,26 +12,6 @@ import uuid from queries import pool -class ActiveConnectionErrorTestCase(unittest.TestCase): - - def setUp(self): - self.pid = uuid.uuid4() - self.connection = mock.Mock() - self.connection.id = uuid.uuid4() - self.exception = pool.ActiveConnectionError(self.pid, self.connection) - - def test_pid_is_assigned(self): - self.assertEqual(self.exception.pid, self.pid) - - def test_cid_is_assigned(self): - self.assertEqual(self.exception.cid, self.connection.id) - - def test_str_value(self): - expectation = 'Connection %s in pool %s is active' % \ - (self.connection.id, self.pid) - self.assertEqual(str(self.exception), expectation) - - class ActivePoolErrorTestCase(unittest.TestCase): def setUp(self):

Remove unused exception

.py

py

bsd-3-clause

gmr/queries

1524

<NME> pool_exception_tests.py <BEF> """ Tests for Exceptions in queries.pool """ import unittest import uuid from queries import pool class ActivePoolErrorTestCase(unittest.TestCase): from queries import pool class ActiveConnectionErrorTestCase(unittest.TestCase): def setUp(self): self.pid = uuid.uuid4() self.connection = mock.Mock() self.connection.id = uuid.uuid4() self.exception = pool.ActiveConnectionError(self.pid, self.connection) def test_pid_is_assigned(self): self.assertEqual(self.exception.pid, self.pid) def test_cid_is_assigned(self): self.assertEqual(self.exception.cid, self.connection.id) def test_str_value(self): expectation = 'Connection %s in pool %s is active' % \ (self.connection.id, self.pid) self.assertEqual(str(self.exception), expectation) class ActivePoolErrorTestCase(unittest.TestCase): def setUp(self): self.assertEqual(self.exception.pid, self.pid) def test_str_value(self): expectation = 'Pool %s has at least one active connection' % self.pid self.assertEqual(str(self.exception), expectation) class ConnectionBusyErrorTestCase(unittest.TestCase): def setUp(self): self.cid = uuid.uuid4() self.exception = pool.ConnectionBusyError(self.cid) def test_cid_is_assigned(self): self.assertEqual(self.exception.cid, self.cid) def test_str_value(self): expectation = 'Connection %s is busy' % self.cid self.assertEqual(str(self.exception), expectation) class ConnectionNotFoundErrorTestCase(unittest.TestCase): def setUp(self): self.pid = uuid.uuid4() self.cid = uuid.uuid4() self.exception = pool.ConnectionNotFoundError(self.pid, self.cid) def test_cid_is_assigned(self): self.assertEqual(self.exception.cid, self.cid) def test_pid_is_assigned(self): self.assertEqual(self.exception.pid, self.pid) def test_str_value(self): expectation = 'Connection %s not found in pool %s' % (self.cid, self.pid) self.assertEqual(str(self.exception), expectation) class NoIdleConnectionsErrorTestCase(unittest.TestCase): def setUp(self): self.pid = uuid.uuid4() self.exception = pool.NoIdleConnectionsError(self.pid) def test_pid_is_assigned(self): self.assertEqual(self.exception.pid, self.pid) def test_str_value(self): expectation = 'Pool %s has no idle connections' % self.pid self.assertEqual(str(self.exception), expectation) class PoolFullErrorTestCase(unittest.TestCase): def setUp(self): self.pid = uuid.uuid4() self.exception = pool.PoolFullError(self.pid) def test_pid_is_assigned(self): self.assertEqual(self.exception.pid, self.pid) def test_str_value(self): expectation = 'Pool %s is at its maximum capacity' % self.pid self.assertEqual(str(self.exception), expectation) <MSG> Remove unused exception Remove duplicate code in exceptions <DFF> @@ -12,26 +12,6 @@ import uuid from queries import pool -class ActiveConnectionErrorTestCase(unittest.TestCase): - - def setUp(self): - self.pid = uuid.uuid4() - self.connection = mock.Mock() - self.connection.id = uuid.uuid4() - self.exception = pool.ActiveConnectionError(self.pid, self.connection) - - def test_pid_is_assigned(self): - self.assertEqual(self.exception.pid, self.pid) - - def test_cid_is_assigned(self): - self.assertEqual(self.exception.cid, self.connection.id) - - def test_str_value(self): - expectation = 'Connection %s in pool %s is active' % \ - (self.connection.id, self.pid) - self.assertEqual(str(self.exception), expectation) - - class ActivePoolErrorTestCase(unittest.TestCase): def setUp(self):

Remove unused exception

.py

py

bsd-3-clause

gmr/queries

1525

<NME> utils.py <BEF> """ Utility functions for access to OS level info and URI parsing """ import collections import getpass import logging import os import platform # All systems do not support pwd module try: import pwd 'scheme,netloc,path,params,query,fragment,' 'username,password,hostname,port') DEFAULT_HOSTNAME = 'localhost' DEFAULT_PORT = 5432 KEYWORDS = ['connect_timeout', 'client_encoding', 'options', except ImportError: import urlparse as _urlparse try: from urllib.parse import unquote except ImportError: from urllib import unquote LOGGER = logging.getLogger(__name__) PARSED = collections.namedtuple('Parsed', 'scheme,netloc,path,params,query,fragment,' 'username,password,hostname,port') PYPY = platform.python_implementation().lower() == 'pypy' KEYWORDS = ['connect_timeout', 'client_encoding', 'options', 'application_name', 'fallback_application_name', 'keepalives', 'keepalives_idle', 'keepalives_interval', 'keepalives_count', 'sslmode', 'requiressl', 'sslcompression', 'sslcert', 'sslkey', 'sslrootcert', 'sslcrl', 'requirepeer', 'krbsrvname', 'gsslib', 'service'] def get_current_user(): """Return the current username for the logged in user :rtype: str """ if pwd is None: return getpass.getuser() """ parsed = urlparse(uri) default_user = get_current_user() kwargs = {'host': parsed.hostname or DEFAULT_HOSTNAME, 'port': parsed.port or DEFAULT_PORT, 'dbname': parsed.path[1:] or default_user, 'user': parsed.username or default_user, 'password': parsed.password} """Return the parsed query string in a python2/3 agnostic fashion :param str query_string: The URI query string :rtype: dict """ return _urlparse.parse_qs(query_string) def uri(host='localhost', port=5432, dbname='postgres', user='postgres', password=None): """Return a PostgreSQL connection URI for the specified values. :param str host: Host to connect to :param int port: Port to connect on :param str dbname: The database name :param str user: User to connect as :param str password: The password to use, None for no password :return str: The PostgreSQL connection URI """ if port: host = '%s:%s' % (host, port) if password: return 'postgresql://%s:%s@%s/%s' % (user, password, host, dbname) return 'postgresql://%s@%s/%s' % (user, host, dbname) def uri_to_kwargs(uri): """Return a URI as kwargs for connecting to PostgreSQL with psycopg2, applying default values for non-specified areas of the URI. :param str uri: The connection URI :rtype: dict """ parsed = urlparse(uri) default_user = get_current_user() password = unquote(parsed.password) if parsed.password else None kwargs = {'host': parsed.hostname, 'port': parsed.port, 'dbname': parsed.path[1:] or default_user, 'user': parsed.username or default_user, 'password': password} values = parse_qs(parsed.query) if 'host' in values: kwargs['host'] = values['host'][0] for k in [k for k in values if k in KEYWORDS]: kwargs[k] = values[k][0] if len(values[k]) == 1 else values[k] try: if kwargs[k].isdigit(): kwargs[k] = int(kwargs[k]) except AttributeError: pass return kwargs def urlparse(url): """Parse the URL in a Python2/3 independent fashion. :param str url: The URL to parse :rtype: Parsed """ value = 'http%s' % url[5:] if url[:5] == 'postgresql' else url parsed = _urlparse.urlparse(value) path, query = parsed.path, parsed.query hostname = parsed.hostname if parsed.hostname else '' return PARSED(parsed.scheme.replace('http', 'postgresql'), parsed.netloc, path, parsed.params, query, parsed.fragment, parsed.username, parsed.password, hostname.replace('%2F', '/').replace('%2f', '/'), parsed.port) <MSG> Remove the default hostname and port in URI parsing From the docs: "The host component is interpreted as described for the parameter host. In particular, a Unix-domain socket connection is chosen if the host part is either empty or starts with a slash, otherwise a TCP/IP connection is initiated. Note, however, that the slash is a reserved character in the hierarchical part of the URI." #1 <DFF> @@ -14,9 +14,6 @@ PARSED = collections.namedtuple('Parsed', 'scheme,netloc,path,params,query,fragment,' 'username,password,hostname,port') -DEFAULT_HOSTNAME = 'localhost' -DEFAULT_PORT = 5432 - KEYWORDS = ['connect_timeout', 'client_encoding', 'options', @@ -68,8 +65,8 @@ def uri_to_kwargs(uri): """ parsed = urlparse(uri) default_user = get_current_user() - kwargs = {'host': parsed.hostname or DEFAULT_HOSTNAME, - 'port': parsed.port or DEFAULT_PORT, + kwargs = {'host': parsed.hostname, + 'port': parsed.port, 'dbname': parsed.path[1:] or default_user, 'user': parsed.username or default_user, 'password': parsed.password}

Remove the default hostname and port in URI parsing

.py

py

bsd-3-clause

gmr/queries

1526

<NME> utils.py <BEF> """ Utility functions for access to OS level info and URI parsing """ import collections import getpass import logging import os import platform # All systems do not support pwd module try: import pwd 'scheme,netloc,path,params,query,fragment,' 'username,password,hostname,port') DEFAULT_HOSTNAME = 'localhost' DEFAULT_PORT = 5432 KEYWORDS = ['connect_timeout', 'client_encoding', 'options', except ImportError: import urlparse as _urlparse try: from urllib.parse import unquote except ImportError: from urllib import unquote LOGGER = logging.getLogger(__name__) PARSED = collections.namedtuple('Parsed', 'scheme,netloc,path,params,query,fragment,' 'username,password,hostname,port') PYPY = platform.python_implementation().lower() == 'pypy' KEYWORDS = ['connect_timeout', 'client_encoding', 'options', 'application_name', 'fallback_application_name', 'keepalives', 'keepalives_idle', 'keepalives_interval', 'keepalives_count', 'sslmode', 'requiressl', 'sslcompression', 'sslcert', 'sslkey', 'sslrootcert', 'sslcrl', 'requirepeer', 'krbsrvname', 'gsslib', 'service'] def get_current_user(): """Return the current username for the logged in user :rtype: str """ if pwd is None: return getpass.getuser() """ parsed = urlparse(uri) default_user = get_current_user() kwargs = {'host': parsed.hostname or DEFAULT_HOSTNAME, 'port': parsed.port or DEFAULT_PORT, 'dbname': parsed.path[1:] or default_user, 'user': parsed.username or default_user, 'password': parsed.password} """Return the parsed query string in a python2/3 agnostic fashion :param str query_string: The URI query string :rtype: dict """ return _urlparse.parse_qs(query_string) def uri(host='localhost', port=5432, dbname='postgres', user='postgres', password=None): """Return a PostgreSQL connection URI for the specified values. :param str host: Host to connect to :param int port: Port to connect on :param str dbname: The database name :param str user: User to connect as :param str password: The password to use, None for no password :return str: The PostgreSQL connection URI """ if port: host = '%s:%s' % (host, port) if password: return 'postgresql://%s:%s@%s/%s' % (user, password, host, dbname) return 'postgresql://%s@%s/%s' % (user, host, dbname) def uri_to_kwargs(uri): """Return a URI as kwargs for connecting to PostgreSQL with psycopg2, applying default values for non-specified areas of the URI. :param str uri: The connection URI :rtype: dict """ parsed = urlparse(uri) default_user = get_current_user() password = unquote(parsed.password) if parsed.password else None kwargs = {'host': parsed.hostname, 'port': parsed.port, 'dbname': parsed.path[1:] or default_user, 'user': parsed.username or default_user, 'password': password} values = parse_qs(parsed.query) if 'host' in values: kwargs['host'] = values['host'][0] for k in [k for k in values if k in KEYWORDS]: kwargs[k] = values[k][0] if len(values[k]) == 1 else values[k] try: if kwargs[k].isdigit(): kwargs[k] = int(kwargs[k]) except AttributeError: pass return kwargs def urlparse(url): """Parse the URL in a Python2/3 independent fashion. :param str url: The URL to parse :rtype: Parsed """ value = 'http%s' % url[5:] if url[:5] == 'postgresql' else url parsed = _urlparse.urlparse(value) path, query = parsed.path, parsed.query hostname = parsed.hostname if parsed.hostname else '' return PARSED(parsed.scheme.replace('http', 'postgresql'), parsed.netloc, path, parsed.params, query, parsed.fragment, parsed.username, parsed.password, hostname.replace('%2F', '/').replace('%2f', '/'), parsed.port) <MSG> Remove the default hostname and port in URI parsing From the docs: "The host component is interpreted as described for the parameter host. In particular, a Unix-domain socket connection is chosen if the host part is either empty or starts with a slash, otherwise a TCP/IP connection is initiated. Note, however, that the slash is a reserved character in the hierarchical part of the URI." #1 <DFF> @@ -14,9 +14,6 @@ PARSED = collections.namedtuple('Parsed', 'scheme,netloc,path,params,query,fragment,' 'username,password,hostname,port') -DEFAULT_HOSTNAME = 'localhost' -DEFAULT_PORT = 5432 - KEYWORDS = ['connect_timeout', 'client_encoding', 'options', @@ -68,8 +65,8 @@ def uri_to_kwargs(uri): """ parsed = urlparse(uri) default_user = get_current_user() - kwargs = {'host': parsed.hostname or DEFAULT_HOSTNAME, - 'port': parsed.port or DEFAULT_PORT, + kwargs = {'host': parsed.hostname, + 'port': parsed.port, 'dbname': parsed.path[1:] or default_user, 'user': parsed.username or default_user, 'password': parsed.password}

Remove the default hostname and port in URI parsing

.py

py

bsd-3-clause

gmr/queries

1527

<NME> tornado_session_tests.py <BEF> """ Tests for functionality in the tornado_session module """ import unittest import mock # Out of order import to ensure psycopg2cffi is registered from queries import pool, tornado_session from psycopg2 import extras from tornado import concurrent, gen, ioloop, testing class ResultsTests(unittest.TestCase): def setUp(self): self.cursor = mock.Mock() self.fd = 10 self.cleanup = mock.Mock() self.obj = tornado_session.Results(self.cursor, self.cleanup, self.fd) def test_cursor_is_assigned(self): self.assertEqual(self.obj.cursor, self.cursor) def test_fd_is_assigned(self): self.assertEqual(self.obj._fd, self.fd) def test_cleanup_is_assigned(self): self.assertEqual(self.obj._cleanup, self.cleanup) @gen.coroutine def test_free_invokes_cleanup(self): yield self.obj.free() self.cleanup.assert_called_once_with(self.cursor, self.fd) class SessionInitTests(unittest.TestCase): def setUp(self): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): self.assertDictEqual(self.obj._futures, {}) def test_creates_empty_connections_dict(self): self.assertDictEqual(self.obj._connections, {}) def test_sets_default_cursor_factory(self): self.assertEqual(self.obj._cursor_factory, extras.RealDictCursor) def test_sets_tornado_ioloop_instance(self): self.assertEqual(self.obj._ioloop, ioloop.IOLoop.instance()) def test_sets_poolmananger_instance(self): self.assertEqual(self.obj._pool_manager, pool.PoolManager.instance()) def test_sets_uri(self): self.assertEqual(self.obj._uri, tornado_session.session.DEFAULT_URI) def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) def test_connection_is_none(self): self.assertIsNone(self.obj.connection) def test_cursor_is_none(self): self.assertIsNone(self.obj.cursor) class SessionConnectTests(testing.AsyncTestCase): def setUp(self): super(SessionConnectTests, self).setUp() self.conn = mock.Mock() self.conn.fileno = mock.Mock(return_value=10) self.obj = tornado_session.TornadoSession(io_loop=self.io_loop) def create_connection(future): future.set_result(self.conn) self.obj._create_connection = create_connection @testing.gen_test def test_connect_returns_new_connection(self): conn = yield self.obj._connect() self.assertEqual(conn, self.conn) @testing.gen_test def test_connect_returns_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) second_result = yield self.obj._connect() self.assertEqual(second_result, conn) @testing.gen_test def test_connect_gets_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: with mock.patch.object(self.io_loop, 'add_handler'): yield self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) @testing.gen_test def test_connect_pooled_connection_invokes_add_handler(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: get.return_value = self.conn with mock.patch.object(self.io_loop, 'add_handler') as add_handler: yield self.obj._connect() add_handler.assert_called_once_with(self.conn.fileno(), self.obj._on_io_events, ioloop.IOLoop.WRITE) def test_psycopg2_connect_invokes_psycopg2_connect(self): with mock.patch('psycopg2.connect') as connect: self.obj._psycopg2_connect({}) connect.assert_called_once_with(**{'async': True}) def test_on_io_events_returns_if_fd_not_present(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_not_called() def test_on_io_events_calls_poll_connection(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._connections[1337] = True self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_called_once_with(1337) def test_exec_cleanup_closes_cursor(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() cursor = mock.Mock() cursor.close = mock.Mock() self.obj._exec_cleanup(cursor, 14) cursor.close.assert_called_once_with() def test_exec_cleanup_frees_connection(self): with mock.patch.object(self.obj._pool_manager, 'free') as pm_free: with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._exec_cleanup(mock.Mock(), 14) pm_free.assert_called_once_with(self.obj.pid, conn) def test_exec_cleanup_frees_connection(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler') as rh: self.obj._connections[14] = mock.Mock() self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) rh.assert_called_once_with(14) def test_exec_removes_connection(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._connections) def test_exec_removes_future(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._futures[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._futures) def test_pool_manager_add_failures_are_propagated(self): futures = [] def add_future(future, callback): futures.append((future, callback)) obj = tornado_session.TornadoSession() obj._ioloop = mock.Mock() obj._ioloop.add_future = add_future future = concurrent.Future() with mock.patch.object(obj._pool_manager, 'add') as add_method: add_method.side_effect = pool.PoolFullError(mock.Mock()) obj._create_connection(future) self.assertEqual(len(futures), 1) connected_future, callback = futures.pop() connected_future.set_result(True) callback(connected_future) self.assertIs(future.exception(), add_method.side_effect) class SessionPublicMethodTests(testing.AsyncTestCase): @testing.gen_test def test_callproc_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.callproc('foo', ['bar']) _execute.assert_called_once_with('callproc', 'foo', ['bar']) @testing.gen_test def test_query_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) """ @testing.gen_test def test_query_error_key_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): yield obj.query('SELECT * FROM foo WHERE bar=%(baz)s', {}) @testing.gen_test def test_query_error_index_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): r = yield obj.query('SELECT * FROM foo WHERE bar=%s', []) """ <MSG> Fix test with dupe name <DFF> @@ -146,7 +146,7 @@ class SessionConnectTests(testing.AsyncTestCase): self.obj._exec_cleanup(mock.Mock(), 14) pm_free.assert_called_once_with(self.obj.pid, conn) - def test_exec_cleanup_frees_connection(self): + def test_exec_cleanup_remove_handler_invoked(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler') as rh: self.obj._connections[14] = mock.Mock()

Fix test with dupe name

.py

py

bsd-3-clause

gmr/queries

1528

<NME> tornado_session_tests.py <BEF> """ Tests for functionality in the tornado_session module """ import unittest import mock # Out of order import to ensure psycopg2cffi is registered from queries import pool, tornado_session from psycopg2 import extras from tornado import concurrent, gen, ioloop, testing class ResultsTests(unittest.TestCase): def setUp(self): self.cursor = mock.Mock() self.fd = 10 self.cleanup = mock.Mock() self.obj = tornado_session.Results(self.cursor, self.cleanup, self.fd) def test_cursor_is_assigned(self): self.assertEqual(self.obj.cursor, self.cursor) def test_fd_is_assigned(self): self.assertEqual(self.obj._fd, self.fd) def test_cleanup_is_assigned(self): self.assertEqual(self.obj._cleanup, self.cleanup) @gen.coroutine def test_free_invokes_cleanup(self): yield self.obj.free() self.cleanup.assert_called_once_with(self.cursor, self.fd) class SessionInitTests(unittest.TestCase): def setUp(self): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): self.assertDictEqual(self.obj._futures, {}) def test_creates_empty_connections_dict(self): self.assertDictEqual(self.obj._connections, {}) def test_sets_default_cursor_factory(self): self.assertEqual(self.obj._cursor_factory, extras.RealDictCursor) def test_sets_tornado_ioloop_instance(self): self.assertEqual(self.obj._ioloop, ioloop.IOLoop.instance()) def test_sets_poolmananger_instance(self): self.assertEqual(self.obj._pool_manager, pool.PoolManager.instance()) def test_sets_uri(self): self.assertEqual(self.obj._uri, tornado_session.session.DEFAULT_URI) def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) def test_connection_is_none(self): self.assertIsNone(self.obj.connection) def test_cursor_is_none(self): self.assertIsNone(self.obj.cursor) class SessionConnectTests(testing.AsyncTestCase): def setUp(self): super(SessionConnectTests, self).setUp() self.conn = mock.Mock() self.conn.fileno = mock.Mock(return_value=10) self.obj = tornado_session.TornadoSession(io_loop=self.io_loop) def create_connection(future): future.set_result(self.conn) self.obj._create_connection = create_connection @testing.gen_test def test_connect_returns_new_connection(self): conn = yield self.obj._connect() self.assertEqual(conn, self.conn) @testing.gen_test def test_connect_returns_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) second_result = yield self.obj._connect() self.assertEqual(second_result, conn) @testing.gen_test def test_connect_gets_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: with mock.patch.object(self.io_loop, 'add_handler'): yield self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) @testing.gen_test def test_connect_pooled_connection_invokes_add_handler(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: get.return_value = self.conn with mock.patch.object(self.io_loop, 'add_handler') as add_handler: yield self.obj._connect() add_handler.assert_called_once_with(self.conn.fileno(), self.obj._on_io_events, ioloop.IOLoop.WRITE) def test_psycopg2_connect_invokes_psycopg2_connect(self): with mock.patch('psycopg2.connect') as connect: self.obj._psycopg2_connect({}) connect.assert_called_once_with(**{'async': True}) def test_on_io_events_returns_if_fd_not_present(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_not_called() def test_on_io_events_calls_poll_connection(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._connections[1337] = True self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_called_once_with(1337) def test_exec_cleanup_closes_cursor(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() cursor = mock.Mock() cursor.close = mock.Mock() self.obj._exec_cleanup(cursor, 14) cursor.close.assert_called_once_with() def test_exec_cleanup_frees_connection(self): with mock.patch.object(self.obj._pool_manager, 'free') as pm_free: with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._exec_cleanup(mock.Mock(), 14) pm_free.assert_called_once_with(self.obj.pid, conn) def test_exec_cleanup_frees_connection(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler') as rh: self.obj._connections[14] = mock.Mock() self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) rh.assert_called_once_with(14) def test_exec_removes_connection(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._connections) def test_exec_removes_future(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._futures[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._futures) def test_pool_manager_add_failures_are_propagated(self): futures = [] def add_future(future, callback): futures.append((future, callback)) obj = tornado_session.TornadoSession() obj._ioloop = mock.Mock() obj._ioloop.add_future = add_future future = concurrent.Future() with mock.patch.object(obj._pool_manager, 'add') as add_method: add_method.side_effect = pool.PoolFullError(mock.Mock()) obj._create_connection(future) self.assertEqual(len(futures), 1) connected_future, callback = futures.pop() connected_future.set_result(True) callback(connected_future) self.assertIs(future.exception(), add_method.side_effect) class SessionPublicMethodTests(testing.AsyncTestCase): @testing.gen_test def test_callproc_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.callproc('foo', ['bar']) _execute.assert_called_once_with('callproc', 'foo', ['bar']) @testing.gen_test def test_query_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) """ @testing.gen_test def test_query_error_key_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): yield obj.query('SELECT * FROM foo WHERE bar=%(baz)s', {}) @testing.gen_test def test_query_error_index_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): r = yield obj.query('SELECT * FROM foo WHERE bar=%s', []) """ <MSG> Fix test with dupe name <DFF> @@ -146,7 +146,7 @@ class SessionConnectTests(testing.AsyncTestCase): self.obj._exec_cleanup(mock.Mock(), 14) pm_free.assert_called_once_with(self.obj.pid, conn) - def test_exec_cleanup_frees_connection(self): + def test_exec_cleanup_remove_handler_invoked(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler') as rh: self.obj._connections[14] = mock.Mock()

Fix test with dupe name

.py

py

bsd-3-clause

gmr/queries

1529

<NME> README.rst <BEF> Queries: PostgreSQL Simplified ============================== *Queries* is a BSD licensed opinionated wrapper of the psycopg2_ library for interacting with PostgreSQL. The popular psycopg2_ package is a full-featured python client. Unfortunately as a developer, you're often repeating the same steps to get started with your applications that use it. Queries aims to reduce the complexity of psycopg2 while adding additional features to make writing PostgreSQL client applications both fast and easy. Check out the `Usage`_ section below to see how easy it can be. Key features include: - Simplified API - Support of Python 2.7+ and 3.4+ - PyPy support via psycopg2cffi_ - Asynchronous support for Tornado_ - Connection information provided by URI - Query results delivered as a generator based iterators - Automatically registered data-type support for UUIDs, Unicode and Unicode Arrays - Ability to directly access psycopg2 ``connection`` and ``cursor`` objects - Internal connection pooling |Version| |Downloads| |Status| |Coverage| Documentation ------------- Documentation is available at https://queries.readthedocs.org Installation ------------ Queries is available via pypi_ and can be installed with easy_install or pip: .. code:: bash pip install queries Usage ----- Queries provides a session based API for interacting with PostgreSQL. Simply pass in the URI_ of the PostgreSQL server to connect to when creating a session: .. code:: python session = queries.Session("postgresql://postgres@localhost:5432/postgres") Queries built-in connection pooling will re-use connections when possible, lowering the overhead of connecting and reconnecting. When specifying a URI, if you omit the username and database name to connect with, Queries will use the current OS username for both. You can also omit the URI when connecting to connect to localhost on port 5432 as the current OS user, connecting to a database named for the current user. For example, if your username is ``fred`` and you omit the URI when issuing ``queries.query`` the URI that is constructed would be ``postgresql://fred@localhost:5432/fred``. If you'd rather use individual values for the connection, the queries.uri() method provides a quick and easy way to create a URI to pass into the various methods. .. code:: python >>> queries.uri("server-name", 5432, "dbname", "user", "pass") 'postgresql://user:pass@server-name:5432/dbname' Environment Variables ^^^^^^^^^^^^^^^^^^^^^ Currently Queries uses the following environment variables for tweaking various configuration values. The supported ones are: * ``QUERIES_MAX_POOL_SIZE`` - Modify the maximum size of the connection pool (default: 1) Using the queries.Session class ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ To execute queries or call stored procedures, you start by creating an instance of the ``queries.Session`` class. It can act as a context manager, meaning you can use it with the ``with`` keyword and it will take care of cleaning up after itself. For more information on the ``with`` keyword and context managers, see PEP343_. In addition to both the ``queries.Session.query`` and ``queries.Session.callproc`` methods that are similar to the simple API methods, the ``queries.Session`` class provides access to the psycopg2 connection and cursor objects. **Using queries.Session.query** The following example shows how a ``queries.Session`` object can be used as a context manager to query the database table: .. code:: python >>> import pprint >>> import queries >>> >>> with queries.Session() as session: ... for row in session.query('SELECT * FROM names'): ... pprint.pprint(row) ... {'id': 1, 'name': u'Jacob'} {'id': 2, 'name': u'Mason'} {'id': 3, 'name': u'Ethan'} **Using queries.Session.callproc** This example uses ``queries.Session.callproc`` to execute a stored procedure and then pretty-prints the single row results as a dictionary: .. code:: python >>> import pprint >>> import queries >>> with queries.Session() as session: ... results = session.callproc('chr', [65]) ... pprint.pprint(results.as_dict()) ... {'chr': u'A'} **Asynchronous Queries with Tornado** In addition to providing a Pythonic, synchronous client API for PostgreSQL, Queries provides a very similar asynchronous API for use with Tornado. The only major difference API difference between ``queries.TornadoSession`` and ``queries.Session`` is the ``TornadoSession.query`` and ``TornadoSession.callproc`` methods return the entire result set instead of acting as an iterator over the results. The following example uses ``TornadoSession.query`` in an asynchronous Tornado_ web application to send a JSON payload with the query result set. .. code:: python from tornado import gen, ioloop, web import queries class MainHandler(web.RequestHandler): def initialize(self): self.session = queries.TornadoSession() @gen.coroutine def get(self): results = yield self.session.query('SELECT * FROM names') self.finish({'data': results.items()}) results.free() application = web.Application([ (r"/", MainHandler), ]) if __name__ == "__main__": application.listen(8888) ioloop.IOLoop.instance().start() Inspiration ----------- Queries is inspired by `Kenneth Reitz's <https://github.com/kennethreitz/>`_ awesome work on `requests <http://docs.python-requests.org/en/latest/>`_. History ------- Queries is a fork and enhancement of pgsql_wrapper_, which can be found in the main GitHub repository of Queries as tags prior to version 1.2.0. .. _pypi: https://pypi.python.org/pypi/queries .. _psycopg2: https://pypi.python.org/pypi/psycopg2 .. _documentation: https://queries.readthedocs.org .. _URI: http://www.postgresql.org/docs/9.3/static/libpq-connect.html#LIBPQ-CONNSTRING .. _pgsql_wrapper: https://pypi.python.org/pypi/pgsql_wrapper .. _Tornado: http://tornadoweb.org .. _PEP343: http://legacy.python.org/dev/peps/pep-0343/ .. _psycopg2cffi: https://pypi.python.org/pypi/psycopg2cffi .. |Coverage| image:: https://img.shields.io/coveralls/gmr/queries.svg? :target: https://coveralls.io/r/gmr/queries .. |Coverage| image:: https://img.shields.io/codecov/c/github/gmr/queries.svg? :target: https://codecov.io/github/gmr/queries?branch=master .. |License| image:: https://img.shields.io/github/license/gmr/queries.svg? :target: https://github.com/gmr/queries <MSG> Add gitter badge <DFF> @@ -21,7 +21,7 @@ Key features include: - Ability to directly access psycopg2 ``connection`` and ``cursor`` objects - Internal connection pooling -|Version| |Downloads| |Status| |Coverage| +|Version| |Downloads| |Status| |Coverage| |Gitter| Documentation ------------- @@ -172,3 +172,6 @@ main GitHub repository of Queries as tags prior to version 1.2.0. .. |Coverage| image:: https://img.shields.io/coveralls/gmr/queries.svg? :target: https://coveralls.io/r/gmr/queries + +.. |Gitter| image:: https://badges.gitter.im/Join Chat.svg + :target: https://gitter.im/gmr/rabbitpy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

Add gitter badge

.rst

rst

bsd-3-clause

gmr/queries

1530

<NME> README.rst <BEF> Queries: PostgreSQL Simplified ============================== *Queries* is a BSD licensed opinionated wrapper of the psycopg2_ library for interacting with PostgreSQL. The popular psycopg2_ package is a full-featured python client. Unfortunately as a developer, you're often repeating the same steps to get started with your applications that use it. Queries aims to reduce the complexity of psycopg2 while adding additional features to make writing PostgreSQL client applications both fast and easy. Check out the `Usage`_ section below to see how easy it can be. Key features include: - Simplified API - Support of Python 2.7+ and 3.4+ - PyPy support via psycopg2cffi_ - Asynchronous support for Tornado_ - Connection information provided by URI - Query results delivered as a generator based iterators - Automatically registered data-type support for UUIDs, Unicode and Unicode Arrays - Ability to directly access psycopg2 ``connection`` and ``cursor`` objects - Internal connection pooling |Version| |Downloads| |Status| |Coverage| Documentation ------------- Documentation is available at https://queries.readthedocs.org Installation ------------ Queries is available via pypi_ and can be installed with easy_install or pip: .. code:: bash pip install queries Usage ----- Queries provides a session based API for interacting with PostgreSQL. Simply pass in the URI_ of the PostgreSQL server to connect to when creating a session: .. code:: python session = queries.Session("postgresql://postgres@localhost:5432/postgres") Queries built-in connection pooling will re-use connections when possible, lowering the overhead of connecting and reconnecting. When specifying a URI, if you omit the username and database name to connect with, Queries will use the current OS username for both. You can also omit the URI when connecting to connect to localhost on port 5432 as the current OS user, connecting to a database named for the current user. For example, if your username is ``fred`` and you omit the URI when issuing ``queries.query`` the URI that is constructed would be ``postgresql://fred@localhost:5432/fred``. If you'd rather use individual values for the connection, the queries.uri() method provides a quick and easy way to create a URI to pass into the various methods. .. code:: python >>> queries.uri("server-name", 5432, "dbname", "user", "pass") 'postgresql://user:pass@server-name:5432/dbname' Environment Variables ^^^^^^^^^^^^^^^^^^^^^ Currently Queries uses the following environment variables for tweaking various configuration values. The supported ones are: * ``QUERIES_MAX_POOL_SIZE`` - Modify the maximum size of the connection pool (default: 1) Using the queries.Session class ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ To execute queries or call stored procedures, you start by creating an instance of the ``queries.Session`` class. It can act as a context manager, meaning you can use it with the ``with`` keyword and it will take care of cleaning up after itself. For more information on the ``with`` keyword and context managers, see PEP343_. In addition to both the ``queries.Session.query`` and ``queries.Session.callproc`` methods that are similar to the simple API methods, the ``queries.Session`` class provides access to the psycopg2 connection and cursor objects. **Using queries.Session.query** The following example shows how a ``queries.Session`` object can be used as a context manager to query the database table: .. code:: python >>> import pprint >>> import queries >>> >>> with queries.Session() as session: ... for row in session.query('SELECT * FROM names'): ... pprint.pprint(row) ... {'id': 1, 'name': u'Jacob'} {'id': 2, 'name': u'Mason'} {'id': 3, 'name': u'Ethan'} **Using queries.Session.callproc** This example uses ``queries.Session.callproc`` to execute a stored procedure and then pretty-prints the single row results as a dictionary: .. code:: python >>> import pprint >>> import queries >>> with queries.Session() as session: ... results = session.callproc('chr', [65]) ... pprint.pprint(results.as_dict()) ... {'chr': u'A'} **Asynchronous Queries with Tornado** In addition to providing a Pythonic, synchronous client API for PostgreSQL, Queries provides a very similar asynchronous API for use with Tornado. The only major difference API difference between ``queries.TornadoSession`` and ``queries.Session`` is the ``TornadoSession.query`` and ``TornadoSession.callproc`` methods return the entire result set instead of acting as an iterator over the results. The following example uses ``TornadoSession.query`` in an asynchronous Tornado_ web application to send a JSON payload with the query result set. .. code:: python from tornado import gen, ioloop, web import queries class MainHandler(web.RequestHandler): def initialize(self): self.session = queries.TornadoSession() @gen.coroutine def get(self): results = yield self.session.query('SELECT * FROM names') self.finish({'data': results.items()}) results.free() application = web.Application([ (r"/", MainHandler), ]) if __name__ == "__main__": application.listen(8888) ioloop.IOLoop.instance().start() Inspiration ----------- Queries is inspired by `Kenneth Reitz's <https://github.com/kennethreitz/>`_ awesome work on `requests <http://docs.python-requests.org/en/latest/>`_. History ------- Queries is a fork and enhancement of pgsql_wrapper_, which can be found in the main GitHub repository of Queries as tags prior to version 1.2.0. .. _pypi: https://pypi.python.org/pypi/queries .. _psycopg2: https://pypi.python.org/pypi/psycopg2 .. _documentation: https://queries.readthedocs.org .. _URI: http://www.postgresql.org/docs/9.3/static/libpq-connect.html#LIBPQ-CONNSTRING .. _pgsql_wrapper: https://pypi.python.org/pypi/pgsql_wrapper .. _Tornado: http://tornadoweb.org .. _PEP343: http://legacy.python.org/dev/peps/pep-0343/ .. _psycopg2cffi: https://pypi.python.org/pypi/psycopg2cffi .. |Coverage| image:: https://img.shields.io/coveralls/gmr/queries.svg? :target: https://coveralls.io/r/gmr/queries .. |Coverage| image:: https://img.shields.io/codecov/c/github/gmr/queries.svg? :target: https://codecov.io/github/gmr/queries?branch=master .. |License| image:: https://img.shields.io/github/license/gmr/queries.svg? :target: https://github.com/gmr/queries <MSG> Add gitter badge <DFF> @@ -21,7 +21,7 @@ Key features include: - Ability to directly access psycopg2 ``connection`` and ``cursor`` objects - Internal connection pooling -|Version| |Downloads| |Status| |Coverage| +|Version| |Downloads| |Status| |Coverage| |Gitter| Documentation ------------- @@ -172,3 +172,6 @@ main GitHub repository of Queries as tags prior to version 1.2.0. .. |Coverage| image:: https://img.shields.io/coveralls/gmr/queries.svg? :target: https://coveralls.io/r/gmr/queries + +.. |Gitter| image:: https://badges.gitter.im/Join Chat.svg + :target: https://gitter.im/gmr/rabbitpy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

Add gitter badge

.rst

rst

bsd-3-clause

gmr/queries

1531

<NME> pool.py <BEF> """ Connection Pooling """ import datetime import logging import os import threading import time LOGGER = logging.getLogger(__name__) DEFAULT_IDLE_TTL = 60 DEFAULT_MAX_SIZE = 100 class Connection(object): DEFAULT_MAX_SIZE = int(os.environ.get('QUERIES_MAX_POOL_SIZE', 1)) class Connection(object): """Contains the handle to the connection, the current state of the connection and methods for manipulating the state of the connection. """ _lock = threading.Lock() def __init__(self, handle): self.handle = handle self.used_by = None self.executions = 0 self.exceptions = 0 def close(self): """Close the connection :raises: ConnectionBusyError """ LOGGER.debug('Connection %s closing', self.id) if self.busy and not self.closed: raise ConnectionBusyError(self) with self._lock: if not self.handle.closed: try: self.handle.close() except psycopg2.InterfaceError as error: LOGGER.error('Error closing socket: %s', error) @property def closed(self): """Return if the psycopg2 connection is closed. :rtype: bool """ return self.handle.closed != 0 @property def busy(self): """Return if the connection is currently executing a query or is locked by a session that still exists. :rtype: bool """ if self.handle.isexecuting(): return True elif self.used_by is None: return False return not self.used_by() is None @property def executing(self): """Return if the connection is currently executing a query :rtype: bool """ return self.handle.isexecuting() def free(self): """Remove the lock on the connection if the connection is not active :raises: ConnectionBusyError """ LOGGER.debug('Connection %s freeing', self.id) if self.handle.isexecuting(): raise ConnectionBusyError(self) with self._lock: self.used_by = None LOGGER.debug('Connection %s freed', self.id) @property def id(self): """Return id of the psycopg2 connection object :rtype: int """ return id(self.handle) def lock(self, session): """Lock the connection, ensuring that it is not busy and storing a weakref for the session. :param queries.Session session: The session to lock the connection with :raises: ConnectionBusyError """ if self.busy: raise ConnectionBusyError(self) with self._lock: self.used_by = weakref.ref(session) LOGGER.debug('Connection %s locked', self.id) @property def locked(self): """Return if the connection is currently exclusively locked :rtype: bool """ return self.used_by is not None class Pool(object): """A connection pool for gaining access to and managing connections""" _lock = threading.Lock() idle_start = None idle_ttl = DEFAULT_IDLE_TTL max_size = DEFAULT_MAX_SIZE def __init__(self, pool_id, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): self.connections = {} self._id = pool_id self.idle_ttl = idle_ttl self.max_size = max_size self.time_method = time_method or time.time def __contains__(self, connection): """Return True if the pool contains the connection""" return id(connection) in self.connections def __len__(self): """Return the number of connections in the pool""" return len(self.connections) def add(self, connection): """Add a new connection to the pool :param connection: The connection to add to the pool :type connection: psycopg2.extensions.connection :raises: PoolFullError """ if id(connection) in self.connections: raise ValueError('Connection already exists in pool') if len(self.connections) == self.max_size: LOGGER.warning('Race condition found when adding new connection') try: connection.close() except (psycopg2.Error, psycopg2.Warning) as error: LOGGER.error('Error closing the conn that cant be used: %s', error) raise PoolFullError(self) with self._lock: self.connections[id(connection)] = Connection(connection) LOGGER.debug('Pool %s added connection %s', self.id, id(connection)) @property def busy_connections(self): """Return a list of active/busy connections :rtype: list """ return [c for c in self.connections.values() if c.busy and not c.closed] def clean(self): """Clean the pool by removing any closed connections and if the pool's idle has exceeded its idle TTL, remove all connections. """ LOGGER.debug('Cleaning the pool') for connection in [self.connections[k] for k in self.connections if self.connections[k].closed]: LOGGER.debug('Removing %s', connection.id) self.remove(connection.handle) if self.idle_duration > self.idle_ttl: self.close() LOGGER.debug('Pool %s cleaned', self.id) def close(self): """Close the pool by closing and removing all of the connections""" for cid in list(self.connections.keys()): self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) @property def closed_connections(self): """Return a list of closed connections :rtype: list """ return [c for c in self.connections.values() if c.closed] def connection_handle(self, connection): """Return a connection object for the given psycopg2 connection :param connection: The connection to return a parent for :type connection: psycopg2.extensions.connection :rtype: Connection """ return self.connections[id(connection)] @property def executing_connections(self): """Return a list of connections actively executing queries :rtype: list """ return [c for c in self.connections.values() if c.executing] def free(self, connection): """Free the connection from use by the session that was using it. :param connection: The connection to free :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ LOGGER.debug('Pool %s freeing connection %s', self.id, id(connection)) try: self.connection_handle(connection).free() except KeyError: raise ConnectionNotFoundError(self.id, id(connection)) if self.idle_connections == list(self.connections.values()): with self._lock: self.idle_start = self.time_method() LOGGER.debug('Pool %s freed connection %s', self.id, id(connection)) def get(self, session): """Return an idle connection and assign the session to the connection :param queries.Session session: The session to assign :rtype: psycopg2.extensions.connection :raises: NoIdleConnectionsError """ idle = self.idle_connections if idle: connection = idle.pop(0) connection.lock(session) if self.idle_start: with self._lock: self.idle_start = None return connection.handle raise NoIdleConnectionsError(self.id) @property def id(self): """Return the ID for this pool :rtype: str """ return self._id @property def idle_connections(self): """Return a list of idle connections :rtype: list """ return [c for c in self.connections.values() if not c.busy and not c.closed] @property def idle_duration(self): """Return the number of seconds that the pool has had no active connections. :rtype: float """ if self.idle_start is None: return 0 return self.time_method() - self.idle_start @property def is_full(self): """Return True if there are no more open slots for connections. :rtype: bool """ return len(self.connections) >= self.max_size def lock(self, connection, session): """Explicitly lock the specified connection :type connection: psycopg2.extensions.connection :param connection: The connection to lock :param queries.Session session: The session to hold the lock """ cid = id(connection) try: self.connection_handle(connection).lock(session) except KeyError: raise ConnectionNotFoundError(self.id, cid) else: if self.idle_start: with self._lock: self.idle_start = None LOGGER.debug('Pool %s locked connection %s', self.id, cid) @property def locked_connections(self): """Return a list of all locked connections :rtype: list """ return [c for c in self.connections.values() if c.locked] def remove(self, connection): """Remove the connection from the pool :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError :raises: ConnectionBusyError """ cid = id(connection) if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) self.connection_handle(connection).close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) def report(self): """Return a report about the pool state and configuration. :rtype: dict """ return { 'connections': { 'busy': len(self.busy_connections), 'closed': len(self.closed_connections), 'executing': len(self.executing_connections), 'idle': len(self.idle_connections), 'locked': len(self.busy_connections) }, 'exceptions': sum([c.exceptions for c in self.connections.values()]), 'executions': sum([c.executions for c in self.connections.values()]), 'full': self.is_full, 'idle': { 'duration': self.idle_duration, 'ttl': self.idle_ttl }, 'max_size': self.max_size } def shutdown(self): """Forcefully shutdown the entire pool, closing all non-executing connections. :raises: ConnectionBusyError raise KeyError('Pool %s already exists' % pid) pool_class = pool_type or Pool with cls._lock: cls._pools[pid] = pool_class(pid, idle_ttl, max_size) @classmethod self.connections[cid].free() self.connections[cid].close() del self.connections[cid] def set_idle_ttl(self, ttl): """Set the idle ttl :param int ttl: The TTL when idle """ with self._lock: self.idle_ttl = ttl def set_max_size(self, size): """Set the maximum number of connections :param int size: The maximum number of connections """ with self._lock: self.max_size = size class PoolManager(object): """The connection pool object implements behavior around connections and their use in queries.Session objects. We carry a pool id instead of the connection URI so that we will not be carrying the URI in memory, creating a possible security issue. """ _lock = threading.Lock() _pools = {} def __contains__(self, pid): """Returns True if the pool exists :param str pid: The pool id to check for :rtype: bool """ return pid in self.__class__._pools @classmethod def instance(cls): """Only allow a single PoolManager instance to exist, returning the handle for it. :rtype: PoolManager """ if not hasattr(cls, '_instance'): with cls._lock: cls._instance = cls() return cls._instance @classmethod def add(cls, pid, connection): """Add a new connection and session to a pool. :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].add(connection) @classmethod def clean(cls, pid): """Clean the specified pool, removing any closed connections or stale locks. :param str pid: The pool id to clean """ with cls._lock: try: cls._ensure_pool_exists(pid) except KeyError: LOGGER.debug('Pool clean invoked against missing pool %s', pid) return cls._pools[pid].clean() cls._maybe_remove_pool(pid) @classmethod def create(cls, pid, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): """Create a new pool, with the ability to pass in values to override the default idle TTL and the default maximum size. A pool's idle TTL defines the amount of time that a pool can be open without any sessions before it is removed. A pool's max size defines the maximum number of connections that can be added to the pool to prevent unbounded open connections. :param str pid: The pool ID :param int idle_ttl: Time in seconds for the idle TTL :param int max_size: The maximum pool size :param callable time_method: Override the use of :py:meth:`time.time` method for time values. :raises: KeyError """ if pid in cls._pools: raise KeyError('Pool %s already exists' % pid) with cls._lock: LOGGER.debug("Creating Pool: %s (%i/%i)", pid, idle_ttl, max_size) cls._pools[pid] = Pool(pid, idle_ttl, max_size, time_method) @classmethod def free(cls, pid, connection): """Free a connection that was locked by a session :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection """ with cls._lock: LOGGER.debug('Freeing %s from pool %s', id(connection), pid) cls._ensure_pool_exists(pid) cls._pools[pid].free(connection) @classmethod def get(cls, pid, session): """Get an idle, unused connection from the pool. Once a connection has been retrieved, it will be marked as in-use until it is freed. :param str pid: The pool ID :param queries.Session session: The session to assign to the connection :rtype: psycopg2.extensions.connection """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].get(session) @classmethod def get_connection(cls, pid, connection): """Return the specified :class:`~queries.pool.Connection` from the pool. :param str pid: The pool ID :param connection: The connection to return for :type connection: psycopg2.extensions.connection :rtype: queries.pool.Connection """ with cls._lock: return cls._pools[pid].connection_handle(connection) @classmethod def has_connection(cls, pid, connection): """Check to see if a pool has the specified connection :param str pid: The pool ID :param connection: The connection to check for :type connection: psycopg2.extensions.connection :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return connection in cls._pools[pid] @classmethod def has_idle_connection(cls, pid): """Check to see if a pool has an idle connection :param str pid: The pool ID :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return bool(cls._pools[pid].idle_connections) @classmethod def is_full(cls, pid): """Return a bool indicating if the specified pool is full :param str pid: The pool id :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].is_full @classmethod def lock(cls, pid, connection, session): """Explicitly lock the specified connection in the pool :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool :param queries.Session session: The session to hold the lock """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].lock(connection, session) @classmethod def remove(cls, pid): """Remove a pool, closing all connections :param str pid: The pool ID """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].close() del cls._pools[pid] @classmethod def remove_connection(cls, pid, connection): """Remove a connection from the pool, closing it if is open. :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ cls._ensure_pool_exists(pid) cls._pools[pid].remove(connection) @classmethod def set_idle_ttl(cls, pid, ttl): """Set the idle TTL for a pool, after which it will be destroyed. :param str pid: The pool id :param int ttl: The TTL for an idle pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_idle_ttl(ttl) @classmethod def set_max_size(cls, pid, size): """Set the maximum number of connections for the specified pool :param str pid: The pool to set the size for :param int size: The maximum number of connections """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_max_size(size) @classmethod def shutdown(cls): """Close all connections on in all pools""" for pid in list(cls._pools.keys()): cls._pools[pid].shutdown() LOGGER.info('Shutdown complete, all pooled connections closed') @classmethod def size(cls, pid): """Return the number of connections in the pool :param str pid: The pool id :rtype int """ with cls._lock: cls._ensure_pool_exists(pid) return len(cls._pools[pid]) @classmethod def report(cls): """Return the state of the all of the registered pools. :rtype: dict """ return { 'timestamp': datetime.datetime.utcnow().isoformat(), 'process': os.getpid(), 'pools': dict([(i, p.report()) for i, p in cls._pools.items()]) } @classmethod def _ensure_pool_exists(cls, pid): """Raise an exception if the pool has yet to be created or has been removed. :param str pid: The pool ID to check for :raises: KeyError """ if pid not in cls._pools: raise KeyError('Pool %s has not been created' % pid) @classmethod def _maybe_remove_pool(cls, pid): """If the pool has no open connections, remove it :param str pid: The pool id to clean """ if not len(cls._pools[pid]): del cls._pools[pid] class QueriesException(Exception): """Base Exception for all other Queries exceptions""" pass class ConnectionException(QueriesException): def __init__(self, cid): self.cid = cid class PoolException(QueriesException): def __init__(self, pid): self.pid = pid class PoolConnectionException(PoolException): def __init__(self, pid, cid): self.pid = pid self.cid = cid class ActivePoolError(PoolException): """Raised when removing a pool that has active connections""" def __str__(self): return 'Pool %s has at least one active connection' % self.pid class ConnectionBusyError(ConnectionException): """Raised when trying to lock a connection that is already busy""" def __str__(self): return 'Connection %s is busy' % self.cid class ConnectionNotFoundError(PoolConnectionException): """Raised if a specific connection is not found in the pool""" def __str__(self): return 'Connection %s not found in pool %s' % (self.cid, self.pid) class NoIdleConnectionsError(PoolException): """Raised if a pool does not have any idle, open connections""" def __str__(self): return 'Pool %s has no idle connections' % self.pid class PoolFullError(PoolException): """Raised when adding a connection to a pool that has hit max-size""" def __str__(self): return 'Pool %s is at its maximum capacity' % self.pid <MSG> Change the max size for a pool to 1 The library should not impose a high connection count by default <DFF> @@ -10,7 +10,7 @@ import weakref LOGGER = logging.getLogger(__name__) DEFAULT_IDLE_TTL = 60 -DEFAULT_MAX_SIZE = 100 +DEFAULT_MAX_SIZE = 1 class Connection(object): @@ -390,6 +390,7 @@ class PoolManager(object): raise KeyError('Pool %s already exists' % pid) pool_class = pool_type or Pool with cls._lock: + LOGGER.debug("Creating Pool: %s (%i/%i)", pid, idle_ttl, max_size) cls._pools[pid] = pool_class(pid, idle_ttl, max_size) @classmethod

Change the max size for a pool to 1

.py

py

bsd-3-clause

gmr/queries

1532

<NME> pool.py <BEF> """ Connection Pooling """ import datetime import logging import os import threading import time LOGGER = logging.getLogger(__name__) DEFAULT_IDLE_TTL = 60 DEFAULT_MAX_SIZE = 100 class Connection(object): DEFAULT_MAX_SIZE = int(os.environ.get('QUERIES_MAX_POOL_SIZE', 1)) class Connection(object): """Contains the handle to the connection, the current state of the connection and methods for manipulating the state of the connection. """ _lock = threading.Lock() def __init__(self, handle): self.handle = handle self.used_by = None self.executions = 0 self.exceptions = 0 def close(self): """Close the connection :raises: ConnectionBusyError """ LOGGER.debug('Connection %s closing', self.id) if self.busy and not self.closed: raise ConnectionBusyError(self) with self._lock: if not self.handle.closed: try: self.handle.close() except psycopg2.InterfaceError as error: LOGGER.error('Error closing socket: %s', error) @property def closed(self): """Return if the psycopg2 connection is closed. :rtype: bool """ return self.handle.closed != 0 @property def busy(self): """Return if the connection is currently executing a query or is locked by a session that still exists. :rtype: bool """ if self.handle.isexecuting(): return True elif self.used_by is None: return False return not self.used_by() is None @property def executing(self): """Return if the connection is currently executing a query :rtype: bool """ return self.handle.isexecuting() def free(self): """Remove the lock on the connection if the connection is not active :raises: ConnectionBusyError """ LOGGER.debug('Connection %s freeing', self.id) if self.handle.isexecuting(): raise ConnectionBusyError(self) with self._lock: self.used_by = None LOGGER.debug('Connection %s freed', self.id) @property def id(self): """Return id of the psycopg2 connection object :rtype: int """ return id(self.handle) def lock(self, session): """Lock the connection, ensuring that it is not busy and storing a weakref for the session. :param queries.Session session: The session to lock the connection with :raises: ConnectionBusyError """ if self.busy: raise ConnectionBusyError(self) with self._lock: self.used_by = weakref.ref(session) LOGGER.debug('Connection %s locked', self.id) @property def locked(self): """Return if the connection is currently exclusively locked :rtype: bool """ return self.used_by is not None class Pool(object): """A connection pool for gaining access to and managing connections""" _lock = threading.Lock() idle_start = None idle_ttl = DEFAULT_IDLE_TTL max_size = DEFAULT_MAX_SIZE def __init__(self, pool_id, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): self.connections = {} self._id = pool_id self.idle_ttl = idle_ttl self.max_size = max_size self.time_method = time_method or time.time def __contains__(self, connection): """Return True if the pool contains the connection""" return id(connection) in self.connections def __len__(self): """Return the number of connections in the pool""" return len(self.connections) def add(self, connection): """Add a new connection to the pool :param connection: The connection to add to the pool :type connection: psycopg2.extensions.connection :raises: PoolFullError """ if id(connection) in self.connections: raise ValueError('Connection already exists in pool') if len(self.connections) == self.max_size: LOGGER.warning('Race condition found when adding new connection') try: connection.close() except (psycopg2.Error, psycopg2.Warning) as error: LOGGER.error('Error closing the conn that cant be used: %s', error) raise PoolFullError(self) with self._lock: self.connections[id(connection)] = Connection(connection) LOGGER.debug('Pool %s added connection %s', self.id, id(connection)) @property def busy_connections(self): """Return a list of active/busy connections :rtype: list """ return [c for c in self.connections.values() if c.busy and not c.closed] def clean(self): """Clean the pool by removing any closed connections and if the pool's idle has exceeded its idle TTL, remove all connections. """ LOGGER.debug('Cleaning the pool') for connection in [self.connections[k] for k in self.connections if self.connections[k].closed]: LOGGER.debug('Removing %s', connection.id) self.remove(connection.handle) if self.idle_duration > self.idle_ttl: self.close() LOGGER.debug('Pool %s cleaned', self.id) def close(self): """Close the pool by closing and removing all of the connections""" for cid in list(self.connections.keys()): self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) @property def closed_connections(self): """Return a list of closed connections :rtype: list """ return [c for c in self.connections.values() if c.closed] def connection_handle(self, connection): """Return a connection object for the given psycopg2 connection :param connection: The connection to return a parent for :type connection: psycopg2.extensions.connection :rtype: Connection """ return self.connections[id(connection)] @property def executing_connections(self): """Return a list of connections actively executing queries :rtype: list """ return [c for c in self.connections.values() if c.executing] def free(self, connection): """Free the connection from use by the session that was using it. :param connection: The connection to free :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ LOGGER.debug('Pool %s freeing connection %s', self.id, id(connection)) try: self.connection_handle(connection).free() except KeyError: raise ConnectionNotFoundError(self.id, id(connection)) if self.idle_connections == list(self.connections.values()): with self._lock: self.idle_start = self.time_method() LOGGER.debug('Pool %s freed connection %s', self.id, id(connection)) def get(self, session): """Return an idle connection and assign the session to the connection :param queries.Session session: The session to assign :rtype: psycopg2.extensions.connection :raises: NoIdleConnectionsError """ idle = self.idle_connections if idle: connection = idle.pop(0) connection.lock(session) if self.idle_start: with self._lock: self.idle_start = None return connection.handle raise NoIdleConnectionsError(self.id) @property def id(self): """Return the ID for this pool :rtype: str """ return self._id @property def idle_connections(self): """Return a list of idle connections :rtype: list """ return [c for c in self.connections.values() if not c.busy and not c.closed] @property def idle_duration(self): """Return the number of seconds that the pool has had no active connections. :rtype: float """ if self.idle_start is None: return 0 return self.time_method() - self.idle_start @property def is_full(self): """Return True if there are no more open slots for connections. :rtype: bool """ return len(self.connections) >= self.max_size def lock(self, connection, session): """Explicitly lock the specified connection :type connection: psycopg2.extensions.connection :param connection: The connection to lock :param queries.Session session: The session to hold the lock """ cid = id(connection) try: self.connection_handle(connection).lock(session) except KeyError: raise ConnectionNotFoundError(self.id, cid) else: if self.idle_start: with self._lock: self.idle_start = None LOGGER.debug('Pool %s locked connection %s', self.id, cid) @property def locked_connections(self): """Return a list of all locked connections :rtype: list """ return [c for c in self.connections.values() if c.locked] def remove(self, connection): """Remove the connection from the pool :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError :raises: ConnectionBusyError """ cid = id(connection) if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) self.connection_handle(connection).close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) def report(self): """Return a report about the pool state and configuration. :rtype: dict """ return { 'connections': { 'busy': len(self.busy_connections), 'closed': len(self.closed_connections), 'executing': len(self.executing_connections), 'idle': len(self.idle_connections), 'locked': len(self.busy_connections) }, 'exceptions': sum([c.exceptions for c in self.connections.values()]), 'executions': sum([c.executions for c in self.connections.values()]), 'full': self.is_full, 'idle': { 'duration': self.idle_duration, 'ttl': self.idle_ttl }, 'max_size': self.max_size } def shutdown(self): """Forcefully shutdown the entire pool, closing all non-executing connections. :raises: ConnectionBusyError raise KeyError('Pool %s already exists' % pid) pool_class = pool_type or Pool with cls._lock: cls._pools[pid] = pool_class(pid, idle_ttl, max_size) @classmethod self.connections[cid].free() self.connections[cid].close() del self.connections[cid] def set_idle_ttl(self, ttl): """Set the idle ttl :param int ttl: The TTL when idle """ with self._lock: self.idle_ttl = ttl def set_max_size(self, size): """Set the maximum number of connections :param int size: The maximum number of connections """ with self._lock: self.max_size = size class PoolManager(object): """The connection pool object implements behavior around connections and their use in queries.Session objects. We carry a pool id instead of the connection URI so that we will not be carrying the URI in memory, creating a possible security issue. """ _lock = threading.Lock() _pools = {} def __contains__(self, pid): """Returns True if the pool exists :param str pid: The pool id to check for :rtype: bool """ return pid in self.__class__._pools @classmethod def instance(cls): """Only allow a single PoolManager instance to exist, returning the handle for it. :rtype: PoolManager """ if not hasattr(cls, '_instance'): with cls._lock: cls._instance = cls() return cls._instance @classmethod def add(cls, pid, connection): """Add a new connection and session to a pool. :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].add(connection) @classmethod def clean(cls, pid): """Clean the specified pool, removing any closed connections or stale locks. :param str pid: The pool id to clean """ with cls._lock: try: cls._ensure_pool_exists(pid) except KeyError: LOGGER.debug('Pool clean invoked against missing pool %s', pid) return cls._pools[pid].clean() cls._maybe_remove_pool(pid) @classmethod def create(cls, pid, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): """Create a new pool, with the ability to pass in values to override the default idle TTL and the default maximum size. A pool's idle TTL defines the amount of time that a pool can be open without any sessions before it is removed. A pool's max size defines the maximum number of connections that can be added to the pool to prevent unbounded open connections. :param str pid: The pool ID :param int idle_ttl: Time in seconds for the idle TTL :param int max_size: The maximum pool size :param callable time_method: Override the use of :py:meth:`time.time` method for time values. :raises: KeyError """ if pid in cls._pools: raise KeyError('Pool %s already exists' % pid) with cls._lock: LOGGER.debug("Creating Pool: %s (%i/%i)", pid, idle_ttl, max_size) cls._pools[pid] = Pool(pid, idle_ttl, max_size, time_method) @classmethod def free(cls, pid, connection): """Free a connection that was locked by a session :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection """ with cls._lock: LOGGER.debug('Freeing %s from pool %s', id(connection), pid) cls._ensure_pool_exists(pid) cls._pools[pid].free(connection) @classmethod def get(cls, pid, session): """Get an idle, unused connection from the pool. Once a connection has been retrieved, it will be marked as in-use until it is freed. :param str pid: The pool ID :param queries.Session session: The session to assign to the connection :rtype: psycopg2.extensions.connection """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].get(session) @classmethod def get_connection(cls, pid, connection): """Return the specified :class:`~queries.pool.Connection` from the pool. :param str pid: The pool ID :param connection: The connection to return for :type connection: psycopg2.extensions.connection :rtype: queries.pool.Connection """ with cls._lock: return cls._pools[pid].connection_handle(connection) @classmethod def has_connection(cls, pid, connection): """Check to see if a pool has the specified connection :param str pid: The pool ID :param connection: The connection to check for :type connection: psycopg2.extensions.connection :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return connection in cls._pools[pid] @classmethod def has_idle_connection(cls, pid): """Check to see if a pool has an idle connection :param str pid: The pool ID :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return bool(cls._pools[pid].idle_connections) @classmethod def is_full(cls, pid): """Return a bool indicating if the specified pool is full :param str pid: The pool id :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].is_full @classmethod def lock(cls, pid, connection, session): """Explicitly lock the specified connection in the pool :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool :param queries.Session session: The session to hold the lock """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].lock(connection, session) @classmethod def remove(cls, pid): """Remove a pool, closing all connections :param str pid: The pool ID """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].close() del cls._pools[pid] @classmethod def remove_connection(cls, pid, connection): """Remove a connection from the pool, closing it if is open. :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ cls._ensure_pool_exists(pid) cls._pools[pid].remove(connection) @classmethod def set_idle_ttl(cls, pid, ttl): """Set the idle TTL for a pool, after which it will be destroyed. :param str pid: The pool id :param int ttl: The TTL for an idle pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_idle_ttl(ttl) @classmethod def set_max_size(cls, pid, size): """Set the maximum number of connections for the specified pool :param str pid: The pool to set the size for :param int size: The maximum number of connections """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_max_size(size) @classmethod def shutdown(cls): """Close all connections on in all pools""" for pid in list(cls._pools.keys()): cls._pools[pid].shutdown() LOGGER.info('Shutdown complete, all pooled connections closed') @classmethod def size(cls, pid): """Return the number of connections in the pool :param str pid: The pool id :rtype int """ with cls._lock: cls._ensure_pool_exists(pid) return len(cls._pools[pid]) @classmethod def report(cls): """Return the state of the all of the registered pools. :rtype: dict """ return { 'timestamp': datetime.datetime.utcnow().isoformat(), 'process': os.getpid(), 'pools': dict([(i, p.report()) for i, p in cls._pools.items()]) } @classmethod def _ensure_pool_exists(cls, pid): """Raise an exception if the pool has yet to be created or has been removed. :param str pid: The pool ID to check for :raises: KeyError """ if pid not in cls._pools: raise KeyError('Pool %s has not been created' % pid) @classmethod def _maybe_remove_pool(cls, pid): """If the pool has no open connections, remove it :param str pid: The pool id to clean """ if not len(cls._pools[pid]): del cls._pools[pid] class QueriesException(Exception): """Base Exception for all other Queries exceptions""" pass class ConnectionException(QueriesException): def __init__(self, cid): self.cid = cid class PoolException(QueriesException): def __init__(self, pid): self.pid = pid class PoolConnectionException(PoolException): def __init__(self, pid, cid): self.pid = pid self.cid = cid class ActivePoolError(PoolException): """Raised when removing a pool that has active connections""" def __str__(self): return 'Pool %s has at least one active connection' % self.pid class ConnectionBusyError(ConnectionException): """Raised when trying to lock a connection that is already busy""" def __str__(self): return 'Connection %s is busy' % self.cid class ConnectionNotFoundError(PoolConnectionException): """Raised if a specific connection is not found in the pool""" def __str__(self): return 'Connection %s not found in pool %s' % (self.cid, self.pid) class NoIdleConnectionsError(PoolException): """Raised if a pool does not have any idle, open connections""" def __str__(self): return 'Pool %s has no idle connections' % self.pid class PoolFullError(PoolException): """Raised when adding a connection to a pool that has hit max-size""" def __str__(self): return 'Pool %s is at its maximum capacity' % self.pid <MSG> Change the max size for a pool to 1 The library should not impose a high connection count by default <DFF> @@ -10,7 +10,7 @@ import weakref LOGGER = logging.getLogger(__name__) DEFAULT_IDLE_TTL = 60 -DEFAULT_MAX_SIZE = 100 +DEFAULT_MAX_SIZE = 1 class Connection(object): @@ -390,6 +390,7 @@ class PoolManager(object): raise KeyError('Pool %s already exists' % pid) pool_class = pool_type or Pool with cls._lock: + LOGGER.debug("Creating Pool: %s (%i/%i)", pid, idle_ttl, max_size) cls._pools[pid] = pool_class(pid, idle_ttl, max_size) @classmethod

Change the max size for a pool to 1

.py

py

bsd-3-clause

gmr/queries

1533

<NME> LICENSE <BEF> Copyright (c) 2012 MeetMe, Inc. 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. * Neither the name of the MeetMe, Inc. nor the names of its contributors may 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 HOLDER 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. <MSG> Update license <DFF> @@ -1,4 +1,4 @@ -Copyright (c) 2012 MeetMe, Inc. +Copyright (c) 2014 Gavin M. Roy All rights reserved. Redistribution and use in source and binary forms, with or without modification, @@ -9,7 +9,7 @@ are permitted provided that the following conditions are met: * 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. - * Neither the name of the MeetMe, Inc. nor the names of its + * Neither the name of the pgsql_wrapper nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

Update license

LICENSE

bsd-3-clause

gmr/queries

1534

<NME> LICENSE <BEF> Copyright (c) 2012 MeetMe, Inc. 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. * Neither the name of the MeetMe, Inc. nor the names of its contributors may 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 HOLDER 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. <MSG> Update license <DFF> @@ -1,4 +1,4 @@ -Copyright (c) 2012 MeetMe, Inc. +Copyright (c) 2014 Gavin M. Roy All rights reserved. Redistribution and use in source and binary forms, with or without modification, @@ -9,7 +9,7 @@ are permitted provided that the following conditions are met: * 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. - * Neither the name of the MeetMe, Inc. nor the names of its + * Neither the name of the pgsql_wrapper nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

Update license

LICENSE

bsd-3-clause

gmr/queries

1535

<NME> pool_tests.py <BEF> """ Tests for functionality in the pool module """ import time import unittest import uuid import mock from queries import pool MAX_POOL_SIZE = 100 def mock_connection(): conn = mock.MagicMock('psycopg2.extensions.connection') conn.close = mock.Mock() conn.closed = True conn.isexecuting = mock.Mock(return_value=False) return conn class PoolTests(unittest.TestCase): def test_id_is_set(self): pool_id = str(uuid.uuid4()) obj = pool.Pool(pool_id) self.assertEqual(obj._id, pool_id) def test_id_property(self): pool_id = str(uuid.uuid4()) obj = pool.Pool(pool_id) self.assertEqual(obj.id, pool_id) def test_idle_ttl_is_default(self): obj = pool.Pool(str(uuid.uuid4())) self.assertEqual(obj.idle_ttl, pool.DEFAULT_IDLE_TTL) def test_max_size_is_default(self): obj = pool.Pool(str(uuid.uuid4())) self.assertEqual(obj.max_size, pool.DEFAULT_MAX_SIZE) def test_idle_ttl_constructor_assignment(self): obj = pool.Pool(str(uuid.uuid4()), 10) self.assertEqual(obj.idle_ttl, 10) def test_max_size_constructor_assignment(self): obj = pool.Pool(str(uuid.uuid4()), max_size=10) self.assertEqual(obj.max_size, 10) def test_idle_ttl_assignment(self): obj = pool.Pool(str(uuid.uuid4())) obj.set_idle_ttl(10) self.assertEqual(obj.idle_ttl, 10) def test_max_size_assignment(self): obj = pool.Pool(str(uuid.uuid4())) obj.set_max_size(10) self.assertEqual(obj.max_size, 10) def test_pool_doesnt_contain_connection(self): obj = pool.Pool(str(uuid.uuid4())) self.assertNotIn('foo', obj) def test_default_connection_count(self): obj = pool.Pool(str(uuid.uuid4())) self.assertEqual(len(obj), 0) def test_add_new_connection(self): psycopg2_conn = mock.Mock() obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertIn(psycopg2_conn, obj) def test_connection_count_after_add(self): psycopg2_conn = mock.Mock() obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertEqual(len(obj), 1) def test_add_existing_connection_raises_on_second_add(self): psycopg2_conn = mock.Mock() obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertRaises(ValueError, obj.add, psycopg2_conn) def test_add_when_pool_is_full_raises(self): obj = pool.Pool(str(uuid.uuid4()), max_size=1) obj.add(mock.Mock()) mock_conn = mock.Mock() self.assertRaises(pool.PoolFullError, obj.add, mock_conn) def test_closed_conn_invokes_remove_on_clean(self): psycopg2_conn = mock.Mock() psycopg2_conn.closed = True obj = pool.Pool(str(uuid.uuid4())) obj.remove = mock.Mock() obj.add(psycopg2_conn) obj.close.assert_called_once_with() def test_close_close_removes_all(self): obj = pool.Pool(str(uuid.uuid4())) obj.remove = mock.Mock() psycopg2_conns = [mock.Mock(), mock.Mock()] obj.close = mock.Mock() obj.clean() obj.close.assert_called_once_with() def test_close_close_removes_all(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) obj.remove = mock.Mock() psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] obj.close() psycopg2_calls = [mock.call(c) for c in psycopg2_conns] obj.remove.assert_has_calls(psycopg2_calls) def test_free_invokes_connection_free(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) self._connection = obj.connection_handle conn = self._connection(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conn) conn.free.assert_called_once_with() def test_free_raises_not_found_exception(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) conn = obj.connection_handle(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conn) conn.free.assert_called_once_with() def test_free_resets_idle_start(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): [obj.add(conn) for conn in psycopg2_conns] for psycopg2_conn in psycopg2_conns: conn = obj.connection_handle(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conns[1]) self.assertAlmostEqual(int(obj.idle_start), int(time.time())) def test_free_raises_on_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.free, mock.Mock()) def test_get_returns_first_psycopg2_conn(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] session = mock.Mock() self.assertEqual(obj.get(session), psycopg2_conns[0]) def test_get_locks_first_psycopg2_conn(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] lock = mock.Mock() with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): session = mock.Mock() obj.get(session) self.assertIsNone(obj.idle_start) obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): session = mock.Mock() obj.idle_start = time.time() obj.get(session) self.assertIsNone(obj.idle_start) def test_get_raises_when_no_idle_connections(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] session = mock.Mock() self.assertRaises(pool.NoIdleConnectionsError, obj.get, session) def test_idle_connections(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): self.assertListEqual([c.handle for c in obj.idle_connections], psycopg2_conns) def test_idle_duration_when_none(self): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = None self.assertEqual(obj.idle_duration, 0) def test_idle_duration_when_set(self): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = time.time() - 5 self.assertAlmostEqual(int(obj.idle_duration), 5) def test_is_full_property_when_full(self): obj = pool.Pool(str(uuid.uuid4()), max_size=2) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] self.assertTrue(obj.is_full) def test_is_full_property_when_not_full(self): obj = pool.Pool(str(uuid.uuid4()), max_size=3) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] self.assertFalse(obj.is_full) def test_connection_lock_is_called_when_lock_is(self): with mock.patch('queries.pool.Connection.lock') as lock: obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) session = mock.Mock() obj.lock(psycopg2_conn, session) lock.assert_called_once_with(session) def test_locks_raises_when_connection_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.lock, mock.Mock(), mock.Mock()) def test_lock_resets_idle_start(self): with mock.patch('queries.pool.Connection.lock'): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = time.time() psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.lock(psycopg2_conn, mock.Mock()) self.assertIsNone(obj.idle_start) def test_remove_removes_connection(self): with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.remove(psycopg2_conn) self.assertNotIn(psycopg2_conn, obj) def test_remove_closes_connection(self): close_method = mock.Mock() with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False, close=close_method): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.remove(psycopg2_conn) close_method.assert_called_once_with() def test_remove_raises_when_connection_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.remove, mock.Mock()) def test_remove_raises_when_connection_is_busy(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() psycopg2_conn.closed = False obj.add(psycopg2_conn) self.assertRaises(pool.ConnectionBusyError, obj.remove, psycopg2_conn) def test__connection_returns_handle(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) self.assertEqual( obj.connection_handle(psycopg2_conn).handle, psycopg2_conn) def test_shutdown_raises_when_executing(self): psycopg2_conn = mock_connection() psycopg2_conn.isexecuting.return_value = True obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertRaises(pool.ConnectionBusyError, obj.shutdown) <MSG> Fix pool test to add 100% coverage <DFF> @@ -100,7 +100,6 @@ class PoolTests(unittest.TestCase): obj.close.assert_called_once_with() def test_close_close_removes_all(self): - obj = pool.Pool(str(uuid.uuid4())) obj.remove = mock.Mock() psycopg2_conns = [mock.Mock(), mock.Mock()] @@ -169,6 +168,7 @@ class PoolTests(unittest.TestCase): with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): session = mock.Mock() + obj.idle_start = time.time() obj.get(session) self.assertIsNone(obj.idle_start)

Fix pool test to add 100% coverage

.py

py

bsd-3-clause

gmr/queries

1536

<NME> pool_tests.py <BEF> """ Tests for functionality in the pool module """ import time import unittest import uuid import mock from queries import pool MAX_POOL_SIZE = 100 def mock_connection(): conn = mock.MagicMock('psycopg2.extensions.connection') conn.close = mock.Mock() conn.closed = True conn.isexecuting = mock.Mock(return_value=False) return conn class PoolTests(unittest.TestCase): def test_id_is_set(self): pool_id = str(uuid.uuid4()) obj = pool.Pool(pool_id) self.assertEqual(obj._id, pool_id) def test_id_property(self): pool_id = str(uuid.uuid4()) obj = pool.Pool(pool_id) self.assertEqual(obj.id, pool_id) def test_idle_ttl_is_default(self): obj = pool.Pool(str(uuid.uuid4())) self.assertEqual(obj.idle_ttl, pool.DEFAULT_IDLE_TTL) def test_max_size_is_default(self): obj = pool.Pool(str(uuid.uuid4())) self.assertEqual(obj.max_size, pool.DEFAULT_MAX_SIZE) def test_idle_ttl_constructor_assignment(self): obj = pool.Pool(str(uuid.uuid4()), 10) self.assertEqual(obj.idle_ttl, 10) def test_max_size_constructor_assignment(self): obj = pool.Pool(str(uuid.uuid4()), max_size=10) self.assertEqual(obj.max_size, 10) def test_idle_ttl_assignment(self): obj = pool.Pool(str(uuid.uuid4())) obj.set_idle_ttl(10) self.assertEqual(obj.idle_ttl, 10) def test_max_size_assignment(self): obj = pool.Pool(str(uuid.uuid4())) obj.set_max_size(10) self.assertEqual(obj.max_size, 10) def test_pool_doesnt_contain_connection(self): obj = pool.Pool(str(uuid.uuid4())) self.assertNotIn('foo', obj) def test_default_connection_count(self): obj = pool.Pool(str(uuid.uuid4())) self.assertEqual(len(obj), 0) def test_add_new_connection(self): psycopg2_conn = mock.Mock() obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertIn(psycopg2_conn, obj) def test_connection_count_after_add(self): psycopg2_conn = mock.Mock() obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertEqual(len(obj), 1) def test_add_existing_connection_raises_on_second_add(self): psycopg2_conn = mock.Mock() obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertRaises(ValueError, obj.add, psycopg2_conn) def test_add_when_pool_is_full_raises(self): obj = pool.Pool(str(uuid.uuid4()), max_size=1) obj.add(mock.Mock()) mock_conn = mock.Mock() self.assertRaises(pool.PoolFullError, obj.add, mock_conn) def test_closed_conn_invokes_remove_on_clean(self): psycopg2_conn = mock.Mock() psycopg2_conn.closed = True obj = pool.Pool(str(uuid.uuid4())) obj.remove = mock.Mock() obj.add(psycopg2_conn) obj.close.assert_called_once_with() def test_close_close_removes_all(self): obj = pool.Pool(str(uuid.uuid4())) obj.remove = mock.Mock() psycopg2_conns = [mock.Mock(), mock.Mock()] obj.close = mock.Mock() obj.clean() obj.close.assert_called_once_with() def test_close_close_removes_all(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) obj.remove = mock.Mock() psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] obj.close() psycopg2_calls = [mock.call(c) for c in psycopg2_conns] obj.remove.assert_has_calls(psycopg2_calls) def test_free_invokes_connection_free(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) self._connection = obj.connection_handle conn = self._connection(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conn) conn.free.assert_called_once_with() def test_free_raises_not_found_exception(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) conn = obj.connection_handle(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conn) conn.free.assert_called_once_with() def test_free_resets_idle_start(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): [obj.add(conn) for conn in psycopg2_conns] for psycopg2_conn in psycopg2_conns: conn = obj.connection_handle(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conns[1]) self.assertAlmostEqual(int(obj.idle_start), int(time.time())) def test_free_raises_on_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.free, mock.Mock()) def test_get_returns_first_psycopg2_conn(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] session = mock.Mock() self.assertEqual(obj.get(session), psycopg2_conns[0]) def test_get_locks_first_psycopg2_conn(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] lock = mock.Mock() with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): session = mock.Mock() obj.get(session) self.assertIsNone(obj.idle_start) obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): session = mock.Mock() obj.idle_start = time.time() obj.get(session) self.assertIsNone(obj.idle_start) def test_get_raises_when_no_idle_connections(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] session = mock.Mock() self.assertRaises(pool.NoIdleConnectionsError, obj.get, session) def test_idle_connections(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): self.assertListEqual([c.handle for c in obj.idle_connections], psycopg2_conns) def test_idle_duration_when_none(self): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = None self.assertEqual(obj.idle_duration, 0) def test_idle_duration_when_set(self): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = time.time() - 5 self.assertAlmostEqual(int(obj.idle_duration), 5) def test_is_full_property_when_full(self): obj = pool.Pool(str(uuid.uuid4()), max_size=2) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] self.assertTrue(obj.is_full) def test_is_full_property_when_not_full(self): obj = pool.Pool(str(uuid.uuid4()), max_size=3) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] self.assertFalse(obj.is_full) def test_connection_lock_is_called_when_lock_is(self): with mock.patch('queries.pool.Connection.lock') as lock: obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) session = mock.Mock() obj.lock(psycopg2_conn, session) lock.assert_called_once_with(session) def test_locks_raises_when_connection_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.lock, mock.Mock(), mock.Mock()) def test_lock_resets_idle_start(self): with mock.patch('queries.pool.Connection.lock'): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = time.time() psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.lock(psycopg2_conn, mock.Mock()) self.assertIsNone(obj.idle_start) def test_remove_removes_connection(self): with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.remove(psycopg2_conn) self.assertNotIn(psycopg2_conn, obj) def test_remove_closes_connection(self): close_method = mock.Mock() with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False, close=close_method): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.remove(psycopg2_conn) close_method.assert_called_once_with() def test_remove_raises_when_connection_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.remove, mock.Mock()) def test_remove_raises_when_connection_is_busy(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() psycopg2_conn.closed = False obj.add(psycopg2_conn) self.assertRaises(pool.ConnectionBusyError, obj.remove, psycopg2_conn) def test__connection_returns_handle(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) self.assertEqual( obj.connection_handle(psycopg2_conn).handle, psycopg2_conn) def test_shutdown_raises_when_executing(self): psycopg2_conn = mock_connection() psycopg2_conn.isexecuting.return_value = True obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertRaises(pool.ConnectionBusyError, obj.shutdown) <MSG> Fix pool test to add 100% coverage <DFF> @@ -100,7 +100,6 @@ class PoolTests(unittest.TestCase): obj.close.assert_called_once_with() def test_close_close_removes_all(self): - obj = pool.Pool(str(uuid.uuid4())) obj.remove = mock.Mock() psycopg2_conns = [mock.Mock(), mock.Mock()] @@ -169,6 +168,7 @@ class PoolTests(unittest.TestCase): with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): session = mock.Mock() + obj.idle_start = time.time() obj.get(session) self.assertIsNone(obj.idle_start)

Fix pool test to add 100% coverage

.py

py

bsd-3-clause

gmr/queries

1537

<NME> tornado_session_tests.py <BEF> """ Tests for functionality in the tornado_session module """ import mock try: import unittest2 as unittest except ImportError: import unittest from psycopg2 import extras from tornado import gen from tornado import ioloop from queries import pool from queries import tornado_session def test_cursor_is_assigned(self): self.assertEqual(self.obj.cursor, self.cursor) def test_fd_is_assigned(self): self.assertEqual(self.obj._fd, self.fd) def test_cleanup_is_assigned(self): self.assertEqual(self.obj._cleanup, self.cleanup) @gen.coroutine def test_free_invokes_cleanup(self): yield self.obj.free() self.cleanup.assert_called_once_with(self.cursor, self.fd) class SessionInitTests(unittest.TestCase): def setUp(self): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): self.assertDictEqual(self.obj._futures, {}) def test_creates_empty_connections_dict(self): self.assertDictEqual(self.obj._connections, {}) def test_sets_default_cursor_factory(self): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): self.assertDictEqual(self.obj._callbacks, {}) def test_creates_empty_connections_dict(self): self.assertDictEqual(self.obj._connections, {}) def test_creates_empty_exceptions_dict(self): self.assertDictEqual(self.obj._exceptions, {}) def test_creates_empty_listeners_dict(self): self.assertDictEqual(self.obj._listeners, {}) def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) def test_connection_is_none(self): self.assertIsNone(self.obj.connection) def test_cursor_is_none(self): self.assertIsNone(self.obj.cursor) class SessionConnectTests(testing.AsyncTestCase): def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) def test_exec_cleanup_closes_cursor(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() cursor = mock.Mock() cursor.close = mock.Mock() self.obj._exec_cleanup(cursor, 14) cursor.close.assert_called_once_with() def test_exec_cleanup_frees_connection(self): with mock.patch.object(self.obj._pool_manager, 'free') as pm_free: with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = conn = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) pm_free.assert_called_once_with(self.obj.pid, conn) def test_exec_cleanup_remove_handler_invoked(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler') as rh: self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) rh.assert_called_once_with(14) def test_exec_removes_connection(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._connections) def test_exec_removes_future(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._futures[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._futures) def test_pool_manager_add_failures_are_propagated(self): futures = [] def add_future(future, callback): futures.append((future, callback)) obj = tornado_session.TornadoSession() obj._ioloop = mock.Mock() obj._ioloop.add_future = add_future future = concurrent.Future() with mock.patch.object(obj._pool_manager, 'add') as add_method: add_method.side_effect = pool.PoolFullError(mock.Mock()) obj._create_connection(future) self.assertEqual(len(futures), 1) connected_future, callback = futures.pop() connected_future.set_result(True) callback(connected_future) self.assertIs(future.exception(), add_method.side_effect) class SessionPublicMethodTests(testing.AsyncTestCase): @testing.gen_test def test_callproc_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.callproc('foo', ['bar']) _execute.assert_called_once_with('callproc', 'foo', ['bar']) @testing.gen_test def test_query_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) """ @testing.gen_test def test_query_error_key_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): yield obj.query('SELECT * FROM foo WHERE bar=%(baz)s', {}) @testing.gen_test def test_query_error_index_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): r = yield obj.query('SELECT * FROM foo WHERE bar=%s', []) """ <MSG> Move to using tornado.concurrent.Future To simplify code and move away from to-be-deprecated code, move away from tornado.gen.Callback, etc to tornado.concurrent.Future @TODO refactor LISTEN/NOTIFY @TODO add additional coverage <DFF> @@ -3,14 +3,20 @@ Tests for functionality in the tornado_session module """ import mock +import tempfile +import time try: import unittest2 as unittest except ImportError: import unittest from psycopg2 import extras +import psycopg2 + +from tornado import concurrent from tornado import gen from tornado import ioloop +from tornado import testing from queries import pool from queries import tornado_session @@ -45,14 +51,11 @@ class SessionInitTests(unittest.TestCase): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): - self.assertDictEqual(self.obj._callbacks, {}) + self.assertDictEqual(self.obj._futures, {}) def test_creates_empty_connections_dict(self): self.assertDictEqual(self.obj._connections, {}) - def test_creates_empty_exceptions_dict(self): - self.assertDictEqual(self.obj._exceptions, {}) - def test_creates_empty_listeners_dict(self): self.assertDictEqual(self.obj._listeners, {}) @@ -70,3 +73,61 @@ class SessionInitTests(unittest.TestCase): def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) + + +class SessionTests(testing.AsyncTestCase): + + @mock.patch('psycopg2.connect') + @mock.patch('psycopg2.extensions.register_type') + @mock.patch('psycopg2.extras.register_uuid') + @mock.patch('queries.utils.uri_to_kwargs') + def setUp(self, uri_to_kwargs, register_uuid, register_type, connect): + + super(SessionTests, self).setUp() + + self.conn = mock.Mock() + self.conn.autocommit = False + self.conn.closed = False + self.conn.cursor = mock.Mock() + + self.conn.fileno = mock.Mock(return_value=True) + self.conn.isexecuting = mock.Mock(return_value=False) + self.conn.reset = mock.Mock() + self.conn.status = psycopg2.extensions.STATUS_BEGIN + + self.psycopg2_connect = connect + self.psycopg2_register_type = register_type + self.psycopg2_register_uuid = register_uuid + + self.uri_to_kwargs = uri_to_kwargs + self.uri_to_kwargs.return_value = {'host': 'localhost', + 'port': 5432, + 'user': 'foo', + 'password': 'bar', + 'dbname': 'foo'} + + @testing.gen_test + def test_callproc_invokes_execute(self): + with mock.patch('queries.tornado_session.TornadoSession._execute') as \ + _execute: + future = concurrent.Future() + future.set_result(True) + _execute.return_value = future + obj = tornado_session.TornadoSession(io_loop=self.io_loop) + result = yield obj.callproc('foo', ['bar']) + _execute.assert_called_once_with('callproc', 'foo', ['bar']) + + @testing.gen_test + def test_query_invokes_execute(self): + with mock.patch('queries.tornado_session.TornadoSession._execute') as \ + _execute: + future = concurrent.Future() + future.set_result(True) + _execute.return_value = future + obj = tornado_session.TornadoSession(io_loop=self.io_loop) + result = yield obj.query('SELECT 1') + _execute.assert_called_once_with('execute', 'SELECT 1', None) + + + +

Move to using tornado.concurrent.Future

.py

py

bsd-3-clause

gmr/queries

1538

<NME> tornado_session_tests.py <BEF> """ Tests for functionality in the tornado_session module """ import mock try: import unittest2 as unittest except ImportError: import unittest from psycopg2 import extras from tornado import gen from tornado import ioloop from queries import pool from queries import tornado_session def test_cursor_is_assigned(self): self.assertEqual(self.obj.cursor, self.cursor) def test_fd_is_assigned(self): self.assertEqual(self.obj._fd, self.fd) def test_cleanup_is_assigned(self): self.assertEqual(self.obj._cleanup, self.cleanup) @gen.coroutine def test_free_invokes_cleanup(self): yield self.obj.free() self.cleanup.assert_called_once_with(self.cursor, self.fd) class SessionInitTests(unittest.TestCase): def setUp(self): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): self.assertDictEqual(self.obj._futures, {}) def test_creates_empty_connections_dict(self): self.assertDictEqual(self.obj._connections, {}) def test_sets_default_cursor_factory(self): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): self.assertDictEqual(self.obj._callbacks, {}) def test_creates_empty_connections_dict(self): self.assertDictEqual(self.obj._connections, {}) def test_creates_empty_exceptions_dict(self): self.assertDictEqual(self.obj._exceptions, {}) def test_creates_empty_listeners_dict(self): self.assertDictEqual(self.obj._listeners, {}) def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) def test_connection_is_none(self): self.assertIsNone(self.obj.connection) def test_cursor_is_none(self): self.assertIsNone(self.obj.cursor) class SessionConnectTests(testing.AsyncTestCase): def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) def test_exec_cleanup_closes_cursor(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() cursor = mock.Mock() cursor.close = mock.Mock() self.obj._exec_cleanup(cursor, 14) cursor.close.assert_called_once_with() def test_exec_cleanup_frees_connection(self): with mock.patch.object(self.obj._pool_manager, 'free') as pm_free: with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = conn = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) pm_free.assert_called_once_with(self.obj.pid, conn) def test_exec_cleanup_remove_handler_invoked(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler') as rh: self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) rh.assert_called_once_with(14) def test_exec_removes_connection(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._connections) def test_exec_removes_future(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._futures[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._futures) def test_pool_manager_add_failures_are_propagated(self): futures = [] def add_future(future, callback): futures.append((future, callback)) obj = tornado_session.TornadoSession() obj._ioloop = mock.Mock() obj._ioloop.add_future = add_future future = concurrent.Future() with mock.patch.object(obj._pool_manager, 'add') as add_method: add_method.side_effect = pool.PoolFullError(mock.Mock()) obj._create_connection(future) self.assertEqual(len(futures), 1) connected_future, callback = futures.pop() connected_future.set_result(True) callback(connected_future) self.assertIs(future.exception(), add_method.side_effect) class SessionPublicMethodTests(testing.AsyncTestCase): @testing.gen_test def test_callproc_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.callproc('foo', ['bar']) _execute.assert_called_once_with('callproc', 'foo', ['bar']) @testing.gen_test def test_query_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) """ @testing.gen_test def test_query_error_key_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): yield obj.query('SELECT * FROM foo WHERE bar=%(baz)s', {}) @testing.gen_test def test_query_error_index_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): r = yield obj.query('SELECT * FROM foo WHERE bar=%s', []) """ <MSG> Move to using tornado.concurrent.Future To simplify code and move away from to-be-deprecated code, move away from tornado.gen.Callback, etc to tornado.concurrent.Future @TODO refactor LISTEN/NOTIFY @TODO add additional coverage <DFF> @@ -3,14 +3,20 @@ Tests for functionality in the tornado_session module """ import mock +import tempfile +import time try: import unittest2 as unittest except ImportError: import unittest from psycopg2 import extras +import psycopg2 + +from tornado import concurrent from tornado import gen from tornado import ioloop +from tornado import testing from queries import pool from queries import tornado_session @@ -45,14 +51,11 @@ class SessionInitTests(unittest.TestCase): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): - self.assertDictEqual(self.obj._callbacks, {}) + self.assertDictEqual(self.obj._futures, {}) def test_creates_empty_connections_dict(self): self.assertDictEqual(self.obj._connections, {}) - def test_creates_empty_exceptions_dict(self): - self.assertDictEqual(self.obj._exceptions, {}) - def test_creates_empty_listeners_dict(self): self.assertDictEqual(self.obj._listeners, {}) @@ -70,3 +73,61 @@ class SessionInitTests(unittest.TestCase): def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) + + +class SessionTests(testing.AsyncTestCase): + + @mock.patch('psycopg2.connect') + @mock.patch('psycopg2.extensions.register_type') + @mock.patch('psycopg2.extras.register_uuid') + @mock.patch('queries.utils.uri_to_kwargs') + def setUp(self, uri_to_kwargs, register_uuid, register_type, connect): + + super(SessionTests, self).setUp() + + self.conn = mock.Mock() + self.conn.autocommit = False + self.conn.closed = False + self.conn.cursor = mock.Mock() + + self.conn.fileno = mock.Mock(return_value=True) + self.conn.isexecuting = mock.Mock(return_value=False) + self.conn.reset = mock.Mock() + self.conn.status = psycopg2.extensions.STATUS_BEGIN + + self.psycopg2_connect = connect + self.psycopg2_register_type = register_type + self.psycopg2_register_uuid = register_uuid + + self.uri_to_kwargs = uri_to_kwargs + self.uri_to_kwargs.return_value = {'host': 'localhost', + 'port': 5432, + 'user': 'foo', + 'password': 'bar', + 'dbname': 'foo'} + + @testing.gen_test + def test_callproc_invokes_execute(self): + with mock.patch('queries.tornado_session.TornadoSession._execute') as \ + _execute: + future = concurrent.Future() + future.set_result(True) + _execute.return_value = future + obj = tornado_session.TornadoSession(io_loop=self.io_loop) + result = yield obj.callproc('foo', ['bar']) + _execute.assert_called_once_with('callproc', 'foo', ['bar']) + + @testing.gen_test + def test_query_invokes_execute(self): + with mock.patch('queries.tornado_session.TornadoSession._execute') as \ + _execute: + future = concurrent.Future() + future.set_result(True) + _execute.return_value = future + obj = tornado_session.TornadoSession(io_loop=self.io_loop) + result = yield obj.query('SELECT 1') + _execute.assert_called_once_with('execute', 'SELECT 1', None) + + + +

Move to using tornado.concurrent.Future

.py

py

bsd-3-clause

gmr/queries

1539

<NME> session.py <BEF> """The Session class allows for a unified (and simplified) view of interfacing with a PostgreSQL database server. Connection details are passed in as a PostgreSQL URI and connections are pooled by default, allowing for reuse of connections across modules in the Python runtime without having to pass around the object handle. While you can still access the raw `psycopg2` connection and cursor objects to provide ultimate flexibility in how you use the queries.Session object, there are convenience methods designed to simplify the interaction with PostgreSQL. For `psycopg2` functionality outside of what is exposed in Session, simply use the Session.connection or Session.cursor properties to gain access to either object just as you would in a program using psycopg2 directly. Example usage: .. code:: python import queries with queries.Session('pgsql://postgres@localhost/postgres') as session: for row in session.Query('SELECT * FROM table'): print row """ import hashlib import logging import psycopg2 from psycopg2 import extensions, extras from queries import pool, results, utils LOGGER = logging.getLogger(__name__) DEFAULT_ENCODING = 'UTF8' DEFAULT_URI = 'postgresql://localhost:5432' class Session(object): """The Session class allows for a unified (and simplified) view of interfacing with a PostgreSQL database server. The Session object can act as a context manager, providing automated cleanup and simple, Pythonic way of interacting with the object. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ _conn = None _cursor = None _tpc_id = None _uri = None # Connection status constants INTRANS = extensions.STATUS_IN_TRANSACTION PREPARED = extensions.STATUS_PREPARED READY = extensions.STATUS_READY SETUP = extensions.STATUS_SETUP # Transaction status constants TX_ACTIVE = extensions.TRANSACTION_STATUS_ACTIVE TX_IDLE = extensions.TRANSACTION_STATUS_IDLE TX_INERROR = extensions.TRANSACTION_STATUS_INERROR TX_INTRANS = extensions.TRANSACTION_STATUS_INTRANS TX_UNKNOWN = extensions.TRANSACTION_STATUS_UNKNOWN def __init__(self, uri=DEFAULT_URI, cursor_factory=extras.RealDictCursor, pool_idle_ttl=pool.DEFAULT_IDLE_TTL, pool_max_size=pool.DEFAULT_MAX_SIZE, autocommit=True): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ self._pool_manager = pool.PoolManager.instance() self._uri = uri # Ensure the pool exists in the pool manager if self.pid not in self._pool_manager: self._pool_manager.create(self.pid, pool_idle_ttl, pool_max_size) self._conn = self._connect() self._cursor_factory = cursor_factory self._cursor = self._get_cursor(self._conn) self._autocommit(autocommit) @property def backend_pid(self): """Return the backend process ID of the PostgreSQL server that this session is connected to. :rtype: int """ return self._conn.get_backend_pid() def callproc(self, name, args=None): """Call a stored procedure on the server, returning the results in a :py:class:`queries.Results` instance. :param str name: The procedure name :param list args: The list of arguments to pass in :rtype: queries.Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ try: self._cursor.callproc(name, args) except psycopg2.Error as err: self._incr_exceptions() raise err finally: self._incr_executions() return results.Results(self._cursor) def close(self): """Explicitly close the connection and remove it from the connection pool if pooling is enabled. If the connection is already closed :raises: psycopg2.InterfaceError """ if not self._conn: raise psycopg2.InterfaceError('Connection not open') LOGGER.info('Closing connection %r in %s', self._conn, self.pid) self._pool_manager.free(self.pid, self._conn) self._pool_manager.remove_connection(self.pid, self._conn) # Un-assign the connection and cursor self._conn, self._cursor = None, None @property def connection(self): """Return the current open connection to PostgreSQL. :rtype: psycopg2.extensions.connection """ return self._conn @property def cursor(self): """Return the current, active cursor for the open connection. :rtype: psycopg2.extensions.cursor """ return self._cursor @property def encoding(self): """Return the current client encoding value. :rtype: str """ return self._conn.encoding @property def notices(self): """Return a list of up to the last 50 server notices sent to the client. :rtype: list """ return self._conn.notices @property def pid(self): """Return the pool ID used for connection pooling. :rtype: str """ return hashlib.md5(':'.join([self.__class__.__name__, self._uri]).encode('utf-8')).hexdigest() def query(self, sql, parameters=None): """A generator to issue a query on the server, mogrifying the parameters against the sql statement. Results are returned as a :py:class:`queries.Results` object which can act as an iterator and has multiple ways to access the result data. :param str sql: The SQL statement :param dict parameters: A dictionary of query parameters :rtype: queries.Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ try: self._cursor.execute(sql, parameters) except psycopg2.Error as err: self._incr_exceptions() raise err finally: self._incr_executions() return results.Results(self._cursor) def set_encoding(self, value=DEFAULT_ENCODING): """Set the client encoding for the session if the value specified is different than the current client encoding. :param str value: The encoding value to use """ if self._conn.encoding != value: self._conn.set_client_encoding(value) def __del__(self): """When deleting the context, ensure the instance is removed from caches, etc. """ self._cleanup() def __enter__(self): """For use as a context manager, return a handle to this object instance. :rtype: Session """ return self def __exit__(self, exc_type, exc_val, exc_tb): """When leaving the context, ensure the instance is removed from caches, etc. """ self._cleanup() def _autocommit(self, autocommit): """Set the isolation level automatically to commit after every query""" self._conn.autocommit = autocommit def _cleanup(self): """Remove the connection from the stack, closing out the cursor""" if self._cursor: LOGGER.debug('Closing the cursor on %s', self.pid) self._cursor.close() self._cursor = None if self._conn: LOGGER.debug('Freeing %s in the pool', self.pid) try: pool.PoolManager.instance().free(self.pid, self._conn) except pool.ConnectionNotFoundError: pass self._conn = None def _connect(self): """Connect to PostgreSQL, either by reusing a connection from the pool if possible, or by creating the new connection. :rtype: psycopg2.extensions.connection :raises: pool.NoIdleConnectionsError """ # Attempt to get a cached connection from the connection pool try: connection = self._pool_manager.get(self.pid, self) LOGGER.debug("Re-using connection for %s", self.pid) except pool.NoIdleConnectionsError: if self._pool_manager.is_full(self.pid): raise # Create a new PostgreSQL connection kwargs = utils.uri_to_kwargs(self._uri) LOGGER.debug("Creating a new connection for %s", self.pid) connection = self._psycopg2_connect(kwargs) self._pool_manager.add(self.pid, connection) self._pool_manager.lock(self.pid, connection, self) # Added in because psycopg2ct connects and leaves the connection in # a weird state: consts.STATUS_DATESTYLE, returning from # Connection._setup without setting the state as const.STATUS_OK if utils.PYPY: connection.reset() # Register the custom data types self._register_unicode(connection) self._register_uuid(connection) return connection def _get_cursor(self, connection, name=None): """Return a cursor for the given cursor_factory. Specify a name to use server-side cursors. :param connection: The connection to create a cursor on :type connection: psycopg2.extensions.connection :param str name: A cursor name for a server side cursor :rtype: psycopg2.extensions.cursor """ cursor = connection.cursor(name=name, cursor_factory=self._cursor_factory) if name is not None: cursor.scrollable = True cursor.withhold = True return cursor def _incr_exceptions(self): """Increment the number of exceptions for the current connection.""" self._pool_manager.get_connection(self.pid, self._conn).exceptions += 1 def _incr_executions(self): """Increment the number of executions for the current connection.""" self._pool_manager.get_connection(self.pid, self._conn).executions += 1 def _psycopg2_connect(self, kwargs): """Return a psycopg2 connection for the specified kwargs. Extend for use in async session adapters. :param dict kwargs: Keyword connection args :rtype: psycopg2.extensions.connection """ return psycopg2.connect(**kwargs) @staticmethod def _register_unicode(connection): """Register the cursor to be able to receive Unicode string. :type connection: psycopg2.extensions.connection :param connection: Where to register things """ psycopg2.extensions.register_type(psycopg2.extensions.UNICODE, connection) psycopg2.extensions.register_type(psycopg2.extensions.UNICODEARRAY, connection) @staticmethod def _register_uuid(connection): """Register the UUID extension from the psycopg2.extra module :type connection: psycopg2.extensions.connection :param connection: Where to register things """ psycopg2.extras.register_uuid(conn_or_curs=connection) @property def _status(self): """Return the current connection status as an integer value. The status should match one of the following constants: - queries.Session.INTRANS: Connection established, in transaction - queries.Session.PREPARED: Prepared for second phase of transaction - queries.Session.READY: Connected, no active transaction :rtype: int """ if self._conn.status == psycopg2.extensions.STATUS_BEGIN: return self.READY return self._conn.status <MSG> update docstring <DFF> @@ -253,7 +253,10 @@ class Session(object): self._cleanup() def _autocommit(self, autocommit): - """Set the isolation level automatically to commit after every query""" + """Set the isolation level automatically to commit or not after every query + + :param autocommit: Boolean (Default - True) + """ self._conn.autocommit = autocommit def _cleanup(self):

update docstring

.py

py

bsd-3-clause

gmr/queries

1540

<NME> session.py <BEF> """The Session class allows for a unified (and simplified) view of interfacing with a PostgreSQL database server. Connection details are passed in as a PostgreSQL URI and connections are pooled by default, allowing for reuse of connections across modules in the Python runtime without having to pass around the object handle. While you can still access the raw `psycopg2` connection and cursor objects to provide ultimate flexibility in how you use the queries.Session object, there are convenience methods designed to simplify the interaction with PostgreSQL. For `psycopg2` functionality outside of what is exposed in Session, simply use the Session.connection or Session.cursor properties to gain access to either object just as you would in a program using psycopg2 directly. Example usage: .. code:: python import queries with queries.Session('pgsql://postgres@localhost/postgres') as session: for row in session.Query('SELECT * FROM table'): print row """ import hashlib import logging import psycopg2 from psycopg2 import extensions, extras from queries import pool, results, utils LOGGER = logging.getLogger(__name__) DEFAULT_ENCODING = 'UTF8' DEFAULT_URI = 'postgresql://localhost:5432' class Session(object): """The Session class allows for a unified (and simplified) view of interfacing with a PostgreSQL database server. The Session object can act as a context manager, providing automated cleanup and simple, Pythonic way of interacting with the object. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ _conn = None _cursor = None _tpc_id = None _uri = None # Connection status constants INTRANS = extensions.STATUS_IN_TRANSACTION PREPARED = extensions.STATUS_PREPARED READY = extensions.STATUS_READY SETUP = extensions.STATUS_SETUP # Transaction status constants TX_ACTIVE = extensions.TRANSACTION_STATUS_ACTIVE TX_IDLE = extensions.TRANSACTION_STATUS_IDLE TX_INERROR = extensions.TRANSACTION_STATUS_INERROR TX_INTRANS = extensions.TRANSACTION_STATUS_INTRANS TX_UNKNOWN = extensions.TRANSACTION_STATUS_UNKNOWN def __init__(self, uri=DEFAULT_URI, cursor_factory=extras.RealDictCursor, pool_idle_ttl=pool.DEFAULT_IDLE_TTL, pool_max_size=pool.DEFAULT_MAX_SIZE, autocommit=True): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ self._pool_manager = pool.PoolManager.instance() self._uri = uri # Ensure the pool exists in the pool manager if self.pid not in self._pool_manager: self._pool_manager.create(self.pid, pool_idle_ttl, pool_max_size) self._conn = self._connect() self._cursor_factory = cursor_factory self._cursor = self._get_cursor(self._conn) self._autocommit(autocommit) @property def backend_pid(self): """Return the backend process ID of the PostgreSQL server that this session is connected to. :rtype: int """ return self._conn.get_backend_pid() def callproc(self, name, args=None): """Call a stored procedure on the server, returning the results in a :py:class:`queries.Results` instance. :param str name: The procedure name :param list args: The list of arguments to pass in :rtype: queries.Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ try: self._cursor.callproc(name, args) except psycopg2.Error as err: self._incr_exceptions() raise err finally: self._incr_executions() return results.Results(self._cursor) def close(self): """Explicitly close the connection and remove it from the connection pool if pooling is enabled. If the connection is already closed :raises: psycopg2.InterfaceError """ if not self._conn: raise psycopg2.InterfaceError('Connection not open') LOGGER.info('Closing connection %r in %s', self._conn, self.pid) self._pool_manager.free(self.pid, self._conn) self._pool_manager.remove_connection(self.pid, self._conn) # Un-assign the connection and cursor self._conn, self._cursor = None, None @property def connection(self): """Return the current open connection to PostgreSQL. :rtype: psycopg2.extensions.connection """ return self._conn @property def cursor(self): """Return the current, active cursor for the open connection. :rtype: psycopg2.extensions.cursor """ return self._cursor @property def encoding(self): """Return the current client encoding value. :rtype: str """ return self._conn.encoding @property def notices(self): """Return a list of up to the last 50 server notices sent to the client. :rtype: list """ return self._conn.notices @property def pid(self): """Return the pool ID used for connection pooling. :rtype: str """ return hashlib.md5(':'.join([self.__class__.__name__, self._uri]).encode('utf-8')).hexdigest() def query(self, sql, parameters=None): """A generator to issue a query on the server, mogrifying the parameters against the sql statement. Results are returned as a :py:class:`queries.Results` object which can act as an iterator and has multiple ways to access the result data. :param str sql: The SQL statement :param dict parameters: A dictionary of query parameters :rtype: queries.Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ try: self._cursor.execute(sql, parameters) except psycopg2.Error as err: self._incr_exceptions() raise err finally: self._incr_executions() return results.Results(self._cursor) def set_encoding(self, value=DEFAULT_ENCODING): """Set the client encoding for the session if the value specified is different than the current client encoding. :param str value: The encoding value to use """ if self._conn.encoding != value: self._conn.set_client_encoding(value) def __del__(self): """When deleting the context, ensure the instance is removed from caches, etc. """ self._cleanup() def __enter__(self): """For use as a context manager, return a handle to this object instance. :rtype: Session """ return self def __exit__(self, exc_type, exc_val, exc_tb): """When leaving the context, ensure the instance is removed from caches, etc. """ self._cleanup() def _autocommit(self, autocommit): """Set the isolation level automatically to commit after every query""" self._conn.autocommit = autocommit def _cleanup(self): """Remove the connection from the stack, closing out the cursor""" if self._cursor: LOGGER.debug('Closing the cursor on %s', self.pid) self._cursor.close() self._cursor = None if self._conn: LOGGER.debug('Freeing %s in the pool', self.pid) try: pool.PoolManager.instance().free(self.pid, self._conn) except pool.ConnectionNotFoundError: pass self._conn = None def _connect(self): """Connect to PostgreSQL, either by reusing a connection from the pool if possible, or by creating the new connection. :rtype: psycopg2.extensions.connection :raises: pool.NoIdleConnectionsError """ # Attempt to get a cached connection from the connection pool try: connection = self._pool_manager.get(self.pid, self) LOGGER.debug("Re-using connection for %s", self.pid) except pool.NoIdleConnectionsError: if self._pool_manager.is_full(self.pid): raise # Create a new PostgreSQL connection kwargs = utils.uri_to_kwargs(self._uri) LOGGER.debug("Creating a new connection for %s", self.pid) connection = self._psycopg2_connect(kwargs) self._pool_manager.add(self.pid, connection) self._pool_manager.lock(self.pid, connection, self) # Added in because psycopg2ct connects and leaves the connection in # a weird state: consts.STATUS_DATESTYLE, returning from # Connection._setup without setting the state as const.STATUS_OK if utils.PYPY: connection.reset() # Register the custom data types self._register_unicode(connection) self._register_uuid(connection) return connection def _get_cursor(self, connection, name=None): """Return a cursor for the given cursor_factory. Specify a name to use server-side cursors. :param connection: The connection to create a cursor on :type connection: psycopg2.extensions.connection :param str name: A cursor name for a server side cursor :rtype: psycopg2.extensions.cursor """ cursor = connection.cursor(name=name, cursor_factory=self._cursor_factory) if name is not None: cursor.scrollable = True cursor.withhold = True return cursor def _incr_exceptions(self): """Increment the number of exceptions for the current connection.""" self._pool_manager.get_connection(self.pid, self._conn).exceptions += 1 def _incr_executions(self): """Increment the number of executions for the current connection.""" self._pool_manager.get_connection(self.pid, self._conn).executions += 1 def _psycopg2_connect(self, kwargs): """Return a psycopg2 connection for the specified kwargs. Extend for use in async session adapters. :param dict kwargs: Keyword connection args :rtype: psycopg2.extensions.connection """ return psycopg2.connect(**kwargs) @staticmethod def _register_unicode(connection): """Register the cursor to be able to receive Unicode string. :type connection: psycopg2.extensions.connection :param connection: Where to register things """ psycopg2.extensions.register_type(psycopg2.extensions.UNICODE, connection) psycopg2.extensions.register_type(psycopg2.extensions.UNICODEARRAY, connection) @staticmethod def _register_uuid(connection): """Register the UUID extension from the psycopg2.extra module :type connection: psycopg2.extensions.connection :param connection: Where to register things """ psycopg2.extras.register_uuid(conn_or_curs=connection) @property def _status(self): """Return the current connection status as an integer value. The status should match one of the following constants: - queries.Session.INTRANS: Connection established, in transaction - queries.Session.PREPARED: Prepared for second phase of transaction - queries.Session.READY: Connected, no active transaction :rtype: int """ if self._conn.status == psycopg2.extensions.STATUS_BEGIN: return self.READY return self._conn.status <MSG> update docstring <DFF> @@ -253,7 +253,10 @@ class Session(object): self._cleanup() def _autocommit(self, autocommit): - """Set the isolation level automatically to commit after every query""" + """Set the isolation level automatically to commit or not after every query + + :param autocommit: Boolean (Default - True) + """ self._conn.autocommit = autocommit def _cleanup(self):

update docstring

.py

py

bsd-3-clause

gmr/queries

1541

<NME> tornado_session_tests.py <BEF> """ Tests for functionality in the tornado_session module """ import unittest import mock # Out of order import to ensure psycopg2cffi is registered from queries import pool, tornado_session from psycopg2 import extras from tornado import concurrent, gen, ioloop, testing class ResultsTests(unittest.TestCase): def setUp(self): self.cursor = mock.Mock() self.fd = 10 self.cleanup = mock.Mock() self.obj = tornado_session.Results(self.cursor, self.cleanup, self.fd) def test_cursor_is_assigned(self): self.assertEqual(self.obj.cursor, self.cursor) def test_fd_is_assigned(self): self.assertEqual(self.obj._fd, self.fd) def test_cleanup_is_assigned(self): self.assertEqual(self.obj._cleanup, self.cleanup) @gen.coroutine def test_free_invokes_cleanup(self): yield self.obj.free() self.cleanup.assert_called_once_with(self.cursor, self.fd) class SessionInitTests(unittest.TestCase): def setUp(self): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): self.assertDictEqual(self.obj._futures, {}) def test_creates_empty_connections_dict(self): self.assertDictEqual(self.obj._connections, {}) def test_sets_default_cursor_factory(self): self.assertEqual(self.obj._cursor_factory, extras.RealDictCursor) def test_sets_tornado_ioloop_instance(self): self.assertEqual(self.obj._ioloop, ioloop.IOLoop.instance()) def test_sets_poolmananger_instance(self): self.assertEqual(self.obj._pool_manager, pool.PoolManager.instance()) def test_sets_uri(self): self.assertEqual(self.obj._uri, tornado_session.session.DEFAULT_URI) def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) def test_connection_is_none(self): self.assertIsNone(self.obj.connection) def test_cursor_is_none(self): self.assertIsNone(self.obj.cursor) class SessionConnectTests(testing.AsyncTestCase): def setUp(self): super(SessionConnectTests, self).setUp() self.conn = mock.Mock() self.conn.fileno = mock.Mock(return_value=10) self.obj = tornado_session.TornadoSession(io_loop=self.io_loop) def create_connection(future): future.set_result(self.conn) self.obj._create_connection = create_connection @testing.gen_test def test_connect_returns_new_connection(self): conn = yield self.obj._connect() self.assertEqual(conn, self.conn) @testing.gen_test def test_connect_returns_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) second_result = yield self.obj._connect() self.assertEqual(second_result, conn) @testing.gen_test def test_connect_gets_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: with mock.patch.object(self.io_loop, 'add_handler'): yield self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) @testing.gen_test def test_connect_pooled_connection_invokes_add_handler(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: get.return_value = self.conn with mock.patch.object(self.io_loop, 'add_handler') as add_handler: yield self.obj._connect() add_handler.assert_called_once_with(self.conn.fileno(), self.obj._on_io_events, ioloop.IOLoop.WRITE) def test_psycopg2_connect_invokes_psycopg2_connect(self): with mock.patch('psycopg2.connect') as connect: self.obj._psycopg2_connect({}) connect.assert_called_once_with(async=True) def test_on_io_events_returns_if_fd_not_present(self): with mock.patch.object(self.obj, '_poll_connection') as poll: with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_not_called() def test_on_io_events_calls_poll_connection(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._connections[1337] = True self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_called_once_with(1337) def test_exec_cleanup_closes_cursor(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() cursor = mock.Mock() cursor.close = mock.Mock() self.obj._exec_cleanup(cursor, 14) cursor.close.assert_called_once_with() def test_exec_cleanup_frees_connection(self): with mock.patch.object(self.obj._pool_manager, 'free') as pm_free: with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = conn = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) pm_free.assert_called_once_with(self.obj.pid, conn) def test_exec_cleanup_remove_handler_invoked(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler') as rh: self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) rh.assert_called_once_with(14) def test_exec_removes_connection(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._connections) def test_exec_removes_future(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._futures[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._futures) def test_pool_manager_add_failures_are_propagated(self): futures = [] def add_future(future, callback): futures.append((future, callback)) obj = tornado_session.TornadoSession() obj._ioloop = mock.Mock() obj._ioloop.add_future = add_future future = concurrent.Future() with mock.patch.object(obj._pool_manager, 'add') as add_method: add_method.side_effect = pool.PoolFullError(mock.Mock()) obj._create_connection(future) self.assertEqual(len(futures), 1) connected_future, callback = futures.pop() connected_future.set_result(True) callback(connected_future) self.assertIs(future.exception(), add_method.side_effect) class SessionPublicMethodTests(testing.AsyncTestCase): @testing.gen_test def test_callproc_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.callproc('foo', ['bar']) _execute.assert_called_once_with('callproc', 'foo', ['bar']) @testing.gen_test def test_query_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) """ @testing.gen_test def test_query_error_key_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): yield obj.query('SELECT * FROM foo WHERE bar=%(baz)s', {}) @testing.gen_test def test_query_error_index_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): r = yield obj.query('SELECT * FROM foo WHERE bar=%s', []) """ <MSG> async is a keyword in 3.7 and now in all pypys <DFF> @@ -117,7 +117,7 @@ class SessionConnectTests(testing.AsyncTestCase): def test_psycopg2_connect_invokes_psycopg2_connect(self): with mock.patch('psycopg2.connect') as connect: self.obj._psycopg2_connect({}) - connect.assert_called_once_with(async=True) + connect.assert_called_once_with({'async': True}) def test_on_io_events_returns_if_fd_not_present(self): with mock.patch.object(self.obj, '_poll_connection') as poll:

async is a keyword in 3.7 and now in all pypys

.py

py

bsd-3-clause

gmr/queries

1542

<NME> tornado_session_tests.py <BEF> """ Tests for functionality in the tornado_session module """ import unittest import mock # Out of order import to ensure psycopg2cffi is registered from queries import pool, tornado_session from psycopg2 import extras from tornado import concurrent, gen, ioloop, testing class ResultsTests(unittest.TestCase): def setUp(self): self.cursor = mock.Mock() self.fd = 10 self.cleanup = mock.Mock() self.obj = tornado_session.Results(self.cursor, self.cleanup, self.fd) def test_cursor_is_assigned(self): self.assertEqual(self.obj.cursor, self.cursor) def test_fd_is_assigned(self): self.assertEqual(self.obj._fd, self.fd) def test_cleanup_is_assigned(self): self.assertEqual(self.obj._cleanup, self.cleanup) @gen.coroutine def test_free_invokes_cleanup(self): yield self.obj.free() self.cleanup.assert_called_once_with(self.cursor, self.fd) class SessionInitTests(unittest.TestCase): def setUp(self): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): self.assertDictEqual(self.obj._futures, {}) def test_creates_empty_connections_dict(self): self.assertDictEqual(self.obj._connections, {}) def test_sets_default_cursor_factory(self): self.assertEqual(self.obj._cursor_factory, extras.RealDictCursor) def test_sets_tornado_ioloop_instance(self): self.assertEqual(self.obj._ioloop, ioloop.IOLoop.instance()) def test_sets_poolmananger_instance(self): self.assertEqual(self.obj._pool_manager, pool.PoolManager.instance()) def test_sets_uri(self): self.assertEqual(self.obj._uri, tornado_session.session.DEFAULT_URI) def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) def test_connection_is_none(self): self.assertIsNone(self.obj.connection) def test_cursor_is_none(self): self.assertIsNone(self.obj.cursor) class SessionConnectTests(testing.AsyncTestCase): def setUp(self): super(SessionConnectTests, self).setUp() self.conn = mock.Mock() self.conn.fileno = mock.Mock(return_value=10) self.obj = tornado_session.TornadoSession(io_loop=self.io_loop) def create_connection(future): future.set_result(self.conn) self.obj._create_connection = create_connection @testing.gen_test def test_connect_returns_new_connection(self): conn = yield self.obj._connect() self.assertEqual(conn, self.conn) @testing.gen_test def test_connect_returns_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) second_result = yield self.obj._connect() self.assertEqual(second_result, conn) @testing.gen_test def test_connect_gets_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: with mock.patch.object(self.io_loop, 'add_handler'): yield self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) @testing.gen_test def test_connect_pooled_connection_invokes_add_handler(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: get.return_value = self.conn with mock.patch.object(self.io_loop, 'add_handler') as add_handler: yield self.obj._connect() add_handler.assert_called_once_with(self.conn.fileno(), self.obj._on_io_events, ioloop.IOLoop.WRITE) def test_psycopg2_connect_invokes_psycopg2_connect(self): with mock.patch('psycopg2.connect') as connect: self.obj._psycopg2_connect({}) connect.assert_called_once_with(async=True) def test_on_io_events_returns_if_fd_not_present(self): with mock.patch.object(self.obj, '_poll_connection') as poll: with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_not_called() def test_on_io_events_calls_poll_connection(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._connections[1337] = True self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_called_once_with(1337) def test_exec_cleanup_closes_cursor(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() cursor = mock.Mock() cursor.close = mock.Mock() self.obj._exec_cleanup(cursor, 14) cursor.close.assert_called_once_with() def test_exec_cleanup_frees_connection(self): with mock.patch.object(self.obj._pool_manager, 'free') as pm_free: with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = conn = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) pm_free.assert_called_once_with(self.obj.pid, conn) def test_exec_cleanup_remove_handler_invoked(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler') as rh: self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) rh.assert_called_once_with(14) def test_exec_removes_connection(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._connections) def test_exec_removes_future(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._futures[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._futures) def test_pool_manager_add_failures_are_propagated(self): futures = [] def add_future(future, callback): futures.append((future, callback)) obj = tornado_session.TornadoSession() obj._ioloop = mock.Mock() obj._ioloop.add_future = add_future future = concurrent.Future() with mock.patch.object(obj._pool_manager, 'add') as add_method: add_method.side_effect = pool.PoolFullError(mock.Mock()) obj._create_connection(future) self.assertEqual(len(futures), 1) connected_future, callback = futures.pop() connected_future.set_result(True) callback(connected_future) self.assertIs(future.exception(), add_method.side_effect) class SessionPublicMethodTests(testing.AsyncTestCase): @testing.gen_test def test_callproc_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.callproc('foo', ['bar']) _execute.assert_called_once_with('callproc', 'foo', ['bar']) @testing.gen_test def test_query_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) """ @testing.gen_test def test_query_error_key_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): yield obj.query('SELECT * FROM foo WHERE bar=%(baz)s', {}) @testing.gen_test def test_query_error_index_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): r = yield obj.query('SELECT * FROM foo WHERE bar=%s', []) """ <MSG> async is a keyword in 3.7 and now in all pypys <DFF> @@ -117,7 +117,7 @@ class SessionConnectTests(testing.AsyncTestCase): def test_psycopg2_connect_invokes_psycopg2_connect(self): with mock.patch('psycopg2.connect') as connect: self.obj._psycopg2_connect({}) - connect.assert_called_once_with(async=True) + connect.assert_called_once_with({'async': True}) def test_on_io_events_returns_if_fd_not_present(self): with mock.patch.object(self.obj, '_poll_connection') as poll:

async is a keyword in 3.7 and now in all pypys

.py

py

bsd-3-clause

gmr/queries

1543

<NME> pool.py <BEF> """ Connection Pooling """ import datetime import logging import os import threading import time import weakref import psycopg2 LOGGER = logging.getLogger(__name__) DEFAULT_IDLE_TTL = 60 DEFAULT_MAX_SIZE = int(os.environ.get('QUERIES_MAX_POOL_SIZE', 1)) class Connection(object): """Contains the handle to the connection, the current state of the connection and methods for manipulating the state of the connection. """ _lock = threading.Lock() def __init__(self, handle): self.handle = handle self.used_by = None self.executions = 0 self.exceptions = 0 def close(self): """Close the connection :raises: ConnectionBusyError """ LOGGER.debug('Connection %s closing', self.id) if self.busy and not self.closed: raise ConnectionBusyError(self) with self._lock: if not self.handle.closed: try: self.handle.close() except psycopg2.InterfaceError as error: LOGGER.error('Error closing socket: %s', error) @property def closed(self): """Return if the psycopg2 connection is closed. :rtype: bool """ return self.handle.closed != 0 @property def busy(self): """Return if the connection is currently executing a query or is locked by a session that still exists. :rtype: bool """ if self.handle.isexecuting(): return True elif self.used_by is None: return False return not self.used_by() is None @property def executing(self): """Return if the connection is currently executing a query :rtype: bool """ return self.handle.isexecuting() def free(self): """Remove the lock on the connection if the connection is not active :raises: ConnectionBusyError """ LOGGER.debug('Connection %s freeing', self.id) if self.handle.isexecuting(): raise ConnectionBusyError(self) with self._lock: self.used_by = None LOGGER.debug('Connection %s freed', self.id) @property def id(self): """Return id of the psycopg2 connection object :rtype: int """ return id(self.handle) def lock(self, session): """Lock the connection, ensuring that it is not busy and storing a weakref for the session. :param queries.Session session: The session to lock the connection with :raises: ConnectionBusyError """ if self.busy: raise ConnectionBusyError(self) with self._lock: self.used_by = weakref.ref(session) LOGGER.debug('Connection %s locked', self.id) @property def locked(self): """Return if the connection is currently exclusively locked :rtype: bool """ return self.used_by is not None class Pool(object): """A connection pool for gaining access to and managing connections""" _lock = threading.Lock() idle_start = None idle_ttl = DEFAULT_IDLE_TTL max_size = DEFAULT_MAX_SIZE def __init__(self, pool_id, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): self.connections = {} self._id = pool_id self.idle_ttl = idle_ttl self.max_size = max_size self.time_method = time_method or time.time def __contains__(self, connection): """Return True if the pool contains the connection""" return id(connection) in self.connections def __len__(self): """Return the number of connections in the pool""" return len(self.connections) def add(self, connection): """Add a new connection to the pool :param connection: The connection to add to the pool :type connection: psycopg2.extensions.connection :raises: PoolFullError """ if id(connection) in self.connections: raise ValueError('Connection already exists in pool') if len(self.connections) == self.max_size: LOGGER.warning('Race condition found when adding new connection') try: connection.close() except (psycopg2.Error, psycopg2.Warning) as error: LOGGER.error('Error closing the conn that cant be used: %s', error) raise PoolFullError(self) with self._lock: self.connections[id(connection)] = Connection(connection) LOGGER.debug('Pool %s added connection %s', self.id, id(connection)) @property def busy_connections(self): """Return a list of active/busy connections :rtype: list """ return [c for c in self.connections.values() if c.busy and not c.closed] def clean(self): """Clean the pool by removing any closed connections and if the pool's idle has exceeded its idle TTL, remove all connections. """ LOGGER.debug('Cleaning the pool') for connection in [self.connections[k] for k in self.connections if self.connections[k].closed]: LOGGER.debug('Removing %s', connection.id) self.remove(connection.handle) if self.idle_duration > self.idle_ttl: self.close() LOGGER.debug('Pool %s cleaned', self.id) def close(self): """Close the pool by closing and removing all of the connections""" for cid in list(self.connections.keys()): self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) @property def closed_connections(self): """Return a list of closed connections :rtype: list """ return [c for c in self.connections.values() if c.closed] def connection_handle(self, connection): """Return a connection object for the given psycopg2 connection :param connection: The connection to return a parent for :type connection: psycopg2.extensions.connection :rtype: Connection """ return self.connections[id(connection)] @property def executing_connections(self): """Return a list of connections actively executing queries :rtype: list """ return [c for c in self.connections.values() if c.executing] def free(self, connection): """Free the connection from use by the session that was using it. :param connection: The connection to free :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ LOGGER.debug('Pool %s freeing connection %s', self.id, id(connection)) try: self.connection_handle(connection).free() except KeyError: raise ConnectionNotFoundError(self.id, id(connection)) if self.idle_connections == list(self.connections.values()): with self._lock: self.idle_start = self.time_method() LOGGER.debug('Pool %s freed connection %s', self.id, id(connection)) def get(self, session): """Return an idle connection and assign the session to the connection :param queries.Session session: The session to assign :rtype: psycopg2.extensions.connection :raises: NoIdleConnectionsError """ idle = self.idle_connections if idle: connection = idle.pop(0) connection.lock(session) if self.idle_start: with self._lock: self.idle_start = None return connection.handle raise NoIdleConnectionsError(self.id) @property def id(self): """Return the ID for this pool :rtype: str """ return self._id @property def idle_connections(self): """Return a list of idle connections :rtype: list """ return [c for c in self.connections.values() if not c.busy and not c.closed] @property def idle_duration(self): """Return the number of seconds that the pool has had no active connections. :rtype: float """ if self.idle_start is None: return 0 return self.time_method() - self.idle_start @property def is_full(self): """Return True if there are no more open slots for connections. :rtype: bool """ return len(self.connections) >= self.max_size def lock(self, connection, session): """Explicitly lock the specified connection :type connection: psycopg2.extensions.connection :param connection: The connection to lock :param queries.Session session: The session to hold the lock """ cid = id(connection) try: self.connection_handle(connection).lock(session) except KeyError: raise ConnectionNotFoundError(self.id, cid) else: if self.idle_start: with self._lock: self.idle_start = None LOGGER.debug('Pool %s locked connection %s', self.id, cid) @property def locked_connections(self): """Return a list of all locked connections :rtype: list """ return [c for c in self.connections.values() if c.locked] def remove(self, connection): """Remove the connection from the pool :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError :raises: ConnectionBusyError """ cid = id(connection) if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) self.connection_handle(connection).close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) def report(self): """Return a report about the pool state and configuration. :rtype: dict """ return { 'connections': { 'busy': len(self.busy_connections), 'closed': len(self.closed_connections), 'executing': len(self.executing_connections), 'idle': len(self.idle_connections), 'locked': len(self.busy_connections) }, 'exceptions': sum([c.exceptions for c in self.connections.values()]), 'executions': sum([c.executions for c in self.connections.values()]), 'full': self.is_full, 'idle': { 'duration': self.idle_duration, 'ttl': self.idle_ttl }, 'max_size': self.max_size } def shutdown(self): """Forcefully shutdown the entire pool, closing all non-executing connections. :raises: ConnectionBusyError """ with self._lock: for cid in list(self.connections.keys()): if self.connections[cid].executing: raise ConnectionBusyError(cid) if self.connections[cid].locked: self.connections[cid].free() self.connections[cid].close() del self.connections[cid] def set_idle_ttl(self, ttl): """Set the idle ttl :param int ttl: The TTL when idle """ with self._lock: self.idle_ttl = ttl def set_max_size(self, size): """Set the maximum number of connections :param int size: The maximum number of connections """ with self._lock: self.max_size = size class PoolManager(object): """The connection pool object implements behavior around connections and their use in queries.Session objects. We carry a pool id instead of the connection URI so that we will not be carrying the URI in memory, creating a possible security issue. """ _lock = threading.Lock() _pools = {} def __contains__(self, pid): """Returns True if the pool exists :param str pid: The pool id to check for :rtype: bool """ return pid in self.__class__._pools @classmethod def instance(cls): """Only allow a single PoolManager instance to exist, returning the handle for it. :rtype: PoolManager """ if not hasattr(cls, '_instance'): with cls._lock: cls._instance = cls() return cls._instance @classmethod def add(cls, pid, connection): """Add a new connection and session to a pool. :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].add(connection) @classmethod def clean(cls, pid): """Clean the specified pool, removing any closed connections or stale locks. :param str pid: The pool id to clean """ with cls._lock: try: cls._ensure_pool_exists(pid) except KeyError: LOGGER.debug('Pool clean invoked against missing pool %s', pid) return cls._pools[pid].clean() cls._maybe_remove_pool(pid) @classmethod def create(cls, pid, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): """Create a new pool, with the ability to pass in values to override the default idle TTL and the default maximum size. A pool's idle TTL defines the amount of time that a pool can be open without any sessions before it is removed. A pool's max size defines the maximum number of connections that can be added to the pool to prevent unbounded open connections. :param str pid: The pool ID :param int idle_ttl: Time in seconds for the idle TTL :param int max_size: The maximum pool size :param callable time_method: Override the use of :py:meth:`time.time` method for time values. :raises: KeyError """ if pid in cls._pools: raise KeyError('Pool %s already exists' % pid) with cls._lock: LOGGER.debug("Creating Pool: %s (%i/%i)", pid, idle_ttl, max_size) cls._pools[pid] = Pool(pid, idle_ttl, max_size, time_method) @classmethod def free(cls, pid, connection): """Free a connection that was locked by a session :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection """ with cls._lock: LOGGER.debug('Freeing %s from pool %s', id(connection), pid) cls._ensure_pool_exists(pid) cls._pools[pid].free(connection) @classmethod def get(cls, pid, session): """Get an idle, unused connection from the pool. Once a connection has been retrieved, it will be marked as in-use until it is freed. :param str pid: The pool ID :param queries.Session session: The session to assign to the connection :rtype: psycopg2.extensions.connection """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].get(session) @classmethod def get_connection(cls, pid, connection): def set_idle_ttl(cls, pid, ttl): """Set the idle TTL for a pool, after which it will be destroyed. :param str pid: The process id :param int ttl: The TTL for an idle pool """ """ with cls._lock: return cls._pools[pid].connection_handle(connection) @classmethod def has_connection(cls, pid, connection): """Check to see if a pool has the specified connection :param str pid: The pool ID :param connection: The connection to check for :type connection: psycopg2.extensions.connection :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return connection in cls._pools[pid] @classmethod def has_idle_connection(cls, pid): """Check to see if a pool has an idle connection :param str pid: The pool ID :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return bool(cls._pools[pid].idle_connections) @classmethod def is_full(cls, pid): """Return a bool indicating if the specified pool is full :param str pid: The pool id :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].is_full @classmethod def lock(cls, pid, connection, session): """Explicitly lock the specified connection in the pool :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool :param queries.Session session: The session to hold the lock """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].lock(connection, session) @classmethod def remove(cls, pid): """Remove a pool, closing all connections :param str pid: The pool ID """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].close() del cls._pools[pid] @classmethod def remove_connection(cls, pid, connection): """Remove a connection from the pool, closing it if is open. :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ cls._ensure_pool_exists(pid) cls._pools[pid].remove(connection) @classmethod def set_idle_ttl(cls, pid, ttl): """Set the idle TTL for a pool, after which it will be destroyed. :param str pid: The pool id :param int ttl: The TTL for an idle pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_idle_ttl(ttl) @classmethod def set_max_size(cls, pid, size): """Set the maximum number of connections for the specified pool :param str pid: The pool to set the size for :param int size: The maximum number of connections """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_max_size(size) @classmethod def shutdown(cls): """Close all connections on in all pools""" for pid in list(cls._pools.keys()): cls._pools[pid].shutdown() LOGGER.info('Shutdown complete, all pooled connections closed') @classmethod def size(cls, pid): """Return the number of connections in the pool :param str pid: The pool id :rtype int """ with cls._lock: cls._ensure_pool_exists(pid) return len(cls._pools[pid]) @classmethod def report(cls): """Return the state of the all of the registered pools. :rtype: dict """ return { 'timestamp': datetime.datetime.utcnow().isoformat(), 'process': os.getpid(), 'pools': dict([(i, p.report()) for i, p in cls._pools.items()]) } @classmethod def _ensure_pool_exists(cls, pid): """Raise an exception if the pool has yet to be created or has been removed. :param str pid: The pool ID to check for :raises: KeyError """ if pid not in cls._pools: raise KeyError('Pool %s has not been created' % pid) @classmethod def _maybe_remove_pool(cls, pid): """If the pool has no open connections, remove it :param str pid: The pool id to clean """ if not len(cls._pools[pid]): del cls._pools[pid] class QueriesException(Exception): """Base Exception for all other Queries exceptions""" pass class ConnectionException(QueriesException): def __init__(self, cid): self.cid = cid class PoolException(QueriesException): def __init__(self, pid): self.pid = pid class PoolConnectionException(PoolException): def __init__(self, pid, cid): self.pid = pid self.cid = cid class ActivePoolError(PoolException): """Raised when removing a pool that has active connections""" def __str__(self): return 'Pool %s has at least one active connection' % self.pid class ConnectionBusyError(ConnectionException): """Raised when trying to lock a connection that is already busy""" def __str__(self): return 'Connection %s is busy' % self.cid class ConnectionNotFoundError(PoolConnectionException): """Raised if a specific connection is not found in the pool""" def __str__(self): return 'Connection %s not found in pool %s' % (self.cid, self.pid) class NoIdleConnectionsError(PoolException): """Raised if a pool does not have any idle, open connections""" def __str__(self): return 'Pool %s has no idle connections' % self.pid class PoolFullError(PoolException): """Raised when adding a connection to a pool that has hit max-size""" def __str__(self): return 'Pool %s is at its maximum capacity' % self.pid <MSG> Docstring fix, process -> pool <DFF> @@ -539,7 +539,7 @@ class PoolManager(object): def set_idle_ttl(cls, pid, ttl): """Set the idle TTL for a pool, after which it will be destroyed. - :param str pid: The process id + :param str pid: The pool id :param int ttl: The TTL for an idle pool """

Docstring fix, process -> pool

.py

py

bsd-3-clause

gmr/queries

1544

<NME> pool.py <BEF> """ Connection Pooling """ import datetime import logging import os import threading import time import weakref import psycopg2 LOGGER = logging.getLogger(__name__) DEFAULT_IDLE_TTL = 60 DEFAULT_MAX_SIZE = int(os.environ.get('QUERIES_MAX_POOL_SIZE', 1)) class Connection(object): """Contains the handle to the connection, the current state of the connection and methods for manipulating the state of the connection. """ _lock = threading.Lock() def __init__(self, handle): self.handle = handle self.used_by = None self.executions = 0 self.exceptions = 0 def close(self): """Close the connection :raises: ConnectionBusyError """ LOGGER.debug('Connection %s closing', self.id) if self.busy and not self.closed: raise ConnectionBusyError(self) with self._lock: if not self.handle.closed: try: self.handle.close() except psycopg2.InterfaceError as error: LOGGER.error('Error closing socket: %s', error) @property def closed(self): """Return if the psycopg2 connection is closed. :rtype: bool """ return self.handle.closed != 0 @property def busy(self): """Return if the connection is currently executing a query or is locked by a session that still exists. :rtype: bool """ if self.handle.isexecuting(): return True elif self.used_by is None: return False return not self.used_by() is None @property def executing(self): """Return if the connection is currently executing a query :rtype: bool """ return self.handle.isexecuting() def free(self): """Remove the lock on the connection if the connection is not active :raises: ConnectionBusyError """ LOGGER.debug('Connection %s freeing', self.id) if self.handle.isexecuting(): raise ConnectionBusyError(self) with self._lock: self.used_by = None LOGGER.debug('Connection %s freed', self.id) @property def id(self): """Return id of the psycopg2 connection object :rtype: int """ return id(self.handle) def lock(self, session): """Lock the connection, ensuring that it is not busy and storing a weakref for the session. :param queries.Session session: The session to lock the connection with :raises: ConnectionBusyError """ if self.busy: raise ConnectionBusyError(self) with self._lock: self.used_by = weakref.ref(session) LOGGER.debug('Connection %s locked', self.id) @property def locked(self): """Return if the connection is currently exclusively locked :rtype: bool """ return self.used_by is not None class Pool(object): """A connection pool for gaining access to and managing connections""" _lock = threading.Lock() idle_start = None idle_ttl = DEFAULT_IDLE_TTL max_size = DEFAULT_MAX_SIZE def __init__(self, pool_id, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): self.connections = {} self._id = pool_id self.idle_ttl = idle_ttl self.max_size = max_size self.time_method = time_method or time.time def __contains__(self, connection): """Return True if the pool contains the connection""" return id(connection) in self.connections def __len__(self): """Return the number of connections in the pool""" return len(self.connections) def add(self, connection): """Add a new connection to the pool :param connection: The connection to add to the pool :type connection: psycopg2.extensions.connection :raises: PoolFullError """ if id(connection) in self.connections: raise ValueError('Connection already exists in pool') if len(self.connections) == self.max_size: LOGGER.warning('Race condition found when adding new connection') try: connection.close() except (psycopg2.Error, psycopg2.Warning) as error: LOGGER.error('Error closing the conn that cant be used: %s', error) raise PoolFullError(self) with self._lock: self.connections[id(connection)] = Connection(connection) LOGGER.debug('Pool %s added connection %s', self.id, id(connection)) @property def busy_connections(self): """Return a list of active/busy connections :rtype: list """ return [c for c in self.connections.values() if c.busy and not c.closed] def clean(self): """Clean the pool by removing any closed connections and if the pool's idle has exceeded its idle TTL, remove all connections. """ LOGGER.debug('Cleaning the pool') for connection in [self.connections[k] for k in self.connections if self.connections[k].closed]: LOGGER.debug('Removing %s', connection.id) self.remove(connection.handle) if self.idle_duration > self.idle_ttl: self.close() LOGGER.debug('Pool %s cleaned', self.id) def close(self): """Close the pool by closing and removing all of the connections""" for cid in list(self.connections.keys()): self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) @property def closed_connections(self): """Return a list of closed connections :rtype: list """ return [c for c in self.connections.values() if c.closed] def connection_handle(self, connection): """Return a connection object for the given psycopg2 connection :param connection: The connection to return a parent for :type connection: psycopg2.extensions.connection :rtype: Connection """ return self.connections[id(connection)] @property def executing_connections(self): """Return a list of connections actively executing queries :rtype: list """ return [c for c in self.connections.values() if c.executing] def free(self, connection): """Free the connection from use by the session that was using it. :param connection: The connection to free :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ LOGGER.debug('Pool %s freeing connection %s', self.id, id(connection)) try: self.connection_handle(connection).free() except KeyError: raise ConnectionNotFoundError(self.id, id(connection)) if self.idle_connections == list(self.connections.values()): with self._lock: self.idle_start = self.time_method() LOGGER.debug('Pool %s freed connection %s', self.id, id(connection)) def get(self, session): """Return an idle connection and assign the session to the connection :param queries.Session session: The session to assign :rtype: psycopg2.extensions.connection :raises: NoIdleConnectionsError """ idle = self.idle_connections if idle: connection = idle.pop(0) connection.lock(session) if self.idle_start: with self._lock: self.idle_start = None return connection.handle raise NoIdleConnectionsError(self.id) @property def id(self): """Return the ID for this pool :rtype: str """ return self._id @property def idle_connections(self): """Return a list of idle connections :rtype: list """ return [c for c in self.connections.values() if not c.busy and not c.closed] @property def idle_duration(self): """Return the number of seconds that the pool has had no active connections. :rtype: float """ if self.idle_start is None: return 0 return self.time_method() - self.idle_start @property def is_full(self): """Return True if there are no more open slots for connections. :rtype: bool """ return len(self.connections) >= self.max_size def lock(self, connection, session): """Explicitly lock the specified connection :type connection: psycopg2.extensions.connection :param connection: The connection to lock :param queries.Session session: The session to hold the lock """ cid = id(connection) try: self.connection_handle(connection).lock(session) except KeyError: raise ConnectionNotFoundError(self.id, cid) else: if self.idle_start: with self._lock: self.idle_start = None LOGGER.debug('Pool %s locked connection %s', self.id, cid) @property def locked_connections(self): """Return a list of all locked connections :rtype: list """ return [c for c in self.connections.values() if c.locked] def remove(self, connection): """Remove the connection from the pool :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError :raises: ConnectionBusyError """ cid = id(connection) if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) self.connection_handle(connection).close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) def report(self): """Return a report about the pool state and configuration. :rtype: dict """ return { 'connections': { 'busy': len(self.busy_connections), 'closed': len(self.closed_connections), 'executing': len(self.executing_connections), 'idle': len(self.idle_connections), 'locked': len(self.busy_connections) }, 'exceptions': sum([c.exceptions for c in self.connections.values()]), 'executions': sum([c.executions for c in self.connections.values()]), 'full': self.is_full, 'idle': { 'duration': self.idle_duration, 'ttl': self.idle_ttl }, 'max_size': self.max_size } def shutdown(self): """Forcefully shutdown the entire pool, closing all non-executing connections. :raises: ConnectionBusyError """ with self._lock: for cid in list(self.connections.keys()): if self.connections[cid].executing: raise ConnectionBusyError(cid) if self.connections[cid].locked: self.connections[cid].free() self.connections[cid].close() del self.connections[cid] def set_idle_ttl(self, ttl): """Set the idle ttl :param int ttl: The TTL when idle """ with self._lock: self.idle_ttl = ttl def set_max_size(self, size): """Set the maximum number of connections :param int size: The maximum number of connections """ with self._lock: self.max_size = size class PoolManager(object): """The connection pool object implements behavior around connections and their use in queries.Session objects. We carry a pool id instead of the connection URI so that we will not be carrying the URI in memory, creating a possible security issue. """ _lock = threading.Lock() _pools = {} def __contains__(self, pid): """Returns True if the pool exists :param str pid: The pool id to check for :rtype: bool """ return pid in self.__class__._pools @classmethod def instance(cls): """Only allow a single PoolManager instance to exist, returning the handle for it. :rtype: PoolManager """ if not hasattr(cls, '_instance'): with cls._lock: cls._instance = cls() return cls._instance @classmethod def add(cls, pid, connection): """Add a new connection and session to a pool. :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].add(connection) @classmethod def clean(cls, pid): """Clean the specified pool, removing any closed connections or stale locks. :param str pid: The pool id to clean """ with cls._lock: try: cls._ensure_pool_exists(pid) except KeyError: LOGGER.debug('Pool clean invoked against missing pool %s', pid) return cls._pools[pid].clean() cls._maybe_remove_pool(pid) @classmethod def create(cls, pid, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): """Create a new pool, with the ability to pass in values to override the default idle TTL and the default maximum size. A pool's idle TTL defines the amount of time that a pool can be open without any sessions before it is removed. A pool's max size defines the maximum number of connections that can be added to the pool to prevent unbounded open connections. :param str pid: The pool ID :param int idle_ttl: Time in seconds for the idle TTL :param int max_size: The maximum pool size :param callable time_method: Override the use of :py:meth:`time.time` method for time values. :raises: KeyError """ if pid in cls._pools: raise KeyError('Pool %s already exists' % pid) with cls._lock: LOGGER.debug("Creating Pool: %s (%i/%i)", pid, idle_ttl, max_size) cls._pools[pid] = Pool(pid, idle_ttl, max_size, time_method) @classmethod def free(cls, pid, connection): """Free a connection that was locked by a session :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection """ with cls._lock: LOGGER.debug('Freeing %s from pool %s', id(connection), pid) cls._ensure_pool_exists(pid) cls._pools[pid].free(connection) @classmethod def get(cls, pid, session): """Get an idle, unused connection from the pool. Once a connection has been retrieved, it will be marked as in-use until it is freed. :param str pid: The pool ID :param queries.Session session: The session to assign to the connection :rtype: psycopg2.extensions.connection """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].get(session) @classmethod def get_connection(cls, pid, connection): def set_idle_ttl(cls, pid, ttl): """Set the idle TTL for a pool, after which it will be destroyed. :param str pid: The process id :param int ttl: The TTL for an idle pool """ """ with cls._lock: return cls._pools[pid].connection_handle(connection) @classmethod def has_connection(cls, pid, connection): """Check to see if a pool has the specified connection :param str pid: The pool ID :param connection: The connection to check for :type connection: psycopg2.extensions.connection :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return connection in cls._pools[pid] @classmethod def has_idle_connection(cls, pid): """Check to see if a pool has an idle connection :param str pid: The pool ID :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return bool(cls._pools[pid].idle_connections) @classmethod def is_full(cls, pid): """Return a bool indicating if the specified pool is full :param str pid: The pool id :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].is_full @classmethod def lock(cls, pid, connection, session): """Explicitly lock the specified connection in the pool :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool :param queries.Session session: The session to hold the lock """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].lock(connection, session) @classmethod def remove(cls, pid): """Remove a pool, closing all connections :param str pid: The pool ID """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].close() del cls._pools[pid] @classmethod def remove_connection(cls, pid, connection): """Remove a connection from the pool, closing it if is open. :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ cls._ensure_pool_exists(pid) cls._pools[pid].remove(connection) @classmethod def set_idle_ttl(cls, pid, ttl): """Set the idle TTL for a pool, after which it will be destroyed. :param str pid: The pool id :param int ttl: The TTL for an idle pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_idle_ttl(ttl) @classmethod def set_max_size(cls, pid, size): """Set the maximum number of connections for the specified pool :param str pid: The pool to set the size for :param int size: The maximum number of connections """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_max_size(size) @classmethod def shutdown(cls): """Close all connections on in all pools""" for pid in list(cls._pools.keys()): cls._pools[pid].shutdown() LOGGER.info('Shutdown complete, all pooled connections closed') @classmethod def size(cls, pid): """Return the number of connections in the pool :param str pid: The pool id :rtype int """ with cls._lock: cls._ensure_pool_exists(pid) return len(cls._pools[pid]) @classmethod def report(cls): """Return the state of the all of the registered pools. :rtype: dict """ return { 'timestamp': datetime.datetime.utcnow().isoformat(), 'process': os.getpid(), 'pools': dict([(i, p.report()) for i, p in cls._pools.items()]) } @classmethod def _ensure_pool_exists(cls, pid): """Raise an exception if the pool has yet to be created or has been removed. :param str pid: The pool ID to check for :raises: KeyError """ if pid not in cls._pools: raise KeyError('Pool %s has not been created' % pid) @classmethod def _maybe_remove_pool(cls, pid): """If the pool has no open connections, remove it :param str pid: The pool id to clean """ if not len(cls._pools[pid]): del cls._pools[pid] class QueriesException(Exception): """Base Exception for all other Queries exceptions""" pass class ConnectionException(QueriesException): def __init__(self, cid): self.cid = cid class PoolException(QueriesException): def __init__(self, pid): self.pid = pid class PoolConnectionException(PoolException): def __init__(self, pid, cid): self.pid = pid self.cid = cid class ActivePoolError(PoolException): """Raised when removing a pool that has active connections""" def __str__(self): return 'Pool %s has at least one active connection' % self.pid class ConnectionBusyError(ConnectionException): """Raised when trying to lock a connection that is already busy""" def __str__(self): return 'Connection %s is busy' % self.cid class ConnectionNotFoundError(PoolConnectionException): """Raised if a specific connection is not found in the pool""" def __str__(self): return 'Connection %s not found in pool %s' % (self.cid, self.pid) class NoIdleConnectionsError(PoolException): """Raised if a pool does not have any idle, open connections""" def __str__(self): return 'Pool %s has no idle connections' % self.pid class PoolFullError(PoolException): """Raised when adding a connection to a pool that has hit max-size""" def __str__(self): return 'Pool %s is at its maximum capacity' % self.pid <MSG> Docstring fix, process -> pool <DFF> @@ -539,7 +539,7 @@ class PoolManager(object): def set_idle_ttl(cls, pid, ttl): """Set the idle TTL for a pool, after which it will be destroyed. - :param str pid: The process id + :param str pid: The pool id :param int ttl: The TTL for an idle pool """

Docstring fix, process -> pool

.py

py

bsd-3-clause

gmr/queries

1545

<NME> __init__.py <BEF> """ Queries: PostgreSQL database access simplified Queries is an opinionated wrapper for interfacing with PostgreSQL that offers caching of connections and support for PyPy via psycopg2ct. The core `queries.Queries` class will automatically register support for UUIDs, Unicode and Unicode arrays. """ import logging import sys try: import psycopg2cffi import psycopg2cffi.extras import psycopg2cffi.extensions except ImportError: pass else: sys.modules['psycopg2'] = psycopg2cffi sys.modules['psycopg2.extras'] = psycopg2cffi.extras sys.modules['psycopg2.extensions'] = psycopg2cffi.extensions from queries.results import Results from queries.session import Session try: from queries.tornado_session import TornadoSession except ImportError: # pragma: nocover TornadoSession = None from queries.utils import uri # For ease of access to different cursor types from psycopg2.extras import DictCursor from psycopg2.extras import NamedTupleCursor from psycopg2.extras import RealDictCursor from psycopg2.extras import LoggingCursor from psycopg2.extras import MinTimeLoggingCursor # Expose exceptions so clients do not need to import psycopg2 too from psycopg2 import Warning from psycopg2 import Error from psycopg2 import DataError from psycopg2 import DatabaseError from psycopg2 import IntegrityError from psycopg2 import InterfaceError from psycopg2 import InternalError from psycopg2 import NotSupportedError from psycopg2 import OperationalError except ImportError: TornadoSession = None from queries.simple import callproc from queries.simple import query from queries.simple import uri # For ease of access to different cursor types from psycopg2.extras import DictCursor from psycopg2.extras import NamedTupleCursor # Add a Null logging handler to prevent logging output when un-configured logging.getLogger('queries').addHandler(logging.NullHandler()) <MSG> Additional documentation updates [ci skip] <DFF> @@ -50,10 +50,6 @@ try: except ImportError: TornadoSession = None -from queries.simple import callproc -from queries.simple import query -from queries.simple import uri - # For ease of access to different cursor types from psycopg2.extras import DictCursor from psycopg2.extras import NamedTupleCursor

Additional documentation updates

.py

py

bsd-3-clause

gmr/queries

1546

<NME> __init__.py <BEF> """ Queries: PostgreSQL database access simplified Queries is an opinionated wrapper for interfacing with PostgreSQL that offers caching of connections and support for PyPy via psycopg2ct. The core `queries.Queries` class will automatically register support for UUIDs, Unicode and Unicode arrays. """ import logging import sys try: import psycopg2cffi import psycopg2cffi.extras import psycopg2cffi.extensions except ImportError: pass else: sys.modules['psycopg2'] = psycopg2cffi sys.modules['psycopg2.extras'] = psycopg2cffi.extras sys.modules['psycopg2.extensions'] = psycopg2cffi.extensions from queries.results import Results from queries.session import Session try: from queries.tornado_session import TornadoSession except ImportError: # pragma: nocover TornadoSession = None from queries.utils import uri # For ease of access to different cursor types from psycopg2.extras import DictCursor from psycopg2.extras import NamedTupleCursor from psycopg2.extras import RealDictCursor from psycopg2.extras import LoggingCursor from psycopg2.extras import MinTimeLoggingCursor # Expose exceptions so clients do not need to import psycopg2 too from psycopg2 import Warning from psycopg2 import Error from psycopg2 import DataError from psycopg2 import DatabaseError from psycopg2 import IntegrityError from psycopg2 import InterfaceError from psycopg2 import InternalError from psycopg2 import NotSupportedError from psycopg2 import OperationalError except ImportError: TornadoSession = None from queries.simple import callproc from queries.simple import query from queries.simple import uri # For ease of access to different cursor types from psycopg2.extras import DictCursor from psycopg2.extras import NamedTupleCursor # Add a Null logging handler to prevent logging output when un-configured logging.getLogger('queries').addHandler(logging.NullHandler()) <MSG> Additional documentation updates [ci skip] <DFF> @@ -50,10 +50,6 @@ try: except ImportError: TornadoSession = None -from queries.simple import callproc -from queries.simple import query -from queries.simple import uri - # For ease of access to different cursor types from psycopg2.extras import DictCursor from psycopg2.extras import NamedTupleCursor

Additional documentation updates

.py

py

bsd-3-clause

gmr/queries

1547

<NME> index.rst <BEF> Queries: PostgreSQL Simplified ============================== *Queries* is a BSD licensed opinionated wrapper of the psycopg2_ library for interacting with PostgreSQL. |Version| |License| The popular psycopg2_ package is a full-featured python client. Unfortunately as a developer, you're often repeating the same steps to get started with your applications that use it. Queries aims to reduce the complexity of psycopg2 while adding additional features to make writing PostgreSQL client applications both fast and easy. *Key features include*: - Simplified API - Support of Python 2.7+ and 3.4+ - PyPy support via psycopg2cffi_ - Asynchronous support for Tornado_ - Connection information provided by URI - Query results delivered as a generator based iterators - Automatically registered data-type support for UUIDs, Unicode and Unicode Arrays - Ability to directly access psycopg2_ :py:class:`~psycopg2.extensions.connection` and :py:class:`~psycopg2.extensions.cursor` objects - Internal connection pooling Installation ------------ Queries can be installed via the `Python Package Index <https://pypi.python.org/pypi/queries>`_ and can be installed by running :command:`easy_install queries` or :command:`pip install queries` When installing Queries, ``pip`` or ``easy_install`` will automatically install the proper dependencies for your platform. Contents -------- .. toctree:: :maxdepth: 1 usage session results tornado_session pool examples/index.rst history Issues ------ Please report any issues to the Github repo at `https://github.com/gmr/queries/issues <https://github.com/gmr/queries/issues>`_ Source ------ Queries source is available on Github at `https://github.com/gmr/queries <https://github.com/gmr/queries>`_ Inspiration ----------- Queries is inspired by `Kenneth Reitz's <https://github.com/kennethreitz/>`_ awesome work on `requests <http://docs.python-requests.org/en/latest/>`_. Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` .. _pypi: https://pypi.python.org/pypi/queries .. _psycopg2: https://pypi.python.org/pypi/psycopg2 .. _documentation: https://queries.readthedocs.org .. _URI: http://www.postgresql.org/docs/9.3/static/libpq-connect.html#LIBPQ-CONNSTRING .. _pgsql_wrapper: https://pypi.python.org/pypi/pgsql_wrapper .. _Tornado: http://tornadoweb.org .. _PEP343: http://legacy.python.org/dev/peps/pep-0343/ .. _psycopg2cffi: https://pypi.python.org/pypi/psycopg2cffi .. |Version| image:: https://img.shields.io/pypi/v/queries.svg? :target: https://pypi.python.org/pypi/queries .. |License| image:: https://img.shields.io/github/license/gmr/queries.svg? .. |License| image:: https://img.shields.io/github/license/gmr/queries.svg? :target: https://github.com/gmr/queries .. |PythonVersions| image:: https://img.shields.io/pypi/pyversions/queries.svg? :target: https://github.com/gmr/queries <MSG> Remove non-working PythonVersions tag <DFF> @@ -81,6 +81,3 @@ Indices and tables .. |License| image:: https://img.shields.io/github/license/gmr/queries.svg? :target: https://github.com/gmr/queries - -.. |PythonVersions| image:: https://img.shields.io/pypi/pyversions/queries.svg? - :target: https://github.com/gmr/queries

Remove non-working PythonVersions tag

.rst

rst

bsd-3-clause

gmr/queries

1548

<NME> index.rst <BEF> Queries: PostgreSQL Simplified ============================== *Queries* is a BSD licensed opinionated wrapper of the psycopg2_ library for interacting with PostgreSQL. |Version| |License| The popular psycopg2_ package is a full-featured python client. Unfortunately as a developer, you're often repeating the same steps to get started with your applications that use it. Queries aims to reduce the complexity of psycopg2 while adding additional features to make writing PostgreSQL client applications both fast and easy. *Key features include*: - Simplified API - Support of Python 2.7+ and 3.4+ - PyPy support via psycopg2cffi_ - Asynchronous support for Tornado_ - Connection information provided by URI - Query results delivered as a generator based iterators - Automatically registered data-type support for UUIDs, Unicode and Unicode Arrays - Ability to directly access psycopg2_ :py:class:`~psycopg2.extensions.connection` and :py:class:`~psycopg2.extensions.cursor` objects - Internal connection pooling Installation ------------ Queries can be installed via the `Python Package Index <https://pypi.python.org/pypi/queries>`_ and can be installed by running :command:`easy_install queries` or :command:`pip install queries` When installing Queries, ``pip`` or ``easy_install`` will automatically install the proper dependencies for your platform. Contents -------- .. toctree:: :maxdepth: 1 usage session results tornado_session pool examples/index.rst history Issues ------ Please report any issues to the Github repo at `https://github.com/gmr/queries/issues <https://github.com/gmr/queries/issues>`_ Source ------ Queries source is available on Github at `https://github.com/gmr/queries <https://github.com/gmr/queries>`_ Inspiration ----------- Queries is inspired by `Kenneth Reitz's <https://github.com/kennethreitz/>`_ awesome work on `requests <http://docs.python-requests.org/en/latest/>`_. Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` .. _pypi: https://pypi.python.org/pypi/queries .. _psycopg2: https://pypi.python.org/pypi/psycopg2 .. _documentation: https://queries.readthedocs.org .. _URI: http://www.postgresql.org/docs/9.3/static/libpq-connect.html#LIBPQ-CONNSTRING .. _pgsql_wrapper: https://pypi.python.org/pypi/pgsql_wrapper .. _Tornado: http://tornadoweb.org .. _PEP343: http://legacy.python.org/dev/peps/pep-0343/ .. _psycopg2cffi: https://pypi.python.org/pypi/psycopg2cffi .. |Version| image:: https://img.shields.io/pypi/v/queries.svg? :target: https://pypi.python.org/pypi/queries .. |License| image:: https://img.shields.io/github/license/gmr/queries.svg? .. |License| image:: https://img.shields.io/github/license/gmr/queries.svg? :target: https://github.com/gmr/queries .. |PythonVersions| image:: https://img.shields.io/pypi/pyversions/queries.svg? :target: https://github.com/gmr/queries <MSG> Remove non-working PythonVersions tag <DFF> @@ -81,6 +81,3 @@ Indices and tables .. |License| image:: https://img.shields.io/github/license/gmr/queries.svg? :target: https://github.com/gmr/queries - -.. |PythonVersions| image:: https://img.shields.io/pypi/pyversions/queries.svg? - :target: https://github.com/gmr/queries

Remove non-working PythonVersions tag

.rst

rst

bsd-3-clause

gmr/queries

1549

<NME> tornado_session.py <BEF> """ Tornado Session Adapter Use Queries asynchronously within the Tornado framework. Example Use: .. code:: python class NameListHandler(web.RequestHandler): def initialize(self): self.session = queries.TornadoSession(pool_max_size=60) @gen.coroutine def get(self): data = yield self.session.query('SELECT * FROM names') if data: self.finish({'names': data.items()}) data.free() else: self.set_status(500, 'Error querying the data') """ import logging import socket import warnings from tornado import concurrent, ioloop from psycopg2 import extras, extensions import psycopg2 from queries import pool, results, session, utils LOGGER = logging.getLogger(__name__) DEFAULT_MAX_POOL_SIZE = 25 class Results(results.Results): """A TornadoSession specific :py:class:`queries.Results` class that adds the :py:meth:`Results.free <queries.tornado_session.Results.free>` method. The :py:meth:`Results.free <queries.tornado_session.Results.free>` method **must** be called to free the connection that the results were generated on. `Results` objects that are not freed will cause the connections to remain locked and your application will eventually run out of connections in the pool. The following examples illustrate the various behaviors that the ::py:class:`queries.Results <queries.tornado_session.Requests>` class implements: **Using Results as an Iterator** .. code:: python results = yield session.query('SELECT * FROM foo') for row in results print row results.free() **Accessing an individual row by index** .. code:: python results = yield session.query('SELECT * FROM foo') print results[1] # Access the second row of the results results.free() **Casting single row results as a dict** .. code:: python results = yield session.query('SELECT * FROM foo LIMIT 1') print results.as_dict() results.free() **Checking to see if a query was successful** .. code:: python sql = "UPDATE foo SET bar='baz' WHERE qux='corgie'" results = yield session.query(sql) if results: print 'Success' results.free() **Checking the number of rows by using len(Results)** .. code:: python results = yield session.query('SELECT * FROM foo') print '%i rows' % len(results) results.free() """ def __init__(self, cursor, cleanup, fd): self.cursor = cursor self._cleanup = cleanup self._fd = fd self._freed = False def free(self): """Release the results and connection lock from the TornadoSession object. This **must** be called after you finish processing the results from :py:meth:`TornadoSession.query <queries.TornadoSession.query>` or :py:meth:`TornadoSession.callproc <queries.TornadoSession.callproc>` or the connection will not be able to be reused by other asynchronous requests. """ self._freed = True self._cleanup(self.cursor, self._fd) def __del__(self): if not self._freed: LOGGER.warning('Auto-freeing result on deletion') self.free() class TornadoSession(session.Session): """Session class for Tornado asynchronous applications. Uses :py:func:`tornado.gen.coroutine` to wrap API methods for use in Tornado. Utilizes connection pooling to ensure that multiple concurrent asynchronous queries do not block each other. Heavily trafficked services will require a higher ``max_pool_size`` to allow for greater connection concurrency. :py:meth:`TornadoSession.query <queries.TornadoSession.query>` and :py:meth:`TornadoSession.callproc <queries.TornadoSession.callproc>` must call :py:meth:`Results.free <queries.tornado_session.Results.free>` :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ def __init__(self, uri=session.DEFAULT_URI, cursor_factory=extras.RealDictCursor, pool_idle_ttl=pool.DEFAULT_IDLE_TTL, pool_max_size=DEFAULT_MAX_POOL_SIZE, io_loop=None): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use :param tornado.ioloop.IOLoop io_loop: IOLoop instance to use """ self._connections = dict() self._cleanup_callback = None self._cursor_factory = cursor_factory self._futures = dict() self._ioloop = io_loop or ioloop.IOLoop.current() self._pool_manager = pool.PoolManager.instance() self._pool_max_size = pool_max_size self._pool_idle_ttl = pool_idle_ttl self._uri = uri self._ensure_pool_exists() def _ensure_pool_exists(self): """Create the pool in the pool manager if it does not exist.""" if self.pid not in self._pool_manager: self._pool_manager.create(self.pid, self._pool_idle_ttl, self._pool_max_size, self._ioloop.time) @property def connection(self): """Do not use this directly with Tornado applications :return: """ return None @property def cursor(self): return None def callproc(self, name, args=None): """Call a stored procedure asynchronously on the server, passing in the arguments to be passed to the stored procedure, yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. You **must** free the results that are returned by this method to unlock the connection used to perform the query. Failure to do so will cause your Tornado application to run out of connections. :param str name: The stored procedure name :param list args: An optional list of procedure arguments :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ return self._execute('callproc', name, args) def query(self, sql, parameters=None): """Issue a query asynchronously on the server, mogrifying the parameters against the sql statement and yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. You **must** free the results that are returned by this method to unlock the connection used to perform the query. Failure to do so will cause your Tornado application to run out of connections. :param str sql: The SQL statement :param dict parameters: A dictionary of query parameters :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ return self._execute('execute', sql, parameters) def validate(self): """Validate the session can connect or has open connections to PostgreSQL. As of ``1.10.3`` .. deprecated:: 1.10.3 As of 1.10.3, this method only warns about Deprecation :rtype: bool """ warnings.warn( 'All functionality removed from this method', DeprecationWarning) def _connect(self): """Connect to PostgreSQL, either by reusing a connection from the pool if possible, or by creating the new connection. :rtype: psycopg2.extensions.connection :raises: pool.NoIdleConnectionsError """ future = concurrent.Future() # Attempt to get a cached connection from the connection pool try: connection = self._pool_manager.get(self.pid, self) self._connections[connection.fileno()] = connection future.set_result(connection) # Add the connection to the IOLoop self._ioloop.add_handler(connection.fileno(), self._on_io_events, ioloop.IOLoop.WRITE) except pool.NoIdleConnectionsError: self._create_connection(future) return future def _create_connection(self, future): """Create a new PostgreSQL connection :param tornado.concurrent.Future future: future for new conn result """ LOGGER.debug('Creating a new connection for %s', self.pid) # Create a new PostgreSQL connection kwargs = utils.uri_to_kwargs(self._uri) try: connection = self._psycopg2_connect(kwargs) except (psycopg2.Error, OSError, socket.error) as error: future.set_exception(error) return # Add the connection for use in _poll_connection fd = connection.fileno() self._connections[fd] = connection def on_connected(cf): """Invoked by the IOLoop when the future is complete for the connection :param Future cf: The future for the initial connection """ if cf.exception(): self._cleanup_fd(fd, True) future.set_exception(cf.exception()) else: try: # Add the connection to the pool LOGGER.debug('Connection established for %s', self.pid) self._pool_manager.add(self.pid, connection) except (ValueError, pool.PoolException) as err: LOGGER.exception('Failed to add %r to the pool', self.pid) self._cleanup_fd(fd) future.set_exception(err) return self._pool_manager.lock(self.pid, connection, self) # Added in because psycopg2cffi connects and leaves the # connection in a weird state: consts.STATUS_DATESTYLE, # returning from Connection._setup without setting the state # as const.STATUS_OK if utils.PYPY: connection.status = extensions.STATUS_READY # Register the custom data types self._register_unicode(connection) self._register_uuid(connection) # Set the future result future.set_result(connection) # Add a future that fires once connected self._futures[fd] = concurrent.Future() self._ioloop.add_future(self._futures[fd], on_connected) # Add the connection to the IOLoop self._ioloop.add_handler(connection.fileno(), self._on_io_events, ioloop.IOLoop.WRITE) def _execute(self, method, query, parameters=None): """Issue a query asynchronously on the server, mogrifying the parameters against the sql statement and yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. This function reduces duplicate code for callproc and query by getting the class attribute for the method passed in as the function to call. :param str method: The method attribute to use :param str query: The SQL statement or Stored Procedure name :param list|dict parameters: A dictionary of query parameters :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ future = concurrent.Future() def on_connected(cf): """Invoked by the future returned by self._connect""" if cf.exception(): future.set_exception(cf.exception()) return # Get the psycopg2 connection object and cursor conn = cf.result() cursor = self._get_cursor(conn) def completed(qf): """Invoked by the IOLoop when the future has completed""" if qf.exception(): self._incr_exceptions(conn) err = qf.exception() LOGGER.debug('Cleaning cursor due to exception: %r', err) self._exec_cleanup(cursor, conn.fileno()) future.set_exception(err) else: self._incr_executions(conn) value = Results(cursor, self._exec_cleanup, conn.fileno()) future.set_result(value) # Setup a callback to wait on the query result self._futures[conn.fileno()] = concurrent.Future() # Add the future to the IOLoop self._ioloop.add_future(self._futures[conn.fileno()], completed) # Get the cursor, execute the query func = getattr(cursor, method) try: func(query, parameters) except Exception as error: future.set_exception(error) # Ensure the pool exists for the connection self._ensure_pool_exists() # Grab a connection to PostgreSQL self._ioloop.add_future(self._connect(), on_connected) # Return the future for the query result return future def _exec_cleanup(self, cursor, fd): """Close the cursor, remove any references to the fd in internal state and remove the fd from the ioloop. :param psycopg2.extensions.cursor cursor: The cursor to close :param int fd: The connection file descriptor """ LOGGER.debug('Closing cursor and cleaning %s', fd) try: cursor.close() except (psycopg2.Error, psycopg2.Warning) as error: LOGGER.debug('Error closing the cursor: %s', error) self._cleanup_fd(fd) # If the cleanup callback exists, remove it if self._cleanup_callback: self._ioloop.remove_timeout(self._cleanup_callback) # Create a new cleanup callback to clean the pool of idle connections self._cleanup_callback = self._ioloop.add_timeout( self._ioloop.time() + self._pool_idle_ttl + 1, self._pool_manager.clean, self.pid) def _cleanup_fd(self, fd, close=False): """Ensure the socket socket is removed from the IOLoop, the connection stack, and futures stack. :param int fd: The fd # to cleanup """ self._ioloop.remove_handler(fd) if fd in self._connections: try: self._pool_manager.free(self.pid, self._connections[fd]) except pool.ConnectionNotFoundError: pass if close: # Create a new cleanup callback to clean the pool of idle connections self._cleanup_callback = self._ioloop.add_timeout( self._pool_idle_ttl + 1, self._pool_manager.clean, self.pid) if fd in self._connections: del self._connections[fd] :param psycopg2.extensions.connection conn: the psycopg2 connection """ self._pool_manager.get_connection(self.pid, conn).exceptions += 1 def _incr_executions(self, conn): """Increment the number of executions for the current connection. :param psycopg2.extensions.connection conn: the psycopg2 connection """ self._pool_manager.get_connection(self.pid, conn).executions += 1 def _on_io_events(self, fd=None, _events=None): """Invoked by Tornado's IOLoop when there are events for the fd :param int fd: The file descriptor for the event :param int _events: The events raised """ if fd not in self._connections: LOGGER.warning('Received IO event for non-existing connection') return self._poll_connection(fd) def _poll_connection(self, fd): """Check with psycopg2 to see what action to take. If the state is POLL_OK, we should have a pending callback for that fd. :param int fd: The socket fd for the postgresql connection """ try: state = self._connections[fd].poll() except (OSError, socket.error) as error: self._ioloop.remove_handler(fd) if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception( psycopg2.OperationalError('Connection error (%s)' % error) ) except (psycopg2.Error, psycopg2.Warning) as error: if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception(error) else: if state == extensions.POLL_OK: if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_result(True) elif state == extensions.POLL_WRITE: self._ioloop.update_handler(fd, ioloop.IOLoop.WRITE) elif state == extensions.POLL_READ: self._ioloop.update_handler(fd, ioloop.IOLoop.READ) elif state == extensions.POLL_ERROR: self._ioloop.remove_handler(fd) if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception( psycopg2.Error('Poll Error')) def _psycopg2_connect(self, kwargs): """Return a psycopg2 connection for the specified kwargs. Extend for use in async session adapters. :param dict kwargs: Keyword connection args :rtype: psycopg2.extensions.connection """ kwargs['async'] = True return psycopg2.connect(**kwargs) <MSG> Merge pull request #26 from dave-shawley/absolute-time IOLoop.add_timeout requires an absolute time. <DFF> @@ -447,7 +447,8 @@ class TornadoSession(session.Session): # Create a new cleanup callback to clean the pool of idle connections self._cleanup_callback = self._ioloop.add_timeout( - self._pool_idle_ttl + 1, self._pool_manager.clean, self.pid) + self._ioloop.time() + self._pool_idle_ttl + 1, + self._pool_manager.clean, self.pid) if fd in self._connections: del self._connections[fd]

Merge pull request #26 from dave-shawley/absolute-time

.py

py

bsd-3-clause

gmr/queries

1550

<NME> tornado_session.py <BEF> """ Tornado Session Adapter Use Queries asynchronously within the Tornado framework. Example Use: .. code:: python class NameListHandler(web.RequestHandler): def initialize(self): self.session = queries.TornadoSession(pool_max_size=60) @gen.coroutine def get(self): data = yield self.session.query('SELECT * FROM names') if data: self.finish({'names': data.items()}) data.free() else: self.set_status(500, 'Error querying the data') """ import logging import socket import warnings from tornado import concurrent, ioloop from psycopg2 import extras, extensions import psycopg2 from queries import pool, results, session, utils LOGGER = logging.getLogger(__name__) DEFAULT_MAX_POOL_SIZE = 25 class Results(results.Results): """A TornadoSession specific :py:class:`queries.Results` class that adds the :py:meth:`Results.free <queries.tornado_session.Results.free>` method. The :py:meth:`Results.free <queries.tornado_session.Results.free>` method **must** be called to free the connection that the results were generated on. `Results` objects that are not freed will cause the connections to remain locked and your application will eventually run out of connections in the pool. The following examples illustrate the various behaviors that the ::py:class:`queries.Results <queries.tornado_session.Requests>` class implements: **Using Results as an Iterator** .. code:: python results = yield session.query('SELECT * FROM foo') for row in results print row results.free() **Accessing an individual row by index** .. code:: python results = yield session.query('SELECT * FROM foo') print results[1] # Access the second row of the results results.free() **Casting single row results as a dict** .. code:: python results = yield session.query('SELECT * FROM foo LIMIT 1') print results.as_dict() results.free() **Checking to see if a query was successful** .. code:: python sql = "UPDATE foo SET bar='baz' WHERE qux='corgie'" results = yield session.query(sql) if results: print 'Success' results.free() **Checking the number of rows by using len(Results)** .. code:: python results = yield session.query('SELECT * FROM foo') print '%i rows' % len(results) results.free() """ def __init__(self, cursor, cleanup, fd): self.cursor = cursor self._cleanup = cleanup self._fd = fd self._freed = False def free(self): """Release the results and connection lock from the TornadoSession object. This **must** be called after you finish processing the results from :py:meth:`TornadoSession.query <queries.TornadoSession.query>` or :py:meth:`TornadoSession.callproc <queries.TornadoSession.callproc>` or the connection will not be able to be reused by other asynchronous requests. """ self._freed = True self._cleanup(self.cursor, self._fd) def __del__(self): if not self._freed: LOGGER.warning('Auto-freeing result on deletion') self.free() class TornadoSession(session.Session): """Session class for Tornado asynchronous applications. Uses :py:func:`tornado.gen.coroutine` to wrap API methods for use in Tornado. Utilizes connection pooling to ensure that multiple concurrent asynchronous queries do not block each other. Heavily trafficked services will require a higher ``max_pool_size`` to allow for greater connection concurrency. :py:meth:`TornadoSession.query <queries.TornadoSession.query>` and :py:meth:`TornadoSession.callproc <queries.TornadoSession.callproc>` must call :py:meth:`Results.free <queries.tornado_session.Results.free>` :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ def __init__(self, uri=session.DEFAULT_URI, cursor_factory=extras.RealDictCursor, pool_idle_ttl=pool.DEFAULT_IDLE_TTL, pool_max_size=DEFAULT_MAX_POOL_SIZE, io_loop=None): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use :param tornado.ioloop.IOLoop io_loop: IOLoop instance to use """ self._connections = dict() self._cleanup_callback = None self._cursor_factory = cursor_factory self._futures = dict() self._ioloop = io_loop or ioloop.IOLoop.current() self._pool_manager = pool.PoolManager.instance() self._pool_max_size = pool_max_size self._pool_idle_ttl = pool_idle_ttl self._uri = uri self._ensure_pool_exists() def _ensure_pool_exists(self): """Create the pool in the pool manager if it does not exist.""" if self.pid not in self._pool_manager: self._pool_manager.create(self.pid, self._pool_idle_ttl, self._pool_max_size, self._ioloop.time) @property def connection(self): """Do not use this directly with Tornado applications :return: """ return None @property def cursor(self): return None def callproc(self, name, args=None): """Call a stored procedure asynchronously on the server, passing in the arguments to be passed to the stored procedure, yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. You **must** free the results that are returned by this method to unlock the connection used to perform the query. Failure to do so will cause your Tornado application to run out of connections. :param str name: The stored procedure name :param list args: An optional list of procedure arguments :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ return self._execute('callproc', name, args) def query(self, sql, parameters=None): """Issue a query asynchronously on the server, mogrifying the parameters against the sql statement and yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. You **must** free the results that are returned by this method to unlock the connection used to perform the query. Failure to do so will cause your Tornado application to run out of connections. :param str sql: The SQL statement :param dict parameters: A dictionary of query parameters :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ return self._execute('execute', sql, parameters) def validate(self): """Validate the session can connect or has open connections to PostgreSQL. As of ``1.10.3`` .. deprecated:: 1.10.3 As of 1.10.3, this method only warns about Deprecation :rtype: bool """ warnings.warn( 'All functionality removed from this method', DeprecationWarning) def _connect(self): """Connect to PostgreSQL, either by reusing a connection from the pool if possible, or by creating the new connection. :rtype: psycopg2.extensions.connection :raises: pool.NoIdleConnectionsError """ future = concurrent.Future() # Attempt to get a cached connection from the connection pool try: connection = self._pool_manager.get(self.pid, self) self._connections[connection.fileno()] = connection future.set_result(connection) # Add the connection to the IOLoop self._ioloop.add_handler(connection.fileno(), self._on_io_events, ioloop.IOLoop.WRITE) except pool.NoIdleConnectionsError: self._create_connection(future) return future def _create_connection(self, future): """Create a new PostgreSQL connection :param tornado.concurrent.Future future: future for new conn result """ LOGGER.debug('Creating a new connection for %s', self.pid) # Create a new PostgreSQL connection kwargs = utils.uri_to_kwargs(self._uri) try: connection = self._psycopg2_connect(kwargs) except (psycopg2.Error, OSError, socket.error) as error: future.set_exception(error) return # Add the connection for use in _poll_connection fd = connection.fileno() self._connections[fd] = connection def on_connected(cf): """Invoked by the IOLoop when the future is complete for the connection :param Future cf: The future for the initial connection """ if cf.exception(): self._cleanup_fd(fd, True) future.set_exception(cf.exception()) else: try: # Add the connection to the pool LOGGER.debug('Connection established for %s', self.pid) self._pool_manager.add(self.pid, connection) except (ValueError, pool.PoolException) as err: LOGGER.exception('Failed to add %r to the pool', self.pid) self._cleanup_fd(fd) future.set_exception(err) return self._pool_manager.lock(self.pid, connection, self) # Added in because psycopg2cffi connects and leaves the # connection in a weird state: consts.STATUS_DATESTYLE, # returning from Connection._setup without setting the state # as const.STATUS_OK if utils.PYPY: connection.status = extensions.STATUS_READY # Register the custom data types self._register_unicode(connection) self._register_uuid(connection) # Set the future result future.set_result(connection) # Add a future that fires once connected self._futures[fd] = concurrent.Future() self._ioloop.add_future(self._futures[fd], on_connected) # Add the connection to the IOLoop self._ioloop.add_handler(connection.fileno(), self._on_io_events, ioloop.IOLoop.WRITE) def _execute(self, method, query, parameters=None): """Issue a query asynchronously on the server, mogrifying the parameters against the sql statement and yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. This function reduces duplicate code for callproc and query by getting the class attribute for the method passed in as the function to call. :param str method: The method attribute to use :param str query: The SQL statement or Stored Procedure name :param list|dict parameters: A dictionary of query parameters :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ future = concurrent.Future() def on_connected(cf): """Invoked by the future returned by self._connect""" if cf.exception(): future.set_exception(cf.exception()) return # Get the psycopg2 connection object and cursor conn = cf.result() cursor = self._get_cursor(conn) def completed(qf): """Invoked by the IOLoop when the future has completed""" if qf.exception(): self._incr_exceptions(conn) err = qf.exception() LOGGER.debug('Cleaning cursor due to exception: %r', err) self._exec_cleanup(cursor, conn.fileno()) future.set_exception(err) else: self._incr_executions(conn) value = Results(cursor, self._exec_cleanup, conn.fileno()) future.set_result(value) # Setup a callback to wait on the query result self._futures[conn.fileno()] = concurrent.Future() # Add the future to the IOLoop self._ioloop.add_future(self._futures[conn.fileno()], completed) # Get the cursor, execute the query func = getattr(cursor, method) try: func(query, parameters) except Exception as error: future.set_exception(error) # Ensure the pool exists for the connection self._ensure_pool_exists() # Grab a connection to PostgreSQL self._ioloop.add_future(self._connect(), on_connected) # Return the future for the query result return future def _exec_cleanup(self, cursor, fd): """Close the cursor, remove any references to the fd in internal state and remove the fd from the ioloop. :param psycopg2.extensions.cursor cursor: The cursor to close :param int fd: The connection file descriptor """ LOGGER.debug('Closing cursor and cleaning %s', fd) try: cursor.close() except (psycopg2.Error, psycopg2.Warning) as error: LOGGER.debug('Error closing the cursor: %s', error) self._cleanup_fd(fd) # If the cleanup callback exists, remove it if self._cleanup_callback: self._ioloop.remove_timeout(self._cleanup_callback) # Create a new cleanup callback to clean the pool of idle connections self._cleanup_callback = self._ioloop.add_timeout( self._ioloop.time() + self._pool_idle_ttl + 1, self._pool_manager.clean, self.pid) def _cleanup_fd(self, fd, close=False): """Ensure the socket socket is removed from the IOLoop, the connection stack, and futures stack. :param int fd: The fd # to cleanup """ self._ioloop.remove_handler(fd) if fd in self._connections: try: self._pool_manager.free(self.pid, self._connections[fd]) except pool.ConnectionNotFoundError: pass if close: # Create a new cleanup callback to clean the pool of idle connections self._cleanup_callback = self._ioloop.add_timeout( self._pool_idle_ttl + 1, self._pool_manager.clean, self.pid) if fd in self._connections: del self._connections[fd] :param psycopg2.extensions.connection conn: the psycopg2 connection """ self._pool_manager.get_connection(self.pid, conn).exceptions += 1 def _incr_executions(self, conn): """Increment the number of executions for the current connection. :param psycopg2.extensions.connection conn: the psycopg2 connection """ self._pool_manager.get_connection(self.pid, conn).executions += 1 def _on_io_events(self, fd=None, _events=None): """Invoked by Tornado's IOLoop when there are events for the fd :param int fd: The file descriptor for the event :param int _events: The events raised """ if fd not in self._connections: LOGGER.warning('Received IO event for non-existing connection') return self._poll_connection(fd) def _poll_connection(self, fd): """Check with psycopg2 to see what action to take. If the state is POLL_OK, we should have a pending callback for that fd. :param int fd: The socket fd for the postgresql connection """ try: state = self._connections[fd].poll() except (OSError, socket.error) as error: self._ioloop.remove_handler(fd) if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception( psycopg2.OperationalError('Connection error (%s)' % error) ) except (psycopg2.Error, psycopg2.Warning) as error: if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception(error) else: if state == extensions.POLL_OK: if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_result(True) elif state == extensions.POLL_WRITE: self._ioloop.update_handler(fd, ioloop.IOLoop.WRITE) elif state == extensions.POLL_READ: self._ioloop.update_handler(fd, ioloop.IOLoop.READ) elif state == extensions.POLL_ERROR: self._ioloop.remove_handler(fd) if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception( psycopg2.Error('Poll Error')) def _psycopg2_connect(self, kwargs): """Return a psycopg2 connection for the specified kwargs. Extend for use in async session adapters. :param dict kwargs: Keyword connection args :rtype: psycopg2.extensions.connection """ kwargs['async'] = True return psycopg2.connect(**kwargs) <MSG> Merge pull request #26 from dave-shawley/absolute-time IOLoop.add_timeout requires an absolute time. <DFF> @@ -447,7 +447,8 @@ class TornadoSession(session.Session): # Create a new cleanup callback to clean the pool of idle connections self._cleanup_callback = self._ioloop.add_timeout( - self._pool_idle_ttl + 1, self._pool_manager.clean, self.pid) + self._ioloop.time() + self._pool_idle_ttl + 1, + self._pool_manager.clean, self.pid) if fd in self._connections: del self._connections[fd]

Merge pull request #26 from dave-shawley/absolute-time

.py

py

bsd-3-clause

gmr/queries

1551

<NME> pool_tests.py <BEF> """ Tests for functionality in the pool module """ import time import unittest import uuid import mock from queries import pool MAX_POOL_SIZE = 100 def mock_connection(): conn = mock.MagicMock('psycopg2.extensions.connection') conn.close = mock.Mock() conn.closed = True conn.isexecuting = mock.Mock(return_value=False) return conn class PoolTests(unittest.TestCase): def test_id_is_set(self): pool_id = str(uuid.uuid4()) obj = pool.Pool(pool_id) self.assertEqual(obj._id, pool_id) def test_id_property(self): pool_id = str(uuid.uuid4()) obj = pool.Pool(pool_id) self.assertEqual(obj.id, pool_id) def test_idle_ttl_is_default(self): obj = pool.Pool(str(uuid.uuid4())) self.assertEqual(obj.idle_ttl, pool.DEFAULT_IDLE_TTL) def test_max_size_is_default(self): obj = pool.Pool(str(uuid.uuid4())) self.assertEqual(obj.max_size, pool.DEFAULT_MAX_SIZE) def test_idle_ttl_constructor_assignment(self): obj = pool.Pool(str(uuid.uuid4()), 10) self.assertEqual(obj.idle_ttl, 10) def test_max_size_constructor_assignment(self): obj = pool.Pool(str(uuid.uuid4()), max_size=10) self.assertEqual(obj.max_size, 10) def test_idle_ttl_assignment(self): obj = pool.Pool(str(uuid.uuid4())) obj.set_idle_ttl(10) self.assertEqual(obj.idle_ttl, 10) def test_max_size_assignment(self): obj = pool.Pool(str(uuid.uuid4())) obj.set_max_size(10) self.assertEqual(obj.max_size, 10) def test_pool_doesnt_contain_connection(self): obj = pool.Pool(str(uuid.uuid4())) self.assertNotIn('foo', obj) def test_default_connection_count(self): obj = pool.Pool(str(uuid.uuid4())) self.assertEqual(len(obj), 0) def test_add_new_connection(self): psycopg2_conn = mock.Mock() obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertIn(psycopg2_conn, obj) def test_connection_count_after_add(self): psycopg2_conn = mock.Mock() obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertEqual(len(obj), 1) def test_add_existing_connection_raises_on_second_add(self): psycopg2_conn = mock.Mock() obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertRaises(ValueError, obj.add, psycopg2_conn) def test_add_when_pool_is_full_raises(self): obj = pool.Pool(str(uuid.uuid4()), max_size=1) obj.add(mock.Mock()) mock_conn = mock.Mock() self.assertRaises(pool.PoolFullError, obj.add, mock_conn) def test_closed_conn_invokes_remove_on_clean(self): psycopg2_conn = mock.Mock() psycopg2_conn.closed = True obj = pool.Pool(str(uuid.uuid4())) obj.remove = mock.Mock() obj.add(psycopg2_conn) obj.clean() obj.remove.assert_called_once_with(psycopg2_conn) def test_clean_closes_all_when_idle(self): obj = pool.Pool(str(uuid.uuid4()), idle_ttl=10) obj.idle_start = time.time() - 20 obj.close = mock.Mock() obj.clean() psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] obj.close() obj.remove.assert_hass_calls(psycopg2_conns) def test_free_invokes_connection_free(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_calls = [mock.call(c) for c in psycopg2_conns] obj.remove.assert_has_calls(psycopg2_calls) def test_free_invokes_connection_free(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) self._connection = obj.connection_handle conn = self._connection(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conn) conn.free.assert_called_once_with() def test_free_raises_not_found_exception(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) conn = obj.connection_handle(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conn) conn.free.assert_called_once_with() def test_free_resets_idle_start(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): [obj.add(conn) for conn in psycopg2_conns] for psycopg2_conn in psycopg2_conns: conn = obj.connection_handle(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conns[1]) self.assertAlmostEqual(int(obj.idle_start), int(time.time())) def test_free_raises_on_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.free, mock.Mock()) def test_get_returns_first_psycopg2_conn(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] session = mock.Mock() self.assertEqual(obj.get(session), psycopg2_conns[0]) def test_get_locks_first_psycopg2_conn(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] lock = mock.Mock() with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False, lock=lock): session = mock.Mock() obj.get(session) lock.assert_called_once_with(session) def test_get_resets_idle_start_to_none(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): session = mock.Mock() obj.idle_start = time.time() obj.get(session) self.assertIsNone(obj.idle_start) def test_get_raises_when_no_idle_connections(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] session = mock.Mock() self.assertRaises(pool.NoIdleConnectionsError, obj.get, session) def test_idle_connections(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): self.assertListEqual([c.handle for c in obj.idle_connections], psycopg2_conns) def test_idle_duration_when_none(self): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = None self.assertEqual(obj.idle_duration, 0) def test_idle_duration_when_set(self): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = time.time() - 5 self.assertAlmostEqual(int(obj.idle_duration), 5) def test_is_full_property_when_full(self): obj = pool.Pool(str(uuid.uuid4()), max_size=2) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] self.assertTrue(obj.is_full) def test_is_full_property_when_not_full(self): obj = pool.Pool(str(uuid.uuid4()), max_size=3) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] self.assertFalse(obj.is_full) def test_connection_lock_is_called_when_lock_is(self): with mock.patch('queries.pool.Connection.lock') as lock: obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) session = mock.Mock() obj.lock(psycopg2_conn, session) lock.assert_called_once_with(session) def test_locks_raises_when_connection_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.lock, mock.Mock(), mock.Mock()) def test_lock_resets_idle_start(self): with mock.patch('queries.pool.Connection.lock'): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = time.time() psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.lock(psycopg2_conn, mock.Mock()) self.assertIsNone(obj.idle_start) def test_remove_removes_connection(self): with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.remove(psycopg2_conn) self.assertNotIn(psycopg2_conn, obj) def test_remove_closes_connection(self): close_method = mock.Mock() with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False, close=close_method): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.remove(psycopg2_conn) close_method.assert_called_once_with() def test_remove_raises_when_connection_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.remove, mock.Mock()) def test_remove_raises_when_connection_is_busy(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() psycopg2_conn.closed = False obj.add(psycopg2_conn) self.assertRaises(pool.ConnectionBusyError, obj.remove, psycopg2_conn) def test__connection_returns_handle(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) self.assertEqual( obj.connection_handle(psycopg2_conn).handle, psycopg2_conn) def test_shutdown_raises_when_executing(self): psycopg2_conn = mock_connection() psycopg2_conn.isexecuting.return_value = True obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertRaises(pool.ConnectionBusyError, obj.shutdown) <MSG> Fix typo in pool.close test. This commit fixes a typo in the mock assert function call that was allowing a failing test to pass. <DFF> @@ -108,7 +108,8 @@ class PoolTests(unittest.TestCase): psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] obj.close() - obj.remove.assert_hass_calls(psycopg2_conns) + psycopg2_calls = [mock.call(c) for c in psycopg2_conns] + obj.remove.assert_has_calls(psycopg2_calls) def test_free_invokes_connection_free(self): obj = pool.Pool(str(uuid.uuid4()))

Fix typo in pool.close test.

.py

py

bsd-3-clause

gmr/queries

1552

<NME> pool_tests.py <BEF> """ Tests for functionality in the pool module """ import time import unittest import uuid import mock from queries import pool MAX_POOL_SIZE = 100 def mock_connection(): conn = mock.MagicMock('psycopg2.extensions.connection') conn.close = mock.Mock() conn.closed = True conn.isexecuting = mock.Mock(return_value=False) return conn class PoolTests(unittest.TestCase): def test_id_is_set(self): pool_id = str(uuid.uuid4()) obj = pool.Pool(pool_id) self.assertEqual(obj._id, pool_id) def test_id_property(self): pool_id = str(uuid.uuid4()) obj = pool.Pool(pool_id) self.assertEqual(obj.id, pool_id) def test_idle_ttl_is_default(self): obj = pool.Pool(str(uuid.uuid4())) self.assertEqual(obj.idle_ttl, pool.DEFAULT_IDLE_TTL) def test_max_size_is_default(self): obj = pool.Pool(str(uuid.uuid4())) self.assertEqual(obj.max_size, pool.DEFAULT_MAX_SIZE) def test_idle_ttl_constructor_assignment(self): obj = pool.Pool(str(uuid.uuid4()), 10) self.assertEqual(obj.idle_ttl, 10) def test_max_size_constructor_assignment(self): obj = pool.Pool(str(uuid.uuid4()), max_size=10) self.assertEqual(obj.max_size, 10) def test_idle_ttl_assignment(self): obj = pool.Pool(str(uuid.uuid4())) obj.set_idle_ttl(10) self.assertEqual(obj.idle_ttl, 10) def test_max_size_assignment(self): obj = pool.Pool(str(uuid.uuid4())) obj.set_max_size(10) self.assertEqual(obj.max_size, 10) def test_pool_doesnt_contain_connection(self): obj = pool.Pool(str(uuid.uuid4())) self.assertNotIn('foo', obj) def test_default_connection_count(self): obj = pool.Pool(str(uuid.uuid4())) self.assertEqual(len(obj), 0) def test_add_new_connection(self): psycopg2_conn = mock.Mock() obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertIn(psycopg2_conn, obj) def test_connection_count_after_add(self): psycopg2_conn = mock.Mock() obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertEqual(len(obj), 1) def test_add_existing_connection_raises_on_second_add(self): psycopg2_conn = mock.Mock() obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertRaises(ValueError, obj.add, psycopg2_conn) def test_add_when_pool_is_full_raises(self): obj = pool.Pool(str(uuid.uuid4()), max_size=1) obj.add(mock.Mock()) mock_conn = mock.Mock() self.assertRaises(pool.PoolFullError, obj.add, mock_conn) def test_closed_conn_invokes_remove_on_clean(self): psycopg2_conn = mock.Mock() psycopg2_conn.closed = True obj = pool.Pool(str(uuid.uuid4())) obj.remove = mock.Mock() obj.add(psycopg2_conn) obj.clean() obj.remove.assert_called_once_with(psycopg2_conn) def test_clean_closes_all_when_idle(self): obj = pool.Pool(str(uuid.uuid4()), idle_ttl=10) obj.idle_start = time.time() - 20 obj.close = mock.Mock() obj.clean() psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] obj.close() obj.remove.assert_hass_calls(psycopg2_conns) def test_free_invokes_connection_free(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_calls = [mock.call(c) for c in psycopg2_conns] obj.remove.assert_has_calls(psycopg2_calls) def test_free_invokes_connection_free(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) self._connection = obj.connection_handle conn = self._connection(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conn) conn.free.assert_called_once_with() def test_free_raises_not_found_exception(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) conn = obj.connection_handle(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conn) conn.free.assert_called_once_with() def test_free_resets_idle_start(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): [obj.add(conn) for conn in psycopg2_conns] for psycopg2_conn in psycopg2_conns: conn = obj.connection_handle(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conns[1]) self.assertAlmostEqual(int(obj.idle_start), int(time.time())) def test_free_raises_on_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.free, mock.Mock()) def test_get_returns_first_psycopg2_conn(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] session = mock.Mock() self.assertEqual(obj.get(session), psycopg2_conns[0]) def test_get_locks_first_psycopg2_conn(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] lock = mock.Mock() with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False, lock=lock): session = mock.Mock() obj.get(session) lock.assert_called_once_with(session) def test_get_resets_idle_start_to_none(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): session = mock.Mock() obj.idle_start = time.time() obj.get(session) self.assertIsNone(obj.idle_start) def test_get_raises_when_no_idle_connections(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] session = mock.Mock() self.assertRaises(pool.NoIdleConnectionsError, obj.get, session) def test_idle_connections(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): self.assertListEqual([c.handle for c in obj.idle_connections], psycopg2_conns) def test_idle_duration_when_none(self): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = None self.assertEqual(obj.idle_duration, 0) def test_idle_duration_when_set(self): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = time.time() - 5 self.assertAlmostEqual(int(obj.idle_duration), 5) def test_is_full_property_when_full(self): obj = pool.Pool(str(uuid.uuid4()), max_size=2) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] self.assertTrue(obj.is_full) def test_is_full_property_when_not_full(self): obj = pool.Pool(str(uuid.uuid4()), max_size=3) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] self.assertFalse(obj.is_full) def test_connection_lock_is_called_when_lock_is(self): with mock.patch('queries.pool.Connection.lock') as lock: obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) session = mock.Mock() obj.lock(psycopg2_conn, session) lock.assert_called_once_with(session) def test_locks_raises_when_connection_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.lock, mock.Mock(), mock.Mock()) def test_lock_resets_idle_start(self): with mock.patch('queries.pool.Connection.lock'): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = time.time() psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.lock(psycopg2_conn, mock.Mock()) self.assertIsNone(obj.idle_start) def test_remove_removes_connection(self): with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.remove(psycopg2_conn) self.assertNotIn(psycopg2_conn, obj) def test_remove_closes_connection(self): close_method = mock.Mock() with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False, close=close_method): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.remove(psycopg2_conn) close_method.assert_called_once_with() def test_remove_raises_when_connection_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.remove, mock.Mock()) def test_remove_raises_when_connection_is_busy(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() psycopg2_conn.closed = False obj.add(psycopg2_conn) self.assertRaises(pool.ConnectionBusyError, obj.remove, psycopg2_conn) def test__connection_returns_handle(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) self.assertEqual( obj.connection_handle(psycopg2_conn).handle, psycopg2_conn) def test_shutdown_raises_when_executing(self): psycopg2_conn = mock_connection() psycopg2_conn.isexecuting.return_value = True obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertRaises(pool.ConnectionBusyError, obj.shutdown) <MSG> Fix typo in pool.close test. This commit fixes a typo in the mock assert function call that was allowing a failing test to pass. <DFF> @@ -108,7 +108,8 @@ class PoolTests(unittest.TestCase): psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] obj.close() - obj.remove.assert_hass_calls(psycopg2_conns) + psycopg2_calls = [mock.call(c) for c in psycopg2_conns] + obj.remove.assert_has_calls(psycopg2_calls) def test_free_invokes_connection_free(self): obj = pool.Pool(str(uuid.uuid4()))

Fix typo in pool.close test.

.py

py

bsd-3-clause

gmr/queries

1553

<NME> index.rst <BEF> Queries: PostgreSQL Simplified ============================== *Queries* is a BSD licensed opinionated wrapper of the psycopg2_ library for interacting with PostgreSQL. |Version| |License| The popular psycopg2_ package is a full-featured python client. Unfortunately as a developer, you're often repeating the same steps to get started with your applications that use it. Queries aims to reduce the complexity of psycopg2 while adding additional features to make writing PostgreSQL client applications both fast and easy. *Key features include*: - Simplified API - Support of Python 2.7+ and 3.4+ - PyPy support via psycopg2cffi_ - Asynchronous support for Tornado_ - Connection information provided by URI - Query results delivered as a generator based iterators - Automatically registered data-type support for UUIDs, Unicode and Unicode Arrays - Ability to directly access psycopg2_ :py:class:`~psycopg2.extensions.connection` and :py:class:`~psycopg2.extensions.cursor` objects - Internal connection pooling Installation ------------ Queries can be installed via the `Python Package Index <https://pypi.python.org/pypi/queries>`_ and can be installed by running :command:`easy_install queries` or :command:`pip install queries` When installing Queries, ``pip`` or ``easy_install`` will automatically install the proper dependencies for your platform. Contents -------- .. toctree:: :maxdepth: 1 usage session results tornado_session pool examples/index.rst history Issues ------ Please report any issues to the Github repo at `https://github.com/gmr/queries/issues <https://github.com/gmr/queries/issues>`_ Issues ------ Please report any issues to the Github repo at `https://github.com/gmr/queries/issues <https://github.com/gmr/rabbitpy/queries>`_ Source ------ Queries is inspired by `Kenneth Reitz's <https://github.com/kennethreitz/>`_ awesome work on `requests <http://docs.python-requests.org/en/latest/>`_. Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` .. _pypi: https://pypi.python.org/pypi/queries .. _psycopg2: https://pypi.python.org/pypi/psycopg2 .. _documentation: https://queries.readthedocs.org .. _URI: http://www.postgresql.org/docs/9.3/static/libpq-connect.html#LIBPQ-CONNSTRING .. _pgsql_wrapper: https://pypi.python.org/pypi/pgsql_wrapper .. _Tornado: http://tornadoweb.org .. _PEP343: http://legacy.python.org/dev/peps/pep-0343/ .. _psycopg2cffi: https://pypi.python.org/pypi/psycopg2cffi .. |Version| image:: https://img.shields.io/pypi/v/queries.svg? :target: https://pypi.python.org/pypi/queries .. |License| image:: https://img.shields.io/github/license/gmr/queries.svg? :target: https://github.com/gmr/queries :target: https://travis-ci.org/gmr/queries .. |Downloads| image:: https://pypip.in/d/queries/badge.svg? :target: https://pypi.python.org/pypi/queries <MSG> Update index.rst fix link on issues <DFF> @@ -51,7 +51,7 @@ Contents Issues ------ -Please report any issues to the Github repo at `https://github.com/gmr/queries/issues <https://github.com/gmr/rabbitpy/queries>`_ +Please report any issues to the Github repo at `https://github.com/gmr/queries/issues <https://github.com/gmr/queries/issues>`_ Source ------ @@ -84,4 +84,4 @@ Indices and tables :target: https://travis-ci.org/gmr/queries .. |Downloads| image:: https://pypip.in/d/queries/badge.svg? - :target: https://pypi.python.org/pypi/queries \ No newline at end of file + :target: https://pypi.python.org/pypi/queries

Update index.rst

.rst

rst

bsd-3-clause

gmr/queries

1554

<NME> index.rst <BEF> Queries: PostgreSQL Simplified ============================== *Queries* is a BSD licensed opinionated wrapper of the psycopg2_ library for interacting with PostgreSQL. |Version| |License| The popular psycopg2_ package is a full-featured python client. Unfortunately as a developer, you're often repeating the same steps to get started with your applications that use it. Queries aims to reduce the complexity of psycopg2 while adding additional features to make writing PostgreSQL client applications both fast and easy. *Key features include*: - Simplified API - Support of Python 2.7+ and 3.4+ - PyPy support via psycopg2cffi_ - Asynchronous support for Tornado_ - Connection information provided by URI - Query results delivered as a generator based iterators - Automatically registered data-type support for UUIDs, Unicode and Unicode Arrays - Ability to directly access psycopg2_ :py:class:`~psycopg2.extensions.connection` and :py:class:`~psycopg2.extensions.cursor` objects - Internal connection pooling Installation ------------ Queries can be installed via the `Python Package Index <https://pypi.python.org/pypi/queries>`_ and can be installed by running :command:`easy_install queries` or :command:`pip install queries` When installing Queries, ``pip`` or ``easy_install`` will automatically install the proper dependencies for your platform. Contents -------- .. toctree:: :maxdepth: 1 usage session results tornado_session pool examples/index.rst history Issues ------ Please report any issues to the Github repo at `https://github.com/gmr/queries/issues <https://github.com/gmr/queries/issues>`_ Issues ------ Please report any issues to the Github repo at `https://github.com/gmr/queries/issues <https://github.com/gmr/rabbitpy/queries>`_ Source ------ Queries is inspired by `Kenneth Reitz's <https://github.com/kennethreitz/>`_ awesome work on `requests <http://docs.python-requests.org/en/latest/>`_. Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` .. _pypi: https://pypi.python.org/pypi/queries .. _psycopg2: https://pypi.python.org/pypi/psycopg2 .. _documentation: https://queries.readthedocs.org .. _URI: http://www.postgresql.org/docs/9.3/static/libpq-connect.html#LIBPQ-CONNSTRING .. _pgsql_wrapper: https://pypi.python.org/pypi/pgsql_wrapper .. _Tornado: http://tornadoweb.org .. _PEP343: http://legacy.python.org/dev/peps/pep-0343/ .. _psycopg2cffi: https://pypi.python.org/pypi/psycopg2cffi .. |Version| image:: https://img.shields.io/pypi/v/queries.svg? :target: https://pypi.python.org/pypi/queries .. |License| image:: https://img.shields.io/github/license/gmr/queries.svg? :target: https://github.com/gmr/queries :target: https://travis-ci.org/gmr/queries .. |Downloads| image:: https://pypip.in/d/queries/badge.svg? :target: https://pypi.python.org/pypi/queries <MSG> Update index.rst fix link on issues <DFF> @@ -51,7 +51,7 @@ Contents Issues ------ -Please report any issues to the Github repo at `https://github.com/gmr/queries/issues <https://github.com/gmr/rabbitpy/queries>`_ +Please report any issues to the Github repo at `https://github.com/gmr/queries/issues <https://github.com/gmr/queries/issues>`_ Source ------ @@ -84,4 +84,4 @@ Indices and tables :target: https://travis-ci.org/gmr/queries .. |Downloads| image:: https://pypip.in/d/queries/badge.svg? - :target: https://pypi.python.org/pypi/queries \ No newline at end of file + :target: https://pypi.python.org/pypi/queries

Update index.rst

.rst

rst

bsd-3-clause

gmr/queries

1555

<NME> pool.py <BEF> """ Connection Pooling """ import datetime import logging import os import threading import time import weakref import psycopg2 LOGGER = logging.getLogger(__name__) DEFAULT_IDLE_TTL = 60 DEFAULT_MAX_SIZE = int(os.environ.get('QUERIES_MAX_POOL_SIZE', 1)) """ _lock = threading.Lock() handle = None used_by = None def __init__(self, handle): self.handle = handle def close(self): """Close the connection self.used_by = None self.executions = 0 self.exceptions = 0 def close(self): """Close the connection :raises: ConnectionBusyError """ LOGGER.debug('Connection %s closing', self.id) if self.busy and not self.closed: raise ConnectionBusyError(self) with self._lock: if not self.handle.closed: try: self.handle.close() except psycopg2.InterfaceError as error: LOGGER.error('Error closing socket: %s', error) @property def closed(self): """Return if the psycopg2 connection is closed. :rtype: bool """ return (self.handle.isexecuting() or (not self.used_by is None or (self.used_by and self.used_by() is not None))) def free(self): """Remove the lock on the connection if the connection is not active :raises: ConnectionBusyError """ if self.handle.isexecuting(): raise ConnectionBusyError(self) with self._lock: @property def executing(self): """Return if the connection is currently executing a query :rtype: bool """ return self.handle.isexecuting() def free(self): """Remove the lock on the connection if the connection is not active :raises: ConnectionBusyError """ LOGGER.debug('Connection %s freeing', self.id) if self.handle.isexecuting(): raise ConnectionBusyError(self) with self._lock: self.used_by = None LOGGER.debug('Connection %s freed', self.id) @property def id(self): """Return id of the psycopg2 connection object :rtype: int """ return id(self.handle) def lock(self, session): """Lock the connection, ensuring that it is not busy and storing a weakref for the session. :param queries.Session session: The session to lock the connection with :raises: ConnectionBusyError """ if self.busy: raise ConnectionBusyError(self) with self._lock: self.used_by = weakref.ref(session) LOGGER.debug('Connection %s locked', self.id) @property def locked(self): """Return if the connection is currently exclusively locked :rtype: bool """ return self.used_by is not None class Pool(object): """A connection pool for gaining access to and managing connections""" _lock = threading.Lock() idle_start = None idle_ttl = DEFAULT_IDLE_TTL max_size = DEFAULT_MAX_SIZE def __init__(self, pool_id, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): self.connections = {} self._id = pool_id self.idle_ttl = idle_ttl idle has exceeded its idle TTL, remove all connections. """ for connection in [self.connections[k] for k in self.connections if self.connections[k].closed]: self.remove(connection.handle) if self.idle_duration > self.idle_ttl: def add(self, connection): """Add a new connection to the pool :param connection: The connection to add to the pool :type connection: psycopg2.extensions.connection :raises: PoolFullError """ if id(connection) in self.connections: raise ValueError('Connection already exists in pool') if len(self.connections) == self.max_size: LOGGER.warning('Race condition found when adding new connection') try: :raises: ConnectionNotFoundError """ try: self._connection(connection).free() except KeyError: LOGGER.debug('Pool %s added connection %s', self.id, id(connection)) @property def busy_connections(self): """Return a list of active/busy connections :rtype: list """ return [c for c in self.connections.values() if c.busy and not c.closed] def clean(self): """Clean the pool by removing any closed connections and if the pool's idle has exceeded its idle TTL, remove all connections. """ LOGGER.debug('Cleaning the pool') for connection in [self.connections[k] for k in self.connections if self.connections[k].closed]: LOGGER.debug('Removing %s', connection.id) self.remove(connection.handle) if self.idle_duration > self.idle_ttl: self.close() LOGGER.debug('Pool %s cleaned', self.id) def close(self): """Close the pool by closing and removing all of the connections""" for cid in list(self.connections.keys()): self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) @property def closed_connections(self): """Return a list of closed connections :rtype: list """ return [c for c in self.connections.values() if c.closed] def connection_handle(self, connection): """Return a connection object for the given psycopg2 connection :param connection: The connection to return a parent for :type connection: psycopg2.extensions.connection :rtype: Connection """ return self.connections[id(connection)] @property def executing_connections(self): """Return a list of connections actively executing queries :rtype: list """ return [c for c in self.connections.values() if c.executing] def free(self, connection): """Free the connection from use by the session that was using it. :param connection: The connection to free :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ LOGGER.debug('Pool %s freeing connection %s', self.id, id(connection)) try: self.connection_handle(connection).free() except KeyError: raise ConnectionNotFoundError(self.id, id(connection)) if self.idle_connections == list(self.connections.values()): with self._lock: self.idle_start = self.time_method() LOGGER.debug('Pool %s freed connection %s', self.id, id(connection)) def get(self, session): """Return an idle connection and assign the session to the connection :param queries.Session session: The session to assign :rtype: psycopg2.extensions.connection :raises: NoIdleConnectionsError """ idle = self.idle_connections if idle: connection = idle.pop(0) connection.lock(session) if self.idle_start: with self._lock: self.idle_start = None return connection.handle raise NoIdleConnectionsError(self.id) @property def id(self): """Return the ID for this pool :rtype: str """ return self._id @property def idle_connections(self): """Return a list of idle connections :rtype: list """ return [c for c in self.connections.values() if not c.busy and not c.closed] @property def idle_duration(self): """Return the number of seconds that the pool has had no active connections. :rtype: float """ if self.idle_start is None: return 0 return self.time_method() - self.idle_start @property def is_full(self): """Return True if there are no more open slots for connections. :rtype: bool """ return len(self.connections) >= self.max_size def lock(self, connection, session): """Explicitly lock the specified connection :type connection: psycopg2.extensions.connection :param connection: The connection to lock :param queries.Session session: The session to hold the lock """ cid = id(connection) try: self.connection_handle(connection).lock(session) except KeyError: raise ConnectionNotFoundError(self.id, cid) else: if self.idle_start: with self._lock: self.idle_start = None LOGGER.debug('Pool %s locked connection %s', self.id, cid) @property def locked_connections(self): """Return a list of all locked connections :rtype: list """ return [c for c in self.connections.values() if c.locked] def remove(self, connection): """Remove the connection from the pool :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError :raises: ConnectionBusyError """ cid = id(connection) if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) self.connection_handle(connection).close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) def report(self): """Return a report about the pool state and configuration. :rtype: dict """ return { 'connections': { 'busy': len(self.busy_connections), 'closed': len(self.closed_connections), 'executing': len(self.executing_connections), 'idle': len(self.idle_connections), 'locked': len(self.busy_connections) }, 'exceptions': sum([c.exceptions for c in self.connections.values()]), 'executions': sum([c.executions for c in self.connections.values()]), 'full': self.is_full, 'idle': { 'duration': self.idle_duration, 'ttl': self.idle_ttl }, 'max_size': self.max_size } def shutdown(self): """Forcefully shutdown the entire pool, closing all non-executing connections. :raises: ConnectionBusyError """ with self._lock: for cid in list(self.connections.keys()): if self.connections[cid].executing: raise ConnectionBusyError(cid) if self.connections[cid].locked: self.connections[cid].free() self.connections[cid].close() del self.connections[cid] def set_idle_ttl(self, ttl): """Set the idle ttl :param int ttl: The TTL when idle """ with self._lock: self.idle_ttl = ttl def set_max_size(self, size): """Set the maximum number of connections :param int size: The maximum number of connections :type connection: psycopg2.extensions.connection """ cls._ensure_pool_exists(pid) with cls._lock: return cls._pools[pid].free(connection) @classmethod def has_connection(cls, pid, connection): carrying the URI in memory, creating a possible security issue. """ _lock = threading.Lock() _pools = {} def __contains__(self, pid): """Returns True if the pool exists :param str pid: The pool id to check for :rtype: bool """ return pid in self.__class__._pools @classmethod def instance(cls): """Only allow a single PoolManager instance to exist, returning the handle for it. :rtype: PoolManager """ if not hasattr(cls, '_instance'): with cls._lock: cls._instance = cls() return cls._instance @classmethod def add(cls, pid, connection): """Add a new connection and session to a pool. :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].add(connection) @classmethod def clean(cls, pid): """Clean the specified pool, removing any closed connections or stale locks. :param str pid: The pool id to clean """ with cls._lock: try: cls._ensure_pool_exists(pid) except KeyError: LOGGER.debug('Pool clean invoked against missing pool %s', pid) return cls._pools[pid].clean() cls._maybe_remove_pool(pid) @classmethod def create(cls, pid, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): """Create a new pool, with the ability to pass in values to override the default idle TTL and the default maximum size. A pool's idle TTL defines the amount of time that a pool can be open without any sessions before it is removed. A pool's max size defines the maximum number of connections that can be added to the pool to prevent unbounded open connections. :param str pid: The pool ID :param int idle_ttl: Time in seconds for the idle TTL :param int max_size: The maximum pool size :param callable time_method: Override the use of :py:meth:`time.time` method for time values. :raises: KeyError """ if pid in cls._pools: raise KeyError('Pool %s already exists' % pid) with cls._lock: LOGGER.debug("Creating Pool: %s (%i/%i)", pid, idle_ttl, max_size) cls._pools[pid] = Pool(pid, idle_ttl, max_size, time_method) @classmethod def free(cls, pid, connection): """Free a connection that was locked by a session :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection """ with cls._lock: LOGGER.debug('Freeing %s from pool %s', id(connection), pid) cls._ensure_pool_exists(pid) cls._pools[pid].free(connection) @classmethod def get(cls, pid, session): """Get an idle, unused connection from the pool. Once a connection has been retrieved, it will be marked as in-use until it is freed. :param str pid: The pool ID :param queries.Session session: The session to assign to the connection :rtype: psycopg2.extensions.connection """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].get(session) @classmethod def get_connection(cls, pid, connection): """Return the specified :class:`~queries.pool.Connection` from the pool. :param str pid: The pool ID :param connection: The connection to return for :type connection: psycopg2.extensions.connection :rtype: queries.pool.Connection """ with cls._lock: return cls._pools[pid].connection_handle(connection) @classmethod def has_connection(cls, pid, connection): """Check to see if a pool has the specified connection :param str pid: The pool ID :param connection: The connection to check for :type connection: psycopg2.extensions.connection :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return connection in cls._pools[pid] @classmethod def has_idle_connection(cls, pid): """Check to see if a pool has an idle connection :param str pid: The pool ID :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return bool(cls._pools[pid].idle_connections) @classmethod def is_full(cls, pid): """Return a bool indicating if the specified pool is full :param str pid: The pool id :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].is_full @classmethod def lock(cls, pid, connection, session): """Explicitly lock the specified connection in the pool :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool :param queries.Session session: The session to hold the lock """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].lock(connection, session) @classmethod def remove(cls, pid): """Remove a pool, closing all connections :param str pid: The pool ID """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].close() del cls._pools[pid] @classmethod def remove_connection(cls, pid, connection): """Remove a connection from the pool, closing it if is open. :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ cls._ensure_pool_exists(pid) cls._pools[pid].remove(connection) @classmethod def set_idle_ttl(cls, pid, ttl): """Set the idle TTL for a pool, after which it will be destroyed. :param str pid: The pool id :param int ttl: The TTL for an idle pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_idle_ttl(ttl) @classmethod def set_max_size(cls, pid, size): """Set the maximum number of connections for the specified pool :param str pid: The pool to set the size for :param int size: The maximum number of connections """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_max_size(size) @classmethod def shutdown(cls): """Close all connections on in all pools""" for pid in list(cls._pools.keys()): cls._pools[pid].shutdown() LOGGER.info('Shutdown complete, all pooled connections closed') @classmethod def size(cls, pid): """Return the number of connections in the pool :param str pid: The pool id :rtype int """ with cls._lock: cls._ensure_pool_exists(pid) return len(cls._pools[pid]) @classmethod def report(cls): """Return the state of the all of the registered pools. :rtype: dict """ return { 'timestamp': datetime.datetime.utcnow().isoformat(), 'process': os.getpid(), 'pools': dict([(i, p.report()) for i, p in cls._pools.items()]) } @classmethod def _ensure_pool_exists(cls, pid): """Raise an exception if the pool has yet to be created or has been removed. :param str pid: The pool ID to check for :raises: KeyError """ if pid not in cls._pools: raise KeyError('Pool %s has not been created' % pid) @classmethod def _maybe_remove_pool(cls, pid): """If the pool has no open connections, remove it :param str pid: The pool id to clean """ if not len(cls._pools[pid]): del cls._pools[pid] class QueriesException(Exception): """Base Exception for all other Queries exceptions""" pass class ConnectionException(QueriesException): def __init__(self, cid): self.cid = cid class PoolException(QueriesException): def __init__(self, pid): self.pid = pid class PoolConnectionException(PoolException): def __init__(self, pid, cid): self.pid = pid self.cid = cid class ActivePoolError(PoolException): """Raised when removing a pool that has active connections""" def __str__(self): return 'Pool %s has at least one active connection' % self.pid class ConnectionBusyError(ConnectionException): """Raised when trying to lock a connection that is already busy""" def __str__(self): return 'Connection %s is busy' % self.cid class ConnectionNotFoundError(PoolConnectionException): """Raised if a specific connection is not found in the pool""" def __str__(self): return 'Connection %s not found in pool %s' % (self.cid, self.pid) class NoIdleConnectionsError(PoolException): """Raised if a pool does not have any idle, open connections""" def __str__(self): return 'Pool %s has no idle connections' % self.pid class PoolFullError(PoolException): """Raised when adding a connection to a pool that has hit max-size""" def __str__(self): return 'Pool %s is at its maximum capacity' % self.pid <MSG> Ensure used_by and handler are not class scoped, refactor busy - Make the Connection.busy code easier to read - Add debug logging <DFF> @@ -20,11 +20,9 @@ class Connection(object): """ _lock = threading.Lock() - handle = None - used_by = None - def __init__(self, handle): self.handle = handle + self.used_by = None def close(self): """Close the connection @@ -55,9 +53,11 @@ class Connection(object): :rtype: bool """ - return (self.handle.isexecuting() or - (not self.used_by is None or - (self.used_by and self.used_by() is not None))) + if self.handle.isexecuting(): + return True + elif self.used_by is None: + return False + return not self.used_by() is None def free(self): """Remove the lock on the connection if the connection is not active @@ -65,6 +65,7 @@ class Connection(object): :raises: ConnectionBusyError """ + LOGGER.debug('Connection %s freeing', self.id) if self.handle.isexecuting(): raise ConnectionBusyError(self) with self._lock: @@ -142,8 +143,10 @@ class Pool(object): idle has exceeded its idle TTL, remove all connections. """ + LOGGER.debug('Cleaning the pool') for connection in [self.connections[k] for k in self.connections if self.connections[k].closed]: + LOGGER.debug('Removing %s', connection.id) self.remove(connection.handle) if self.idle_duration > self.idle_ttl: @@ -165,6 +168,7 @@ class Pool(object): :raises: ConnectionNotFoundError """ + LOGGER.debug('Pool %s freeing connection %s', self.id, id(connection)) try: self._connection(connection).free() except KeyError: @@ -411,9 +415,10 @@ class PoolManager(object): :type connection: psycopg2.extensions.connection """ + LOGGER.debug('Freeing %s from pool %s', id(connection), pid) cls._ensure_pool_exists(pid) with cls._lock: - return cls._pools[pid].free(connection) + cls._pools[pid].free(connection) @classmethod def has_connection(cls, pid, connection):

Ensure used_by and handler are not class scoped, refactor busy

.py

py

bsd-3-clause

gmr/queries

1556

<NME> pool.py <BEF> """ Connection Pooling """ import datetime import logging import os import threading import time import weakref import psycopg2 LOGGER = logging.getLogger(__name__) DEFAULT_IDLE_TTL = 60 DEFAULT_MAX_SIZE = int(os.environ.get('QUERIES_MAX_POOL_SIZE', 1)) """ _lock = threading.Lock() handle = None used_by = None def __init__(self, handle): self.handle = handle def close(self): """Close the connection self.used_by = None self.executions = 0 self.exceptions = 0 def close(self): """Close the connection :raises: ConnectionBusyError """ LOGGER.debug('Connection %s closing', self.id) if self.busy and not self.closed: raise ConnectionBusyError(self) with self._lock: if not self.handle.closed: try: self.handle.close() except psycopg2.InterfaceError as error: LOGGER.error('Error closing socket: %s', error) @property def closed(self): """Return if the psycopg2 connection is closed. :rtype: bool """ return (self.handle.isexecuting() or (not self.used_by is None or (self.used_by and self.used_by() is not None))) def free(self): """Remove the lock on the connection if the connection is not active :raises: ConnectionBusyError """ if self.handle.isexecuting(): raise ConnectionBusyError(self) with self._lock: @property def executing(self): """Return if the connection is currently executing a query :rtype: bool """ return self.handle.isexecuting() def free(self): """Remove the lock on the connection if the connection is not active :raises: ConnectionBusyError """ LOGGER.debug('Connection %s freeing', self.id) if self.handle.isexecuting(): raise ConnectionBusyError(self) with self._lock: self.used_by = None LOGGER.debug('Connection %s freed', self.id) @property def id(self): """Return id of the psycopg2 connection object :rtype: int """ return id(self.handle) def lock(self, session): """Lock the connection, ensuring that it is not busy and storing a weakref for the session. :param queries.Session session: The session to lock the connection with :raises: ConnectionBusyError """ if self.busy: raise ConnectionBusyError(self) with self._lock: self.used_by = weakref.ref(session) LOGGER.debug('Connection %s locked', self.id) @property def locked(self): """Return if the connection is currently exclusively locked :rtype: bool """ return self.used_by is not None class Pool(object): """A connection pool for gaining access to and managing connections""" _lock = threading.Lock() idle_start = None idle_ttl = DEFAULT_IDLE_TTL max_size = DEFAULT_MAX_SIZE def __init__(self, pool_id, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): self.connections = {} self._id = pool_id self.idle_ttl = idle_ttl idle has exceeded its idle TTL, remove all connections. """ for connection in [self.connections[k] for k in self.connections if self.connections[k].closed]: self.remove(connection.handle) if self.idle_duration > self.idle_ttl: def add(self, connection): """Add a new connection to the pool :param connection: The connection to add to the pool :type connection: psycopg2.extensions.connection :raises: PoolFullError """ if id(connection) in self.connections: raise ValueError('Connection already exists in pool') if len(self.connections) == self.max_size: LOGGER.warning('Race condition found when adding new connection') try: :raises: ConnectionNotFoundError """ try: self._connection(connection).free() except KeyError: LOGGER.debug('Pool %s added connection %s', self.id, id(connection)) @property def busy_connections(self): """Return a list of active/busy connections :rtype: list """ return [c for c in self.connections.values() if c.busy and not c.closed] def clean(self): """Clean the pool by removing any closed connections and if the pool's idle has exceeded its idle TTL, remove all connections. """ LOGGER.debug('Cleaning the pool') for connection in [self.connections[k] for k in self.connections if self.connections[k].closed]: LOGGER.debug('Removing %s', connection.id) self.remove(connection.handle) if self.idle_duration > self.idle_ttl: self.close() LOGGER.debug('Pool %s cleaned', self.id) def close(self): """Close the pool by closing and removing all of the connections""" for cid in list(self.connections.keys()): self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) @property def closed_connections(self): """Return a list of closed connections :rtype: list """ return [c for c in self.connections.values() if c.closed] def connection_handle(self, connection): """Return a connection object for the given psycopg2 connection :param connection: The connection to return a parent for :type connection: psycopg2.extensions.connection :rtype: Connection """ return self.connections[id(connection)] @property def executing_connections(self): """Return a list of connections actively executing queries :rtype: list """ return [c for c in self.connections.values() if c.executing] def free(self, connection): """Free the connection from use by the session that was using it. :param connection: The connection to free :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ LOGGER.debug('Pool %s freeing connection %s', self.id, id(connection)) try: self.connection_handle(connection).free() except KeyError: raise ConnectionNotFoundError(self.id, id(connection)) if self.idle_connections == list(self.connections.values()): with self._lock: self.idle_start = self.time_method() LOGGER.debug('Pool %s freed connection %s', self.id, id(connection)) def get(self, session): """Return an idle connection and assign the session to the connection :param queries.Session session: The session to assign :rtype: psycopg2.extensions.connection :raises: NoIdleConnectionsError """ idle = self.idle_connections if idle: connection = idle.pop(0) connection.lock(session) if self.idle_start: with self._lock: self.idle_start = None return connection.handle raise NoIdleConnectionsError(self.id) @property def id(self): """Return the ID for this pool :rtype: str """ return self._id @property def idle_connections(self): """Return a list of idle connections :rtype: list """ return [c for c in self.connections.values() if not c.busy and not c.closed] @property def idle_duration(self): """Return the number of seconds that the pool has had no active connections. :rtype: float """ if self.idle_start is None: return 0 return self.time_method() - self.idle_start @property def is_full(self): """Return True if there are no more open slots for connections. :rtype: bool """ return len(self.connections) >= self.max_size def lock(self, connection, session): """Explicitly lock the specified connection :type connection: psycopg2.extensions.connection :param connection: The connection to lock :param queries.Session session: The session to hold the lock """ cid = id(connection) try: self.connection_handle(connection).lock(session) except KeyError: raise ConnectionNotFoundError(self.id, cid) else: if self.idle_start: with self._lock: self.idle_start = None LOGGER.debug('Pool %s locked connection %s', self.id, cid) @property def locked_connections(self): """Return a list of all locked connections :rtype: list """ return [c for c in self.connections.values() if c.locked] def remove(self, connection): """Remove the connection from the pool :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError :raises: ConnectionBusyError """ cid = id(connection) if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) self.connection_handle(connection).close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) def report(self): """Return a report about the pool state and configuration. :rtype: dict """ return { 'connections': { 'busy': len(self.busy_connections), 'closed': len(self.closed_connections), 'executing': len(self.executing_connections), 'idle': len(self.idle_connections), 'locked': len(self.busy_connections) }, 'exceptions': sum([c.exceptions for c in self.connections.values()]), 'executions': sum([c.executions for c in self.connections.values()]), 'full': self.is_full, 'idle': { 'duration': self.idle_duration, 'ttl': self.idle_ttl }, 'max_size': self.max_size } def shutdown(self): """Forcefully shutdown the entire pool, closing all non-executing connections. :raises: ConnectionBusyError """ with self._lock: for cid in list(self.connections.keys()): if self.connections[cid].executing: raise ConnectionBusyError(cid) if self.connections[cid].locked: self.connections[cid].free() self.connections[cid].close() del self.connections[cid] def set_idle_ttl(self, ttl): """Set the idle ttl :param int ttl: The TTL when idle """ with self._lock: self.idle_ttl = ttl def set_max_size(self, size): """Set the maximum number of connections :param int size: The maximum number of connections :type connection: psycopg2.extensions.connection """ cls._ensure_pool_exists(pid) with cls._lock: return cls._pools[pid].free(connection) @classmethod def has_connection(cls, pid, connection): carrying the URI in memory, creating a possible security issue. """ _lock = threading.Lock() _pools = {} def __contains__(self, pid): """Returns True if the pool exists :param str pid: The pool id to check for :rtype: bool """ return pid in self.__class__._pools @classmethod def instance(cls): """Only allow a single PoolManager instance to exist, returning the handle for it. :rtype: PoolManager """ if not hasattr(cls, '_instance'): with cls._lock: cls._instance = cls() return cls._instance @classmethod def add(cls, pid, connection): """Add a new connection and session to a pool. :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].add(connection) @classmethod def clean(cls, pid): """Clean the specified pool, removing any closed connections or stale locks. :param str pid: The pool id to clean """ with cls._lock: try: cls._ensure_pool_exists(pid) except KeyError: LOGGER.debug('Pool clean invoked against missing pool %s', pid) return cls._pools[pid].clean() cls._maybe_remove_pool(pid) @classmethod def create(cls, pid, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): """Create a new pool, with the ability to pass in values to override the default idle TTL and the default maximum size. A pool's idle TTL defines the amount of time that a pool can be open without any sessions before it is removed. A pool's max size defines the maximum number of connections that can be added to the pool to prevent unbounded open connections. :param str pid: The pool ID :param int idle_ttl: Time in seconds for the idle TTL :param int max_size: The maximum pool size :param callable time_method: Override the use of :py:meth:`time.time` method for time values. :raises: KeyError """ if pid in cls._pools: raise KeyError('Pool %s already exists' % pid) with cls._lock: LOGGER.debug("Creating Pool: %s (%i/%i)", pid, idle_ttl, max_size) cls._pools[pid] = Pool(pid, idle_ttl, max_size, time_method) @classmethod def free(cls, pid, connection): """Free a connection that was locked by a session :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection """ with cls._lock: LOGGER.debug('Freeing %s from pool %s', id(connection), pid) cls._ensure_pool_exists(pid) cls._pools[pid].free(connection) @classmethod def get(cls, pid, session): """Get an idle, unused connection from the pool. Once a connection has been retrieved, it will be marked as in-use until it is freed. :param str pid: The pool ID :param queries.Session session: The session to assign to the connection :rtype: psycopg2.extensions.connection """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].get(session) @classmethod def get_connection(cls, pid, connection): """Return the specified :class:`~queries.pool.Connection` from the pool. :param str pid: The pool ID :param connection: The connection to return for :type connection: psycopg2.extensions.connection :rtype: queries.pool.Connection """ with cls._lock: return cls._pools[pid].connection_handle(connection) @classmethod def has_connection(cls, pid, connection): """Check to see if a pool has the specified connection :param str pid: The pool ID :param connection: The connection to check for :type connection: psycopg2.extensions.connection :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return connection in cls._pools[pid] @classmethod def has_idle_connection(cls, pid): """Check to see if a pool has an idle connection :param str pid: The pool ID :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return bool(cls._pools[pid].idle_connections) @classmethod def is_full(cls, pid): """Return a bool indicating if the specified pool is full :param str pid: The pool id :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].is_full @classmethod def lock(cls, pid, connection, session): """Explicitly lock the specified connection in the pool :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool :param queries.Session session: The session to hold the lock """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].lock(connection, session) @classmethod def remove(cls, pid): """Remove a pool, closing all connections :param str pid: The pool ID """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].close() del cls._pools[pid] @classmethod def remove_connection(cls, pid, connection): """Remove a connection from the pool, closing it if is open. :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ cls._ensure_pool_exists(pid) cls._pools[pid].remove(connection) @classmethod def set_idle_ttl(cls, pid, ttl): """Set the idle TTL for a pool, after which it will be destroyed. :param str pid: The pool id :param int ttl: The TTL for an idle pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_idle_ttl(ttl) @classmethod def set_max_size(cls, pid, size): """Set the maximum number of connections for the specified pool :param str pid: The pool to set the size for :param int size: The maximum number of connections """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_max_size(size) @classmethod def shutdown(cls): """Close all connections on in all pools""" for pid in list(cls._pools.keys()): cls._pools[pid].shutdown() LOGGER.info('Shutdown complete, all pooled connections closed') @classmethod def size(cls, pid): """Return the number of connections in the pool :param str pid: The pool id :rtype int """ with cls._lock: cls._ensure_pool_exists(pid) return len(cls._pools[pid]) @classmethod def report(cls): """Return the state of the all of the registered pools. :rtype: dict """ return { 'timestamp': datetime.datetime.utcnow().isoformat(), 'process': os.getpid(), 'pools': dict([(i, p.report()) for i, p in cls._pools.items()]) } @classmethod def _ensure_pool_exists(cls, pid): """Raise an exception if the pool has yet to be created or has been removed. :param str pid: The pool ID to check for :raises: KeyError """ if pid not in cls._pools: raise KeyError('Pool %s has not been created' % pid) @classmethod def _maybe_remove_pool(cls, pid): """If the pool has no open connections, remove it :param str pid: The pool id to clean """ if not len(cls._pools[pid]): del cls._pools[pid] class QueriesException(Exception): """Base Exception for all other Queries exceptions""" pass class ConnectionException(QueriesException): def __init__(self, cid): self.cid = cid class PoolException(QueriesException): def __init__(self, pid): self.pid = pid class PoolConnectionException(PoolException): def __init__(self, pid, cid): self.pid = pid self.cid = cid class ActivePoolError(PoolException): """Raised when removing a pool that has active connections""" def __str__(self): return 'Pool %s has at least one active connection' % self.pid class ConnectionBusyError(ConnectionException): """Raised when trying to lock a connection that is already busy""" def __str__(self): return 'Connection %s is busy' % self.cid class ConnectionNotFoundError(PoolConnectionException): """Raised if a specific connection is not found in the pool""" def __str__(self): return 'Connection %s not found in pool %s' % (self.cid, self.pid) class NoIdleConnectionsError(PoolException): """Raised if a pool does not have any idle, open connections""" def __str__(self): return 'Pool %s has no idle connections' % self.pid class PoolFullError(PoolException): """Raised when adding a connection to a pool that has hit max-size""" def __str__(self): return 'Pool %s is at its maximum capacity' % self.pid <MSG> Ensure used_by and handler are not class scoped, refactor busy - Make the Connection.busy code easier to read - Add debug logging <DFF> @@ -20,11 +20,9 @@ class Connection(object): """ _lock = threading.Lock() - handle = None - used_by = None - def __init__(self, handle): self.handle = handle + self.used_by = None def close(self): """Close the connection @@ -55,9 +53,11 @@ class Connection(object): :rtype: bool """ - return (self.handle.isexecuting() or - (not self.used_by is None or - (self.used_by and self.used_by() is not None))) + if self.handle.isexecuting(): + return True + elif self.used_by is None: + return False + return not self.used_by() is None def free(self): """Remove the lock on the connection if the connection is not active @@ -65,6 +65,7 @@ class Connection(object): :raises: ConnectionBusyError """ + LOGGER.debug('Connection %s freeing', self.id) if self.handle.isexecuting(): raise ConnectionBusyError(self) with self._lock: @@ -142,8 +143,10 @@ class Pool(object): idle has exceeded its idle TTL, remove all connections. """ + LOGGER.debug('Cleaning the pool') for connection in [self.connections[k] for k in self.connections if self.connections[k].closed]: + LOGGER.debug('Removing %s', connection.id) self.remove(connection.handle) if self.idle_duration > self.idle_ttl: @@ -165,6 +168,7 @@ class Pool(object): :raises: ConnectionNotFoundError """ + LOGGER.debug('Pool %s freeing connection %s', self.id, id(connection)) try: self._connection(connection).free() except KeyError: @@ -411,9 +415,10 @@ class PoolManager(object): :type connection: psycopg2.extensions.connection """ + LOGGER.debug('Freeing %s from pool %s', id(connection), pid) cls._ensure_pool_exists(pid) with cls._lock: - return cls._pools[pid].free(connection) + cls._pools[pid].free(connection) @classmethod def has_connection(cls, pid, connection):

Ensure used_by and handler are not class scoped, refactor busy

.py

py

bsd-3-clause

gmr/queries

1557

<NME> pool.py <BEF> """ Connection Pooling """ import datetime import logging import os import time import weakref LOGGER = logging.getLogger(__name__) DEFAULT_IDLE_TTL = 60 DEFAULT_IDLE_TTL = 60 DEFAULT_MAX_SIZE = int(os.environ.get('QUERIES_MAX_POOL_SIZE', 1)) class Connection(object): """Contains the handle to the connection, the current state of the connection and methods for manipulating the state of the connection. """ _lock = threading.Lock() def __init__(self, handle): self.handle = handle self.used_by = None self.executions = 0 self.exceptions = 0 def close(self): """Close the connection :raises: ConnectionBusyError """ LOGGER.debug('Connection %s closing', self.id) if self.busy and not self.closed: raise ConnectionBusyError(self) with self._lock: if not self.handle.closed: try: self.handle.close() except psycopg2.InterfaceError as error: LOGGER.error('Error closing socket: %s', error) @property def closed(self): """Return if the psycopg2 connection is closed. :rtype: bool """ return self.handle.closed != 0 @property def busy(self): """Return if the connection is currently executing a query or is locked by a session that still exists. :rtype: bool """ if self.handle.isexecuting(): return True elif self.used_by is None: return False return not self.used_by() is None @property def executing(self): """Return if the connection is currently executing a query :rtype: bool """ return self.handle.isexecuting() def free(self): """Remove the lock on the connection if the connection is not active :raises: ConnectionBusyError """ LOGGER.debug('Connection %s freeing', self.id) if self.handle.isexecuting(): raise ConnectionBusyError(self) with self._lock: self.used_by = None LOGGER.debug('Connection %s freed', self.id) @property def id(self): """Return id of the psycopg2 connection object :rtype: int """ return id(self.handle) def lock(self, session): """Lock the connection, ensuring that it is not busy and storing a weakref for the session. :param queries.Session session: The session to lock the connection with :raises: ConnectionBusyError """ if self.busy: raise ConnectionBusyError(self) with self._lock: self.used_by = weakref.ref(session) LOGGER.debug('Connection %s locked', self.id) @property def locked(self): """Return if the connection is currently exclusively locked :rtype: bool """ return self.used_by is not None class Pool(object): """A connection pool for gaining access to and managing connections""" _lock = threading.Lock() idle_start = None idle_ttl = DEFAULT_IDLE_TTL max_size = DEFAULT_MAX_SIZE def __init__(self, pool_id, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): self.connections = {} self._id = pool_id self.idle_ttl = idle_ttl self.max_size = max_size self.time_method = time_method or time.time def __contains__(self, connection): """Return True if the pool contains the connection""" return id(connection) in self.connections def __len__(self): """Return the number of connections in the pool""" return len(self.connections) raise ValueError('Connection already exists in pool') if len(self.connections) == self.max_size: raise PoolFullError(self) with self._lock: self.connections[id(connection)] = Connection(connection) LOGGER.warning('Race condition found when adding new connection') try: connection.close() except (psycopg2.Error, psycopg2.Warning) as error: LOGGER.error('Error closing the conn that cant be used: %s', error) raise PoolFullError(self) with self._lock: self.connections[id(connection)] = Connection(connection) LOGGER.debug('Pool %s added connection %s', self.id, id(connection)) @property def busy_connections(self): """Return a list of active/busy connections :rtype: list """ return [c for c in self.connections.values() if c.busy and not c.closed] def clean(self): """Clean the pool by removing any closed connections and if the pool's idle has exceeded its idle TTL, remove all connections. """ LOGGER.debug('Cleaning the pool') for connection in [self.connections[k] for k in self.connections if self.connections[k].closed]: LOGGER.debug('Removing %s', connection.id) self.remove(connection.handle) if self.idle_duration > self.idle_ttl: self.close() LOGGER.debug('Pool %s cleaned', self.id) def close(self): """Close the pool by closing and removing all of the connections""" for cid in list(self.connections.keys()): self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) @property def closed_connections(self): """Return a list of closed connections :rtype: list """ return [c for c in self.connections.values() if c.closed] def connection_handle(self, connection): """Return a connection object for the given psycopg2 connection :param connection: The connection to return a parent for :type connection: psycopg2.extensions.connection :rtype: Connection """ return self.connections[id(connection)] @property def executing_connections(self): """Return a list of connections actively executing queries :rtype: list """ return [c for c in self.connections.values() if c.executing] def free(self, connection): """Free the connection from use by the session that was using it. :param connection: The connection to free :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ LOGGER.debug('Pool %s freeing connection %s', self.id, id(connection)) try: self.connection_handle(connection).free() except KeyError: raise ConnectionNotFoundError(self.id, id(connection)) if self.idle_connections == list(self.connections.values()): with self._lock: self.idle_start = self.time_method() LOGGER.debug('Pool %s freed connection %s', self.id, id(connection)) def get(self, session): """Return an idle connection and assign the session to the connection :param queries.Session session: The session to assign :rtype: psycopg2.extensions.connection :raises: NoIdleConnectionsError """ idle = self.idle_connections if idle: connection = idle.pop(0) connection.lock(session) if self.idle_start: with self._lock: self.idle_start = None return connection.handle raise NoIdleConnectionsError(self.id) @property def id(self): """Return the ID for this pool :rtype: str """ return self._id @property def idle_connections(self): """Return a list of idle connections :rtype: list """ return [c for c in self.connections.values() if not c.busy and not c.closed] @property def idle_duration(self): """Return the number of seconds that the pool has had no active connections. :rtype: float """ if self.idle_start is None: return 0 return self.time_method() - self.idle_start @property def is_full(self): """Return True if there are no more open slots for connections. :rtype: bool """ return len(self.connections) >= self.max_size def lock(self, connection, session): """Explicitly lock the specified connection :type connection: psycopg2.extensions.connection :param connection: The connection to lock :param queries.Session session: The session to hold the lock """ cid = id(connection) try: self.connection_handle(connection).lock(session) except KeyError: raise ConnectionNotFoundError(self.id, cid) else: if self.idle_start: with self._lock: self.idle_start = None LOGGER.debug('Pool %s locked connection %s', self.id, cid) @property def locked_connections(self): """Return a list of all locked connections :rtype: list """ return [c for c in self.connections.values() if c.locked] def remove(self, connection): """Remove the connection from the pool :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError :raises: ConnectionBusyError """ cid = id(connection) if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) self.connection_handle(connection).close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) def report(self): """Return a report about the pool state and configuration. :rtype: dict """ return { 'connections': { 'busy': len(self.busy_connections), 'closed': len(self.closed_connections), 'executing': len(self.executing_connections), 'idle': len(self.idle_connections), 'locked': len(self.busy_connections) }, 'exceptions': sum([c.exceptions for c in self.connections.values()]), 'executions': sum([c.executions for c in self.connections.values()]), 'full': self.is_full, 'idle': { 'duration': self.idle_duration, 'ttl': self.idle_ttl }, 'max_size': self.max_size } def shutdown(self): """Forcefully shutdown the entire pool, closing all non-executing connections. :raises: ConnectionBusyError """ with self._lock: for cid in list(self.connections.keys()): if self.connections[cid].executing: raise ConnectionBusyError(cid) if self.connections[cid].locked: self.connections[cid].free() self.connections[cid].close() del self.connections[cid] def set_idle_ttl(self, ttl): """Set the idle ttl :param int ttl: The TTL when idle """ with self._lock: self.idle_ttl = ttl def set_max_size(self, size): """Set the maximum number of connections :param int size: The maximum number of connections """ with self._lock: self.max_size = size class PoolManager(object): """The connection pool object implements behavior around connections and their use in queries.Session objects. We carry a pool id instead of the connection URI so that we will not be carrying the URI in memory, creating a possible security issue. """ _lock = threading.Lock() _pools = {} def __contains__(self, pid): """Returns True if the pool exists :param str pid: The pool id to check for :rtype: bool """ return pid in self.__class__._pools @classmethod def instance(cls): """Only allow a single PoolManager instance to exist, returning the handle for it. :rtype: PoolManager """ if not hasattr(cls, '_instance'): with cls._lock: cls._instance = cls() return cls._instance @classmethod def add(cls, pid, connection): """Add a new connection and session to a pool. :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].add(connection) @classmethod def clean(cls, pid): """Clean the specified pool, removing any closed connections or stale locks. :param str pid: The pool id to clean """ with cls._lock: try: cls._ensure_pool_exists(pid) except KeyError: LOGGER.debug('Pool clean invoked against missing pool %s', pid) return cls._pools[pid].clean() cls._maybe_remove_pool(pid) @classmethod def create(cls, pid, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): """Create a new pool, with the ability to pass in values to override the default idle TTL and the default maximum size. A pool's idle TTL defines the amount of time that a pool can be open without any sessions before it is removed. A pool's max size defines the maximum number of connections that can be added to the pool to prevent unbounded open connections. :param str pid: The pool ID :param int idle_ttl: Time in seconds for the idle TTL :param int max_size: The maximum pool size :param callable time_method: Override the use of :py:meth:`time.time` method for time values. :raises: KeyError """ if pid in cls._pools: raise KeyError('Pool %s already exists' % pid) with cls._lock: LOGGER.debug("Creating Pool: %s (%i/%i)", pid, idle_ttl, max_size) cls._pools[pid] = Pool(pid, idle_ttl, max_size, time_method) @classmethod def free(cls, pid, connection): """Free a connection that was locked by a session :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection """ with cls._lock: LOGGER.debug('Freeing %s from pool %s', id(connection), pid) cls._ensure_pool_exists(pid) cls._pools[pid].free(connection) @classmethod def get(cls, pid, session): """Get an idle, unused connection from the pool. Once a connection has been retrieved, it will be marked as in-use until it is freed. :param str pid: The pool ID :param queries.Session session: The session to assign to the connection :rtype: psycopg2.extensions.connection """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].get(session) @classmethod def get_connection(cls, pid, connection): """Return the specified :class:`~queries.pool.Connection` from the pool. :param str pid: The pool ID :param connection: The connection to return for :type connection: psycopg2.extensions.connection :rtype: queries.pool.Connection """ with cls._lock: return cls._pools[pid].connection_handle(connection) @classmethod def has_connection(cls, pid, connection): """Check to see if a pool has the specified connection :param str pid: The pool ID :param connection: The connection to check for :type connection: psycopg2.extensions.connection :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return connection in cls._pools[pid] @classmethod def has_idle_connection(cls, pid): """Check to see if a pool has an idle connection :param str pid: The pool ID :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return bool(cls._pools[pid].idle_connections) @classmethod def is_full(cls, pid): """Return a bool indicating if the specified pool is full :param str pid: The pool id :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].is_full @classmethod def lock(cls, pid, connection, session): """Explicitly lock the specified connection in the pool raise KeyError('Pool %s has not been created' % pid) class ConnectionException(Exception): def __init__(self, cid): self.cid = cid class PoolException(Exception): def __init__(self, pid): self.pid = pid class PoolConnectionException(Exception): def __init__(self, pid, cid): self.pid = pid self.cid = cid @classmethod def remove_connection(cls, pid, connection): """Remove a connection from the pool, closing it if is open. :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ cls._ensure_pool_exists(pid) cls._pools[pid].remove(connection) @classmethod def set_idle_ttl(cls, pid, ttl): """Set the idle TTL for a pool, after which it will be destroyed. :param str pid: The pool id :param int ttl: The TTL for an idle pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_idle_ttl(ttl) @classmethod def set_max_size(cls, pid, size): """Set the maximum number of connections for the specified pool :param str pid: The pool to set the size for :param int size: The maximum number of connections """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_max_size(size) @classmethod def shutdown(cls): """Close all connections on in all pools""" for pid in list(cls._pools.keys()): cls._pools[pid].shutdown() LOGGER.info('Shutdown complete, all pooled connections closed') @classmethod def size(cls, pid): """Return the number of connections in the pool :param str pid: The pool id :rtype int """ with cls._lock: cls._ensure_pool_exists(pid) return len(cls._pools[pid]) @classmethod def report(cls): """Return the state of the all of the registered pools. :rtype: dict """ return { 'timestamp': datetime.datetime.utcnow().isoformat(), 'process': os.getpid(), 'pools': dict([(i, p.report()) for i, p in cls._pools.items()]) } @classmethod def _ensure_pool_exists(cls, pid): """Raise an exception if the pool has yet to be created or has been removed. :param str pid: The pool ID to check for :raises: KeyError """ if pid not in cls._pools: raise KeyError('Pool %s has not been created' % pid) @classmethod def _maybe_remove_pool(cls, pid): """If the pool has no open connections, remove it :param str pid: The pool id to clean """ if not len(cls._pools[pid]): del cls._pools[pid] class QueriesException(Exception): """Base Exception for all other Queries exceptions""" pass class ConnectionException(QueriesException): def __init__(self, cid): self.cid = cid class PoolException(QueriesException): def __init__(self, pid): self.pid = pid class PoolConnectionException(PoolException): def __init__(self, pid, cid): self.pid = pid self.cid = cid class ActivePoolError(PoolException): """Raised when removing a pool that has active connections""" def __str__(self): return 'Pool %s has at least one active connection' % self.pid class ConnectionBusyError(ConnectionException): """Raised when trying to lock a connection that is already busy""" def __str__(self): return 'Connection %s is busy' % self.cid class ConnectionNotFoundError(PoolConnectionException): """Raised if a specific connection is not found in the pool""" def __str__(self): return 'Connection %s not found in pool %s' % (self.cid, self.pid) class NoIdleConnectionsError(PoolException): """Raised if a pool does not have any idle, open connections""" def __str__(self): return 'Pool %s has no idle connections' % self.pid class PoolFullError(PoolException): """Raised when adding a connection to a pool that has hit max-size""" def __str__(self): return 'Pool %s is at its maximum capacity' % self.pid <MSG> Address possible race condition - If too many simultaneous new connections are being made at the same time, it is possible that a pool can fill up by the time a connection is finally established when used asynchronously. This could cause leaked psycopg2 connections to occur when the PoolFullError is raised. To address this, the connection is closed prior to the error being raised. In addition, when closing the connection, make sure that if for any reason psycopg2 raises an exception, we handle that. - Update all Queries exceptions to use a base QueriesException to they're easier to catch at a level that's isolated to the queries package. <DFF> @@ -8,6 +8,8 @@ import threading import time import weakref +import psycopg2 + LOGGER = logging.getLogger(__name__) DEFAULT_IDLE_TTL = 60 @@ -152,6 +154,12 @@ class Pool(object): raise ValueError('Connection already exists in pool') if len(self.connections) == self.max_size: + LOGGER.warning('Race condition found when adding new connection') + try: + connection.close() + except psycopg2.Error as error: + LOGGER.error('Error closing the conn that cant be used: %s', + error) raise PoolFullError(self) with self._lock: self.connections[id(connection)] = Connection(connection) @@ -584,17 +592,22 @@ class PoolManager(object): raise KeyError('Pool %s has not been created' % pid) -class ConnectionException(Exception): +class QueriesException(Exception): + """Base Exception for all other Queries exceptions""" + pass + + +class ConnectionException(QueriesException): def __init__(self, cid): self.cid = cid -class PoolException(Exception): +class PoolException(QueriesException): def __init__(self, pid): self.pid = pid -class PoolConnectionException(Exception): +class PoolConnectionException(PoolException): def __init__(self, pid, cid): self.pid = pid self.cid = cid

Address possible race condition

.py

py

bsd-3-clause

gmr/queries

1558

<NME> pool.py <BEF> """ Connection Pooling """ import datetime import logging import os import time import weakref LOGGER = logging.getLogger(__name__) DEFAULT_IDLE_TTL = 60 DEFAULT_IDLE_TTL = 60 DEFAULT_MAX_SIZE = int(os.environ.get('QUERIES_MAX_POOL_SIZE', 1)) class Connection(object): """Contains the handle to the connection, the current state of the connection and methods for manipulating the state of the connection. """ _lock = threading.Lock() def __init__(self, handle): self.handle = handle self.used_by = None self.executions = 0 self.exceptions = 0 def close(self): """Close the connection :raises: ConnectionBusyError """ LOGGER.debug('Connection %s closing', self.id) if self.busy and not self.closed: raise ConnectionBusyError(self) with self._lock: if not self.handle.closed: try: self.handle.close() except psycopg2.InterfaceError as error: LOGGER.error('Error closing socket: %s', error) @property def closed(self): """Return if the psycopg2 connection is closed. :rtype: bool """ return self.handle.closed != 0 @property def busy(self): """Return if the connection is currently executing a query or is locked by a session that still exists. :rtype: bool """ if self.handle.isexecuting(): return True elif self.used_by is None: return False return not self.used_by() is None @property def executing(self): """Return if the connection is currently executing a query :rtype: bool """ return self.handle.isexecuting() def free(self): """Remove the lock on the connection if the connection is not active :raises: ConnectionBusyError """ LOGGER.debug('Connection %s freeing', self.id) if self.handle.isexecuting(): raise ConnectionBusyError(self) with self._lock: self.used_by = None LOGGER.debug('Connection %s freed', self.id) @property def id(self): """Return id of the psycopg2 connection object :rtype: int """ return id(self.handle) def lock(self, session): """Lock the connection, ensuring that it is not busy and storing a weakref for the session. :param queries.Session session: The session to lock the connection with :raises: ConnectionBusyError """ if self.busy: raise ConnectionBusyError(self) with self._lock: self.used_by = weakref.ref(session) LOGGER.debug('Connection %s locked', self.id) @property def locked(self): """Return if the connection is currently exclusively locked :rtype: bool """ return self.used_by is not None class Pool(object): """A connection pool for gaining access to and managing connections""" _lock = threading.Lock() idle_start = None idle_ttl = DEFAULT_IDLE_TTL max_size = DEFAULT_MAX_SIZE def __init__(self, pool_id, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): self.connections = {} self._id = pool_id self.idle_ttl = idle_ttl self.max_size = max_size self.time_method = time_method or time.time def __contains__(self, connection): """Return True if the pool contains the connection""" return id(connection) in self.connections def __len__(self): """Return the number of connections in the pool""" return len(self.connections) raise ValueError('Connection already exists in pool') if len(self.connections) == self.max_size: raise PoolFullError(self) with self._lock: self.connections[id(connection)] = Connection(connection) LOGGER.warning('Race condition found when adding new connection') try: connection.close() except (psycopg2.Error, psycopg2.Warning) as error: LOGGER.error('Error closing the conn that cant be used: %s', error) raise PoolFullError(self) with self._lock: self.connections[id(connection)] = Connection(connection) LOGGER.debug('Pool %s added connection %s', self.id, id(connection)) @property def busy_connections(self): """Return a list of active/busy connections :rtype: list """ return [c for c in self.connections.values() if c.busy and not c.closed] def clean(self): """Clean the pool by removing any closed connections and if the pool's idle has exceeded its idle TTL, remove all connections. """ LOGGER.debug('Cleaning the pool') for connection in [self.connections[k] for k in self.connections if self.connections[k].closed]: LOGGER.debug('Removing %s', connection.id) self.remove(connection.handle) if self.idle_duration > self.idle_ttl: self.close() LOGGER.debug('Pool %s cleaned', self.id) def close(self): """Close the pool by closing and removing all of the connections""" for cid in list(self.connections.keys()): self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) @property def closed_connections(self): """Return a list of closed connections :rtype: list """ return [c for c in self.connections.values() if c.closed] def connection_handle(self, connection): """Return a connection object for the given psycopg2 connection :param connection: The connection to return a parent for :type connection: psycopg2.extensions.connection :rtype: Connection """ return self.connections[id(connection)] @property def executing_connections(self): """Return a list of connections actively executing queries :rtype: list """ return [c for c in self.connections.values() if c.executing] def free(self, connection): """Free the connection from use by the session that was using it. :param connection: The connection to free :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ LOGGER.debug('Pool %s freeing connection %s', self.id, id(connection)) try: self.connection_handle(connection).free() except KeyError: raise ConnectionNotFoundError(self.id, id(connection)) if self.idle_connections == list(self.connections.values()): with self._lock: self.idle_start = self.time_method() LOGGER.debug('Pool %s freed connection %s', self.id, id(connection)) def get(self, session): """Return an idle connection and assign the session to the connection :param queries.Session session: The session to assign :rtype: psycopg2.extensions.connection :raises: NoIdleConnectionsError """ idle = self.idle_connections if idle: connection = idle.pop(0) connection.lock(session) if self.idle_start: with self._lock: self.idle_start = None return connection.handle raise NoIdleConnectionsError(self.id) @property def id(self): """Return the ID for this pool :rtype: str """ return self._id @property def idle_connections(self): """Return a list of idle connections :rtype: list """ return [c for c in self.connections.values() if not c.busy and not c.closed] @property def idle_duration(self): """Return the number of seconds that the pool has had no active connections. :rtype: float """ if self.idle_start is None: return 0 return self.time_method() - self.idle_start @property def is_full(self): """Return True if there are no more open slots for connections. :rtype: bool """ return len(self.connections) >= self.max_size def lock(self, connection, session): """Explicitly lock the specified connection :type connection: psycopg2.extensions.connection :param connection: The connection to lock :param queries.Session session: The session to hold the lock """ cid = id(connection) try: self.connection_handle(connection).lock(session) except KeyError: raise ConnectionNotFoundError(self.id, cid) else: if self.idle_start: with self._lock: self.idle_start = None LOGGER.debug('Pool %s locked connection %s', self.id, cid) @property def locked_connections(self): """Return a list of all locked connections :rtype: list """ return [c for c in self.connections.values() if c.locked] def remove(self, connection): """Remove the connection from the pool :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError :raises: ConnectionBusyError """ cid = id(connection) if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) self.connection_handle(connection).close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) def report(self): """Return a report about the pool state and configuration. :rtype: dict """ return { 'connections': { 'busy': len(self.busy_connections), 'closed': len(self.closed_connections), 'executing': len(self.executing_connections), 'idle': len(self.idle_connections), 'locked': len(self.busy_connections) }, 'exceptions': sum([c.exceptions for c in self.connections.values()]), 'executions': sum([c.executions for c in self.connections.values()]), 'full': self.is_full, 'idle': { 'duration': self.idle_duration, 'ttl': self.idle_ttl }, 'max_size': self.max_size } def shutdown(self): """Forcefully shutdown the entire pool, closing all non-executing connections. :raises: ConnectionBusyError """ with self._lock: for cid in list(self.connections.keys()): if self.connections[cid].executing: raise ConnectionBusyError(cid) if self.connections[cid].locked: self.connections[cid].free() self.connections[cid].close() del self.connections[cid] def set_idle_ttl(self, ttl): """Set the idle ttl :param int ttl: The TTL when idle """ with self._lock: self.idle_ttl = ttl def set_max_size(self, size): """Set the maximum number of connections :param int size: The maximum number of connections """ with self._lock: self.max_size = size class PoolManager(object): """The connection pool object implements behavior around connections and their use in queries.Session objects. We carry a pool id instead of the connection URI so that we will not be carrying the URI in memory, creating a possible security issue. """ _lock = threading.Lock() _pools = {} def __contains__(self, pid): """Returns True if the pool exists :param str pid: The pool id to check for :rtype: bool """ return pid in self.__class__._pools @classmethod def instance(cls): """Only allow a single PoolManager instance to exist, returning the handle for it. :rtype: PoolManager """ if not hasattr(cls, '_instance'): with cls._lock: cls._instance = cls() return cls._instance @classmethod def add(cls, pid, connection): """Add a new connection and session to a pool. :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].add(connection) @classmethod def clean(cls, pid): """Clean the specified pool, removing any closed connections or stale locks. :param str pid: The pool id to clean """ with cls._lock: try: cls._ensure_pool_exists(pid) except KeyError: LOGGER.debug('Pool clean invoked against missing pool %s', pid) return cls._pools[pid].clean() cls._maybe_remove_pool(pid) @classmethod def create(cls, pid, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): """Create a new pool, with the ability to pass in values to override the default idle TTL and the default maximum size. A pool's idle TTL defines the amount of time that a pool can be open without any sessions before it is removed. A pool's max size defines the maximum number of connections that can be added to the pool to prevent unbounded open connections. :param str pid: The pool ID :param int idle_ttl: Time in seconds for the idle TTL :param int max_size: The maximum pool size :param callable time_method: Override the use of :py:meth:`time.time` method for time values. :raises: KeyError """ if pid in cls._pools: raise KeyError('Pool %s already exists' % pid) with cls._lock: LOGGER.debug("Creating Pool: %s (%i/%i)", pid, idle_ttl, max_size) cls._pools[pid] = Pool(pid, idle_ttl, max_size, time_method) @classmethod def free(cls, pid, connection): """Free a connection that was locked by a session :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection """ with cls._lock: LOGGER.debug('Freeing %s from pool %s', id(connection), pid) cls._ensure_pool_exists(pid) cls._pools[pid].free(connection) @classmethod def get(cls, pid, session): """Get an idle, unused connection from the pool. Once a connection has been retrieved, it will be marked as in-use until it is freed. :param str pid: The pool ID :param queries.Session session: The session to assign to the connection :rtype: psycopg2.extensions.connection """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].get(session) @classmethod def get_connection(cls, pid, connection): """Return the specified :class:`~queries.pool.Connection` from the pool. :param str pid: The pool ID :param connection: The connection to return for :type connection: psycopg2.extensions.connection :rtype: queries.pool.Connection """ with cls._lock: return cls._pools[pid].connection_handle(connection) @classmethod def has_connection(cls, pid, connection): """Check to see if a pool has the specified connection :param str pid: The pool ID :param connection: The connection to check for :type connection: psycopg2.extensions.connection :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return connection in cls._pools[pid] @classmethod def has_idle_connection(cls, pid): """Check to see if a pool has an idle connection :param str pid: The pool ID :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return bool(cls._pools[pid].idle_connections) @classmethod def is_full(cls, pid): """Return a bool indicating if the specified pool is full :param str pid: The pool id :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].is_full @classmethod def lock(cls, pid, connection, session): """Explicitly lock the specified connection in the pool raise KeyError('Pool %s has not been created' % pid) class ConnectionException(Exception): def __init__(self, cid): self.cid = cid class PoolException(Exception): def __init__(self, pid): self.pid = pid class PoolConnectionException(Exception): def __init__(self, pid, cid): self.pid = pid self.cid = cid @classmethod def remove_connection(cls, pid, connection): """Remove a connection from the pool, closing it if is open. :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ cls._ensure_pool_exists(pid) cls._pools[pid].remove(connection) @classmethod def set_idle_ttl(cls, pid, ttl): """Set the idle TTL for a pool, after which it will be destroyed. :param str pid: The pool id :param int ttl: The TTL for an idle pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_idle_ttl(ttl) @classmethod def set_max_size(cls, pid, size): """Set the maximum number of connections for the specified pool :param str pid: The pool to set the size for :param int size: The maximum number of connections """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_max_size(size) @classmethod def shutdown(cls): """Close all connections on in all pools""" for pid in list(cls._pools.keys()): cls._pools[pid].shutdown() LOGGER.info('Shutdown complete, all pooled connections closed') @classmethod def size(cls, pid): """Return the number of connections in the pool :param str pid: The pool id :rtype int """ with cls._lock: cls._ensure_pool_exists(pid) return len(cls._pools[pid]) @classmethod def report(cls): """Return the state of the all of the registered pools. :rtype: dict """ return { 'timestamp': datetime.datetime.utcnow().isoformat(), 'process': os.getpid(), 'pools': dict([(i, p.report()) for i, p in cls._pools.items()]) } @classmethod def _ensure_pool_exists(cls, pid): """Raise an exception if the pool has yet to be created or has been removed. :param str pid: The pool ID to check for :raises: KeyError """ if pid not in cls._pools: raise KeyError('Pool %s has not been created' % pid) @classmethod def _maybe_remove_pool(cls, pid): """If the pool has no open connections, remove it :param str pid: The pool id to clean """ if not len(cls._pools[pid]): del cls._pools[pid] class QueriesException(Exception): """Base Exception for all other Queries exceptions""" pass class ConnectionException(QueriesException): def __init__(self, cid): self.cid = cid class PoolException(QueriesException): def __init__(self, pid): self.pid = pid class PoolConnectionException(PoolException): def __init__(self, pid, cid): self.pid = pid self.cid = cid class ActivePoolError(PoolException): """Raised when removing a pool that has active connections""" def __str__(self): return 'Pool %s has at least one active connection' % self.pid class ConnectionBusyError(ConnectionException): """Raised when trying to lock a connection that is already busy""" def __str__(self): return 'Connection %s is busy' % self.cid class ConnectionNotFoundError(PoolConnectionException): """Raised if a specific connection is not found in the pool""" def __str__(self): return 'Connection %s not found in pool %s' % (self.cid, self.pid) class NoIdleConnectionsError(PoolException): """Raised if a pool does not have any idle, open connections""" def __str__(self): return 'Pool %s has no idle connections' % self.pid class PoolFullError(PoolException): """Raised when adding a connection to a pool that has hit max-size""" def __str__(self): return 'Pool %s is at its maximum capacity' % self.pid <MSG> Address possible race condition - If too many simultaneous new connections are being made at the same time, it is possible that a pool can fill up by the time a connection is finally established when used asynchronously. This could cause leaked psycopg2 connections to occur when the PoolFullError is raised. To address this, the connection is closed prior to the error being raised. In addition, when closing the connection, make sure that if for any reason psycopg2 raises an exception, we handle that. - Update all Queries exceptions to use a base QueriesException to they're easier to catch at a level that's isolated to the queries package. <DFF> @@ -8,6 +8,8 @@ import threading import time import weakref +import psycopg2 + LOGGER = logging.getLogger(__name__) DEFAULT_IDLE_TTL = 60 @@ -152,6 +154,12 @@ class Pool(object): raise ValueError('Connection already exists in pool') if len(self.connections) == self.max_size: + LOGGER.warning('Race condition found when adding new connection') + try: + connection.close() + except psycopg2.Error as error: + LOGGER.error('Error closing the conn that cant be used: %s', + error) raise PoolFullError(self) with self._lock: self.connections[id(connection)] = Connection(connection) @@ -584,17 +592,22 @@ class PoolManager(object): raise KeyError('Pool %s has not been created' % pid) -class ConnectionException(Exception): +class QueriesException(Exception): + """Base Exception for all other Queries exceptions""" + pass + + +class ConnectionException(QueriesException): def __init__(self, cid): self.cid = cid -class PoolException(Exception): +class PoolException(QueriesException): def __init__(self, pid): self.pid = pid -class PoolConnectionException(Exception): +class PoolConnectionException(PoolException): def __init__(self, pid, cid): self.pid = pid self.cid = cid

Address possible race condition

.py

py

bsd-3-clause

gmr/queries

1559

<NME> session_tests.py <BEF> """ Tests for functionality in the session module """ import hashlib import logging import unittest import mock from psycopg2 import extras import psycopg2 # Out of order import to ensure psycopg2cffi is registered from queries import pool, results, session, utils LOGGER = logging.getLogger(__name__) class SessionTestCase(unittest.TestCase): URI = 'postgresql://foo:bar@localhost:5432/foo' @mock.patch('psycopg2.connect') @mock.patch('psycopg2.extensions.register_type') @mock.patch('psycopg2.extras.register_uuid') @mock.patch('queries.utils.uri_to_kwargs') def setUp(self, uri_to_kwargs, register_uuid, register_type, connect): self.conn = mock.Mock() self.conn.autocommit = False self.conn.closed = False self.conn.cursor = mock.Mock() self.conn.isexecuting = mock.Mock(return_value=False) self.conn.reset = mock.Mock() self.conn.status = psycopg2.extensions.STATUS_BEGIN self.psycopg2_connect = connect self.psycopg2_connect.return_value = self.conn self.psycopg2_register_type = register_type self.psycopg2_register_uuid = register_uuid self.uri_to_kwargs = uri_to_kwargs self.uri_to_kwargs.return_value = {'host': 'localhost', 'password': None} self._connect.assert_called_once_with(**expectation) def test_psycopg2_register_uuid(self): """Ensure that the UUID extension was registered""" self._reg_uuid.assert_called_once_with(conn_or_curs=self.client._conn) def test_init_creates_new_pool(self): self.assertIn(self.obj.pid, self.obj._pool_manager) def test_init_creates_connection(self): conns = \ [value.handle for key, value in self.obj._pool_manager._pools[self.obj.pid].connections.items()] self.assertIn(self.conn, conns) def test_init_sets_cursorfactory(self): self.assertEqual(self.obj._cursor_factory, extras.RealDictCursor) def test_init_gets_cursor(self): self.conn.cursor.assert_called_once_with( name=None, cursor_factory=extras.RealDictCursor) def test_init_sets_autocommit(self): self.assertTrue(self.conn.autocommit) def test_backend_pid_invokes_conn_backend_pid(self): self.conn.get_backend_pid = get_backend_pid = mock.Mock() LOGGER.debug('ValueL %s', self.obj.backend_pid) get_backend_pid.assert_called_once_with() def test_callproc_invokes_cursor_callproc(self): self.obj._cursor.callproc = mock.Mock() args = ('foo', ['bar', 'baz']) self.obj.callproc(*args) self.obj._cursor.callproc.assert_called_once_with(*args) def test_callproc_returns_results(self): self.obj._cursor.callproc = mock.Mock() args = ('foo', ['bar', 'baz']) self.assertIsInstance(self.obj.callproc(*args), results.Results) def test_close_raises_exception(self): self.obj._conn = None self.assertRaises(psycopg2.InterfaceError, self.obj.close) def test_close_removes_connection(self): self.obj.close() self.assertNotIn(self.conn, self.obj._pool_manager._pools[self.obj.pid]) def test_close_unassigns_connection(self): self.obj.close() self.assertIsNone(self.obj._conn) def test_close_unassigns_cursor(self): self.obj.close() self.assertIsNone(self.obj._cursor) def test_connection_property_returns_correct_value(self): self.assertEqual(self.obj.connection, self.conn) def test_cursor_property_returns_correct_value(self): self.assertEqual(self.obj.cursor, self.obj._cursor) def test_encoding_property_value(self): self.conn.encoding = 'UTF-8' self.assertEqual(self.obj.encoding, 'UTF-8') def test_notices_value(self): self.conn.notices = [1, 2, 3] self.assertListEqual(self.obj.notices, [1, 2, 3]) def test_pid_value(self): expectation = hashlib.md5( ':'.join([self.obj.__class__.__name__, self.URI]).encode('utf-8')).hexdigest() self.assertEqual(self.obj.pid, expectation) def test_query_invokes_cursor_execute(self): self.obj._cursor.callproc = mock.Mock() args = ('SELECT * FROM foo', ['bar', 'baz']) self.obj.query(*args) self.obj._cursor.execute.assert_called_once_with(*args) def test_set_encoding_sets_encoding_if_different(self): self.conn.encoding = 'LATIN-1' self.conn.set_client_encoding = set_client_encoding = mock.Mock() self.obj.set_encoding('UTF-8') set_client_encoding.assert_called_once_with('UTF-8') def test_set_encoding_does_not_set_encoding_if_same(self): self.conn.encoding = 'UTF-8' self.conn.set_client_encoding = set_client_encoding = mock.Mock() self.obj.set_encoding('UTF-8') self.assertFalse(set_client_encoding.called) @unittest.skipIf(utils.PYPY, 'PYPY does not invoke object.__del__ synchronously') def test_del_invokes_cleanup(self): cleanup = mock.Mock() with mock.patch.multiple('queries.session.Session', _cleanup=cleanup, _connect=mock.Mock(), _get_cursor=mock.Mock(), _autocommit=mock.Mock()): obj = session.Session(self.URI) del obj cleanup.assert_called_once_with() def test_exit_invokes_cleanup(self): cleanup = mock.Mock() with mock.patch.multiple('queries.session.Session', _cleanup=cleanup, _connect=mock.Mock(), _get_cursor=mock.Mock(), _autocommit=mock.Mock()): with session.Session(self.URI): pass self.assertTrue(cleanup.called) def test_autocommit_sets_attribute(self): self.conn.autocommit = False self.obj._autocommit(True) self.assertTrue(self.conn.autocommit) def test_cleanup_closes_cursor(self): self.obj._cursor.close = closeit = mock.Mock() self.conn = None self.obj._cleanup() closeit.assert_called_once_with() def test_cleanup_sets_cursor_to_none(self): self.obj._cursor.close = mock.Mock() self.conn = None self.obj._cleanup() self.assertIsNone(self.obj._cursor) def test_cleanup_frees_connection(self): with mock.patch.object(self.obj._pool_manager, 'free') as free: conn = self.obj._conn self.obj._cleanup() free.assert_called_once_with(self.obj.pid, conn) def test_cleanup_sets_connect_to_none(self): self.obj._cleanup() self.assertIsNone(self.obj._conn) def test_connect_invokes_pool_manager_get(self): with mock.patch.object(self.obj._pool_manager, 'get') as get: self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) def test_connect_raises_noidleconnectionserror(self): with mock.patch.object(self.obj._pool_manager, 'get') as get: with mock.patch.object(self.obj._pool_manager, 'is_full') as full: get.side_effect = pool.NoIdleConnectionsError(self.obj.pid) full.return_value = True self.assertRaises(pool.NoIdleConnectionsError, self.obj._connect) def test_connect_invokes_uri_to_kwargs(self): self.uri_to_kwargs.assert_called_once_with(self.URI) def test_connect_returned_the_proper_value(self): self.assertEqual(self.obj.connection, self.conn) def test_status_is_ready_by_default(self): self.assertEqual(self.obj._status, self.obj.READY) def test_status_when_not_ready(self): self.conn.status = self.obj.SETUP self.assertEqual(self.obj._status, self.obj.SETUP) def test_get_named_cursor_sets_scrollable(self): result = self.obj._get_cursor(self.obj._conn, 'test1') self.assertTrue(result.scrollable) def test_get_named_cursor_sets_withhold(self): result = self.obj._get_cursor(self.obj._conn, 'test2') self.assertTrue(result.withhhold) @unittest.skipUnless(utils.PYPY, 'connection.reset is PYPY only behavior') def test_connection_reset_in_pypy(self): self.conn.reset.assert_called_once_with() <MSG> Test that JSON is registered as well <DFF> @@ -42,6 +42,10 @@ class SessionTests(unittest.TestCase): 'password': None} self._connect.assert_called_once_with(**expectation) + def test_psycopg2_register_json(self): + """Ensure that the JSON extension was registered""" + self._reg_json.assert_called_once_with(conn_or_curs=self.client._conn) + def test_psycopg2_register_uuid(self): """Ensure that the UUID extension was registered""" self._reg_uuid.assert_called_once_with(conn_or_curs=self.client._conn)

Test that JSON is registered as well

.py

py

bsd-3-clause

gmr/queries

1560

<NME> session_tests.py <BEF> """ Tests for functionality in the session module """ import hashlib import logging import unittest import mock from psycopg2 import extras import psycopg2 # Out of order import to ensure psycopg2cffi is registered from queries import pool, results, session, utils LOGGER = logging.getLogger(__name__) class SessionTestCase(unittest.TestCase): URI = 'postgresql://foo:bar@localhost:5432/foo' @mock.patch('psycopg2.connect') @mock.patch('psycopg2.extensions.register_type') @mock.patch('psycopg2.extras.register_uuid') @mock.patch('queries.utils.uri_to_kwargs') def setUp(self, uri_to_kwargs, register_uuid, register_type, connect): self.conn = mock.Mock() self.conn.autocommit = False self.conn.closed = False self.conn.cursor = mock.Mock() self.conn.isexecuting = mock.Mock(return_value=False) self.conn.reset = mock.Mock() self.conn.status = psycopg2.extensions.STATUS_BEGIN self.psycopg2_connect = connect self.psycopg2_connect.return_value = self.conn self.psycopg2_register_type = register_type self.psycopg2_register_uuid = register_uuid self.uri_to_kwargs = uri_to_kwargs self.uri_to_kwargs.return_value = {'host': 'localhost', 'password': None} self._connect.assert_called_once_with(**expectation) def test_psycopg2_register_uuid(self): """Ensure that the UUID extension was registered""" self._reg_uuid.assert_called_once_with(conn_or_curs=self.client._conn) def test_init_creates_new_pool(self): self.assertIn(self.obj.pid, self.obj._pool_manager) def test_init_creates_connection(self): conns = \ [value.handle for key, value in self.obj._pool_manager._pools[self.obj.pid].connections.items()] self.assertIn(self.conn, conns) def test_init_sets_cursorfactory(self): self.assertEqual(self.obj._cursor_factory, extras.RealDictCursor) def test_init_gets_cursor(self): self.conn.cursor.assert_called_once_with( name=None, cursor_factory=extras.RealDictCursor) def test_init_sets_autocommit(self): self.assertTrue(self.conn.autocommit) def test_backend_pid_invokes_conn_backend_pid(self): self.conn.get_backend_pid = get_backend_pid = mock.Mock() LOGGER.debug('ValueL %s', self.obj.backend_pid) get_backend_pid.assert_called_once_with() def test_callproc_invokes_cursor_callproc(self): self.obj._cursor.callproc = mock.Mock() args = ('foo', ['bar', 'baz']) self.obj.callproc(*args) self.obj._cursor.callproc.assert_called_once_with(*args) def test_callproc_returns_results(self): self.obj._cursor.callproc = mock.Mock() args = ('foo', ['bar', 'baz']) self.assertIsInstance(self.obj.callproc(*args), results.Results) def test_close_raises_exception(self): self.obj._conn = None self.assertRaises(psycopg2.InterfaceError, self.obj.close) def test_close_removes_connection(self): self.obj.close() self.assertNotIn(self.conn, self.obj._pool_manager._pools[self.obj.pid]) def test_close_unassigns_connection(self): self.obj.close() self.assertIsNone(self.obj._conn) def test_close_unassigns_cursor(self): self.obj.close() self.assertIsNone(self.obj._cursor) def test_connection_property_returns_correct_value(self): self.assertEqual(self.obj.connection, self.conn) def test_cursor_property_returns_correct_value(self): self.assertEqual(self.obj.cursor, self.obj._cursor) def test_encoding_property_value(self): self.conn.encoding = 'UTF-8' self.assertEqual(self.obj.encoding, 'UTF-8') def test_notices_value(self): self.conn.notices = [1, 2, 3] self.assertListEqual(self.obj.notices, [1, 2, 3]) def test_pid_value(self): expectation = hashlib.md5( ':'.join([self.obj.__class__.__name__, self.URI]).encode('utf-8')).hexdigest() self.assertEqual(self.obj.pid, expectation) def test_query_invokes_cursor_execute(self): self.obj._cursor.callproc = mock.Mock() args = ('SELECT * FROM foo', ['bar', 'baz']) self.obj.query(*args) self.obj._cursor.execute.assert_called_once_with(*args) def test_set_encoding_sets_encoding_if_different(self): self.conn.encoding = 'LATIN-1' self.conn.set_client_encoding = set_client_encoding = mock.Mock() self.obj.set_encoding('UTF-8') set_client_encoding.assert_called_once_with('UTF-8') def test_set_encoding_does_not_set_encoding_if_same(self): self.conn.encoding = 'UTF-8' self.conn.set_client_encoding = set_client_encoding = mock.Mock() self.obj.set_encoding('UTF-8') self.assertFalse(set_client_encoding.called) @unittest.skipIf(utils.PYPY, 'PYPY does not invoke object.__del__ synchronously') def test_del_invokes_cleanup(self): cleanup = mock.Mock() with mock.patch.multiple('queries.session.Session', _cleanup=cleanup, _connect=mock.Mock(), _get_cursor=mock.Mock(), _autocommit=mock.Mock()): obj = session.Session(self.URI) del obj cleanup.assert_called_once_with() def test_exit_invokes_cleanup(self): cleanup = mock.Mock() with mock.patch.multiple('queries.session.Session', _cleanup=cleanup, _connect=mock.Mock(), _get_cursor=mock.Mock(), _autocommit=mock.Mock()): with session.Session(self.URI): pass self.assertTrue(cleanup.called) def test_autocommit_sets_attribute(self): self.conn.autocommit = False self.obj._autocommit(True) self.assertTrue(self.conn.autocommit) def test_cleanup_closes_cursor(self): self.obj._cursor.close = closeit = mock.Mock() self.conn = None self.obj._cleanup() closeit.assert_called_once_with() def test_cleanup_sets_cursor_to_none(self): self.obj._cursor.close = mock.Mock() self.conn = None self.obj._cleanup() self.assertIsNone(self.obj._cursor) def test_cleanup_frees_connection(self): with mock.patch.object(self.obj._pool_manager, 'free') as free: conn = self.obj._conn self.obj._cleanup() free.assert_called_once_with(self.obj.pid, conn) def test_cleanup_sets_connect_to_none(self): self.obj._cleanup() self.assertIsNone(self.obj._conn) def test_connect_invokes_pool_manager_get(self): with mock.patch.object(self.obj._pool_manager, 'get') as get: self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) def test_connect_raises_noidleconnectionserror(self): with mock.patch.object(self.obj._pool_manager, 'get') as get: with mock.patch.object(self.obj._pool_manager, 'is_full') as full: get.side_effect = pool.NoIdleConnectionsError(self.obj.pid) full.return_value = True self.assertRaises(pool.NoIdleConnectionsError, self.obj._connect) def test_connect_invokes_uri_to_kwargs(self): self.uri_to_kwargs.assert_called_once_with(self.URI) def test_connect_returned_the_proper_value(self): self.assertEqual(self.obj.connection, self.conn) def test_status_is_ready_by_default(self): self.assertEqual(self.obj._status, self.obj.READY) def test_status_when_not_ready(self): self.conn.status = self.obj.SETUP self.assertEqual(self.obj._status, self.obj.SETUP) def test_get_named_cursor_sets_scrollable(self): result = self.obj._get_cursor(self.obj._conn, 'test1') self.assertTrue(result.scrollable) def test_get_named_cursor_sets_withhold(self): result = self.obj._get_cursor(self.obj._conn, 'test2') self.assertTrue(result.withhhold) @unittest.skipUnless(utils.PYPY, 'connection.reset is PYPY only behavior') def test_connection_reset_in_pypy(self): self.conn.reset.assert_called_once_with() <MSG> Test that JSON is registered as well <DFF> @@ -42,6 +42,10 @@ class SessionTests(unittest.TestCase): 'password': None} self._connect.assert_called_once_with(**expectation) + def test_psycopg2_register_json(self): + """Ensure that the JSON extension was registered""" + self._reg_json.assert_called_once_with(conn_or_curs=self.client._conn) + def test_psycopg2_register_uuid(self): """Ensure that the UUID extension was registered""" self._reg_uuid.assert_called_once_with(conn_or_curs=self.client._conn)

Test that JSON is registered as well

.py

py

bsd-3-clause

gmr/queries

1561

<NME> utils_tests.py <BEF> """ Tests for functionality in the utils module """ import mock try: import unittest2 as unittest except ImportError: import unittest from queries import utils import queries from queries import utils class GetCurrentUserTests(unittest.TestCase): @mock.patch('pwd.getpwuid') def test_get_current_user(self, getpwuid): """get_current_user returns value from pwd.getpwuid""" getpwuid.return_value = ['mocky'] self.assertEqual(utils.get_current_user(), 'mocky') class PYPYDetectionTests(unittest.TestCase): def test_pypy_flag(self): """PYPY flag is set properly""" self.assertEqual(queries.utils.PYPY, platform.python_implementation() == 'PyPy') class URICreationTests(unittest.TestCase): def test_uri_with_password(self): expectation = 'postgresql://foo:bar@baz:5433/qux' self.assertEqual(queries.uri('baz', 5433, 'qux', 'foo', 'bar'), expectation) def test_uri_without_password(self): expectation = 'postgresql://foo@baz:5433/qux' self.assertEqual(queries.uri('baz', 5433, 'qux', 'foo'), expectation) def test_default_uri(self): expectation = 'postgresql://postgres@localhost:5432/postgres' self.assertEqual(queries.uri(), expectation) class URLParseTestCase(unittest.TestCase): URI = 'postgresql://foo:bar@baz:5444/qux' def test_urlparse_hostname(self): """hostname should match expectation""" self.assertEqual(utils.urlparse(self.URI).hostname, 'baz') def test_urlparse_port(self): """port should match expectation""" self.assertEqual(utils.urlparse(self.URI).port, 5444) def test_urlparse_path(self): """path should match expectation""" self.assertEqual(utils.urlparse(self.URI).path, '/qux') def test_urlparse_username(self): """username should match expectation""" self.assertEqual(utils.urlparse(self.URI).username, 'foo') def test_urlparse_password(self): """password should match expectation""" self.assertEqual(utils.urlparse(self.URI).password, 'bar') class URIToKWargsTestCase(unittest.TestCase): URI = ('postgresql://foo:c%23%5E%25%23%27%24%40%3A@baz:5444/qux?' 'options=foo&options=bar&keepalives=1&invalid=true') def test_uri_to_kwargs_host(self): """hostname should match expectation""" self.assertEqual(utils.uri_to_kwargs(self.URI)['host'], 'baz') def test_uri_to_kwargs_port(self): """port should match expectation""" self.assertEqual(utils.uri_to_kwargs(self.URI)['port'], 5444) def test_uri_to_kwargs_dbname(self): """dbname should match expectation""" self.assertEqual(utils.uri_to_kwargs(self.URI)['dbname'], 'qux') def test_uri_to_kwargs_username(self): """user should match expectation""" self.assertEqual(utils.uri_to_kwargs(self.URI)['user'], 'foo') def test_uri_to_kwargs_password(self): """password should match expectation""" self.assertEqual(utils.uri_to_kwargs(self.URI)['password'], 'c#^%#\'$@:') def test_uri_to_kwargs_options(self): """options should match expectation""" self.assertEqual(utils.uri_to_kwargs(self.URI)['options'], ['foo', 'bar']) def test_uri_to_kwargs_keepalive(self): """keepalive should match expectation""" self.assertEqual(utils.uri_to_kwargs(self.URI)['keepalives'], 1) def test_uri_to_kwargs_invalid(self): """invalid query argument should not be in kwargs""" self.assertNotIn('invaid', utils.uri_to_kwargs(self.URI)) def test_unix_socket_path_format_one(self): socket_path = 'postgresql://%2Fvar%2Flib%2Fpostgresql/dbname' result = utils.uri_to_kwargs(socket_path) self.assertEqual(result['host'], '/var/lib/postgresql') def test_unix_socket_path_format2(self): socket_path = 'postgresql:///postgres?host=/tmp/' result = utils.uri_to_kwargs(socket_path) self.assertEqual(result['host'], '/tmp/') <MSG> Remove unittest2 use <DFF> @@ -3,10 +3,7 @@ Tests for functionality in the utils module """ import mock -try: - import unittest2 as unittest -except ImportError: - import unittest +import unittest from queries import utils

Remove unittest2 use

.py

py

bsd-3-clause

gmr/queries

1562

<NME> utils_tests.py <BEF> """ Tests for functionality in the utils module """ import mock try: import unittest2 as unittest except ImportError: import unittest from queries import utils import queries from queries import utils class GetCurrentUserTests(unittest.TestCase): @mock.patch('pwd.getpwuid') def test_get_current_user(self, getpwuid): """get_current_user returns value from pwd.getpwuid""" getpwuid.return_value = ['mocky'] self.assertEqual(utils.get_current_user(), 'mocky') class PYPYDetectionTests(unittest.TestCase): def test_pypy_flag(self): """PYPY flag is set properly""" self.assertEqual(queries.utils.PYPY, platform.python_implementation() == 'PyPy') class URICreationTests(unittest.TestCase): def test_uri_with_password(self): expectation = 'postgresql://foo:bar@baz:5433/qux' self.assertEqual(queries.uri('baz', 5433, 'qux', 'foo', 'bar'), expectation) def test_uri_without_password(self): expectation = 'postgresql://foo@baz:5433/qux' self.assertEqual(queries.uri('baz', 5433, 'qux', 'foo'), expectation) def test_default_uri(self): expectation = 'postgresql://postgres@localhost:5432/postgres' self.assertEqual(queries.uri(), expectation) class URLParseTestCase(unittest.TestCase): URI = 'postgresql://foo:bar@baz:5444/qux' def test_urlparse_hostname(self): """hostname should match expectation""" self.assertEqual(utils.urlparse(self.URI).hostname, 'baz') def test_urlparse_port(self): """port should match expectation""" self.assertEqual(utils.urlparse(self.URI).port, 5444) def test_urlparse_path(self): """path should match expectation""" self.assertEqual(utils.urlparse(self.URI).path, '/qux') def test_urlparse_username(self): """username should match expectation""" self.assertEqual(utils.urlparse(self.URI).username, 'foo') def test_urlparse_password(self): """password should match expectation""" self.assertEqual(utils.urlparse(self.URI).password, 'bar') class URIToKWargsTestCase(unittest.TestCase): URI = ('postgresql://foo:c%23%5E%25%23%27%24%40%3A@baz:5444/qux?' 'options=foo&options=bar&keepalives=1&invalid=true') def test_uri_to_kwargs_host(self): """hostname should match expectation""" self.assertEqual(utils.uri_to_kwargs(self.URI)['host'], 'baz') def test_uri_to_kwargs_port(self): """port should match expectation""" self.assertEqual(utils.uri_to_kwargs(self.URI)['port'], 5444) def test_uri_to_kwargs_dbname(self): """dbname should match expectation""" self.assertEqual(utils.uri_to_kwargs(self.URI)['dbname'], 'qux') def test_uri_to_kwargs_username(self): """user should match expectation""" self.assertEqual(utils.uri_to_kwargs(self.URI)['user'], 'foo') def test_uri_to_kwargs_password(self): """password should match expectation""" self.assertEqual(utils.uri_to_kwargs(self.URI)['password'], 'c#^%#\'$@:') def test_uri_to_kwargs_options(self): """options should match expectation""" self.assertEqual(utils.uri_to_kwargs(self.URI)['options'], ['foo', 'bar']) def test_uri_to_kwargs_keepalive(self): """keepalive should match expectation""" self.assertEqual(utils.uri_to_kwargs(self.URI)['keepalives'], 1) def test_uri_to_kwargs_invalid(self): """invalid query argument should not be in kwargs""" self.assertNotIn('invaid', utils.uri_to_kwargs(self.URI)) def test_unix_socket_path_format_one(self): socket_path = 'postgresql://%2Fvar%2Flib%2Fpostgresql/dbname' result = utils.uri_to_kwargs(socket_path) self.assertEqual(result['host'], '/var/lib/postgresql') def test_unix_socket_path_format2(self): socket_path = 'postgresql:///postgres?host=/tmp/' result = utils.uri_to_kwargs(socket_path) self.assertEqual(result['host'], '/tmp/') <MSG> Remove unittest2 use <DFF> @@ -3,10 +3,7 @@ Tests for functionality in the utils module """ import mock -try: - import unittest2 as unittest -except ImportError: - import unittest +import unittest from queries import utils

Remove unittest2 use

.py

py

bsd-3-clause

gmr/queries

1563

<NME> tornado_session.py <BEF> """ Tornado Session Adapter Use Queries asynchronously within the Tornado framework. Example Use: .. code:: python class NameListHandler(web.RequestHandler): def initialize(self): self.session = queries.TornadoSession(pool_max_size=60) @gen.coroutine def get(self): data = yield self.session.query('SELECT * FROM names') if data: self.finish({'names': data.items()}) data.free() else: self.set_status(500, 'Error querying the data') """ import logging import socket import warnings from tornado import concurrent, ioloop from psycopg2 import extras, extensions import psycopg2 from queries import pool, results, session, utils LOGGER = logging.getLogger(__name__) DEFAULT_MAX_POOL_SIZE = 25 class Results(results.Results): """A TornadoSession specific :py:class:`queries.Results` class that adds the :py:meth:`Results.free <queries.tornado_session.Results.free>` method. The :py:meth:`Results.free <queries.tornado_session.Results.free>` method **must** be called to free the connection that the results were generated on. `Results` objects that are not freed will cause the connections to remain locked and your application will eventually run out of connections in the pool. The following examples illustrate the various behaviors that the ::py:class:`queries.Results <queries.tornado_session.Requests>` class implements: **Using Results as an Iterator** .. code:: python results = yield session.query('SELECT * FROM foo') for row in results print row results.free() **Accessing an individual row by index** .. code:: python results = yield session.query('SELECT * FROM foo') print results[1] # Access the second row of the results results.free() **Casting single row results as a dict** .. code:: python results = yield session.query('SELECT * FROM foo LIMIT 1') print results.as_dict() results.free() **Checking to see if a query was successful** .. code:: python sql = "UPDATE foo SET bar='baz' WHERE qux='corgie'" results = yield session.query(sql) if results: print 'Success' results.free() :param str name: The stored procedure name :param list args: An optional list of procedure arguments :rtype: list """ # Grab a connection, either new or out of the pool def free(self): """Release the results and connection lock from the TornadoSession object. This **must** be called after you finish processing the results from :py:meth:`TornadoSession.query <queries.TornadoSession.query>` or :py:meth:`TornadoSession.callproc <queries.TornadoSession.callproc>` or the connection will not be able to be reused by other asynchronous requests. """ self._freed = True self._cleanup(self.cursor, self._fd) def __del__(self): if not self._freed: LOGGER.warning('Auto-freeing result on deletion') self.free() class TornadoSession(session.Session): """Session class for Tornado asynchronous applications. Uses :py:func:`tornado.gen.coroutine` to wrap API methods for use in Tornado. Utilizes connection pooling to ensure that multiple concurrent asynchronous queries do not block each other. Heavily trafficked services will require a higher ``max_pool_size`` to allow for greater connection concurrency. :py:meth:`TornadoSession.query <queries.TornadoSession.query>` and :py:meth:`TornadoSession.callproc <queries.TornadoSession.callproc>` must call :py:meth:`Results.free <queries.tornado_session.Results.free>` :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ def __init__(self, uri=session.DEFAULT_URI, cursor_factory=extras.RealDictCursor, pool_idle_ttl=pool.DEFAULT_IDLE_TTL, pool_max_size=DEFAULT_MAX_POOL_SIZE, io_loop=None): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use :param tornado.ioloop.IOLoop io_loop: IOLoop instance to use """ self._connections = dict() self._cleanup_callback = None self._cursor_factory = cursor_factory self._futures = dict() self._ioloop = io_loop or ioloop.IOLoop.current() self._pool_manager = pool.PoolManager.instance() self._pool_max_size = pool_max_size self._pool_idle_ttl = pool_idle_ttl self._uri = uri self._ensure_pool_exists() def _ensure_pool_exists(self): """Create the pool in the pool manager if it does not exist.""" if self.pid not in self._pool_manager: self._pool_manager.create(self.pid, self._pool_idle_ttl, self._pool_max_size, self._ioloop.time) @property def connection(self): """Do not use this directly with Tornado applications :return: """ return None @property def cursor(self): return None def callproc(self, name, args=None): """Call a stored procedure asynchronously on the server, passing in the arguments to be passed to the stored procedure, yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. You **must** free the results that are returned by this method to unlock the connection used to perform the query. Failure to do so will cause your Tornado application to run out of connections. :param str name: The stored procedure name :param list args: An optional list of procedure arguments :param str sql: The SQL statement :param dict parameters: A dictionary of query parameters :return tuple: (row_count, rows) """ # Grab a connection, either new or out of the pool parameters against the sql statement and yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. You **must** free the results that are returned by this method to unlock the connection used to perform the query. Failure to do so will cause your Tornado application to run out of connections. :param str sql: The SQL statement :param dict parameters: A dictionary of query parameters :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ return self._execute('execute', sql, parameters) def validate(self): """Validate the session can connect or has open connections to PostgreSQL. As of ``1.10.3`` .. deprecated:: 1.10.3 As of 1.10.3, this method only warns about Deprecation :rtype: bool """ warnings.warn( 'All functionality removed from this method', DeprecationWarning) def _connect(self): """Connect to PostgreSQL, either by reusing a connection from the pool if possible, or by creating the new connection. :rtype: psycopg2.extensions.connection :raises: pool.NoIdleConnectionsError """ future = concurrent.Future() # Attempt to get a cached connection from the connection pool try: connection = self._pool_manager.get(self.pid, self) self._connections[connection.fileno()] = connection future.set_result(connection) # Add the connection to the IOLoop self._ioloop.add_handler(connection.fileno(), self._on_io_events, ioloop.IOLoop.WRITE) except pool.NoIdleConnectionsError: self._create_connection(future) return future def _create_connection(self, future): """Create a new PostgreSQL connection :param tornado.concurrent.Future future: future for new conn result """ LOGGER.debug('Creating a new connection for %s', self.pid) # Create a new PostgreSQL connection kwargs = utils.uri_to_kwargs(self._uri) try: connection = self._psycopg2_connect(kwargs) except (psycopg2.Error, OSError, socket.error) as error: future.set_exception(error) return # Add the connection for use in _poll_connection fd = connection.fileno() self._connections[fd] = connection def on_connected(cf): """Invoked by the IOLoop when the future is complete for the connection :param Future cf: The future for the initial connection """ if cf.exception(): self._cleanup_fd(fd, True) future.set_exception(cf.exception()) else: try: # Add the connection to the pool LOGGER.debug('Connection established for %s', self.pid) self._pool_manager.add(self.pid, connection) except (ValueError, pool.PoolException) as err: LOGGER.exception('Failed to add %r to the pool', self.pid) self._cleanup_fd(fd) future.set_exception(err) return self._pool_manager.lock(self.pid, connection, self) # Added in because psycopg2cffi connects and leaves the # connection in a weird state: consts.STATUS_DATESTYLE, # returning from Connection._setup without setting the state # as const.STATUS_OK if utils.PYPY: connection.status = extensions.STATUS_READY # Register the custom data types self._register_unicode(connection) self._register_uuid(connection) # Set the future result future.set_result(connection) # Add a future that fires once connected self._futures[fd] = concurrent.Future() self._ioloop.add_future(self._futures[fd], on_connected) # Add the connection to the IOLoop self._ioloop.add_handler(connection.fileno(), self._on_io_events, ioloop.IOLoop.WRITE) def _execute(self, method, query, parameters=None): """Issue a query asynchronously on the server, mogrifying the parameters against the sql statement and yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. This function reduces duplicate code for callproc and query by getting the class attribute for the method passed in as the function to call. :param str method: The method attribute to use :param str query: The SQL statement or Stored Procedure name :param list|dict parameters: A dictionary of query parameters :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ future = concurrent.Future() def on_connected(cf): """Invoked by the future returned by self._connect""" if cf.exception(): future.set_exception(cf.exception()) return # Get the psycopg2 connection object and cursor conn = cf.result() cursor = self._get_cursor(conn) def completed(qf): """Invoked by the IOLoop when the future has completed""" if qf.exception(): self._incr_exceptions(conn) err = qf.exception() LOGGER.debug('Cleaning cursor due to exception: %r', err) self._exec_cleanup(cursor, conn.fileno()) future.set_exception(err) else: self._incr_executions(conn) value = Results(cursor, self._exec_cleanup, conn.fileno()) future.set_result(value) # Setup a callback to wait on the query result self._futures[conn.fileno()] = concurrent.Future() # Add the future to the IOLoop self._ioloop.add_future(self._futures[conn.fileno()], completed) # Get the cursor, execute the query func = getattr(cursor, method) try: func(query, parameters) except Exception as error: future.set_exception(error) # Ensure the pool exists for the connection self._ensure_pool_exists() # Grab a connection to PostgreSQL self._ioloop.add_future(self._connect(), on_connected) # Return the future for the query result return future def _exec_cleanup(self, cursor, fd): """Close the cursor, remove any references to the fd in internal state and remove the fd from the ioloop. :param psycopg2.extensions.cursor cursor: The cursor to close :param int fd: The connection file descriptor """ LOGGER.debug('Closing cursor and cleaning %s', fd) try: cursor.close() except (psycopg2.Error, psycopg2.Warning) as error: LOGGER.debug('Error closing the cursor: %s', error) self._cleanup_fd(fd) # If the cleanup callback exists, remove it if self._cleanup_callback: self._ioloop.remove_timeout(self._cleanup_callback) # Create a new cleanup callback to clean the pool of idle connections self._cleanup_callback = self._ioloop.add_timeout( self._ioloop.time() + self._pool_idle_ttl + 1, self._pool_manager.clean, self.pid) def _cleanup_fd(self, fd, close=False): """Ensure the socket socket is removed from the IOLoop, the connection stack, and futures stack. :param int fd: The fd # to cleanup """ self._ioloop.remove_handler(fd) if fd in self._connections: try: self._pool_manager.free(self.pid, self._connections[fd]) except pool.ConnectionNotFoundError: pass if close: self._connections[fd].close() del self._connections[fd] if fd in self._futures: del self._futures[fd] def _incr_exceptions(self, conn): """Increment the number of exceptions for the current connection. :param psycopg2.extensions.connection conn: the psycopg2 connection """ self._pool_manager.get_connection(self.pid, conn).exceptions += 1 def _incr_executions(self, conn): """Increment the number of executions for the current connection. :param psycopg2.extensions.connection conn: the psycopg2 connection """ self._pool_manager.get_connection(self.pid, conn).executions += 1 def _on_io_events(self, fd=None, _events=None): """Invoked by Tornado's IOLoop when there are events for the fd :param int fd: The file descriptor for the event :param int _events: The events raised """ if fd not in self._connections: LOGGER.warning('Received IO event for non-existing connection') return self._poll_connection(fd) def _poll_connection(self, fd): """Check with psycopg2 to see what action to take. If the state is POLL_OK, we should have a pending callback for that fd. :param int fd: The socket fd for the postgresql connection """ try: state = self._connections[fd].poll() except (OSError, socket.error) as error: self._ioloop.remove_handler(fd) if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception( psycopg2.OperationalError('Connection error (%s)' % error) ) except (psycopg2.Error, psycopg2.Warning) as error: if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception(error) else: if state == extensions.POLL_OK: if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_result(True) elif state == extensions.POLL_WRITE: self._ioloop.update_handler(fd, ioloop.IOLoop.WRITE) elif state == extensions.POLL_READ: self._ioloop.update_handler(fd, ioloop.IOLoop.READ) elif state == extensions.POLL_ERROR: self._ioloop.remove_handler(fd) if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception( psycopg2.Error('Poll Error')) def _psycopg2_connect(self, kwargs): """Return a psycopg2 connection for the specified kwargs. Extend for use in async session adapters. :param dict kwargs: Keyword connection args :rtype: psycopg2.extensions.connection """ kwargs['async'] = True return psycopg2.connect(**kwargs) <MSG> Documentation updates <DFF> @@ -87,7 +87,15 @@ class TornadoSession(session.Session): :param str name: The stored procedure name :param list args: An optional list of procedure arguments - :rtype: list + :return tuple: int, list + :raises: queries.DataError + :raises: queries.DatabaseError + :raises: queries.IntegrityError + :raises: queries.InternalError + :raises: queries.InterfaceError + :raises: queries.NotSupportedError + :raises: queries.OperationalError + :raises: queries.ProgrammingError """ # Grab a connection, either new or out of the pool @@ -186,7 +194,15 @@ class TornadoSession(session.Session): :param str sql: The SQL statement :param dict parameters: A dictionary of query parameters - :return tuple: (row_count, rows) + :return tuple: int, list + :raises: queries.DataError + :raises: queries.DatabaseError + :raises: queries.IntegrityError + :raises: queries.InternalError + :raises: queries.InterfaceError + :raises: queries.NotSupportedError + :raises: queries.OperationalError + :raises: queries.ProgrammingError """ # Grab a connection, either new or out of the pool

Documentation updates

.py

py

bsd-3-clause

gmr/queries

1564

<NME> tornado_session.py <BEF> """ Tornado Session Adapter Use Queries asynchronously within the Tornado framework. Example Use: .. code:: python class NameListHandler(web.RequestHandler): def initialize(self): self.session = queries.TornadoSession(pool_max_size=60) @gen.coroutine def get(self): data = yield self.session.query('SELECT * FROM names') if data: self.finish({'names': data.items()}) data.free() else: self.set_status(500, 'Error querying the data') """ import logging import socket import warnings from tornado import concurrent, ioloop from psycopg2 import extras, extensions import psycopg2 from queries import pool, results, session, utils LOGGER = logging.getLogger(__name__) DEFAULT_MAX_POOL_SIZE = 25 class Results(results.Results): """A TornadoSession specific :py:class:`queries.Results` class that adds the :py:meth:`Results.free <queries.tornado_session.Results.free>` method. The :py:meth:`Results.free <queries.tornado_session.Results.free>` method **must** be called to free the connection that the results were generated on. `Results` objects that are not freed will cause the connections to remain locked and your application will eventually run out of connections in the pool. The following examples illustrate the various behaviors that the ::py:class:`queries.Results <queries.tornado_session.Requests>` class implements: **Using Results as an Iterator** .. code:: python results = yield session.query('SELECT * FROM foo') for row in results print row results.free() **Accessing an individual row by index** .. code:: python results = yield session.query('SELECT * FROM foo') print results[1] # Access the second row of the results results.free() **Casting single row results as a dict** .. code:: python results = yield session.query('SELECT * FROM foo LIMIT 1') print results.as_dict() results.free() **Checking to see if a query was successful** .. code:: python sql = "UPDATE foo SET bar='baz' WHERE qux='corgie'" results = yield session.query(sql) if results: print 'Success' results.free() :param str name: The stored procedure name :param list args: An optional list of procedure arguments :rtype: list """ # Grab a connection, either new or out of the pool def free(self): """Release the results and connection lock from the TornadoSession object. This **must** be called after you finish processing the results from :py:meth:`TornadoSession.query <queries.TornadoSession.query>` or :py:meth:`TornadoSession.callproc <queries.TornadoSession.callproc>` or the connection will not be able to be reused by other asynchronous requests. """ self._freed = True self._cleanup(self.cursor, self._fd) def __del__(self): if not self._freed: LOGGER.warning('Auto-freeing result on deletion') self.free() class TornadoSession(session.Session): """Session class for Tornado asynchronous applications. Uses :py:func:`tornado.gen.coroutine` to wrap API methods for use in Tornado. Utilizes connection pooling to ensure that multiple concurrent asynchronous queries do not block each other. Heavily trafficked services will require a higher ``max_pool_size`` to allow for greater connection concurrency. :py:meth:`TornadoSession.query <queries.TornadoSession.query>` and :py:meth:`TornadoSession.callproc <queries.TornadoSession.callproc>` must call :py:meth:`Results.free <queries.tornado_session.Results.free>` :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ def __init__(self, uri=session.DEFAULT_URI, cursor_factory=extras.RealDictCursor, pool_idle_ttl=pool.DEFAULT_IDLE_TTL, pool_max_size=DEFAULT_MAX_POOL_SIZE, io_loop=None): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use :param tornado.ioloop.IOLoop io_loop: IOLoop instance to use """ self._connections = dict() self._cleanup_callback = None self._cursor_factory = cursor_factory self._futures = dict() self._ioloop = io_loop or ioloop.IOLoop.current() self._pool_manager = pool.PoolManager.instance() self._pool_max_size = pool_max_size self._pool_idle_ttl = pool_idle_ttl self._uri = uri self._ensure_pool_exists() def _ensure_pool_exists(self): """Create the pool in the pool manager if it does not exist.""" if self.pid not in self._pool_manager: self._pool_manager.create(self.pid, self._pool_idle_ttl, self._pool_max_size, self._ioloop.time) @property def connection(self): """Do not use this directly with Tornado applications :return: """ return None @property def cursor(self): return None def callproc(self, name, args=None): """Call a stored procedure asynchronously on the server, passing in the arguments to be passed to the stored procedure, yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. You **must** free the results that are returned by this method to unlock the connection used to perform the query. Failure to do so will cause your Tornado application to run out of connections. :param str name: The stored procedure name :param list args: An optional list of procedure arguments :param str sql: The SQL statement :param dict parameters: A dictionary of query parameters :return tuple: (row_count, rows) """ # Grab a connection, either new or out of the pool parameters against the sql statement and yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. You **must** free the results that are returned by this method to unlock the connection used to perform the query. Failure to do so will cause your Tornado application to run out of connections. :param str sql: The SQL statement :param dict parameters: A dictionary of query parameters :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ return self._execute('execute', sql, parameters) def validate(self): """Validate the session can connect or has open connections to PostgreSQL. As of ``1.10.3`` .. deprecated:: 1.10.3 As of 1.10.3, this method only warns about Deprecation :rtype: bool """ warnings.warn( 'All functionality removed from this method', DeprecationWarning) def _connect(self): """Connect to PostgreSQL, either by reusing a connection from the pool if possible, or by creating the new connection. :rtype: psycopg2.extensions.connection :raises: pool.NoIdleConnectionsError """ future = concurrent.Future() # Attempt to get a cached connection from the connection pool try: connection = self._pool_manager.get(self.pid, self) self._connections[connection.fileno()] = connection future.set_result(connection) # Add the connection to the IOLoop self._ioloop.add_handler(connection.fileno(), self._on_io_events, ioloop.IOLoop.WRITE) except pool.NoIdleConnectionsError: self._create_connection(future) return future def _create_connection(self, future): """Create a new PostgreSQL connection :param tornado.concurrent.Future future: future for new conn result """ LOGGER.debug('Creating a new connection for %s', self.pid) # Create a new PostgreSQL connection kwargs = utils.uri_to_kwargs(self._uri) try: connection = self._psycopg2_connect(kwargs) except (psycopg2.Error, OSError, socket.error) as error: future.set_exception(error) return # Add the connection for use in _poll_connection fd = connection.fileno() self._connections[fd] = connection def on_connected(cf): """Invoked by the IOLoop when the future is complete for the connection :param Future cf: The future for the initial connection """ if cf.exception(): self._cleanup_fd(fd, True) future.set_exception(cf.exception()) else: try: # Add the connection to the pool LOGGER.debug('Connection established for %s', self.pid) self._pool_manager.add(self.pid, connection) except (ValueError, pool.PoolException) as err: LOGGER.exception('Failed to add %r to the pool', self.pid) self._cleanup_fd(fd) future.set_exception(err) return self._pool_manager.lock(self.pid, connection, self) # Added in because psycopg2cffi connects and leaves the # connection in a weird state: consts.STATUS_DATESTYLE, # returning from Connection._setup without setting the state # as const.STATUS_OK if utils.PYPY: connection.status = extensions.STATUS_READY # Register the custom data types self._register_unicode(connection) self._register_uuid(connection) # Set the future result future.set_result(connection) # Add a future that fires once connected self._futures[fd] = concurrent.Future() self._ioloop.add_future(self._futures[fd], on_connected) # Add the connection to the IOLoop self._ioloop.add_handler(connection.fileno(), self._on_io_events, ioloop.IOLoop.WRITE) def _execute(self, method, query, parameters=None): """Issue a query asynchronously on the server, mogrifying the parameters against the sql statement and yielding the results as a :py:class:`Results <queries.tornado_session.Results>` object. This function reduces duplicate code for callproc and query by getting the class attribute for the method passed in as the function to call. :param str method: The method attribute to use :param str query: The SQL statement or Stored Procedure name :param list|dict parameters: A dictionary of query parameters :rtype: Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ future = concurrent.Future() def on_connected(cf): """Invoked by the future returned by self._connect""" if cf.exception(): future.set_exception(cf.exception()) return # Get the psycopg2 connection object and cursor conn = cf.result() cursor = self._get_cursor(conn) def completed(qf): """Invoked by the IOLoop when the future has completed""" if qf.exception(): self._incr_exceptions(conn) err = qf.exception() LOGGER.debug('Cleaning cursor due to exception: %r', err) self._exec_cleanup(cursor, conn.fileno()) future.set_exception(err) else: self._incr_executions(conn) value = Results(cursor, self._exec_cleanup, conn.fileno()) future.set_result(value) # Setup a callback to wait on the query result self._futures[conn.fileno()] = concurrent.Future() # Add the future to the IOLoop self._ioloop.add_future(self._futures[conn.fileno()], completed) # Get the cursor, execute the query func = getattr(cursor, method) try: func(query, parameters) except Exception as error: future.set_exception(error) # Ensure the pool exists for the connection self._ensure_pool_exists() # Grab a connection to PostgreSQL self._ioloop.add_future(self._connect(), on_connected) # Return the future for the query result return future def _exec_cleanup(self, cursor, fd): """Close the cursor, remove any references to the fd in internal state and remove the fd from the ioloop. :param psycopg2.extensions.cursor cursor: The cursor to close :param int fd: The connection file descriptor """ LOGGER.debug('Closing cursor and cleaning %s', fd) try: cursor.close() except (psycopg2.Error, psycopg2.Warning) as error: LOGGER.debug('Error closing the cursor: %s', error) self._cleanup_fd(fd) # If the cleanup callback exists, remove it if self._cleanup_callback: self._ioloop.remove_timeout(self._cleanup_callback) # Create a new cleanup callback to clean the pool of idle connections self._cleanup_callback = self._ioloop.add_timeout( self._ioloop.time() + self._pool_idle_ttl + 1, self._pool_manager.clean, self.pid) def _cleanup_fd(self, fd, close=False): """Ensure the socket socket is removed from the IOLoop, the connection stack, and futures stack. :param int fd: The fd # to cleanup """ self._ioloop.remove_handler(fd) if fd in self._connections: try: self._pool_manager.free(self.pid, self._connections[fd]) except pool.ConnectionNotFoundError: pass if close: self._connections[fd].close() del self._connections[fd] if fd in self._futures: del self._futures[fd] def _incr_exceptions(self, conn): """Increment the number of exceptions for the current connection. :param psycopg2.extensions.connection conn: the psycopg2 connection """ self._pool_manager.get_connection(self.pid, conn).exceptions += 1 def _incr_executions(self, conn): """Increment the number of executions for the current connection. :param psycopg2.extensions.connection conn: the psycopg2 connection """ self._pool_manager.get_connection(self.pid, conn).executions += 1 def _on_io_events(self, fd=None, _events=None): """Invoked by Tornado's IOLoop when there are events for the fd :param int fd: The file descriptor for the event :param int _events: The events raised """ if fd not in self._connections: LOGGER.warning('Received IO event for non-existing connection') return self._poll_connection(fd) def _poll_connection(self, fd): """Check with psycopg2 to see what action to take. If the state is POLL_OK, we should have a pending callback for that fd. :param int fd: The socket fd for the postgresql connection """ try: state = self._connections[fd].poll() except (OSError, socket.error) as error: self._ioloop.remove_handler(fd) if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception( psycopg2.OperationalError('Connection error (%s)' % error) ) except (psycopg2.Error, psycopg2.Warning) as error: if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception(error) else: if state == extensions.POLL_OK: if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_result(True) elif state == extensions.POLL_WRITE: self._ioloop.update_handler(fd, ioloop.IOLoop.WRITE) elif state == extensions.POLL_READ: self._ioloop.update_handler(fd, ioloop.IOLoop.READ) elif state == extensions.POLL_ERROR: self._ioloop.remove_handler(fd) if fd in self._futures and not self._futures[fd].done(): self._futures[fd].set_exception( psycopg2.Error('Poll Error')) def _psycopg2_connect(self, kwargs): """Return a psycopg2 connection for the specified kwargs. Extend for use in async session adapters. :param dict kwargs: Keyword connection args :rtype: psycopg2.extensions.connection """ kwargs['async'] = True return psycopg2.connect(**kwargs) <MSG> Documentation updates <DFF> @@ -87,7 +87,15 @@ class TornadoSession(session.Session): :param str name: The stored procedure name :param list args: An optional list of procedure arguments - :rtype: list + :return tuple: int, list + :raises: queries.DataError + :raises: queries.DatabaseError + :raises: queries.IntegrityError + :raises: queries.InternalError + :raises: queries.InterfaceError + :raises: queries.NotSupportedError + :raises: queries.OperationalError + :raises: queries.ProgrammingError """ # Grab a connection, either new or out of the pool @@ -186,7 +194,15 @@ class TornadoSession(session.Session): :param str sql: The SQL statement :param dict parameters: A dictionary of query parameters - :return tuple: (row_count, rows) + :return tuple: int, list + :raises: queries.DataError + :raises: queries.DatabaseError + :raises: queries.IntegrityError + :raises: queries.InternalError + :raises: queries.InterfaceError + :raises: queries.NotSupportedError + :raises: queries.OperationalError + :raises: queries.ProgrammingError """ # Grab a connection, either new or out of the pool

Documentation updates

.py

py

bsd-3-clause

gmr/queries

1565

<NME> conf.py <BEF> # -*- coding: utf-8 -*- # # Queries documentation build configuration file, created by # sphinx-quickstart on Fri Apr 25 10:36:39 2014. # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys sys.path.insert(0, '../') # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = u'Queries' copyright = u'2014 - 2016, Gavin M. Roy' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # import queries release = queries.__version__ version = '.'.join(release.split('.')[0:1]) # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build'] # The reST default role (used for this markup: `text`) to use for all # documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. #keep_warnings = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. #html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_domain_indices = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a <link> tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'Queriesdoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ ('index', 'Queries.tex', u'Queries Documentation', u'Gavin M. Roy', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'queries', u'Queries Documentation', [u'Gavin M. Roy'], 1) ] # If true, show URL addresses after external links. #man_show_urls = False # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', 'Queries', u'Queries Documentation', u'Gavin M. Roy', 'Queries', 'PostgreSQL Simplified', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'psycopg2': ('http://initd.org/psycopg/docs/', None), 'tornado': ('http://www.tornadoweb.org/en/stable', None)} 'tornado': ('http://www.tornadoweb.org/en/stable', None) } <MSG> Make the end year dynamic <DFF> @@ -1,264 +1,42 @@ # -*- coding: utf-8 -*- -# -# Queries documentation build configuration file, created by -# sphinx-quickstart on Fri Apr 25 10:36:39 2014. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. +import datetime import sys -sys.path.insert(0, '../') - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) -# -- General configuration ------------------------------------------------ +sys.path.insert(0, '../') -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +import queries -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode', ] - -# Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] - -# The suffix of source filenames. source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. master_doc = 'index' - -# General information about the project. -project = u'Queries' -copyright = u'2014 - 2016, Gavin M. Roy' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -import queries +project = 'Queries' +copyright = '2014 - {}, Gavin M. Roy'.format( + datetime.date.today().strftime('%Y')) release = queries.__version__ version = '.'.join(release.split('.')[0:1]) - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. exclude_patterns = ['_build'] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. html_theme = 'default' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# "<project> v<release> documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -#html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a <link> tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. htmlhelp_basename = 'Queriesdoc' - - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). +latex_elements = {} latex_documents = [ ('index', 'Queries.tex', u'Queries Documentation', u'Gavin M. Roy', 'manual'), ] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). man_pages = [ ('index', 'queries', u'Queries Documentation', [u'Gavin M. Roy'], 1) ] - -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) texinfo_documents = [ ('index', 'Queries', u'Queries Documentation', u'Gavin M. Roy', 'Queries', 'PostgreSQL Simplified', 'Miscellaneous'), ] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False - -# Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'psycopg2': ('http://initd.org/psycopg/docs/', None), 'tornado': ('http://www.tornadoweb.org/en/stable', None)}

Make the end year dynamic

.py

py

bsd-3-clause

gmr/queries

1566

<NME> conf.py <BEF> # -*- coding: utf-8 -*- # # Queries documentation build configuration file, created by # sphinx-quickstart on Fri Apr 25 10:36:39 2014. # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys sys.path.insert(0, '../') # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = u'Queries' copyright = u'2014 - 2016, Gavin M. Roy' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # import queries release = queries.__version__ version = '.'.join(release.split('.')[0:1]) # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build'] # The reST default role (used for this markup: `text`) to use for all # documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. #keep_warnings = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. #html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_domain_indices = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a <link> tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'Queriesdoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ ('index', 'Queries.tex', u'Queries Documentation', u'Gavin M. Roy', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'queries', u'Queries Documentation', [u'Gavin M. Roy'], 1) ] # If true, show URL addresses after external links. #man_show_urls = False # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', 'Queries', u'Queries Documentation', u'Gavin M. Roy', 'Queries', 'PostgreSQL Simplified', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'psycopg2': ('http://initd.org/psycopg/docs/', None), 'tornado': ('http://www.tornadoweb.org/en/stable', None)} 'tornado': ('http://www.tornadoweb.org/en/stable', None) } <MSG> Make the end year dynamic <DFF> @@ -1,264 +1,42 @@ # -*- coding: utf-8 -*- -# -# Queries documentation build configuration file, created by -# sphinx-quickstart on Fri Apr 25 10:36:39 2014. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. +import datetime import sys -sys.path.insert(0, '../') - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) -# -- General configuration ------------------------------------------------ +sys.path.insert(0, '../') -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +import queries -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode', ] - -# Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] - -# The suffix of source filenames. source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. master_doc = 'index' - -# General information about the project. -project = u'Queries' -copyright = u'2014 - 2016, Gavin M. Roy' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -import queries +project = 'Queries' +copyright = '2014 - {}, Gavin M. Roy'.format( + datetime.date.today().strftime('%Y')) release = queries.__version__ version = '.'.join(release.split('.')[0:1]) - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. exclude_patterns = ['_build'] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. html_theme = 'default' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# "<project> v<release> documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -#html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a <link> tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. htmlhelp_basename = 'Queriesdoc' - - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). +latex_elements = {} latex_documents = [ ('index', 'Queries.tex', u'Queries Documentation', u'Gavin M. Roy', 'manual'), ] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). man_pages = [ ('index', 'queries', u'Queries Documentation', [u'Gavin M. Roy'], 1) ] - -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) texinfo_documents = [ ('index', 'Queries', u'Queries Documentation', u'Gavin M. Roy', 'Queries', 'PostgreSQL Simplified', 'Miscellaneous'), ] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False - -# Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'psycopg2': ('http://initd.org/psycopg/docs/', None), 'tornado': ('http://www.tornadoweb.org/en/stable', None)}

Make the end year dynamic

.py

py

bsd-3-clause

gmr/queries

1567

<NME> session.py <BEF> """The Session class allows for a unified (and simplified) view of interfacing with a PostgreSQL database server. Connection details are passed in as a PostgreSQL URI and connections are pooled by default, allowing for reuse of connections across modules in the Python runtime without having to pass around the object handle. While you can still access the raw `psycopg2` connection and cursor objects to provide ultimate flexibility in how you use the queries.Session object, there are convenience methods designed to simplify the interaction with PostgreSQL. For `psycopg2` functionality outside of what is exposed in Session, simply use the Session.connection or Session.cursor properties to gain access to either object just as you would in a program using psycopg2 directly. Example usage: .. code:: python import queries with queries.Session('pgsql://postgres@localhost/postgres') as session: for row in session.Query('SELECT * FROM table'): print row """ import hashlib import logging import psycopg2 from psycopg2 import extensions, extras from queries import pool, results, utils LOGGER = logging.getLogger(__name__) DEFAULT_ENCODING = 'UTF8' DEFAULT_URI = 'postgresql://localhost:5432' class Session(object): """The Session class allows for a unified (and simplified) view of interfacing with a PostgreSQL database server. The Session object can act as a context manager, providing automated cleanup and simple, Pythonic way of interacting with the object. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use :param bool use_pool: Use the connection pool """ _from_pool = False _tpc_id = None # Connection status constants INTRANS = extensions.STATUS_IN_TRANSACTION TX_ACTIVE = extensions.TRANSACTION_STATUS_ACTIVE TX_IDLE = extensions.TRANSACTION_STATUS_IDLE TX_INERROR = extensions.TRANSACTION_STATUS_INERROR TX_INTRANS = extensions.TRANSACTION_STATUS_INTRANS TX_UNKNOWN = extensions.TRANSACTION_STATUS_UNKNOWN def __init__(self, uri=DEFAULT_URI, cursor_factory=extras.RealDictCursor, pool_idle_ttl=pool.DEFAULT_IDLE_TTL, pool_max_size=pool.DEFAULT_MAX_SIZE, autocommit=True): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ self._pool_manager = pool.PoolManager.instance() self._uri = uri # Ensure the pool exists in the pool manager if self.pid not in self._pool_manager: self._pool_manager.create(self.pid, pool_idle_ttl, pool_max_size) self._conn = self._connect() self._cursor_factory = cursor_factory self._cursor = self._get_cursor(self._conn) self._autocommit(autocommit) @property def backend_pid(self): """Return the backend process ID of the PostgreSQL server that this session is connected to. :rtype: int """ return self._conn.get_backend_pid() def callproc(self, name, args=None): """Call a stored procedure on the server, returning the results in a :py:class:`queries.Results` instance. :param str name: The procedure name :param list args: The list of arguments to pass in :rtype: queries.Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ try: self._cursor.callproc(name, args) except psycopg2.Error as err: self._incr_exceptions() raise err finally: self._incr_executions() return results.Results(self._cursor) def close(self): """Explicitly close the connection and remove it from the connection pool if pooling is enabled. If the connection is already closed :raises: psycopg2.InterfaceError """ if not self._conn: raise psycopg2.InterfaceError('Connection not open') LOGGER.info('Closing connection %r in %s', self._conn, self.pid) self._pool_manager.free(self.pid, self._conn) self._pool_manager.remove_connection(self.pid, self._conn) # Un-assign the connection and cursor self._conn, self._cursor = None, None @property def connection(self): """Return the current open connection to PostgreSQL. :rtype: psycopg2.extensions.connection """ return self._conn @property def cursor(self): """Return the current, active cursor for the open connection. :rtype: psycopg2.extensions.cursor """ return self._cursor @property def encoding(self): """Return the current client encoding value. :rtype: str """ return self._conn.encoding @property def notices(self): """Return a list of up to the last 50 server notices sent to the client. :rtype: list """ return self._conn.notices @property def pid(self): """Return the pool ID used for connection pooling. :rtype: str """ return hashlib.md5(':'.join([self.__class__.__name__, self._uri]).encode('utf-8')).hexdigest() def query(self, sql, parameters=None): """A generator to issue a query on the server, mogrifying the parameters against the sql statement. Results are returned as a :py:class:`queries.Results` object which can act as an iterator and has multiple ways to access the result data. :param str sql: The SQL statement :param dict parameters: A dictionary of query parameters :rtype: queries.Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ try: self._cursor.execute(sql, parameters) except psycopg2.Error as err: self._incr_exceptions() raise err finally: self._incr_executions() return results.Results(self._cursor) def set_encoding(self, value=DEFAULT_ENCODING): """Set the client encoding for the session if the value specified is different than the current client encoding. :param str value: The encoding value to use """ if self._conn.encoding != value: self._conn.set_client_encoding(value) def __del__(self): """When deleting the context, ensure the instance is removed from caches, etc. """ self._cleanup() def __enter__(self): """For use as a context manager, return a handle to this object instance. :rtype: Session """ return self def __exit__(self, exc_type, exc_val, exc_tb): """When leaving the context, ensure the instance is removed from caches, etc. """ self._cleanup() def _autocommit(self, autocommit): """Set the isolation level automatically to commit or not after every query :param autocommit: Boolean (Default - True) """ self._conn.autocommit = autocommit def _cleanup(self): """Remove the connection from the stack, closing out the cursor""" if self._cursor: LOGGER.debug('Closing the cursor on %s', self.pid) self._cursor.close() self._cursor = None if self._conn: LOGGER.debug('Freeing %s in the pool', self.pid) try: pool.PoolManager.instance().free(self.pid, self._conn) except pool.ConnectionNotFoundError: pass self._conn = None def _connect(self): """Connect to PostgreSQL, either by reusing a connection from the pool if possible, or by creating the new connection. :rtype: psycopg2.extensions.connection :raises: pool.NoIdleConnectionsError """ # Attempt to get a cached connection from the connection pool try: connection = self._pool_manager.get(self.pid, self) LOGGER.debug("Re-using connection for %s", self.pid) except pool.NoIdleConnectionsError: if self._pool_manager.is_full(self.pid): raise # Create a new PostgreSQL connection kwargs = utils.uri_to_kwargs(self._uri) LOGGER.debug("Creating a new connection for %s", self.pid) connection = self._psycopg2_connect(kwargs) self._pool_manager.add(self.pid, connection) self._pool_manager.lock(self.pid, connection, self) # Added in because psycopg2ct connects and leaves the connection in # a weird state: consts.STATUS_DATESTYLE, returning from # Connection._setup without setting the state as const.STATUS_OK if utils.PYPY: connection.reset() # Register the custom data types self._register_unicode(connection) self._register_uuid(connection) return connection def _get_cursor(self, connection, name=None): """Return a cursor for the given cursor_factory. Specify a name to use server-side cursors. :param connection: The connection to create a cursor on :type connection: psycopg2.extensions.connection :param str name: A cursor name for a server side cursor :rtype: psycopg2.extensions.cursor """ cursor = connection.cursor(name=name, cursor_factory=self._cursor_factory) if name is not None: cursor.scrollable = True cursor.withhold = True return cursor def _incr_exceptions(self): """Increment the number of exceptions for the current connection.""" self._pool_manager.get_connection(self.pid, self._conn).exceptions += 1 def _incr_executions(self): """Increment the number of executions for the current connection.""" self._pool_manager.get_connection(self.pid, self._conn).executions += 1 def _psycopg2_connect(self, kwargs): """Return a psycopg2 connection for the specified kwargs. Extend for use in async session adapters. :param dict kwargs: Keyword connection args :rtype: psycopg2.extensions.connection """ return psycopg2.connect(**kwargs) @staticmethod def _register_unicode(connection): """Register the cursor to be able to receive Unicode string. :type connection: psycopg2.extensions.connection :param connection: Where to register things """ psycopg2.extensions.register_type(psycopg2.extensions.UNICODE, connection) psycopg2.extensions.register_type(psycopg2.extensions.UNICODEARRAY, connection) @staticmethod def _register_uuid(connection): """Register the UUID extension from the psycopg2.extra module :type connection: psycopg2.extensions.connection :param connection: Where to register things """ psycopg2.extras.register_uuid(conn_or_curs=connection) :rtype: str """ return hashlib.md5(self._uri.encode('utf-8')).digest() def _psycopg2_connect(self, kwargs): """Return a psycopg2 connection for the specified kwargs. Extend for - queries.Session.INTRANS: Connection established, in transaction - queries.Session.PREPARED: Prepared for second phase of transaction - queries.Session.READY: Connected, no active transaction :rtype: int """ if self._conn.status == psycopg2.extensions.STATUS_BEGIN: return self.READY return self._conn.status <MSG> Use strings for pool ids, add class level constants to reduce code in child classes <DFF> @@ -51,8 +51,13 @@ class Session(object): :param bool use_pool: Use the connection pool """ + _conn = None + _cursor = None + _cursor_factory = None _from_pool = False _tpc_id = None + _uri = None + _use_pool = True # Connection status constants INTRANS = extensions.STATUS_IN_TRANSACTION @@ -365,7 +370,7 @@ class Session(object): :rtype: str """ - return hashlib.md5(self._uri.encode('utf-8')).digest() + return str(hashlib.md5(self._uri.encode('utf-8')).digest()) def _psycopg2_connect(self, kwargs): """Return a psycopg2 connection for the specified kwargs. Extend for

Use strings for pool ids, add class level constants to reduce code in child classes

.py

py

bsd-3-clause

gmr/queries

1568

<NME> session.py <BEF> """The Session class allows for a unified (and simplified) view of interfacing with a PostgreSQL database server. Connection details are passed in as a PostgreSQL URI and connections are pooled by default, allowing for reuse of connections across modules in the Python runtime without having to pass around the object handle. While you can still access the raw `psycopg2` connection and cursor objects to provide ultimate flexibility in how you use the queries.Session object, there are convenience methods designed to simplify the interaction with PostgreSQL. For `psycopg2` functionality outside of what is exposed in Session, simply use the Session.connection or Session.cursor properties to gain access to either object just as you would in a program using psycopg2 directly. Example usage: .. code:: python import queries with queries.Session('pgsql://postgres@localhost/postgres') as session: for row in session.Query('SELECT * FROM table'): print row """ import hashlib import logging import psycopg2 from psycopg2 import extensions, extras from queries import pool, results, utils LOGGER = logging.getLogger(__name__) DEFAULT_ENCODING = 'UTF8' DEFAULT_URI = 'postgresql://localhost:5432' class Session(object): """The Session class allows for a unified (and simplified) view of interfacing with a PostgreSQL database server. The Session object can act as a context manager, providing automated cleanup and simple, Pythonic way of interacting with the object. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use :param bool use_pool: Use the connection pool """ _from_pool = False _tpc_id = None # Connection status constants INTRANS = extensions.STATUS_IN_TRANSACTION TX_ACTIVE = extensions.TRANSACTION_STATUS_ACTIVE TX_IDLE = extensions.TRANSACTION_STATUS_IDLE TX_INERROR = extensions.TRANSACTION_STATUS_INERROR TX_INTRANS = extensions.TRANSACTION_STATUS_INTRANS TX_UNKNOWN = extensions.TRANSACTION_STATUS_UNKNOWN def __init__(self, uri=DEFAULT_URI, cursor_factory=extras.RealDictCursor, pool_idle_ttl=pool.DEFAULT_IDLE_TTL, pool_max_size=pool.DEFAULT_MAX_SIZE, autocommit=True): """Connect to a PostgreSQL server using the module wide connection and set the isolation level. :param str uri: PostgreSQL connection URI :param psycopg2.extensions.cursor: The cursor type to use :param int pool_idle_ttl: How long idle pools keep connections open :param int pool_max_size: The maximum size of the pool to use """ self._pool_manager = pool.PoolManager.instance() self._uri = uri # Ensure the pool exists in the pool manager if self.pid not in self._pool_manager: self._pool_manager.create(self.pid, pool_idle_ttl, pool_max_size) self._conn = self._connect() self._cursor_factory = cursor_factory self._cursor = self._get_cursor(self._conn) self._autocommit(autocommit) @property def backend_pid(self): """Return the backend process ID of the PostgreSQL server that this session is connected to. :rtype: int """ return self._conn.get_backend_pid() def callproc(self, name, args=None): """Call a stored procedure on the server, returning the results in a :py:class:`queries.Results` instance. :param str name: The procedure name :param list args: The list of arguments to pass in :rtype: queries.Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ try: self._cursor.callproc(name, args) except psycopg2.Error as err: self._incr_exceptions() raise err finally: self._incr_executions() return results.Results(self._cursor) def close(self): """Explicitly close the connection and remove it from the connection pool if pooling is enabled. If the connection is already closed :raises: psycopg2.InterfaceError """ if not self._conn: raise psycopg2.InterfaceError('Connection not open') LOGGER.info('Closing connection %r in %s', self._conn, self.pid) self._pool_manager.free(self.pid, self._conn) self._pool_manager.remove_connection(self.pid, self._conn) # Un-assign the connection and cursor self._conn, self._cursor = None, None @property def connection(self): """Return the current open connection to PostgreSQL. :rtype: psycopg2.extensions.connection """ return self._conn @property def cursor(self): """Return the current, active cursor for the open connection. :rtype: psycopg2.extensions.cursor """ return self._cursor @property def encoding(self): """Return the current client encoding value. :rtype: str """ return self._conn.encoding @property def notices(self): """Return a list of up to the last 50 server notices sent to the client. :rtype: list """ return self._conn.notices @property def pid(self): """Return the pool ID used for connection pooling. :rtype: str """ return hashlib.md5(':'.join([self.__class__.__name__, self._uri]).encode('utf-8')).hexdigest() def query(self, sql, parameters=None): """A generator to issue a query on the server, mogrifying the parameters against the sql statement. Results are returned as a :py:class:`queries.Results` object which can act as an iterator and has multiple ways to access the result data. :param str sql: The SQL statement :param dict parameters: A dictionary of query parameters :rtype: queries.Results :raises: queries.DataError :raises: queries.DatabaseError :raises: queries.IntegrityError :raises: queries.InternalError :raises: queries.InterfaceError :raises: queries.NotSupportedError :raises: queries.OperationalError :raises: queries.ProgrammingError """ try: self._cursor.execute(sql, parameters) except psycopg2.Error as err: self._incr_exceptions() raise err finally: self._incr_executions() return results.Results(self._cursor) def set_encoding(self, value=DEFAULT_ENCODING): """Set the client encoding for the session if the value specified is different than the current client encoding. :param str value: The encoding value to use """ if self._conn.encoding != value: self._conn.set_client_encoding(value) def __del__(self): """When deleting the context, ensure the instance is removed from caches, etc. """ self._cleanup() def __enter__(self): """For use as a context manager, return a handle to this object instance. :rtype: Session """ return self def __exit__(self, exc_type, exc_val, exc_tb): """When leaving the context, ensure the instance is removed from caches, etc. """ self._cleanup() def _autocommit(self, autocommit): """Set the isolation level automatically to commit or not after every query :param autocommit: Boolean (Default - True) """ self._conn.autocommit = autocommit def _cleanup(self): """Remove the connection from the stack, closing out the cursor""" if self._cursor: LOGGER.debug('Closing the cursor on %s', self.pid) self._cursor.close() self._cursor = None if self._conn: LOGGER.debug('Freeing %s in the pool', self.pid) try: pool.PoolManager.instance().free(self.pid, self._conn) except pool.ConnectionNotFoundError: pass self._conn = None def _connect(self): """Connect to PostgreSQL, either by reusing a connection from the pool if possible, or by creating the new connection. :rtype: psycopg2.extensions.connection :raises: pool.NoIdleConnectionsError """ # Attempt to get a cached connection from the connection pool try: connection = self._pool_manager.get(self.pid, self) LOGGER.debug("Re-using connection for %s", self.pid) except pool.NoIdleConnectionsError: if self._pool_manager.is_full(self.pid): raise # Create a new PostgreSQL connection kwargs = utils.uri_to_kwargs(self._uri) LOGGER.debug("Creating a new connection for %s", self.pid) connection = self._psycopg2_connect(kwargs) self._pool_manager.add(self.pid, connection) self._pool_manager.lock(self.pid, connection, self) # Added in because psycopg2ct connects and leaves the connection in # a weird state: consts.STATUS_DATESTYLE, returning from # Connection._setup without setting the state as const.STATUS_OK if utils.PYPY: connection.reset() # Register the custom data types self._register_unicode(connection) self._register_uuid(connection) return connection def _get_cursor(self, connection, name=None): """Return a cursor for the given cursor_factory. Specify a name to use server-side cursors. :param connection: The connection to create a cursor on :type connection: psycopg2.extensions.connection :param str name: A cursor name for a server side cursor :rtype: psycopg2.extensions.cursor """ cursor = connection.cursor(name=name, cursor_factory=self._cursor_factory) if name is not None: cursor.scrollable = True cursor.withhold = True return cursor def _incr_exceptions(self): """Increment the number of exceptions for the current connection.""" self._pool_manager.get_connection(self.pid, self._conn).exceptions += 1 def _incr_executions(self): """Increment the number of executions for the current connection.""" self._pool_manager.get_connection(self.pid, self._conn).executions += 1 def _psycopg2_connect(self, kwargs): """Return a psycopg2 connection for the specified kwargs. Extend for use in async session adapters. :param dict kwargs: Keyword connection args :rtype: psycopg2.extensions.connection """ return psycopg2.connect(**kwargs) @staticmethod def _register_unicode(connection): """Register the cursor to be able to receive Unicode string. :type connection: psycopg2.extensions.connection :param connection: Where to register things """ psycopg2.extensions.register_type(psycopg2.extensions.UNICODE, connection) psycopg2.extensions.register_type(psycopg2.extensions.UNICODEARRAY, connection) @staticmethod def _register_uuid(connection): """Register the UUID extension from the psycopg2.extra module :type connection: psycopg2.extensions.connection :param connection: Where to register things """ psycopg2.extras.register_uuid(conn_or_curs=connection) :rtype: str """ return hashlib.md5(self._uri.encode('utf-8')).digest() def _psycopg2_connect(self, kwargs): """Return a psycopg2 connection for the specified kwargs. Extend for - queries.Session.INTRANS: Connection established, in transaction - queries.Session.PREPARED: Prepared for second phase of transaction - queries.Session.READY: Connected, no active transaction :rtype: int """ if self._conn.status == psycopg2.extensions.STATUS_BEGIN: return self.READY return self._conn.status <MSG> Use strings for pool ids, add class level constants to reduce code in child classes <DFF> @@ -51,8 +51,13 @@ class Session(object): :param bool use_pool: Use the connection pool """ + _conn = None + _cursor = None + _cursor_factory = None _from_pool = False _tpc_id = None + _uri = None + _use_pool = True # Connection status constants INTRANS = extensions.STATUS_IN_TRANSACTION @@ -365,7 +370,7 @@ class Session(object): :rtype: str """ - return hashlib.md5(self._uri.encode('utf-8')).digest() + return str(hashlib.md5(self._uri.encode('utf-8')).digest()) def _psycopg2_connect(self, kwargs): """Return a psycopg2 connection for the specified kwargs. Extend for

Use strings for pool ids, add class level constants to reduce code in child classes

.py

py

bsd-3-clause

gmr/queries

1569

<NME> pool.py <BEF> """ Connection Pooling """ import datetime import logging import os import threading import time import weakref import psycopg2 LOGGER = logging.getLogger(__name__) DEFAULT_IDLE_TTL = 60 DEFAULT_MAX_SIZE = int(os.environ.get('QUERIES_MAX_POOL_SIZE', 1)) class Connection(object): """Contains the handle to the connection, the current state of the connection and methods for manipulating the state of the connection. """ _lock = threading.Lock() def __init__(self, handle): self.handle = handle self.used_by = None self.executions = 0 self.exceptions = 0 def close(self): """Close the connection :raises: ConnectionBusyError """ LOGGER.debug('Connection %s closing', self.id) if self.busy and not self.closed: raise ConnectionBusyError(self) with self._lock: if not self.handle.closed: try: self.handle.close() except psycopg2.InterfaceError as error: LOGGER.error('Error closing socket: %s', error) @property def closed(self): """Return if the psycopg2 connection is closed. :rtype: bool """ return self.handle.closed != 0 @property def busy(self): """Return if the connection is currently executing a query or is locked by a session that still exists. :rtype: bool """ if self.handle.isexecuting(): return True elif self.used_by is None: return False return not self.used_by() is None @property def executing(self): """Return if the connection is currently executing a query :rtype: bool """ return self.handle.isexecuting() def free(self): """Remove the lock on the connection if the connection is not active :raises: ConnectionBusyError """ LOGGER.debug('Connection %s freeing', self.id) if self.handle.isexecuting(): raise ConnectionBusyError(self) with self._lock: self.used_by = None LOGGER.debug('Connection %s freed', self.id) @property def id(self): """Return id of the psycopg2 connection object :rtype: int """A connection pool for gaining access to and managing connections""" _lock = threading.Lock() connections = dict() idle_start = None idle_ttl = DEFAULT_IDLE_TTL max_size = DEFAULT_MAX_SIZE a weakref for the session. pool_id, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE): self._id = pool_id self.idle_ttl = idle_ttl self.max_size = max_size self.used_by = weakref.ref(session) LOGGER.debug('Connection %s locked', self.id) @property def locked(self): """Return if the connection is currently exclusively locked :rtype: bool """ return self.used_by is not None class Pool(object): """A connection pool for gaining access to and managing connections""" _lock = threading.Lock() idle_start = None idle_ttl = DEFAULT_IDLE_TTL max_size = DEFAULT_MAX_SIZE def __init__(self, pool_id, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): self.connections = {} self._id = pool_id self.idle_ttl = idle_ttl """ for connection in [self.connections[k] for k in self.connections if self.connections[k].handle.closed]: self.remove(connection.handle) if self.idle_duration > self.idle_ttl: def __len__(self): """Return the number of connections in the pool""" return len(self.connections) def close(self): """Close the pool by closing and removing all of the connections""" for cid in [self.connections.keys()]: self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) """ if id(connection) in self.connections: raise ValueError('Connection already exists in pool') if len(self.connections) == self.max_size: LOGGER.warning('Race condition found when adding new connection') try: connection.close() except (psycopg2.Error, psycopg2.Warning) as error: except KeyError: raise ConnectionNotFoundError(self.id, id(connection)) if not self.idle_connections: with self._lock: self.idle_start = time.time() LOGGER.debug('Pool %s freed connection %s', self.id, id(connection)) def get(self, session): """Return a list of active/busy connections :rtype: list """ return [c for c in self.connections.values() if c.busy and not c.closed] def clean(self): """Clean the pool by removing any closed connections and if the pool's idle has exceeded its idle TTL, remove all connections. """ LOGGER.debug('Cleaning the pool') for connection in [self.connections[k] for k in self.connections if self.connections[k].closed]: LOGGER.debug('Removing %s', connection.id) self.remove(connection.handle) if self.idle_duration > self.idle_ttl: self.close() LOGGER.debug('Pool %s cleaned', self.id) def close(self): """Close the pool by closing and removing all of the connections""" for cid in list(self.connections.keys()): self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) @property def closed_connections(self): """Return a list of closed connections :rtype: list """ return [c for c in self.connections.values() if c.closed] def connection_handle(self, connection): """Return a connection object for the given psycopg2 connection :param connection: The connection to return a parent for :type connection: psycopg2.extensions.connection :rtype: Connection """ return self.connections[id(connection)] @property def executing_connections(self): """Return a list of connections actively executing queries :rtype: list """ return [c for c in self.connections.values() if c.executing] def free(self, connection): """Free the connection from use by the session that was using it. :param connection: The connection to free :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ LOGGER.debug('Pool %s freeing connection %s', self.id, id(connection)) try: self.connection_handle(connection).free() except KeyError: raise ConnectionNotFoundError(self.id, id(connection)) if self.idle_connections == list(self.connections.values()): with self._lock: self.idle_start = self.time_method() LOGGER.debug('Pool %s freed connection %s', self.id, id(connection)) def get(self, session): """Remove the connection from the pool :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError :raises: ConnectionBusyError """ cid = id(connection) try: c = self._connection(connection) except KeyError: raise ConnectionNotFoundError(self.id, cid) c.close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) def id(self): """Return the ID for this pool :rtype: str """ return self._id @property def idle_connections(self): """Return a list of idle connections :rtype: list """ return [c for c in self.connections.values() if not c.busy and not c.closed] @property def idle_duration(self): """Return the number of seconds that the pool has had no active connections. :rtype: float """ if self.idle_start is None: return 0 return self.time_method() - self.idle_start @property def is_full(self): """Return True if there are no more open slots for connections. :rtype: bool """ return len(self.connections) >= self.max_size def lock(self, connection, session): """Explicitly lock the specified connection :type connection: psycopg2.extensions.connection :param connection: The connection to lock :param queries.Session session: The session to hold the lock """ cid = id(connection) try: self.connection_handle(connection).lock(session) except KeyError: raise ConnectionNotFoundError(self.id, cid) else: if self.idle_start: with self._lock: self.idle_start = None LOGGER.debug('Pool %s locked connection %s', self.id, cid) @property def locked_connections(self): """Return a list of all locked connections :rtype: list """ return [c for c in self.connections.values() if c.locked] def remove(self, connection): """Remove the connection from the pool :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError :raises: ConnectionBusyError """ cid = id(connection) if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) self.connection_handle(connection).close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) def report(self): """Return a report about the pool state and configuration. :rtype: dict """ return { 'connections': { 'busy': len(self.busy_connections), 'closed': len(self.closed_connections), 'executing': len(self.executing_connections), 'idle': len(self.idle_connections), 'locked': len(self.busy_connections) }, 'exceptions': sum([c.exceptions for c in self.connections.values()]), 'executions': sum([c.executions for c in self.connections.values()]), 'full': self.is_full, 'idle': { 'duration': self.idle_duration, 'ttl': self.idle_ttl }, 'max_size': self.max_size } def shutdown(self): """Forcefully shutdown the entire pool, closing all non-executing connections. :raises: ConnectionBusyError """ with self._lock: for cid in list(self.connections.keys()): if self.connections[cid].executing: raise ConnectionBusyError(cid) if self.connections[cid].locked: self.connections[cid].free() self.connections[cid].close() del self.connections[cid] def set_idle_ttl(self, ttl): """Set the idle ttl :param int ttl: The TTL when idle """ with self._lock: self.idle_ttl = ttl def set_max_size(self, size): """Set the maximum number of connections :param int size: The maximum number of connections """ with self._lock: self.max_size = size class PoolManager(object): """The connection pool object implements behavior around connections and their use in queries.Session objects. We carry a pool id instead of the connection URI so that we will not be carrying the URI in memory, creating a possible security issue. """ _lock = threading.Lock() _pools = {} def __contains__(self, pid): """Returns True if the pool exists :param str pid: The pool id to check for :rtype: bool """ return pid in self.__class__._pools @classmethod def instance(cls): """Only allow a single PoolManager instance to exist, returning the handle for it. :rtype: PoolManager """ if not hasattr(cls, '_instance'): with cls._lock: cls._instance = cls() return cls._instance @classmethod def add(cls, pid, connection): """Add a new connection and session to a pool. :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].add(connection) @classmethod def clean(cls, pid): """Clean the specified pool, removing any closed connections or stale locks. :param str pid: The pool id to clean """ with cls._lock: try: cls._ensure_pool_exists(pid) except KeyError: LOGGER.debug('Pool clean invoked against missing pool %s', pid) return cls._pools[pid].clean() cls._maybe_remove_pool(pid) @classmethod def create(cls, pid, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): """Create a new pool, with the ability to pass in values to override the default idle TTL and the default maximum size. A pool's idle TTL defines the amount of time that a pool can be open without any sessions before it is removed. A pool's max size defines the maximum number of connections that can be added to the pool to prevent unbounded open connections. :param str pid: The pool ID :param int idle_ttl: Time in seconds for the idle TTL :param int max_size: The maximum pool size :param callable time_method: Override the use of :py:meth:`time.time` method for time values. :raises: KeyError """ if pid in cls._pools: raise KeyError('Pool %s already exists' % pid) with cls._lock: LOGGER.debug("Creating Pool: %s (%i/%i)", pid, idle_ttl, max_size) cls._pools[pid] = Pool(pid, idle_ttl, max_size, time_method) @classmethod def free(cls, pid, connection): """Free a connection that was locked by a session :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection """ with cls._lock: LOGGER.debug('Freeing %s from pool %s', id(connection), pid) cls._ensure_pool_exists(pid) cls._pools[pid].free(connection) @classmethod def get(cls, pid, session): """Get an idle, unused connection from the pool. Once a connection has been retrieved, it will be marked as in-use until it is freed. :param str pid: The pool ID :param queries.Session session: The session to assign to the connection :rtype: psycopg2.extensions.connection """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].get(session) @classmethod def get_connection(cls, pid, connection): """Return the specified :class:`~queries.pool.Connection` from the pool. :param str pid: The pool ID :param connection: The connection to return for :type connection: psycopg2.extensions.connection :rtype: queries.pool.Connection """ with cls._lock: return cls._pools[pid].connection_handle(connection) @classmethod def has_connection(cls, pid, connection): """Check to see if a pool has the specified connection :param str pid: The pool ID :param connection: The connection to check for :type connection: psycopg2.extensions.connection :rtype: bool """ with cls._lock: class ConnectionBusyError(Exception): """Raised when trying to lock a connection that is already busy""" def __init__(self, connection): self.cid = connection.id def __str__(self): return 'Connection %s is busy' % self.cid :rtype: bool class ConnectionNotFoundError(Exception): """Raised if a specific connection is not found in the pool""" def __init__(self, pid, connection): self.pid = pid self.cid = connection def __str__(self): return 'Connection %s not found in pool %s' % (self.cid, self.pid) :param str pid: The pool id :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].is_full @classmethod def lock(cls, pid, connection, session): """Explicitly lock the specified connection in the pool :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool :param queries.Session session: The session to hold the lock """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].lock(connection, session) @classmethod def remove(cls, pid): """Remove a pool, closing all connections :param str pid: The pool ID """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].close() del cls._pools[pid] @classmethod def remove_connection(cls, pid, connection): """Remove a connection from the pool, closing it if is open. :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ cls._ensure_pool_exists(pid) cls._pools[pid].remove(connection) @classmethod def set_idle_ttl(cls, pid, ttl): """Set the idle TTL for a pool, after which it will be destroyed. :param str pid: The pool id :param int ttl: The TTL for an idle pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_idle_ttl(ttl) @classmethod def set_max_size(cls, pid, size): """Set the maximum number of connections for the specified pool :param str pid: The pool to set the size for :param int size: The maximum number of connections """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_max_size(size) @classmethod def shutdown(cls): """Close all connections on in all pools""" for pid in list(cls._pools.keys()): cls._pools[pid].shutdown() LOGGER.info('Shutdown complete, all pooled connections closed') @classmethod def size(cls, pid): """Return the number of connections in the pool :param str pid: The pool id :rtype int """ with cls._lock: cls._ensure_pool_exists(pid) return len(cls._pools[pid]) @classmethod def report(cls): """Return the state of the all of the registered pools. :rtype: dict """ return { 'timestamp': datetime.datetime.utcnow().isoformat(), 'process': os.getpid(), 'pools': dict([(i, p.report()) for i, p in cls._pools.items()]) } @classmethod def _ensure_pool_exists(cls, pid): """Raise an exception if the pool has yet to be created or has been removed. :param str pid: The pool ID to check for :raises: KeyError """ if pid not in cls._pools: raise KeyError('Pool %s has not been created' % pid) @classmethod def _maybe_remove_pool(cls, pid): """If the pool has no open connections, remove it :param str pid: The pool id to clean """ if not len(cls._pools[pid]): del cls._pools[pid] class QueriesException(Exception): """Base Exception for all other Queries exceptions""" pass class ConnectionException(QueriesException): def __init__(self, cid): self.cid = cid class PoolException(QueriesException): def __init__(self, pid): self.pid = pid class PoolConnectionException(PoolException): def __init__(self, pid, cid): self.pid = pid self.cid = cid class ActivePoolError(PoolException): """Raised when removing a pool that has active connections""" def __str__(self): return 'Pool %s has at least one active connection' % self.pid class ConnectionBusyError(ConnectionException): """Raised when trying to lock a connection that is already busy""" def __str__(self): return 'Connection %s is busy' % self.cid class ConnectionNotFoundError(PoolConnectionException): """Raised if a specific connection is not found in the pool""" def __str__(self): return 'Connection %s not found in pool %s' % (self.cid, self.pid) class NoIdleConnectionsError(PoolException): """Raised if a pool does not have any idle, open connections""" def __str__(self): return 'Pool %s has no idle connections' % self.pid class PoolFullError(PoolException): """Raised when adding a connection to a pool that has hit max-size""" def __str__(self): return 'Pool %s is at its maximum capacity' % self.pid <MSG> Fix scoping issues and bugs with free() and idle_connections <DFF> @@ -99,7 +99,6 @@ class Pool(object): """A connection pool for gaining access to and managing connections""" _lock = threading.Lock() - connections = dict() idle_start = None idle_ttl = DEFAULT_IDLE_TTL max_size = DEFAULT_MAX_SIZE @@ -108,6 +107,7 @@ class Pool(object): pool_id, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE): + self.connections = dict() self._id = pool_id self.idle_ttl = idle_ttl self.max_size = max_size @@ -143,7 +143,7 @@ class Pool(object): """ for connection in [self.connections[k] for k in self.connections if - self.connections[k].handle.closed]: + self.connections[k].closed]: self.remove(connection.handle) if self.idle_duration > self.idle_ttl: @@ -153,7 +153,7 @@ class Pool(object): def close(self): """Close the pool by closing and removing all of the connections""" - for cid in [self.connections.keys()]: + for cid in self.connections: self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) @@ -170,10 +170,9 @@ class Pool(object): except KeyError: raise ConnectionNotFoundError(self.id, id(connection)) - if not self.idle_connections: + if self.idle_connections == self.connections.values(): with self._lock: self.idle_start = time.time() - LOGGER.debug('Pool %s freed connection %s', self.id, id(connection)) def get(self, session): @@ -258,17 +257,18 @@ class Pool(object): """Remove the connection from the pool :param connection: The connection to remove - :type connection: psycopg2.extensions.connection + :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError :raises: ConnectionBusyError """ cid = id(connection) - try: - c = self._connection(connection) - except KeyError: + if cid not in self: raise ConnectionNotFoundError(self.id, cid) - c.close() + conn = self._connection(connection) + if conn.busy: + raise ConnectionBusyError(cid) + conn.close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) @@ -562,8 +562,8 @@ class ActivePoolError(Exception): class ConnectionBusyError(Exception): """Raised when trying to lock a connection that is already busy""" - def __init__(self, connection): - self.cid = connection.id + def __init__(self, cid): + self.cid = cid def __str__(self): return 'Connection %s is busy' % self.cid @@ -572,9 +572,9 @@ class ConnectionBusyError(Exception): class ConnectionNotFoundError(Exception): """Raised if a specific connection is not found in the pool""" - def __init__(self, pid, connection): + def __init__(self, pid, cid): self.pid = pid - self.cid = connection + self.cid = cid def __str__(self): return 'Connection %s not found in pool %s' % (self.cid, self.pid)

Fix scoping issues and bugs with free() and idle_connections

.py

py

bsd-3-clause

gmr/queries

1570

<NME> pool.py <BEF> """ Connection Pooling """ import datetime import logging import os import threading import time import weakref import psycopg2 LOGGER = logging.getLogger(__name__) DEFAULT_IDLE_TTL = 60 DEFAULT_MAX_SIZE = int(os.environ.get('QUERIES_MAX_POOL_SIZE', 1)) class Connection(object): """Contains the handle to the connection, the current state of the connection and methods for manipulating the state of the connection. """ _lock = threading.Lock() def __init__(self, handle): self.handle = handle self.used_by = None self.executions = 0 self.exceptions = 0 def close(self): """Close the connection :raises: ConnectionBusyError """ LOGGER.debug('Connection %s closing', self.id) if self.busy and not self.closed: raise ConnectionBusyError(self) with self._lock: if not self.handle.closed: try: self.handle.close() except psycopg2.InterfaceError as error: LOGGER.error('Error closing socket: %s', error) @property def closed(self): """Return if the psycopg2 connection is closed. :rtype: bool """ return self.handle.closed != 0 @property def busy(self): """Return if the connection is currently executing a query or is locked by a session that still exists. :rtype: bool """ if self.handle.isexecuting(): return True elif self.used_by is None: return False return not self.used_by() is None @property def executing(self): """Return if the connection is currently executing a query :rtype: bool """ return self.handle.isexecuting() def free(self): """Remove the lock on the connection if the connection is not active :raises: ConnectionBusyError """ LOGGER.debug('Connection %s freeing', self.id) if self.handle.isexecuting(): raise ConnectionBusyError(self) with self._lock: self.used_by = None LOGGER.debug('Connection %s freed', self.id) @property def id(self): """Return id of the psycopg2 connection object :rtype: int """A connection pool for gaining access to and managing connections""" _lock = threading.Lock() connections = dict() idle_start = None idle_ttl = DEFAULT_IDLE_TTL max_size = DEFAULT_MAX_SIZE a weakref for the session. pool_id, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE): self._id = pool_id self.idle_ttl = idle_ttl self.max_size = max_size self.used_by = weakref.ref(session) LOGGER.debug('Connection %s locked', self.id) @property def locked(self): """Return if the connection is currently exclusively locked :rtype: bool """ return self.used_by is not None class Pool(object): """A connection pool for gaining access to and managing connections""" _lock = threading.Lock() idle_start = None idle_ttl = DEFAULT_IDLE_TTL max_size = DEFAULT_MAX_SIZE def __init__(self, pool_id, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): self.connections = {} self._id = pool_id self.idle_ttl = idle_ttl """ for connection in [self.connections[k] for k in self.connections if self.connections[k].handle.closed]: self.remove(connection.handle) if self.idle_duration > self.idle_ttl: def __len__(self): """Return the number of connections in the pool""" return len(self.connections) def close(self): """Close the pool by closing and removing all of the connections""" for cid in [self.connections.keys()]: self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) """ if id(connection) in self.connections: raise ValueError('Connection already exists in pool') if len(self.connections) == self.max_size: LOGGER.warning('Race condition found when adding new connection') try: connection.close() except (psycopg2.Error, psycopg2.Warning) as error: except KeyError: raise ConnectionNotFoundError(self.id, id(connection)) if not self.idle_connections: with self._lock: self.idle_start = time.time() LOGGER.debug('Pool %s freed connection %s', self.id, id(connection)) def get(self, session): """Return a list of active/busy connections :rtype: list """ return [c for c in self.connections.values() if c.busy and not c.closed] def clean(self): """Clean the pool by removing any closed connections and if the pool's idle has exceeded its idle TTL, remove all connections. """ LOGGER.debug('Cleaning the pool') for connection in [self.connections[k] for k in self.connections if self.connections[k].closed]: LOGGER.debug('Removing %s', connection.id) self.remove(connection.handle) if self.idle_duration > self.idle_ttl: self.close() LOGGER.debug('Pool %s cleaned', self.id) def close(self): """Close the pool by closing and removing all of the connections""" for cid in list(self.connections.keys()): self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) @property def closed_connections(self): """Return a list of closed connections :rtype: list """ return [c for c in self.connections.values() if c.closed] def connection_handle(self, connection): """Return a connection object for the given psycopg2 connection :param connection: The connection to return a parent for :type connection: psycopg2.extensions.connection :rtype: Connection """ return self.connections[id(connection)] @property def executing_connections(self): """Return a list of connections actively executing queries :rtype: list """ return [c for c in self.connections.values() if c.executing] def free(self, connection): """Free the connection from use by the session that was using it. :param connection: The connection to free :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ LOGGER.debug('Pool %s freeing connection %s', self.id, id(connection)) try: self.connection_handle(connection).free() except KeyError: raise ConnectionNotFoundError(self.id, id(connection)) if self.idle_connections == list(self.connections.values()): with self._lock: self.idle_start = self.time_method() LOGGER.debug('Pool %s freed connection %s', self.id, id(connection)) def get(self, session): """Remove the connection from the pool :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError :raises: ConnectionBusyError """ cid = id(connection) try: c = self._connection(connection) except KeyError: raise ConnectionNotFoundError(self.id, cid) c.close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) def id(self): """Return the ID for this pool :rtype: str """ return self._id @property def idle_connections(self): """Return a list of idle connections :rtype: list """ return [c for c in self.connections.values() if not c.busy and not c.closed] @property def idle_duration(self): """Return the number of seconds that the pool has had no active connections. :rtype: float """ if self.idle_start is None: return 0 return self.time_method() - self.idle_start @property def is_full(self): """Return True if there are no more open slots for connections. :rtype: bool """ return len(self.connections) >= self.max_size def lock(self, connection, session): """Explicitly lock the specified connection :type connection: psycopg2.extensions.connection :param connection: The connection to lock :param queries.Session session: The session to hold the lock """ cid = id(connection) try: self.connection_handle(connection).lock(session) except KeyError: raise ConnectionNotFoundError(self.id, cid) else: if self.idle_start: with self._lock: self.idle_start = None LOGGER.debug('Pool %s locked connection %s', self.id, cid) @property def locked_connections(self): """Return a list of all locked connections :rtype: list """ return [c for c in self.connections.values() if c.locked] def remove(self, connection): """Remove the connection from the pool :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError :raises: ConnectionBusyError """ cid = id(connection) if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) self.connection_handle(connection).close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) def report(self): """Return a report about the pool state and configuration. :rtype: dict """ return { 'connections': { 'busy': len(self.busy_connections), 'closed': len(self.closed_connections), 'executing': len(self.executing_connections), 'idle': len(self.idle_connections), 'locked': len(self.busy_connections) }, 'exceptions': sum([c.exceptions for c in self.connections.values()]), 'executions': sum([c.executions for c in self.connections.values()]), 'full': self.is_full, 'idle': { 'duration': self.idle_duration, 'ttl': self.idle_ttl }, 'max_size': self.max_size } def shutdown(self): """Forcefully shutdown the entire pool, closing all non-executing connections. :raises: ConnectionBusyError """ with self._lock: for cid in list(self.connections.keys()): if self.connections[cid].executing: raise ConnectionBusyError(cid) if self.connections[cid].locked: self.connections[cid].free() self.connections[cid].close() del self.connections[cid] def set_idle_ttl(self, ttl): """Set the idle ttl :param int ttl: The TTL when idle """ with self._lock: self.idle_ttl = ttl def set_max_size(self, size): """Set the maximum number of connections :param int size: The maximum number of connections """ with self._lock: self.max_size = size class PoolManager(object): """The connection pool object implements behavior around connections and their use in queries.Session objects. We carry a pool id instead of the connection URI so that we will not be carrying the URI in memory, creating a possible security issue. """ _lock = threading.Lock() _pools = {} def __contains__(self, pid): """Returns True if the pool exists :param str pid: The pool id to check for :rtype: bool """ return pid in self.__class__._pools @classmethod def instance(cls): """Only allow a single PoolManager instance to exist, returning the handle for it. :rtype: PoolManager """ if not hasattr(cls, '_instance'): with cls._lock: cls._instance = cls() return cls._instance @classmethod def add(cls, pid, connection): """Add a new connection and session to a pool. :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].add(connection) @classmethod def clean(cls, pid): """Clean the specified pool, removing any closed connections or stale locks. :param str pid: The pool id to clean """ with cls._lock: try: cls._ensure_pool_exists(pid) except KeyError: LOGGER.debug('Pool clean invoked against missing pool %s', pid) return cls._pools[pid].clean() cls._maybe_remove_pool(pid) @classmethod def create(cls, pid, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): """Create a new pool, with the ability to pass in values to override the default idle TTL and the default maximum size. A pool's idle TTL defines the amount of time that a pool can be open without any sessions before it is removed. A pool's max size defines the maximum number of connections that can be added to the pool to prevent unbounded open connections. :param str pid: The pool ID :param int idle_ttl: Time in seconds for the idle TTL :param int max_size: The maximum pool size :param callable time_method: Override the use of :py:meth:`time.time` method for time values. :raises: KeyError """ if pid in cls._pools: raise KeyError('Pool %s already exists' % pid) with cls._lock: LOGGER.debug("Creating Pool: %s (%i/%i)", pid, idle_ttl, max_size) cls._pools[pid] = Pool(pid, idle_ttl, max_size, time_method) @classmethod def free(cls, pid, connection): """Free a connection that was locked by a session :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection """ with cls._lock: LOGGER.debug('Freeing %s from pool %s', id(connection), pid) cls._ensure_pool_exists(pid) cls._pools[pid].free(connection) @classmethod def get(cls, pid, session): """Get an idle, unused connection from the pool. Once a connection has been retrieved, it will be marked as in-use until it is freed. :param str pid: The pool ID :param queries.Session session: The session to assign to the connection :rtype: psycopg2.extensions.connection """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].get(session) @classmethod def get_connection(cls, pid, connection): """Return the specified :class:`~queries.pool.Connection` from the pool. :param str pid: The pool ID :param connection: The connection to return for :type connection: psycopg2.extensions.connection :rtype: queries.pool.Connection """ with cls._lock: return cls._pools[pid].connection_handle(connection) @classmethod def has_connection(cls, pid, connection): """Check to see if a pool has the specified connection :param str pid: The pool ID :param connection: The connection to check for :type connection: psycopg2.extensions.connection :rtype: bool """ with cls._lock: class ConnectionBusyError(Exception): """Raised when trying to lock a connection that is already busy""" def __init__(self, connection): self.cid = connection.id def __str__(self): return 'Connection %s is busy' % self.cid :rtype: bool class ConnectionNotFoundError(Exception): """Raised if a specific connection is not found in the pool""" def __init__(self, pid, connection): self.pid = pid self.cid = connection def __str__(self): return 'Connection %s not found in pool %s' % (self.cid, self.pid) :param str pid: The pool id :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].is_full @classmethod def lock(cls, pid, connection, session): """Explicitly lock the specified connection in the pool :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool :param queries.Session session: The session to hold the lock """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].lock(connection, session) @classmethod def remove(cls, pid): """Remove a pool, closing all connections :param str pid: The pool ID """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].close() del cls._pools[pid] @classmethod def remove_connection(cls, pid, connection): """Remove a connection from the pool, closing it if is open. :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ cls._ensure_pool_exists(pid) cls._pools[pid].remove(connection) @classmethod def set_idle_ttl(cls, pid, ttl): """Set the idle TTL for a pool, after which it will be destroyed. :param str pid: The pool id :param int ttl: The TTL for an idle pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_idle_ttl(ttl) @classmethod def set_max_size(cls, pid, size): """Set the maximum number of connections for the specified pool :param str pid: The pool to set the size for :param int size: The maximum number of connections """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_max_size(size) @classmethod def shutdown(cls): """Close all connections on in all pools""" for pid in list(cls._pools.keys()): cls._pools[pid].shutdown() LOGGER.info('Shutdown complete, all pooled connections closed') @classmethod def size(cls, pid): """Return the number of connections in the pool :param str pid: The pool id :rtype int """ with cls._lock: cls._ensure_pool_exists(pid) return len(cls._pools[pid]) @classmethod def report(cls): """Return the state of the all of the registered pools. :rtype: dict """ return { 'timestamp': datetime.datetime.utcnow().isoformat(), 'process': os.getpid(), 'pools': dict([(i, p.report()) for i, p in cls._pools.items()]) } @classmethod def _ensure_pool_exists(cls, pid): """Raise an exception if the pool has yet to be created or has been removed. :param str pid: The pool ID to check for :raises: KeyError """ if pid not in cls._pools: raise KeyError('Pool %s has not been created' % pid) @classmethod def _maybe_remove_pool(cls, pid): """If the pool has no open connections, remove it :param str pid: The pool id to clean """ if not len(cls._pools[pid]): del cls._pools[pid] class QueriesException(Exception): """Base Exception for all other Queries exceptions""" pass class ConnectionException(QueriesException): def __init__(self, cid): self.cid = cid class PoolException(QueriesException): def __init__(self, pid): self.pid = pid class PoolConnectionException(PoolException): def __init__(self, pid, cid): self.pid = pid self.cid = cid class ActivePoolError(PoolException): """Raised when removing a pool that has active connections""" def __str__(self): return 'Pool %s has at least one active connection' % self.pid class ConnectionBusyError(ConnectionException): """Raised when trying to lock a connection that is already busy""" def __str__(self): return 'Connection %s is busy' % self.cid class ConnectionNotFoundError(PoolConnectionException): """Raised if a specific connection is not found in the pool""" def __str__(self): return 'Connection %s not found in pool %s' % (self.cid, self.pid) class NoIdleConnectionsError(PoolException): """Raised if a pool does not have any idle, open connections""" def __str__(self): return 'Pool %s has no idle connections' % self.pid class PoolFullError(PoolException): """Raised when adding a connection to a pool that has hit max-size""" def __str__(self): return 'Pool %s is at its maximum capacity' % self.pid <MSG> Fix scoping issues and bugs with free() and idle_connections <DFF> @@ -99,7 +99,6 @@ class Pool(object): """A connection pool for gaining access to and managing connections""" _lock = threading.Lock() - connections = dict() idle_start = None idle_ttl = DEFAULT_IDLE_TTL max_size = DEFAULT_MAX_SIZE @@ -108,6 +107,7 @@ class Pool(object): pool_id, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE): + self.connections = dict() self._id = pool_id self.idle_ttl = idle_ttl self.max_size = max_size @@ -143,7 +143,7 @@ class Pool(object): """ for connection in [self.connections[k] for k in self.connections if - self.connections[k].handle.closed]: + self.connections[k].closed]: self.remove(connection.handle) if self.idle_duration > self.idle_ttl: @@ -153,7 +153,7 @@ class Pool(object): def close(self): """Close the pool by closing and removing all of the connections""" - for cid in [self.connections.keys()]: + for cid in self.connections: self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) @@ -170,10 +170,9 @@ class Pool(object): except KeyError: raise ConnectionNotFoundError(self.id, id(connection)) - if not self.idle_connections: + if self.idle_connections == self.connections.values(): with self._lock: self.idle_start = time.time() - LOGGER.debug('Pool %s freed connection %s', self.id, id(connection)) def get(self, session): @@ -258,17 +257,18 @@ class Pool(object): """Remove the connection from the pool :param connection: The connection to remove - :type connection: psycopg2.extensions.connection + :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError :raises: ConnectionBusyError """ cid = id(connection) - try: - c = self._connection(connection) - except KeyError: + if cid not in self: raise ConnectionNotFoundError(self.id, cid) - c.close() + conn = self._connection(connection) + if conn.busy: + raise ConnectionBusyError(cid) + conn.close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) @@ -562,8 +562,8 @@ class ActivePoolError(Exception): class ConnectionBusyError(Exception): """Raised when trying to lock a connection that is already busy""" - def __init__(self, connection): - self.cid = connection.id + def __init__(self, cid): + self.cid = cid def __str__(self): return 'Connection %s is busy' % self.cid @@ -572,9 +572,9 @@ class ConnectionBusyError(Exception): class ConnectionNotFoundError(Exception): """Raised if a specific connection is not found in the pool""" - def __init__(self, pid, connection): + def __init__(self, pid, cid): self.pid = pid - self.cid = connection + self.cid = cid def __str__(self): return 'Connection %s not found in pool %s' % (self.cid, self.pid)

Fix scoping issues and bugs with free() and idle_connections

.py

py

bsd-3-clause

gmr/queries

1571

<NME> utils.py <BEF> """ Utility functions for access to OS level info and URI parsing """ import collections import getpass import logging import os import platform # All systems do not support pwd module try: import pwd except ImportError: pwd = None # Python 2 & 3 compatibility try: from urllib import parse as _urlparse except ImportError: import urlparse as _urlparse try: from urllib.parse import unquote except ImportError: from urllib import unquote LOGGER = logging.getLogger(__name__) PARSED = collections.namedtuple('Parsed', 'scheme,netloc,path,params,query,fragment,' 'username,password,hostname,port') PYPY = platform.python_implementation().lower() == 'pypy' KEYWORDS = ['connect_timeout', 'client_encoding', 'options', 'application_name', 'fallback_application_name', 'keepalives', 'keepalives_idle', 'keepalives_interval', 'keepalives_count', 'sslmode', 'requiressl', 'sslcompression', 'sslcert', 'sslkey', 'sslrootcert', 'sslcrl', 'requirepeer', 'krbsrvname', 'gsslib', 'service'] def get_current_user(): """Return the current username for the logged in user :rtype: str """ if pwd is None: return getpass.getuser() else: try: return pwd.getpwuid(os.getuid())[0] except KeyError as error: LOGGER.error('Could not get logged-in user: %s', error) def parse_qs(query_string): """Return the parsed query string in a python2/3 agnostic fashion :param str query_string: The URI query string :rtype: dict """ return _urlparse.parse_qs(query_string) def uri(host='localhost', port=5432, dbname='postgres', user='postgres', password=None): """Return a PostgreSQL connection URI for the specified values. :param str host: Host to connect to :param int port: Port to connect on :param str dbname: The database name :param str user: User to connect as :param str password: The password to use, None for no password :rtype: Parsed """ value = 'http%s' % url[5:] if url[:5] == 'pgsql' else url parsed = _urlparse.urlparse(value) return PARSED(parsed.scheme.replace('http', 'pgsql'), parsed.netloc, parsed.path, parsed.params, parsed.query, parsed.fragment, parsed.username, parsed.password, parsed.hostname, parsed.port) def uri_to_kwargs(uri): """Return a URI as kwargs for connecting to PostgreSQL with psycopg2, applying default values for non-specified areas of the URI. :param str uri: The connection URI :rtype: dict """ parsed = urlparse(uri) default_user = get_current_user() password = unquote(parsed.password) if parsed.password else None kwargs = {'host': parsed.hostname, 'port': parsed.port, 'dbname': parsed.path[1:] or default_user, 'user': parsed.username or default_user, 'password': password} values = parse_qs(parsed.query) if 'host' in values: kwargs['host'] = values['host'][0] for k in [k for k in values if k in KEYWORDS]: kwargs[k] = values[k][0] if len(values[k]) == 1 else values[k] try: if kwargs[k].isdigit(): kwargs[k] = int(kwargs[k]) except AttributeError: pass return kwargs def urlparse(url): """Parse the URL in a Python2/3 independent fashion. :param str url: The URL to parse :rtype: Parsed """ value = 'http%s' % url[5:] if url[:5] == 'postgresql' else url parsed = _urlparse.urlparse(value) path, query = parsed.path, parsed.query hostname = parsed.hostname if parsed.hostname else '' return PARSED(parsed.scheme.replace('http', 'postgresql'), parsed.netloc, path, parsed.params, query, parsed.fragment, parsed.username, parsed.password, hostname.replace('%2F', '/').replace('%2f', '/'), parsed.port) <MSG> Update urlparse to deal with python 2.6 <DFF> @@ -91,9 +91,9 @@ def urlparse(url): :rtype: Parsed """ - value = 'http%s' % url[5:] if url[:5] == 'pgsql' else url + value = 'http%s' % url[5:] if url[:5] == 'postgresql' else url parsed = _urlparse.urlparse(value) - return PARSED(parsed.scheme.replace('http', 'pgsql'), parsed.netloc, + return PARSED(parsed.scheme.replace('http', 'postgresql'), parsed.netloc, parsed.path, parsed.params, parsed.query, parsed.fragment, parsed.username, parsed.password, parsed.hostname, parsed.port)

Update urlparse to deal with python 2.6

.py

py

bsd-3-clause

gmr/queries

1572

<NME> utils.py <BEF> """ Utility functions for access to OS level info and URI parsing """ import collections import getpass import logging import os import platform # All systems do not support pwd module try: import pwd except ImportError: pwd = None # Python 2 & 3 compatibility try: from urllib import parse as _urlparse except ImportError: import urlparse as _urlparse try: from urllib.parse import unquote except ImportError: from urllib import unquote LOGGER = logging.getLogger(__name__) PARSED = collections.namedtuple('Parsed', 'scheme,netloc,path,params,query,fragment,' 'username,password,hostname,port') PYPY = platform.python_implementation().lower() == 'pypy' KEYWORDS = ['connect_timeout', 'client_encoding', 'options', 'application_name', 'fallback_application_name', 'keepalives', 'keepalives_idle', 'keepalives_interval', 'keepalives_count', 'sslmode', 'requiressl', 'sslcompression', 'sslcert', 'sslkey', 'sslrootcert', 'sslcrl', 'requirepeer', 'krbsrvname', 'gsslib', 'service'] def get_current_user(): """Return the current username for the logged in user :rtype: str """ if pwd is None: return getpass.getuser() else: try: return pwd.getpwuid(os.getuid())[0] except KeyError as error: LOGGER.error('Could not get logged-in user: %s', error) def parse_qs(query_string): """Return the parsed query string in a python2/3 agnostic fashion :param str query_string: The URI query string :rtype: dict """ return _urlparse.parse_qs(query_string) def uri(host='localhost', port=5432, dbname='postgres', user='postgres', password=None): """Return a PostgreSQL connection URI for the specified values. :param str host: Host to connect to :param int port: Port to connect on :param str dbname: The database name :param str user: User to connect as :param str password: The password to use, None for no password :rtype: Parsed """ value = 'http%s' % url[5:] if url[:5] == 'pgsql' else url parsed = _urlparse.urlparse(value) return PARSED(parsed.scheme.replace('http', 'pgsql'), parsed.netloc, parsed.path, parsed.params, parsed.query, parsed.fragment, parsed.username, parsed.password, parsed.hostname, parsed.port) def uri_to_kwargs(uri): """Return a URI as kwargs for connecting to PostgreSQL with psycopg2, applying default values for non-specified areas of the URI. :param str uri: The connection URI :rtype: dict """ parsed = urlparse(uri) default_user = get_current_user() password = unquote(parsed.password) if parsed.password else None kwargs = {'host': parsed.hostname, 'port': parsed.port, 'dbname': parsed.path[1:] or default_user, 'user': parsed.username or default_user, 'password': password} values = parse_qs(parsed.query) if 'host' in values: kwargs['host'] = values['host'][0] for k in [k for k in values if k in KEYWORDS]: kwargs[k] = values[k][0] if len(values[k]) == 1 else values[k] try: if kwargs[k].isdigit(): kwargs[k] = int(kwargs[k]) except AttributeError: pass return kwargs def urlparse(url): """Parse the URL in a Python2/3 independent fashion. :param str url: The URL to parse :rtype: Parsed """ value = 'http%s' % url[5:] if url[:5] == 'postgresql' else url parsed = _urlparse.urlparse(value) path, query = parsed.path, parsed.query hostname = parsed.hostname if parsed.hostname else '' return PARSED(parsed.scheme.replace('http', 'postgresql'), parsed.netloc, path, parsed.params, query, parsed.fragment, parsed.username, parsed.password, hostname.replace('%2F', '/').replace('%2f', '/'), parsed.port) <MSG> Update urlparse to deal with python 2.6 <DFF> @@ -91,9 +91,9 @@ def urlparse(url): :rtype: Parsed """ - value = 'http%s' % url[5:] if url[:5] == 'pgsql' else url + value = 'http%s' % url[5:] if url[:5] == 'postgresql' else url parsed = _urlparse.urlparse(value) - return PARSED(parsed.scheme.replace('http', 'pgsql'), parsed.netloc, + return PARSED(parsed.scheme.replace('http', 'postgresql'), parsed.netloc, parsed.path, parsed.params, parsed.query, parsed.fragment, parsed.username, parsed.password, parsed.hostname, parsed.port)

Update urlparse to deal with python 2.6

.py

py

bsd-3-clause

gmr/queries

1573

<NME> history.rst <BEF> Version History =============== - Next Release - Implement ``Results.__bool__`` to be explicit about Python 3 support. - 1.10.3 2017-11-01 - Remove the functionality from ``TornadoSession.validate`` and make it raise a ``DeprecationWarning`` - Catch the ``KeyError`` raised when ``PoolManager.clean()`` is invoked for a pool that doesn't exist ----------------- - REMOVED support for Python 2.6 - FIXED CPU Pegging bug: Cleanup IOLoop and internal stack in ``TornadoSession`` on connection error. In the case of a connection error, the failure to do this caused CPU to peg @ 100% utilization looping on a non-existent file descriptor. Thanks to `cknave <https://github.com/cknave>`_ for his work on identifying the issue, proposing a fix, and writing a working test case. - Move the integration tests to use a local docker development environment - Added new methods ``queries.pool.Pool.report`` and ``queries.pool.PoolManager.Report`` for reporting pool status. - Added new methods to ``queries.pool.Pool`` for returning a list of busy, closed, executing, and locked connections. 1.10.4 2018-01-10 ----------------- - Implement ``Results.__bool__`` to be explicit about Python 3 support. - Catch any exception raised when using TornadoSession and invoking the execute function in psycopg2 for exceptions raised prior to sending the query to Postgres. This could be psycopg2.Error, IndexError, KeyError, or who knows, it's not documented in psycopg2. 1.10.3 2017-11-01 ----------------- - Remove the functionality from ``TornadoSession.validate`` and make it raise a ``DeprecationWarning`` - Catch the ``KeyError`` raised when ``PoolManager.clean()`` is invoked for a pool that doesn't exist 1.10.2 2017-10-26 ----------------- - Ensure the pool exists when executing a query in TornadoSession, the new timeout behavior prevented that from happening. 1.10.1 2017-10-24 ----------------- - Use an absolute time in the call to ``add_timeout`` 1.10.0 2017-09-27 ----------------- - Free when tornado_session.Result is ``__del__``'d without ``free`` being called. - Auto-clean the pool after Results.free TTL+1 in tornado_session.TornadoSession - Don't raise NotImplementedError in Results.free for synchronous use, just treat as a noop 1.9.1 2016-10-25 ---------------- - Add better exception handling around connections and getting the logged in user 1.9.0 2016-07-01 ---------------- - Handle a potential race condition in TornadoSession when too many simultaneous new connections are made and a pool fills up - Increase logging in various places to be more informative - Restructure queries specific exceptions to all extend off of a base QueriesException - Trivial code cleanup 1.8.10 2016-06-14 ----------------- - Propagate PoolManager exceptions from TornadoSession (#20) - Fix by Dave Shawley 1.8.9 2015-11-11 ---------------- - Move to psycopg2cffi for PyPy support 1.7.5 2015-09-03 ---------------- - Don't let Session and TornadoSession share connections 1.7.1 2015-03-25 ---------------- - Fix TornadoSession's use of cleanup (#8) - Fix by Oren Itamar 1.7.0 2015-01-13 ---------------- - Implement :py:meth:`Pool.shutdown <queries.pool.Pool.shutdown>` and :py:meth:`PoolManager.shutdown <queries.pool.PoolManager.shutdown>` to cleanly shutdown all open, non-executing connections across a Pool or all pools. Update locks in Pool operations to ensure atomicity. 1.6.1 2015-01-09 ---------------- - Fixes an iteration error when closing a pool (#7) - Fix by Chris McGuire 1.6.0 2014-11-20 ----------------- - Handle URI encoded password values properly 1.5.0 2014-10-07 ---------------- - Handle empty query results in the iterator (#4) - Fix by Den Teresh 1.4.0 2014-09-04 ---------------- - Address exception handling in tornado_session <MSG> Merge the history file updates <DFF> @@ -1,7 +1,9 @@ Version History =============== -- Next Release +- 1.10.4 2018-01-10 - Implement ``Results.__bool__`` to be explicit about Python 3 support. + - Catch any exception raised when using TornadoSession and invoking the execute function in psycopg2 for exceptions raised prior to sending the query to Postgres. + This could be psycopg2.Error, IndexError, KeyError, or who knows, it's not documented in psycopg2. - 1.10.3 2017-11-01 - Remove the functionality from ``TornadoSession.validate`` and make it raise a ``DeprecationWarning`` - Catch the ``KeyError`` raised when ``PoolManager.clean()`` is invoked for a pool that doesn't exist

Merge the history file updates

.rst

rst

bsd-3-clause

gmr/queries

1574

<NME> history.rst <BEF> Version History =============== - Next Release - Implement ``Results.__bool__`` to be explicit about Python 3 support. - 1.10.3 2017-11-01 - Remove the functionality from ``TornadoSession.validate`` and make it raise a ``DeprecationWarning`` - Catch the ``KeyError`` raised when ``PoolManager.clean()`` is invoked for a pool that doesn't exist ----------------- - REMOVED support for Python 2.6 - FIXED CPU Pegging bug: Cleanup IOLoop and internal stack in ``TornadoSession`` on connection error. In the case of a connection error, the failure to do this caused CPU to peg @ 100% utilization looping on a non-existent file descriptor. Thanks to `cknave <https://github.com/cknave>`_ for his work on identifying the issue, proposing a fix, and writing a working test case. - Move the integration tests to use a local docker development environment - Added new methods ``queries.pool.Pool.report`` and ``queries.pool.PoolManager.Report`` for reporting pool status. - Added new methods to ``queries.pool.Pool`` for returning a list of busy, closed, executing, and locked connections. 1.10.4 2018-01-10 ----------------- - Implement ``Results.__bool__`` to be explicit about Python 3 support. - Catch any exception raised when using TornadoSession and invoking the execute function in psycopg2 for exceptions raised prior to sending the query to Postgres. This could be psycopg2.Error, IndexError, KeyError, or who knows, it's not documented in psycopg2. 1.10.3 2017-11-01 ----------------- - Remove the functionality from ``TornadoSession.validate`` and make it raise a ``DeprecationWarning`` - Catch the ``KeyError`` raised when ``PoolManager.clean()`` is invoked for a pool that doesn't exist 1.10.2 2017-10-26 ----------------- - Ensure the pool exists when executing a query in TornadoSession, the new timeout behavior prevented that from happening. 1.10.1 2017-10-24 ----------------- - Use an absolute time in the call to ``add_timeout`` 1.10.0 2017-09-27 ----------------- - Free when tornado_session.Result is ``__del__``'d without ``free`` being called. - Auto-clean the pool after Results.free TTL+1 in tornado_session.TornadoSession - Don't raise NotImplementedError in Results.free for synchronous use, just treat as a noop 1.9.1 2016-10-25 ---------------- - Add better exception handling around connections and getting the logged in user 1.9.0 2016-07-01 ---------------- - Handle a potential race condition in TornadoSession when too many simultaneous new connections are made and a pool fills up - Increase logging in various places to be more informative - Restructure queries specific exceptions to all extend off of a base QueriesException - Trivial code cleanup 1.8.10 2016-06-14 ----------------- - Propagate PoolManager exceptions from TornadoSession (#20) - Fix by Dave Shawley 1.8.9 2015-11-11 ---------------- - Move to psycopg2cffi for PyPy support 1.7.5 2015-09-03 ---------------- - Don't let Session and TornadoSession share connections 1.7.1 2015-03-25 ---------------- - Fix TornadoSession's use of cleanup (#8) - Fix by Oren Itamar 1.7.0 2015-01-13 ---------------- - Implement :py:meth:`Pool.shutdown <queries.pool.Pool.shutdown>` and :py:meth:`PoolManager.shutdown <queries.pool.PoolManager.shutdown>` to cleanly shutdown all open, non-executing connections across a Pool or all pools. Update locks in Pool operations to ensure atomicity. 1.6.1 2015-01-09 ---------------- - Fixes an iteration error when closing a pool (#7) - Fix by Chris McGuire 1.6.0 2014-11-20 ----------------- - Handle URI encoded password values properly 1.5.0 2014-10-07 ---------------- - Handle empty query results in the iterator (#4) - Fix by Den Teresh 1.4.0 2014-09-04 ---------------- - Address exception handling in tornado_session <MSG> Merge the history file updates <DFF> @@ -1,7 +1,9 @@ Version History =============== -- Next Release +- 1.10.4 2018-01-10 - Implement ``Results.__bool__`` to be explicit about Python 3 support. + - Catch any exception raised when using TornadoSession and invoking the execute function in psycopg2 for exceptions raised prior to sending the query to Postgres. + This could be psycopg2.Error, IndexError, KeyError, or who knows, it's not documented in psycopg2. - 1.10.3 2017-11-01 - Remove the functionality from ``TornadoSession.validate`` and make it raise a ``DeprecationWarning`` - Catch the ``KeyError`` raised when ``PoolManager.clean()`` is invoked for a pool that doesn't exist

Merge the history file updates

.rst

rst

bsd-3-clause

gmr/queries

1575

<NME> pool.py <BEF> """ Connection Pooling """ import datetime import logging import os import threading import time import weakref import psycopg2 LOGGER = logging.getLogger(__name__) DEFAULT_IDLE_TTL = 60 DEFAULT_MAX_SIZE = int(os.environ.get('QUERIES_MAX_POOL_SIZE', 1)) class Connection(object): """Contains the handle to the connection, the current state of the connection and methods for manipulating the state of the connection. """ _lock = threading.Lock() def __init__(self, handle): self.handle = handle self.used_by = None self.executions = 0 self.exceptions = 0 def close(self): """Close the connection :raises: ConnectionBusyError """ LOGGER.debug('Connection %s closing', self.id) if self.busy and not self.closed: raise ConnectionBusyError(self) with self._lock: if not self.handle.closed: try: self.handle.close() except psycopg2.InterfaceError as error: LOGGER.error('Error closing socket: %s', error) @property def closed(self): """Return if the psycopg2 connection is closed. :rtype: bool """ return self.handle.closed != 0 @property def busy(self): """Return if the connection is currently executing a query or is locked by a session that still exists. :rtype: bool """ if self.handle.isexecuting(): return True elif self.used_by is None: return False return not self.used_by() is None @property def executing(self): """Return if the connection is currently executing a query :rtype: bool """ return self.handle.isexecuting() def free(self): """Remove the lock on the connection if the connection is not active :raises: ConnectionBusyError """ LOGGER.debug('Connection %s freeing', self.id) if self.handle.isexecuting(): raise ConnectionBusyError(self) with self._lock: self.used_by = None LOGGER.debug('Connection %s freed', self.id) @property def id(self): """Return id of the psycopg2 connection object :rtype: int """ return id(self.handle) def lock(self, session): """Lock the connection, ensuring that it is not busy and storing a weakref for the session. :param queries.Session session: The session to lock the connection with :raises: ConnectionBusyError """ if self.busy: raise ConnectionBusyError(self) with self._lock: self.used_by = weakref.ref(session) LOGGER.debug('Connection %s locked', self.id) @property def locked(self): """Return if the connection is currently exclusively locked :rtype: bool """ return self.used_by is not None class Pool(object): """A connection pool for gaining access to and managing connections""" _lock = threading.Lock() idle_start = None idle_ttl = DEFAULT_IDLE_TTL max_size = DEFAULT_MAX_SIZE def __init__(self, pool_id, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): self.connections = {} self._id = pool_id self.idle_ttl = idle_ttl self.max_size = max_size self.time_method = time_method or time.time def __contains__(self, connection): """Return True if the pool contains the connection""" return id(connection) in self.connections def __len__(self): """Return the number of connections in the pool""" return len(self.connections) def add(self, connection): """Add a new connection to the pool :param connection: The connection to add to the pool :type connection: psycopg2.extensions.connection :raises: PoolFullError """ if id(connection) in self.connections: raise ValueError('Connection already exists in pool') if len(self.connections) == self.max_size: LOGGER.warning('Race condition found when adding new connection') try: connection.close() except (psycopg2.Error, psycopg2.Warning) as error: LOGGER.error('Error closing the conn that cant be used: %s', error) raise PoolFullError(self) with self._lock: self.connections[id(connection)] = Connection(connection) LOGGER.debug('Pool %s added connection %s', self.id, id(connection)) @property def busy_connections(self): """Return a list of active/busy connections :rtype: list """ return [c for c in self.connections.values() if c.busy and not c.closed] def clean(self): """Clean the pool by removing any closed connections and if the pool's idle has exceeded its idle TTL, remove all connections. """ LOGGER.debug('Cleaning the pool') for connection in [self.connections[k] for k in self.connections if self.connections[k].closed]: LOGGER.debug('Removing %s', connection.id) self.remove(connection.handle) if self.idle_duration > self.idle_ttl: self.close() LOGGER.debug('Pool %s cleaned', self.id) def close(self): """Close the pool by closing and removing all of the connections""" for cid in list(self.connections.keys()): self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) @property def closed_connections(self): """Return a list of closed connections :rtype: list """ return [c for c in self.connections.values() if c.closed] def connection_handle(self, connection): """Return a connection object for the given psycopg2 connection :param connection: The connection to return a parent for :type connection: psycopg2.extensions.connection :rtype: Connection """ return self.connections[id(connection)] @property def executing_connections(self): """Return a list of connections actively executing queries :rtype: list """ return [c for c in self.connections.values() if c.executing] def free(self, connection): """Free the connection from use by the session that was using it. :param connection: The connection to free :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ LOGGER.debug('Pool %s freeing connection %s', self.id, id(connection)) try: self.connection_handle(connection).free() except KeyError: raise ConnectionNotFoundError(self.id, id(connection)) if self.idle_connections == list(self.connections.values()): with self._lock: self.idle_start = self.time_method() LOGGER.debug('Pool %s freed connection %s', self.id, id(connection)) def get(self, session): """Return an idle connection and assign the session to the connection :param queries.Session session: The session to assign :rtype: psycopg2.extensions.connection :raises: NoIdleConnectionsError """ cid = id(connection) if cid not in self: raise ConnectionNotFoundError(self.id, cid) conn = self._connection(connection) if conn.busy: self.idle_start = None return connection.handle raise NoIdleConnectionsError(self.id) @property def id(self): """Return the ID for this pool :rtype: str """ return self._id @property def idle_connections(self): """Return a list of idle connections :rtype: list """ return [c for c in self.connections.values() if not c.busy and not c.closed] @property def idle_duration(self): """Return the number of seconds that the pool has had no active connections. :rtype: float """ if self.idle_start is None: return 0 return self.time_method() - self.idle_start @property def is_full(self): """Return True if there are no more open slots for connections. :rtype: bool """ return len(self.connections) >= self.max_size def lock(self, connection, session): """Explicitly lock the specified connection :type connection: psycopg2.extensions.connection :param connection: The connection to lock :param queries.Session session: The session to hold the lock """ cid = id(connection) try: self.connection_handle(connection).lock(session) except KeyError: raise ConnectionNotFoundError(self.id, cid) else: if self.idle_start: with self._lock: self.idle_start = None LOGGER.debug('Pool %s locked connection %s', self.id, cid) @property def locked_connections(self): """Return a list of all locked connections :rtype: list """ return [c for c in self.connections.values() if c.locked] def remove(self, connection): """Remove the connection from the pool :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError :raises: ConnectionBusyError """ cid = id(connection) if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) self.connection_handle(connection).close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) def report(self): """Return a report about the pool state and configuration. :rtype: dict """ return { 'connections': { 'busy': len(self.busy_connections), 'closed': len(self.closed_connections), 'executing': len(self.executing_connections), 'idle': len(self.idle_connections), 'locked': len(self.busy_connections) }, 'exceptions': sum([c.exceptions for c in self.connections.values()]), 'executions': sum([c.executions for c in self.connections.values()]), 'full': self.is_full, 'idle': { 'duration': self.idle_duration, 'ttl': self.idle_ttl }, 'max_size': self.max_size } def shutdown(self): """Forcefully shutdown the entire pool, closing all non-executing connections. :raises: ConnectionBusyError """ with self._lock: for cid in list(self.connections.keys()): if self.connections[cid].executing: raise ConnectionBusyError(cid) if self.connections[cid].locked: self.connections[cid].free() self.connections[cid].close() del self.connections[cid] def set_idle_ttl(self, ttl): """Set the idle ttl :param int ttl: The TTL when idle """ with self._lock: self.idle_ttl = ttl def set_max_size(self, size): """Set the maximum number of connections :param int size: The maximum number of connections """ with self._lock: self.max_size = size class PoolManager(object): """The connection pool object implements behavior around connections and their use in queries.Session objects. We carry a pool id instead of the connection URI so that we will not be carrying the URI in memory, creating a possible security issue. """ _lock = threading.Lock() _pools = {} def __contains__(self, pid): """Returns True if the pool exists :param str pid: The pool id to check for :rtype: bool """ return pid in self.__class__._pools @classmethod def instance(cls): """Only allow a single PoolManager instance to exist, returning the handle for it. :rtype: PoolManager """ if not hasattr(cls, '_instance'): with cls._lock: cls._instance = cls() return cls._instance @classmethod def add(cls, pid, connection): """Add a new connection and session to a pool. :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].add(connection) @classmethod def clean(cls, pid): """Clean the specified pool, removing any closed connections or stale locks. :param str pid: The pool id to clean """ with cls._lock: try: cls._ensure_pool_exists(pid) except KeyError: LOGGER.debug('Pool clean invoked against missing pool %s', pid) return cls._pools[pid].clean() cls._maybe_remove_pool(pid) @classmethod def create(cls, pid, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): """Create a new pool, with the ability to pass in values to override the default idle TTL and the default maximum size. A pool's idle TTL defines the amount of time that a pool can be open without any sessions before it is removed. A pool's max size defines the maximum number of connections that can be added to the pool to prevent unbounded open connections. :param str pid: The pool ID :param int idle_ttl: Time in seconds for the idle TTL :param int max_size: The maximum pool size :param callable time_method: Override the use of :py:meth:`time.time` method for time values. :raises: KeyError """ if pid in cls._pools: raise KeyError('Pool %s already exists' % pid) with cls._lock: LOGGER.debug("Creating Pool: %s (%i/%i)", pid, idle_ttl, max_size) cls._pools[pid] = Pool(pid, idle_ttl, max_size, time_method) @classmethod def free(cls, pid, connection): """Free a connection that was locked by a session :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection """ with cls._lock: LOGGER.debug('Freeing %s from pool %s', id(connection), pid) cls._ensure_pool_exists(pid) cls._pools[pid].free(connection) @classmethod def get(cls, pid, session): """Get an idle, unused connection from the pool. Once a connection has been retrieved, it will be marked as in-use until it is freed. :param str pid: The pool ID :param queries.Session session: The session to assign to the connection :rtype: psycopg2.extensions.connection """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].get(session) @classmethod def get_connection(cls, pid, connection): """Return the specified :class:`~queries.pool.Connection` from the pool. :param str pid: The pool ID :param connection: The connection to return for :type connection: psycopg2.extensions.connection :rtype: queries.pool.Connection """ with cls._lock: return cls._pools[pid].connection_handle(connection) @classmethod def has_connection(cls, pid, connection): """Check to see if a pool has the specified connection :param str pid: The pool ID :param connection: The connection to check for :type connection: psycopg2.extensions.connection :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return connection in cls._pools[pid] @classmethod def has_idle_connection(cls, pid): """Check to see if a pool has an idle connection :param str pid: The pool ID :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return bool(cls._pools[pid].idle_connections) @classmethod def is_full(cls, pid): """Return a bool indicating if the specified pool is full :param str pid: The pool id :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].is_full @classmethod def lock(cls, pid, connection, session): """Explicitly lock the specified connection in the pool :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool :param queries.Session session: The session to hold the lock """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].lock(connection, session) @classmethod def remove(cls, pid): """Remove a pool, closing all connections :param str pid: The pool ID """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].close() del cls._pools[pid] @classmethod def remove_connection(cls, pid, connection): """Remove a connection from the pool, closing it if is open. :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ cls._ensure_pool_exists(pid) cls._pools[pid].remove(connection) @classmethod def set_idle_ttl(cls, pid, ttl): """Set the idle TTL for a pool, after which it will be destroyed. :param str pid: The pool id :param int ttl: The TTL for an idle pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_idle_ttl(ttl) @classmethod def set_max_size(cls, pid, size): """Set the maximum number of connections for the specified pool :param str pid: The pool to set the size for :param int size: The maximum number of connections """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_max_size(size) @classmethod def shutdown(cls): """Close all connections on in all pools""" for pid in list(cls._pools.keys()): cls._pools[pid].shutdown() LOGGER.info('Shutdown complete, all pooled connections closed') @classmethod def size(cls, pid): """Return the number of connections in the pool :param str pid: The pool id :rtype int """ with cls._lock: cls._ensure_pool_exists(pid) return len(cls._pools[pid]) @classmethod def report(cls): """Return the state of the all of the registered pools. :rtype: dict """ return { 'timestamp': datetime.datetime.utcnow().isoformat(), 'process': os.getpid(), 'pools': dict([(i, p.report()) for i, p in cls._pools.items()]) } @classmethod def _ensure_pool_exists(cls, pid): """Raise an exception if the pool has yet to be created or has been removed. :param str pid: The pool ID to check for :raises: KeyError """ if pid not in cls._pools: raise KeyError('Pool %s has not been created' % pid) @classmethod def _maybe_remove_pool(cls, pid): """If the pool has no open connections, remove it :param str pid: The pool id to clean """ if not len(cls._pools[pid]): del cls._pools[pid] class QueriesException(Exception): """Base Exception for all other Queries exceptions""" pass class ConnectionException(QueriesException): def __init__(self, cid): self.cid = cid class PoolException(QueriesException): def __init__(self, pid): self.pid = pid class PoolConnectionException(PoolException): def __init__(self, pid, cid): self.pid = pid self.cid = cid class ActivePoolError(PoolException): """Raised when removing a pool that has active connections""" def __str__(self): return 'Pool %s has at least one active connection' % self.pid class ConnectionBusyError(ConnectionException): """Raised when trying to lock a connection that is already busy""" def __str__(self): return 'Connection %s is busy' % self.cid class ConnectionNotFoundError(PoolConnectionException): """Raised if a specific connection is not found in the pool""" def __str__(self): return 'Connection %s not found in pool %s' % (self.cid, self.pid) class NoIdleConnectionsError(PoolException): """Raised if a pool does not have any idle, open connections""" def __str__(self): return 'Pool %s has no idle connections' % self.pid class PoolFullError(PoolException): """Raised when adding a connection to a pool that has hit max-size""" def __str__(self): return 'Pool %s is at its maximum capacity' % self.pid <MSG> Check the correct iterable <DFF> @@ -263,7 +263,7 @@ class Pool(object): """ cid = id(connection) - if cid not in self: + if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) conn = self._connection(connection) if conn.busy:

Check the correct iterable

.py

py

bsd-3-clause

gmr/queries

1576

<NME> pool.py <BEF> """ Connection Pooling """ import datetime import logging import os import threading import time import weakref import psycopg2 LOGGER = logging.getLogger(__name__) DEFAULT_IDLE_TTL = 60 DEFAULT_MAX_SIZE = int(os.environ.get('QUERIES_MAX_POOL_SIZE', 1)) class Connection(object): """Contains the handle to the connection, the current state of the connection and methods for manipulating the state of the connection. """ _lock = threading.Lock() def __init__(self, handle): self.handle = handle self.used_by = None self.executions = 0 self.exceptions = 0 def close(self): """Close the connection :raises: ConnectionBusyError """ LOGGER.debug('Connection %s closing', self.id) if self.busy and not self.closed: raise ConnectionBusyError(self) with self._lock: if not self.handle.closed: try: self.handle.close() except psycopg2.InterfaceError as error: LOGGER.error('Error closing socket: %s', error) @property def closed(self): """Return if the psycopg2 connection is closed. :rtype: bool """ return self.handle.closed != 0 @property def busy(self): """Return if the connection is currently executing a query or is locked by a session that still exists. :rtype: bool """ if self.handle.isexecuting(): return True elif self.used_by is None: return False return not self.used_by() is None @property def executing(self): """Return if the connection is currently executing a query :rtype: bool """ return self.handle.isexecuting() def free(self): """Remove the lock on the connection if the connection is not active :raises: ConnectionBusyError """ LOGGER.debug('Connection %s freeing', self.id) if self.handle.isexecuting(): raise ConnectionBusyError(self) with self._lock: self.used_by = None LOGGER.debug('Connection %s freed', self.id) @property def id(self): """Return id of the psycopg2 connection object :rtype: int """ return id(self.handle) def lock(self, session): """Lock the connection, ensuring that it is not busy and storing a weakref for the session. :param queries.Session session: The session to lock the connection with :raises: ConnectionBusyError """ if self.busy: raise ConnectionBusyError(self) with self._lock: self.used_by = weakref.ref(session) LOGGER.debug('Connection %s locked', self.id) @property def locked(self): """Return if the connection is currently exclusively locked :rtype: bool """ return self.used_by is not None class Pool(object): """A connection pool for gaining access to and managing connections""" _lock = threading.Lock() idle_start = None idle_ttl = DEFAULT_IDLE_TTL max_size = DEFAULT_MAX_SIZE def __init__(self, pool_id, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): self.connections = {} self._id = pool_id self.idle_ttl = idle_ttl self.max_size = max_size self.time_method = time_method or time.time def __contains__(self, connection): """Return True if the pool contains the connection""" return id(connection) in self.connections def __len__(self): """Return the number of connections in the pool""" return len(self.connections) def add(self, connection): """Add a new connection to the pool :param connection: The connection to add to the pool :type connection: psycopg2.extensions.connection :raises: PoolFullError """ if id(connection) in self.connections: raise ValueError('Connection already exists in pool') if len(self.connections) == self.max_size: LOGGER.warning('Race condition found when adding new connection') try: connection.close() except (psycopg2.Error, psycopg2.Warning) as error: LOGGER.error('Error closing the conn that cant be used: %s', error) raise PoolFullError(self) with self._lock: self.connections[id(connection)] = Connection(connection) LOGGER.debug('Pool %s added connection %s', self.id, id(connection)) @property def busy_connections(self): """Return a list of active/busy connections :rtype: list """ return [c for c in self.connections.values() if c.busy and not c.closed] def clean(self): """Clean the pool by removing any closed connections and if the pool's idle has exceeded its idle TTL, remove all connections. """ LOGGER.debug('Cleaning the pool') for connection in [self.connections[k] for k in self.connections if self.connections[k].closed]: LOGGER.debug('Removing %s', connection.id) self.remove(connection.handle) if self.idle_duration > self.idle_ttl: self.close() LOGGER.debug('Pool %s cleaned', self.id) def close(self): """Close the pool by closing and removing all of the connections""" for cid in list(self.connections.keys()): self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) @property def closed_connections(self): """Return a list of closed connections :rtype: list """ return [c for c in self.connections.values() if c.closed] def connection_handle(self, connection): """Return a connection object for the given psycopg2 connection :param connection: The connection to return a parent for :type connection: psycopg2.extensions.connection :rtype: Connection """ return self.connections[id(connection)] @property def executing_connections(self): """Return a list of connections actively executing queries :rtype: list """ return [c for c in self.connections.values() if c.executing] def free(self, connection): """Free the connection from use by the session that was using it. :param connection: The connection to free :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ LOGGER.debug('Pool %s freeing connection %s', self.id, id(connection)) try: self.connection_handle(connection).free() except KeyError: raise ConnectionNotFoundError(self.id, id(connection)) if self.idle_connections == list(self.connections.values()): with self._lock: self.idle_start = self.time_method() LOGGER.debug('Pool %s freed connection %s', self.id, id(connection)) def get(self, session): """Return an idle connection and assign the session to the connection :param queries.Session session: The session to assign :rtype: psycopg2.extensions.connection :raises: NoIdleConnectionsError """ cid = id(connection) if cid not in self: raise ConnectionNotFoundError(self.id, cid) conn = self._connection(connection) if conn.busy: self.idle_start = None return connection.handle raise NoIdleConnectionsError(self.id) @property def id(self): """Return the ID for this pool :rtype: str """ return self._id @property def idle_connections(self): """Return a list of idle connections :rtype: list """ return [c for c in self.connections.values() if not c.busy and not c.closed] @property def idle_duration(self): """Return the number of seconds that the pool has had no active connections. :rtype: float """ if self.idle_start is None: return 0 return self.time_method() - self.idle_start @property def is_full(self): """Return True if there are no more open slots for connections. :rtype: bool """ return len(self.connections) >= self.max_size def lock(self, connection, session): """Explicitly lock the specified connection :type connection: psycopg2.extensions.connection :param connection: The connection to lock :param queries.Session session: The session to hold the lock """ cid = id(connection) try: self.connection_handle(connection).lock(session) except KeyError: raise ConnectionNotFoundError(self.id, cid) else: if self.idle_start: with self._lock: self.idle_start = None LOGGER.debug('Pool %s locked connection %s', self.id, cid) @property def locked_connections(self): """Return a list of all locked connections :rtype: list """ return [c for c in self.connections.values() if c.locked] def remove(self, connection): """Remove the connection from the pool :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError :raises: ConnectionBusyError """ cid = id(connection) if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) self.connection_handle(connection).close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) def report(self): """Return a report about the pool state and configuration. :rtype: dict """ return { 'connections': { 'busy': len(self.busy_connections), 'closed': len(self.closed_connections), 'executing': len(self.executing_connections), 'idle': len(self.idle_connections), 'locked': len(self.busy_connections) }, 'exceptions': sum([c.exceptions for c in self.connections.values()]), 'executions': sum([c.executions for c in self.connections.values()]), 'full': self.is_full, 'idle': { 'duration': self.idle_duration, 'ttl': self.idle_ttl }, 'max_size': self.max_size } def shutdown(self): """Forcefully shutdown the entire pool, closing all non-executing connections. :raises: ConnectionBusyError """ with self._lock: for cid in list(self.connections.keys()): if self.connections[cid].executing: raise ConnectionBusyError(cid) if self.connections[cid].locked: self.connections[cid].free() self.connections[cid].close() del self.connections[cid] def set_idle_ttl(self, ttl): """Set the idle ttl :param int ttl: The TTL when idle """ with self._lock: self.idle_ttl = ttl def set_max_size(self, size): """Set the maximum number of connections :param int size: The maximum number of connections """ with self._lock: self.max_size = size class PoolManager(object): """The connection pool object implements behavior around connections and their use in queries.Session objects. We carry a pool id instead of the connection URI so that we will not be carrying the URI in memory, creating a possible security issue. """ _lock = threading.Lock() _pools = {} def __contains__(self, pid): """Returns True if the pool exists :param str pid: The pool id to check for :rtype: bool """ return pid in self.__class__._pools @classmethod def instance(cls): """Only allow a single PoolManager instance to exist, returning the handle for it. :rtype: PoolManager """ if not hasattr(cls, '_instance'): with cls._lock: cls._instance = cls() return cls._instance @classmethod def add(cls, pid, connection): """Add a new connection and session to a pool. :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].add(connection) @classmethod def clean(cls, pid): """Clean the specified pool, removing any closed connections or stale locks. :param str pid: The pool id to clean """ with cls._lock: try: cls._ensure_pool_exists(pid) except KeyError: LOGGER.debug('Pool clean invoked against missing pool %s', pid) return cls._pools[pid].clean() cls._maybe_remove_pool(pid) @classmethod def create(cls, pid, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): """Create a new pool, with the ability to pass in values to override the default idle TTL and the default maximum size. A pool's idle TTL defines the amount of time that a pool can be open without any sessions before it is removed. A pool's max size defines the maximum number of connections that can be added to the pool to prevent unbounded open connections. :param str pid: The pool ID :param int idle_ttl: Time in seconds for the idle TTL :param int max_size: The maximum pool size :param callable time_method: Override the use of :py:meth:`time.time` method for time values. :raises: KeyError """ if pid in cls._pools: raise KeyError('Pool %s already exists' % pid) with cls._lock: LOGGER.debug("Creating Pool: %s (%i/%i)", pid, idle_ttl, max_size) cls._pools[pid] = Pool(pid, idle_ttl, max_size, time_method) @classmethod def free(cls, pid, connection): """Free a connection that was locked by a session :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection """ with cls._lock: LOGGER.debug('Freeing %s from pool %s', id(connection), pid) cls._ensure_pool_exists(pid) cls._pools[pid].free(connection) @classmethod def get(cls, pid, session): """Get an idle, unused connection from the pool. Once a connection has been retrieved, it will be marked as in-use until it is freed. :param str pid: The pool ID :param queries.Session session: The session to assign to the connection :rtype: psycopg2.extensions.connection """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].get(session) @classmethod def get_connection(cls, pid, connection): """Return the specified :class:`~queries.pool.Connection` from the pool. :param str pid: The pool ID :param connection: The connection to return for :type connection: psycopg2.extensions.connection :rtype: queries.pool.Connection """ with cls._lock: return cls._pools[pid].connection_handle(connection) @classmethod def has_connection(cls, pid, connection): """Check to see if a pool has the specified connection :param str pid: The pool ID :param connection: The connection to check for :type connection: psycopg2.extensions.connection :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return connection in cls._pools[pid] @classmethod def has_idle_connection(cls, pid): """Check to see if a pool has an idle connection :param str pid: The pool ID :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return bool(cls._pools[pid].idle_connections) @classmethod def is_full(cls, pid): """Return a bool indicating if the specified pool is full :param str pid: The pool id :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].is_full @classmethod def lock(cls, pid, connection, session): """Explicitly lock the specified connection in the pool :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool :param queries.Session session: The session to hold the lock """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].lock(connection, session) @classmethod def remove(cls, pid): """Remove a pool, closing all connections :param str pid: The pool ID """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].close() del cls._pools[pid] @classmethod def remove_connection(cls, pid, connection): """Remove a connection from the pool, closing it if is open. :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ cls._ensure_pool_exists(pid) cls._pools[pid].remove(connection) @classmethod def set_idle_ttl(cls, pid, ttl): """Set the idle TTL for a pool, after which it will be destroyed. :param str pid: The pool id :param int ttl: The TTL for an idle pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_idle_ttl(ttl) @classmethod def set_max_size(cls, pid, size): """Set the maximum number of connections for the specified pool :param str pid: The pool to set the size for :param int size: The maximum number of connections """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_max_size(size) @classmethod def shutdown(cls): """Close all connections on in all pools""" for pid in list(cls._pools.keys()): cls._pools[pid].shutdown() LOGGER.info('Shutdown complete, all pooled connections closed') @classmethod def size(cls, pid): """Return the number of connections in the pool :param str pid: The pool id :rtype int """ with cls._lock: cls._ensure_pool_exists(pid) return len(cls._pools[pid]) @classmethod def report(cls): """Return the state of the all of the registered pools. :rtype: dict """ return { 'timestamp': datetime.datetime.utcnow().isoformat(), 'process': os.getpid(), 'pools': dict([(i, p.report()) for i, p in cls._pools.items()]) } @classmethod def _ensure_pool_exists(cls, pid): """Raise an exception if the pool has yet to be created or has been removed. :param str pid: The pool ID to check for :raises: KeyError """ if pid not in cls._pools: raise KeyError('Pool %s has not been created' % pid) @classmethod def _maybe_remove_pool(cls, pid): """If the pool has no open connections, remove it :param str pid: The pool id to clean """ if not len(cls._pools[pid]): del cls._pools[pid] class QueriesException(Exception): """Base Exception for all other Queries exceptions""" pass class ConnectionException(QueriesException): def __init__(self, cid): self.cid = cid class PoolException(QueriesException): def __init__(self, pid): self.pid = pid class PoolConnectionException(PoolException): def __init__(self, pid, cid): self.pid = pid self.cid = cid class ActivePoolError(PoolException): """Raised when removing a pool that has active connections""" def __str__(self): return 'Pool %s has at least one active connection' % self.pid class ConnectionBusyError(ConnectionException): """Raised when trying to lock a connection that is already busy""" def __str__(self): return 'Connection %s is busy' % self.cid class ConnectionNotFoundError(PoolConnectionException): """Raised if a specific connection is not found in the pool""" def __str__(self): return 'Connection %s not found in pool %s' % (self.cid, self.pid) class NoIdleConnectionsError(PoolException): """Raised if a pool does not have any idle, open connections""" def __str__(self): return 'Pool %s has no idle connections' % self.pid class PoolFullError(PoolException): """Raised when adding a connection to a pool that has hit max-size""" def __str__(self): return 'Pool %s is at its maximum capacity' % self.pid <MSG> Check the correct iterable <DFF> @@ -263,7 +263,7 @@ class Pool(object): """ cid = id(connection) - if cid not in self: + if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) conn = self._connection(connection) if conn.busy:

Check the correct iterable

.py

py

bsd-3-clause

gmr/queries

1577

<NME> simple-tornado.py <BEF> import datetime import logging from queries import pool import queries from tornado import gen, ioloop, web def initialize(self): self.session = queries.TornadoSession() @gen.coroutine def prepare(self): try: yield self.session.validate() except queries.OperationalError as error: logging.error('Error connecting to the database: %s', error) raise web.HTTPError(503) @gen.coroutine def get(self): try: def get(self): try: result = yield self.application.session.query(self.SQL) except queries.OperationalError as error: logging.error('Error connecting to the database: %s', error) raise web.HTTPError(503) application = web.Application([ (r"/", ExampleHandler), ]) if __name__ == "__main__": logging.basicConfig(level=logging.INFO) application.listen(8888) ioloop.IOLoop.instance().start() class ReportHandler(web.RequestHandler): @gen.coroutine def get(self): self.finish(pool.PoolManager.report()) if __name__ == '__main__': logging.basicConfig(level=logging.DEBUG) application = web.Application([ (r'/', ExampleHandler), (r'/report', ReportHandler) ], debug=True) application.session = queries.TornadoSession() application.listen(8000) ioloop.IOLoop.instance().start() <MSG> Move example <DFF> @@ -8,14 +8,6 @@ class ExampleHandler(web.RequestHandler): def initialize(self): self.session = queries.TornadoSession() - @gen.coroutine - def prepare(self): - try: - yield self.session.validate() - except queries.OperationalError as error: - logging.error('Error connecting to the database: %s', error) - raise web.HTTPError(503) - @gen.coroutine def get(self): try: @@ -29,10 +21,10 @@ class ExampleHandler(web.RequestHandler): application = web.Application([ - (r"/", ExampleHandler), + (r'/', ExampleHandler), ]) -if __name__ == "__main__": +if __name__ == '__main__': logging.basicConfig(level=logging.INFO) application.listen(8888) ioloop.IOLoop.instance().start()

Move example

.py

py

bsd-3-clause

gmr/queries

1578

<NME> simple-tornado.py <BEF> import datetime import logging from queries import pool import queries from tornado import gen, ioloop, web def initialize(self): self.session = queries.TornadoSession() @gen.coroutine def prepare(self): try: yield self.session.validate() except queries.OperationalError as error: logging.error('Error connecting to the database: %s', error) raise web.HTTPError(503) @gen.coroutine def get(self): try: def get(self): try: result = yield self.application.session.query(self.SQL) except queries.OperationalError as error: logging.error('Error connecting to the database: %s', error) raise web.HTTPError(503) application = web.Application([ (r"/", ExampleHandler), ]) if __name__ == "__main__": logging.basicConfig(level=logging.INFO) application.listen(8888) ioloop.IOLoop.instance().start() class ReportHandler(web.RequestHandler): @gen.coroutine def get(self): self.finish(pool.PoolManager.report()) if __name__ == '__main__': logging.basicConfig(level=logging.DEBUG) application = web.Application([ (r'/', ExampleHandler), (r'/report', ReportHandler) ], debug=True) application.session = queries.TornadoSession() application.listen(8000) ioloop.IOLoop.instance().start() <MSG> Move example <DFF> @@ -8,14 +8,6 @@ class ExampleHandler(web.RequestHandler): def initialize(self): self.session = queries.TornadoSession() - @gen.coroutine - def prepare(self): - try: - yield self.session.validate() - except queries.OperationalError as error: - logging.error('Error connecting to the database: %s', error) - raise web.HTTPError(503) - @gen.coroutine def get(self): try: @@ -29,10 +21,10 @@ class ExampleHandler(web.RequestHandler): application = web.Application([ - (r"/", ExampleHandler), + (r'/', ExampleHandler), ]) -if __name__ == "__main__": +if __name__ == '__main__': logging.basicConfig(level=logging.INFO) application.listen(8888) ioloop.IOLoop.instance().start()

Move example

.py

py

bsd-3-clause

gmr/queries

1579

<NME> tornado_session_tests.py <BEF> """ Tests for functionality in the tornado_session module """ import unittest import mock # Out of order import to ensure psycopg2cffi is registered from queries import pool, tornado_session from psycopg2 import extras from tornado import concurrent, gen, ioloop, testing class ResultsTests(unittest.TestCase): def setUp(self): self.cursor = mock.Mock() self.fd = 10 self.cleanup = mock.Mock() self.obj = tornado_session.Results(self.cursor, self.cleanup, self.fd) def test_cursor_is_assigned(self): self.assertEqual(self.obj.cursor, self.cursor) def test_fd_is_assigned(self): self.assertEqual(self.obj._fd, self.fd) def test_cleanup_is_assigned(self): self.assertEqual(self.obj._cleanup, self.cleanup) @gen.coroutine def test_free_invokes_cleanup(self): yield self.obj.free() self.cleanup.assert_called_once_with(self.cursor, self.fd) class SessionInitTests(unittest.TestCase): def setUp(self): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): self.assertDictEqual(self.obj._futures, {}) def test_creates_empty_connections_dict(self): self.assertDictEqual(self.obj._connections, {}) def test_sets_default_cursor_factory(self): self.assertEqual(self.obj._cursor_factory, extras.RealDictCursor) def test_sets_tornado_ioloop_instance(self): self.assertEqual(self.obj._ioloop, ioloop.IOLoop.instance()) def test_sets_poolmananger_instance(self): self.assertEqual(self.obj._pool_manager, pool.PoolManager.instance()) def test_sets_uri(self): self.assertEqual(self.obj._uri, tornado_session.session.DEFAULT_URI) def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) def test_connection_is_none(self): self.assertIsNone(self.obj.connection) def test_cursor_is_none(self): self.assertIsNone(self.obj.cursor) class SessionConnectTests(testing.AsyncTestCase): def setUp(self): super(SessionConnectTests, self).setUp() self.conn = mock.Mock() self.conn.fileno = mock.Mock(return_value=10) self.obj = tornado_session.TornadoSession(io_loop=self.io_loop) def create_connection(future): future.set_result(self.conn) self.obj._create_connection = create_connection @testing.gen_test def test_connect_returns_new_connection(self): conn = yield self.obj._connect() self.assertEqual(conn, self.conn) @testing.gen_test def test_connect_returns_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) second_result = yield self.obj._connect() self.assertEqual(second_result, conn) @testing.gen_test def test_connect_gets_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: with mock.patch.object(self.io_loop, 'add_handler'): yield self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) @testing.gen_test def test_connect_pooled_connection_invokes_add_handler(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: get.return_value = self.conn with mock.patch.object(self.io_loop, 'add_handler') as add_handler: yield self.obj._connect() add_handler.assert_called_once_with(self.conn.fileno(), self.obj._on_io_events, ioloop.IOLoop.WRITE) def test_psycopg2_connect_invokes_psycopg2_connect(self): with mock.patch('psycopg2.connect') as connect: self.obj._psycopg2_connect({}) connect.assert_called_once_with(**{'async': True}) def test_on_io_events_returns_if_fd_not_present(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_not_called() def test_on_io_events_calls_poll_connection(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._connections[1337] = True self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_called_once_with(1337) def test_exec_cleanup_closes_cursor(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() cursor = mock.Mock() cursor.close = mock.Mock() self.obj._exec_cleanup(cursor, 14) cursor.close.assert_called_once_with() def test_exec_cleanup_frees_connection(self): with mock.patch.object(self.obj._pool_manager, 'free') as pm_free: with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = conn = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) pm_free.assert_called_once_with(self.obj.pid, conn) def test_exec_cleanup_remove_handler_invoked(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler') as rh: self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) rh.assert_called_once_with(14) def test_exec_removes_connection(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._connections) def test_exec_removes_future(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._futures[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._futures) def test_pool_manager_add_failures_are_propagated(self): futures = [] def add_future(future, callback): futures.append((future, callback)) obj = tornado_session.TornadoSession() obj._ioloop = mock.Mock() obj._ioloop.add_future = add_future future = concurrent.Future() with mock.patch.object(obj._pool_manager, 'add') as add_method: add_method.side_effect = pool.PoolFullError(mock.Mock()) obj._create_connection(future) self.assertEqual(len(futures), 1) connected_future, callback = futures.pop() connected_future.set_result(True) callback(connected_future) self.assertIs(future.exception(), add_method.side_effect) class SessionPublicMethodTests(testing.AsyncTestCase): @testing.gen_test def test_callproc_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.callproc('foo', ['bar']) _execute.assert_called_once_with('callproc', 'foo', ['bar']) @testing.gen_test def test_query_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) @testing.gen_test def test_query_error_key_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): yield obj.query('SELECT * FROM foo WHERE bar=%(baz)s', {}) @testing.gen_test def test_query_error_index_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): yield obj.query('SELECT * FROM foo WHERE bar=%s', []) <MSG> Temporarily disable tests <DFF> @@ -215,6 +215,7 @@ class SessionPublicMethodTests(testing.AsyncTestCase): yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) + """ @testing.gen_test def test_query_error_key_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) @@ -225,4 +226,5 @@ class SessionPublicMethodTests(testing.AsyncTestCase): def test_query_error_index_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): - yield obj.query('SELECT * FROM foo WHERE bar=%s', []) + r = yield obj.query('SELECT * FROM foo WHERE bar=%s', []) + """

Temporarily disable tests

.py

py

bsd-3-clause

gmr/queries

1580

<NME> tornado_session_tests.py <BEF> """ Tests for functionality in the tornado_session module """ import unittest import mock # Out of order import to ensure psycopg2cffi is registered from queries import pool, tornado_session from psycopg2 import extras from tornado import concurrent, gen, ioloop, testing class ResultsTests(unittest.TestCase): def setUp(self): self.cursor = mock.Mock() self.fd = 10 self.cleanup = mock.Mock() self.obj = tornado_session.Results(self.cursor, self.cleanup, self.fd) def test_cursor_is_assigned(self): self.assertEqual(self.obj.cursor, self.cursor) def test_fd_is_assigned(self): self.assertEqual(self.obj._fd, self.fd) def test_cleanup_is_assigned(self): self.assertEqual(self.obj._cleanup, self.cleanup) @gen.coroutine def test_free_invokes_cleanup(self): yield self.obj.free() self.cleanup.assert_called_once_with(self.cursor, self.fd) class SessionInitTests(unittest.TestCase): def setUp(self): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): self.assertDictEqual(self.obj._futures, {}) def test_creates_empty_connections_dict(self): self.assertDictEqual(self.obj._connections, {}) def test_sets_default_cursor_factory(self): self.assertEqual(self.obj._cursor_factory, extras.RealDictCursor) def test_sets_tornado_ioloop_instance(self): self.assertEqual(self.obj._ioloop, ioloop.IOLoop.instance()) def test_sets_poolmananger_instance(self): self.assertEqual(self.obj._pool_manager, pool.PoolManager.instance()) def test_sets_uri(self): self.assertEqual(self.obj._uri, tornado_session.session.DEFAULT_URI) def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) def test_connection_is_none(self): self.assertIsNone(self.obj.connection) def test_cursor_is_none(self): self.assertIsNone(self.obj.cursor) class SessionConnectTests(testing.AsyncTestCase): def setUp(self): super(SessionConnectTests, self).setUp() self.conn = mock.Mock() self.conn.fileno = mock.Mock(return_value=10) self.obj = tornado_session.TornadoSession(io_loop=self.io_loop) def create_connection(future): future.set_result(self.conn) self.obj._create_connection = create_connection @testing.gen_test def test_connect_returns_new_connection(self): conn = yield self.obj._connect() self.assertEqual(conn, self.conn) @testing.gen_test def test_connect_returns_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) second_result = yield self.obj._connect() self.assertEqual(second_result, conn) @testing.gen_test def test_connect_gets_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: with mock.patch.object(self.io_loop, 'add_handler'): yield self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) @testing.gen_test def test_connect_pooled_connection_invokes_add_handler(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: get.return_value = self.conn with mock.patch.object(self.io_loop, 'add_handler') as add_handler: yield self.obj._connect() add_handler.assert_called_once_with(self.conn.fileno(), self.obj._on_io_events, ioloop.IOLoop.WRITE) def test_psycopg2_connect_invokes_psycopg2_connect(self): with mock.patch('psycopg2.connect') as connect: self.obj._psycopg2_connect({}) connect.assert_called_once_with(**{'async': True}) def test_on_io_events_returns_if_fd_not_present(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_not_called() def test_on_io_events_calls_poll_connection(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._connections[1337] = True self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_called_once_with(1337) def test_exec_cleanup_closes_cursor(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() cursor = mock.Mock() cursor.close = mock.Mock() self.obj._exec_cleanup(cursor, 14) cursor.close.assert_called_once_with() def test_exec_cleanup_frees_connection(self): with mock.patch.object(self.obj._pool_manager, 'free') as pm_free: with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = conn = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) pm_free.assert_called_once_with(self.obj.pid, conn) def test_exec_cleanup_remove_handler_invoked(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler') as rh: self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) rh.assert_called_once_with(14) def test_exec_removes_connection(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._connections) def test_exec_removes_future(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._futures[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._futures) def test_pool_manager_add_failures_are_propagated(self): futures = [] def add_future(future, callback): futures.append((future, callback)) obj = tornado_session.TornadoSession() obj._ioloop = mock.Mock() obj._ioloop.add_future = add_future future = concurrent.Future() with mock.patch.object(obj._pool_manager, 'add') as add_method: add_method.side_effect = pool.PoolFullError(mock.Mock()) obj._create_connection(future) self.assertEqual(len(futures), 1) connected_future, callback = futures.pop() connected_future.set_result(True) callback(connected_future) self.assertIs(future.exception(), add_method.side_effect) class SessionPublicMethodTests(testing.AsyncTestCase): @testing.gen_test def test_callproc_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.callproc('foo', ['bar']) _execute.assert_called_once_with('callproc', 'foo', ['bar']) @testing.gen_test def test_query_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) @testing.gen_test def test_query_error_key_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): yield obj.query('SELECT * FROM foo WHERE bar=%(baz)s', {}) @testing.gen_test def test_query_error_index_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): yield obj.query('SELECT * FROM foo WHERE bar=%s', []) <MSG> Temporarily disable tests <DFF> @@ -215,6 +215,7 @@ class SessionPublicMethodTests(testing.AsyncTestCase): yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) + """ @testing.gen_test def test_query_error_key_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) @@ -225,4 +226,5 @@ class SessionPublicMethodTests(testing.AsyncTestCase): def test_query_error_index_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): - yield obj.query('SELECT * FROM foo WHERE bar=%s', []) + r = yield obj.query('SELECT * FROM foo WHERE bar=%s', []) + """

Temporarily disable tests

.py

py

bsd-3-clause

gmr/queries

1581

<NME> tornado_session_tests.py <BEF> """ Tests for functionality in the tornado_session module """ import unittest import mock # Out of order import to ensure psycopg2cffi is registered from queries import pool, tornado_session from psycopg2 import extras from tornado import concurrent, gen, ioloop, testing class ResultsTests(unittest.TestCase): def setUp(self): self.cursor = mock.Mock() self.fd = 10 self.cleanup = mock.Mock() self.obj = tornado_session.Results(self.cursor, self.cleanup, self.fd) def test_cursor_is_assigned(self): self.assertEqual(self.obj.cursor, self.cursor) def test_fd_is_assigned(self): self.assertEqual(self.obj._fd, self.fd) def test_cleanup_is_assigned(self): self.assertEqual(self.obj._cleanup, self.cleanup) @gen.coroutine def test_free_invokes_cleanup(self): yield self.obj.free() self.cleanup.assert_called_once_with(self.cursor, self.fd) class SessionInitTests(unittest.TestCase): def setUp(self): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): self.assertDictEqual(self.obj._futures, {}) def test_creates_empty_connections_dict(self): self.assertDictEqual(self.obj._connections, {}) def test_sets_default_cursor_factory(self): self.assertEqual(self.obj._cursor_factory, extras.RealDictCursor) def test_sets_tornado_ioloop_instance(self): self.assertEqual(self.obj._ioloop, ioloop.IOLoop.instance()) def test_sets_poolmananger_instance(self): self.assertEqual(self.obj._pool_manager, pool.PoolManager.instance()) def test_sets_uri(self): self.assertEqual(self.obj._uri, tornado_session.session.DEFAULT_URI) def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) def test_connection_is_none(self): self.assertIsNone(self.obj.connection) def test_cursor_is_none(self): self.assertIsNone(self.obj.cursor) class SessionConnectTests(testing.AsyncTestCase): def setUp(self): super(SessionConnectTests, self).setUp() self.conn = mock.Mock() self.conn.fileno = mock.Mock(return_value=10) self.obj = tornado_session.TornadoSession(io_loop=self.io_loop) def create_connection(future): future.set_result(self.conn) self.obj._create_connection = create_connection @testing.gen_test def test_connect_returns_new_connection(self): conn = yield self.obj._connect() self.assertEqual(conn, self.conn) @testing.gen_test def test_connect_returns_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) second_result = yield self.obj._connect() self.assertEqual(second_result, conn) @testing.gen_test def test_connect_gets_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: with mock.patch.object(self.io_loop, 'add_handler'): yield self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) @testing.gen_test def test_connect_pooled_connection_invokes_add_handler(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: get.return_value = self.conn with mock.patch.object(self.io_loop, 'add_handler') as add_handler: yield self.obj._connect() add_handler.assert_called_once_with(self.conn.fileno(), self.obj._on_io_events, ioloop.IOLoop.WRITE) def test_psycopg2_connect_invokes_psycopg2_connect(self): with mock.patch('psycopg2.connect') as connect: self.obj._psycopg2_connect({}) connect.assert_called_once_with(**{'async': True}) def test_on_io_events_returns_if_fd_not_present(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_not_called() def test_on_io_events_calls_poll_connection(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._connections[1337] = True self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_called_once_with(1337) def test_exec_cleanup_closes_cursor(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() cursor = mock.Mock() cursor.close = mock.Mock() self.obj._exec_cleanup(cursor, 14) cursor.close.assert_called_once_with() def test_exec_cleanup_frees_connection(self): with mock.patch.object(self.obj._pool_manager, 'free') as pm_free: with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = conn = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) pm_free.assert_called_once_with(self.obj.pid, conn) def test_exec_cleanup_remove_handler_invoked(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler') as rh: self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) rh.assert_called_once_with(14) def test_exec_removes_connection(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._connections) def test_exec_removes_future(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._futures[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._futures) def test_pool_manager_add_failures_are_propagated(self): futures = [] def add_future(future, callback): futures.append((future, callback)) obj = tornado_session.TornadoSession() obj._ioloop = mock.Mock() obj._ioloop.add_future = add_future future = concurrent.Future() with mock.patch.object(obj._pool_manager, 'add') as add_method: add_method.side_effect = pool.PoolFullError(mock.Mock()) obj._create_connection(future) self.assertEqual(len(futures), 1) connected_future, callback = futures.pop() connected_future.set_result(True) callback(connected_future) self.assertIs(future.exception(), add_method.side_effect) class SessionPublicMethodTests(testing.AsyncTestCase): @testing.gen_test def test_callproc_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.callproc('foo', ['bar']) _execute.assert_called_once_with('callproc', 'foo', ['bar']) @testing.gen_test def test_query_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) """ @testing.gen_test obj = tornado_session.TornadoSession(io_loop=self.io_loop) result = yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) @testing.gen_test def test_validate_invokes_connect(self): with mock.patch('queries.tornado_session.TornadoSession._connect') as \ _connect: with mock.patch('queries.pool.PoolManager.free'): future = concurrent.Future() connection = mock.Mock() connection.fileno = mock.Mock(return_value=10) future.set_result(connection) _connect.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.validate() _connect.assert_called_once_with() yield obj.query('SELECT * FROM foo WHERE bar=%(baz)s', {}) @testing.gen_test def test_query_error_index_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): r = yield obj.query('SELECT * FROM foo WHERE bar=%s', []) """ <MSG> Remove broken test <DFF> @@ -220,17 +220,3 @@ class SessionPublicMethodTests(testing.AsyncTestCase): obj = tornado_session.TornadoSession(io_loop=self.io_loop) result = yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) - - @testing.gen_test - def test_validate_invokes_connect(self): - with mock.patch('queries.tornado_session.TornadoSession._connect') as \ - _connect: - with mock.patch('queries.pool.PoolManager.free'): - future = concurrent.Future() - connection = mock.Mock() - connection.fileno = mock.Mock(return_value=10) - future.set_result(connection) - _connect.return_value = future - obj = tornado_session.TornadoSession(io_loop=self.io_loop) - yield obj.validate() - _connect.assert_called_once_with()

Remove broken test

.py

py

bsd-3-clause

gmr/queries

1582

<NME> tornado_session_tests.py <BEF> """ Tests for functionality in the tornado_session module """ import unittest import mock # Out of order import to ensure psycopg2cffi is registered from queries import pool, tornado_session from psycopg2 import extras from tornado import concurrent, gen, ioloop, testing class ResultsTests(unittest.TestCase): def setUp(self): self.cursor = mock.Mock() self.fd = 10 self.cleanup = mock.Mock() self.obj = tornado_session.Results(self.cursor, self.cleanup, self.fd) def test_cursor_is_assigned(self): self.assertEqual(self.obj.cursor, self.cursor) def test_fd_is_assigned(self): self.assertEqual(self.obj._fd, self.fd) def test_cleanup_is_assigned(self): self.assertEqual(self.obj._cleanup, self.cleanup) @gen.coroutine def test_free_invokes_cleanup(self): yield self.obj.free() self.cleanup.assert_called_once_with(self.cursor, self.fd) class SessionInitTests(unittest.TestCase): def setUp(self): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): self.assertDictEqual(self.obj._futures, {}) def test_creates_empty_connections_dict(self): self.assertDictEqual(self.obj._connections, {}) def test_sets_default_cursor_factory(self): self.assertEqual(self.obj._cursor_factory, extras.RealDictCursor) def test_sets_tornado_ioloop_instance(self): self.assertEqual(self.obj._ioloop, ioloop.IOLoop.instance()) def test_sets_poolmananger_instance(self): self.assertEqual(self.obj._pool_manager, pool.PoolManager.instance()) def test_sets_uri(self): self.assertEqual(self.obj._uri, tornado_session.session.DEFAULT_URI) def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) def test_connection_is_none(self): self.assertIsNone(self.obj.connection) def test_cursor_is_none(self): self.assertIsNone(self.obj.cursor) class SessionConnectTests(testing.AsyncTestCase): def setUp(self): super(SessionConnectTests, self).setUp() self.conn = mock.Mock() self.conn.fileno = mock.Mock(return_value=10) self.obj = tornado_session.TornadoSession(io_loop=self.io_loop) def create_connection(future): future.set_result(self.conn) self.obj._create_connection = create_connection @testing.gen_test def test_connect_returns_new_connection(self): conn = yield self.obj._connect() self.assertEqual(conn, self.conn) @testing.gen_test def test_connect_returns_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) second_result = yield self.obj._connect() self.assertEqual(second_result, conn) @testing.gen_test def test_connect_gets_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: with mock.patch.object(self.io_loop, 'add_handler'): yield self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) @testing.gen_test def test_connect_pooled_connection_invokes_add_handler(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: get.return_value = self.conn with mock.patch.object(self.io_loop, 'add_handler') as add_handler: yield self.obj._connect() add_handler.assert_called_once_with(self.conn.fileno(), self.obj._on_io_events, ioloop.IOLoop.WRITE) def test_psycopg2_connect_invokes_psycopg2_connect(self): with mock.patch('psycopg2.connect') as connect: self.obj._psycopg2_connect({}) connect.assert_called_once_with(**{'async': True}) def test_on_io_events_returns_if_fd_not_present(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_not_called() def test_on_io_events_calls_poll_connection(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._connections[1337] = True self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_called_once_with(1337) def test_exec_cleanup_closes_cursor(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() cursor = mock.Mock() cursor.close = mock.Mock() self.obj._exec_cleanup(cursor, 14) cursor.close.assert_called_once_with() def test_exec_cleanup_frees_connection(self): with mock.patch.object(self.obj._pool_manager, 'free') as pm_free: with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = conn = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) pm_free.assert_called_once_with(self.obj.pid, conn) def test_exec_cleanup_remove_handler_invoked(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler') as rh: self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) rh.assert_called_once_with(14) def test_exec_removes_connection(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._connections) def test_exec_removes_future(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._futures[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._futures) def test_pool_manager_add_failures_are_propagated(self): futures = [] def add_future(future, callback): futures.append((future, callback)) obj = tornado_session.TornadoSession() obj._ioloop = mock.Mock() obj._ioloop.add_future = add_future future = concurrent.Future() with mock.patch.object(obj._pool_manager, 'add') as add_method: add_method.side_effect = pool.PoolFullError(mock.Mock()) obj._create_connection(future) self.assertEqual(len(futures), 1) connected_future, callback = futures.pop() connected_future.set_result(True) callback(connected_future) self.assertIs(future.exception(), add_method.side_effect) class SessionPublicMethodTests(testing.AsyncTestCase): @testing.gen_test def test_callproc_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.callproc('foo', ['bar']) _execute.assert_called_once_with('callproc', 'foo', ['bar']) @testing.gen_test def test_query_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) """ @testing.gen_test obj = tornado_session.TornadoSession(io_loop=self.io_loop) result = yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) @testing.gen_test def test_validate_invokes_connect(self): with mock.patch('queries.tornado_session.TornadoSession._connect') as \ _connect: with mock.patch('queries.pool.PoolManager.free'): future = concurrent.Future() connection = mock.Mock() connection.fileno = mock.Mock(return_value=10) future.set_result(connection) _connect.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.validate() _connect.assert_called_once_with() yield obj.query('SELECT * FROM foo WHERE bar=%(baz)s', {}) @testing.gen_test def test_query_error_index_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): r = yield obj.query('SELECT * FROM foo WHERE bar=%s', []) """ <MSG> Remove broken test <DFF> @@ -220,17 +220,3 @@ class SessionPublicMethodTests(testing.AsyncTestCase): obj = tornado_session.TornadoSession(io_loop=self.io_loop) result = yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) - - @testing.gen_test - def test_validate_invokes_connect(self): - with mock.patch('queries.tornado_session.TornadoSession._connect') as \ - _connect: - with mock.patch('queries.pool.PoolManager.free'): - future = concurrent.Future() - connection = mock.Mock() - connection.fileno = mock.Mock(return_value=10) - future.set_result(connection) - _connect.return_value = future - obj = tornado_session.TornadoSession(io_loop=self.io_loop) - yield obj.validate() - _connect.assert_called_once_with()

Remove broken test

.py

py

bsd-3-clause

gmr/queries

1583

<NME> setup.py <BEF> import os import platform import setuptools # PYPY vs cpython if platform.python_implementation() == 'PyPy': install_requires = ['psycopg2cffi>=2.7.2,<3'] else: install_requires = ['psycopg2>=2.5.1,<3'] # Install tornado if generating docs on readthedocs if os.environ.get('READTHEDOCS', None) == 'True': install_requires.append('tornado') setuptools.setup( name='queries', version='2.1.0', description='Simplified PostgreSQL client built upon Psycopg2', long_description=open('README.rst').read(), maintainer='Gavin M. Roy', maintainer_email='gavinmroy@gmail.com', url='https://github.com/gmr/queries', install_requires=install_requires, extras_require={'tornado': 'tornado<6'}, license='BSD', package_data={'': ['LICENSE', 'README.rst']}, 'Topic :: Software Development :: Libraries'] setup(name='queries', version='1.10.2', description="Simplified PostgreSQL client built upon Psycopg2", maintainer="Gavin M. Roy", maintainer_email="gavinmroy@gmail.com", 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.4', 'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3.8', 'Programming Language :: Python :: Implementation :: CPython', 'Programming Language :: Python :: Implementation :: PyPy', 'Topic :: Database', 'Topic :: Software Development :: Libraries'], zip_safe=True) <MSG> Bump version <DFF> @@ -28,7 +28,7 @@ classifiers = ['Development Status :: 5 - Production/Stable', 'Topic :: Software Development :: Libraries'] setup(name='queries', - version='1.10.2', + version='1.10.3', description="Simplified PostgreSQL client built upon Psycopg2", maintainer="Gavin M. Roy", maintainer_email="gavinmroy@gmail.com",

Bump version

.py

py

bsd-3-clause

gmr/queries

1584

<NME> setup.py <BEF> import os import platform import setuptools # PYPY vs cpython if platform.python_implementation() == 'PyPy': install_requires = ['psycopg2cffi>=2.7.2,<3'] else: install_requires = ['psycopg2>=2.5.1,<3'] # Install tornado if generating docs on readthedocs if os.environ.get('READTHEDOCS', None) == 'True': install_requires.append('tornado') setuptools.setup( name='queries', version='2.1.0', description='Simplified PostgreSQL client built upon Psycopg2', long_description=open('README.rst').read(), maintainer='Gavin M. Roy', maintainer_email='gavinmroy@gmail.com', url='https://github.com/gmr/queries', install_requires=install_requires, extras_require={'tornado': 'tornado<6'}, license='BSD', package_data={'': ['LICENSE', 'README.rst']}, 'Topic :: Software Development :: Libraries'] setup(name='queries', version='1.10.2', description="Simplified PostgreSQL client built upon Psycopg2", maintainer="Gavin M. Roy", maintainer_email="gavinmroy@gmail.com", 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.4', 'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3.8', 'Programming Language :: Python :: Implementation :: CPython', 'Programming Language :: Python :: Implementation :: PyPy', 'Topic :: Database', 'Topic :: Software Development :: Libraries'], zip_safe=True) <MSG> Bump version <DFF> @@ -28,7 +28,7 @@ classifiers = ['Development Status :: 5 - Production/Stable', 'Topic :: Software Development :: Libraries'] setup(name='queries', - version='1.10.2', + version='1.10.3', description="Simplified PostgreSQL client built upon Psycopg2", maintainer="Gavin M. Roy", maintainer_email="gavinmroy@gmail.com",

Bump version

.py

py

bsd-3-clause

gmr/queries

1585

<NME> pool_connection_tests.py <BEF> """ Tests for Connection class in the pool module """ import unittest import weakref import mock from queries import pool class ConnectionTests(unittest.TestCase): def setUp(self): self.handle = mock.Mock() self.handle.close = mock.Mock() self.handle.closed = True self.handle.isexecuting = mock.Mock(return_value=False) self.connection = pool.Connection(self.handle) self.connection.used_by = None def test_handle_should_match(self): self.assertEqual(self.handle, self.connection.handle) def test_busy_isexecuting_is_false(self): self.assertFalse(self.connection.busy) def test_busy_isexecuting_is_true(self): self.handle.isexecuting.return_value = True self.assertTrue(self.connection.busy) def test_busy_is_used(self): self.handle.isexecuting.return_value = False self.connection.used_by = mock.Mock() self.assertTrue(self.connection.busy) def test_executing_is_true(self): self.handle.isexecuting.return_value = True self.assertTrue(self.connection.executing) def test_executing_is_false(self): self.handle.isexecuting.return_value = False self.assertFalse(self.connection.executing) def test_locked_is_true(self): self.connection.used_by = mock.Mock() self.assertTrue(self.connection.locked) def test_locked_is_false(self): self.connection.used_by = None self.assertFalse(self.connection.locked) def test_closed_is_true(self): self.handle.closed = True self.assertTrue(self.connection.closed) def test_closed_is_false(self): self.handle.closed = False self.assertFalse(self.connection.closed) def test_close_raises_when_busy(self): self.handle.isexecuting.return_value = True self.handle.closed = False self.assertRaises(pool.ConnectionBusyError, self.connection.close) def test_close_invokes_handle_close(self): self.handle.isexecuting.return_value = False self.handle.isexecuting.return_value = False self.connection.used_by = None self.connection.close() self.handle.close.assertCalledOnce() def test_free_raises_when_busy(self): self.handle.isexecuting.return_value = True self.assertRaises(pool.ConnectionBusyError, self.connection.free) def test_free_resets_used_by(self): self.handle.isexecuting.return_value = False self.connection.used_by = mock.Mock() self.connection.free() self.assertIsNone(self.connection.used_by) def test_id_value_matches(self): self.assertEqual(id(self.handle), self.connection.id) def test_lock_raises_when_busy(self): self.connection.used_by = mock.Mock() self.assertRaises(pool.ConnectionBusyError, self.connection.lock, mock.Mock()) def test_lock_session_used_by(self): session = mock.Mock() self.connection.lock(session) self.assertIn(self.connection.used_by, weakref.getweakrefs(session)) <MSG> Fix the test for Python 3.5 <DFF> @@ -69,7 +69,7 @@ class ConnectionTests(unittest.TestCase): self.handle.isexecuting.return_value = False self.connection.used_by = None self.connection.close() - self.handle.close.assertCalledOnce() + self.assertEqual(len(self.handle.close.mock_calls), 1) def test_free_raises_when_busy(self): self.handle.isexecuting.return_value = True

Fix the test for Python 3.5

.py

py

bsd-3-clause

gmr/queries

1586

<NME> pool_connection_tests.py <BEF> """ Tests for Connection class in the pool module """ import unittest import weakref import mock from queries import pool class ConnectionTests(unittest.TestCase): def setUp(self): self.handle = mock.Mock() self.handle.close = mock.Mock() self.handle.closed = True self.handle.isexecuting = mock.Mock(return_value=False) self.connection = pool.Connection(self.handle) self.connection.used_by = None def test_handle_should_match(self): self.assertEqual(self.handle, self.connection.handle) def test_busy_isexecuting_is_false(self): self.assertFalse(self.connection.busy) def test_busy_isexecuting_is_true(self): self.handle.isexecuting.return_value = True self.assertTrue(self.connection.busy) def test_busy_is_used(self): self.handle.isexecuting.return_value = False self.connection.used_by = mock.Mock() self.assertTrue(self.connection.busy) def test_executing_is_true(self): self.handle.isexecuting.return_value = True self.assertTrue(self.connection.executing) def test_executing_is_false(self): self.handle.isexecuting.return_value = False self.assertFalse(self.connection.executing) def test_locked_is_true(self): self.connection.used_by = mock.Mock() self.assertTrue(self.connection.locked) def test_locked_is_false(self): self.connection.used_by = None self.assertFalse(self.connection.locked) def test_closed_is_true(self): self.handle.closed = True self.assertTrue(self.connection.closed) def test_closed_is_false(self): self.handle.closed = False self.assertFalse(self.connection.closed) def test_close_raises_when_busy(self): self.handle.isexecuting.return_value = True self.handle.closed = False self.assertRaises(pool.ConnectionBusyError, self.connection.close) def test_close_invokes_handle_close(self): self.handle.isexecuting.return_value = False self.handle.isexecuting.return_value = False self.connection.used_by = None self.connection.close() self.handle.close.assertCalledOnce() def test_free_raises_when_busy(self): self.handle.isexecuting.return_value = True self.assertRaises(pool.ConnectionBusyError, self.connection.free) def test_free_resets_used_by(self): self.handle.isexecuting.return_value = False self.connection.used_by = mock.Mock() self.connection.free() self.assertIsNone(self.connection.used_by) def test_id_value_matches(self): self.assertEqual(id(self.handle), self.connection.id) def test_lock_raises_when_busy(self): self.connection.used_by = mock.Mock() self.assertRaises(pool.ConnectionBusyError, self.connection.lock, mock.Mock()) def test_lock_session_used_by(self): session = mock.Mock() self.connection.lock(session) self.assertIn(self.connection.used_by, weakref.getweakrefs(session)) <MSG> Fix the test for Python 3.5 <DFF> @@ -69,7 +69,7 @@ class ConnectionTests(unittest.TestCase): self.handle.isexecuting.return_value = False self.connection.used_by = None self.connection.close() - self.handle.close.assertCalledOnce() + self.assertEqual(len(self.handle.close.mock_calls), 1) def test_free_raises_when_busy(self): self.handle.isexecuting.return_value = True

Fix the test for Python 3.5

.py

py

bsd-3-clause

gmr/queries

1587

<NME> results.py <BEF> """ query or callproc Results """ import logging import psycopg2 LOGGER = logging.getLogger(__name__) class Results(object): """The :py:class:`Results` class contains the results returned from :py:meth:`Session.query <queries.Session.query>` and :py:meth:`Session.callproc <queries.Session.callproc>`. It is able to act as an iterator and provides many different methods for accessing the information about and results from a query. """ def __init__(self, cursor, cleanup=None, fd=None): self.cursor = cursor self._cleanup = cleanup self._fd = fd def __getitem__(self, item): """Fetch an individual row from the result set :rtype: mixed :raises: IndexError """ try: self.cursor.scroll(item, 'absolute') except psycopg2.ProgrammingError: raise IndexError('No such row') else: return self.cursor.fetchone() def __iter__(self): """Iterate through the result set :rtype: mixed """ if self.cursor.rowcount: self._rewind() for row in self.cursor: yield row def __len__(self): """Return the number of rows that were returned from the query :rtype: int """ return self.cursor.rowcount if self.cursor.rowcount >= 0 else 0 def __nonzero__(self): return bool(self.cursor.rowcount) def __bool__(self): return self.__nonzero__() def __repr__(self): return '<queries.%s rows=%s>' % (self.__class__.__name__, len(self)) def as_dict(self): """Return a single row result as a dictionary. If the results contain """ if not self.cursor.rowcount: return 0 self._rewind() if self.cursor.rowcount == 1: return {} self._rewind() if self.cursor.rowcount == 1: return dict(self.cursor.fetchone()) else: raise ValueError('More than one row') def count(self): """Return the number of rows that were returned from the query :rtype: int """ connections. """ LOGGER.warning("Released results in queries.Session") def items(self): """Return all of the rows that are in the result set. LOGGER.debug('Invoking synchronous free has no effect') def items(self): """Return all of the rows that are in the result set. :rtype: list """ if not self.cursor.rowcount: return [] self.cursor.scroll(0, 'absolute') return self.cursor.fetchall() @property def rownumber(self): """Return the current offset of the result set :rtype: int """ return self.cursor.rownumber @property def query(self): """Return a read-only value of the query that was submitted to PostgreSQL. :rtype: str """ return self.cursor.query @property def status(self): """Return the status message returned by PostgreSQL after the query was executed. :rtype: str """ return self.cursor.statusmessage def _rewind(self): """Rewind the cursor to the first row""" self.cursor.scroll(0, 'absolute') <MSG> Add coverage of results.Results <DFF> @@ -15,11 +15,11 @@ class Results(object): as an iterator and provides many different methods for accessing the information about and results from a query. + :param psycopg2.extensions.cursor cursor: The cursor for the results + """ - def __init__(self, cursor, cleanup=None, fd=None): + def __init__(self, cursor): self.cursor = cursor - self._cleanup = cleanup - self._fd = fd def __getitem__(self, item): """Fetch an individual row from the result set @@ -68,7 +68,7 @@ class Results(object): """ if not self.cursor.rowcount: - return 0 + return {} self._rewind() if self.cursor.rowcount == 1: @@ -89,7 +89,7 @@ class Results(object): connections. """ - LOGGER.warning("Released results in queries.Session") + raise NotImplementedError def items(self): """Return all of the rows that are in the result set.

Add coverage of results.Results

.py

py

bsd-3-clause

gmr/queries

1588

<NME> results.py <BEF> """ query or callproc Results """ import logging import psycopg2 LOGGER = logging.getLogger(__name__) class Results(object): """The :py:class:`Results` class contains the results returned from :py:meth:`Session.query <queries.Session.query>` and :py:meth:`Session.callproc <queries.Session.callproc>`. It is able to act as an iterator and provides many different methods for accessing the information about and results from a query. """ def __init__(self, cursor, cleanup=None, fd=None): self.cursor = cursor self._cleanup = cleanup self._fd = fd def __getitem__(self, item): """Fetch an individual row from the result set :rtype: mixed :raises: IndexError """ try: self.cursor.scroll(item, 'absolute') except psycopg2.ProgrammingError: raise IndexError('No such row') else: return self.cursor.fetchone() def __iter__(self): """Iterate through the result set :rtype: mixed """ if self.cursor.rowcount: self._rewind() for row in self.cursor: yield row def __len__(self): """Return the number of rows that were returned from the query :rtype: int """ return self.cursor.rowcount if self.cursor.rowcount >= 0 else 0 def __nonzero__(self): return bool(self.cursor.rowcount) def __bool__(self): return self.__nonzero__() def __repr__(self): return '<queries.%s rows=%s>' % (self.__class__.__name__, len(self)) def as_dict(self): """Return a single row result as a dictionary. If the results contain """ if not self.cursor.rowcount: return 0 self._rewind() if self.cursor.rowcount == 1: return {} self._rewind() if self.cursor.rowcount == 1: return dict(self.cursor.fetchone()) else: raise ValueError('More than one row') def count(self): """Return the number of rows that were returned from the query :rtype: int """ connections. """ LOGGER.warning("Released results in queries.Session") def items(self): """Return all of the rows that are in the result set. LOGGER.debug('Invoking synchronous free has no effect') def items(self): """Return all of the rows that are in the result set. :rtype: list """ if not self.cursor.rowcount: return [] self.cursor.scroll(0, 'absolute') return self.cursor.fetchall() @property def rownumber(self): """Return the current offset of the result set :rtype: int """ return self.cursor.rownumber @property def query(self): """Return a read-only value of the query that was submitted to PostgreSQL. :rtype: str """ return self.cursor.query @property def status(self): """Return the status message returned by PostgreSQL after the query was executed. :rtype: str """ return self.cursor.statusmessage def _rewind(self): """Rewind the cursor to the first row""" self.cursor.scroll(0, 'absolute') <MSG> Add coverage of results.Results <DFF> @@ -15,11 +15,11 @@ class Results(object): as an iterator and provides many different methods for accessing the information about and results from a query. + :param psycopg2.extensions.cursor cursor: The cursor for the results + """ - def __init__(self, cursor, cleanup=None, fd=None): + def __init__(self, cursor): self.cursor = cursor - self._cleanup = cleanup - self._fd = fd def __getitem__(self, item): """Fetch an individual row from the result set @@ -68,7 +68,7 @@ class Results(object): """ if not self.cursor.rowcount: - return 0 + return {} self._rewind() if self.cursor.rowcount == 1: @@ -89,7 +89,7 @@ class Results(object): connections. """ - LOGGER.warning("Released results in queries.Session") + raise NotImplementedError def items(self): """Return all of the rows that are in the result set.

Add coverage of results.Results

.py

py

bsd-3-clause

gmr/queries

1589

<NME> pool_manager_tests.py <BEF> """ Tests for Manager class in the pool module """ import unittest import uuid import mock from queries import pool def mock_connection(): conn = mock.MagicMock('psycopg2.extensions.connection') conn.close = mock.Mock() conn.closed = True conn.isexecuting = mock.Mock(return_value=False) return conn class ManagerTests(unittest.TestCase): def setUp(self): self.manager = pool.PoolManager.instance() def tearDown(self): self.manager.shutdown() def test_singleton_behavior(self): self.assertEqual(pool.PoolManager.instance(), self.manager) def test_has_pool_false(self): self.assertNotIn(mock.Mock(), self.manager) def test_has_pool_true(self): pid = str(uuid.uuid4()) self.manager.create(pid) self.assertIn(pid, self.manager) def test_adding_to_pool(self): pid = str(uuid.uuid4()) self.manager.create(pid) def test_clean_ensures_pool_exists(self): pid = str(uuid.uuid4()) psycopg2_conn = mock.Mock() self.assertRaises(KeyError, self.manager.clean, pid) def test_shutdown_closes_all(self): pid1, pid2 = str(uuid.uuid4()), str(uuid.uuid4()) self.manager.create(pid1) self.manager._pools[pid1].shutdown = method1 = mock.Mock() self.manager.create(pid2) self.manager._pools[pid2].shutdown = method2 = mock.Mock() self.manager.shutdown() method1.assert_called_once_with() method2.assert_called_once_with() <MSG> Add additional test coverage of PoolManager <DFF> @@ -43,5 +43,197 @@ class ManagerTests(unittest.TestCase): def test_clean_ensures_pool_exists(self): pid = str(uuid.uuid4()) - psycopg2_conn = mock.Mock() self.assertRaises(KeyError, self.manager.clean, pid) + + def test_clean_invokes_pool_clean(self): + pid = str(uuid.uuid4()) + with mock.patch('queries.pool.Pool') as Pool: + self.manager._pools[pid] = Pool() + self.manager._pools[pid].clean = clean = mock.Mock() + self.manager.clean(pid) + clean.assert_called_once_with() + + def test_clean_removes_pool(self): + pid = str(uuid.uuid4()) + with mock.patch('queries.pool.Pool') as Pool: + self.manager._pools[pid] = Pool() + self.manager.clean(pid) + self.assertNotIn(pid, self.manager._pools) + + def test_create_prevents_duplicate_pool_id(self): + pid = str(uuid.uuid4()) + with mock.patch('queries.pool.Pool') as Pool: + self.manager._pools[pid] = Pool() + self.assertRaises(KeyError, self.manager.create, pid, 10, 10, Pool) + + def test_create_created_default_pool_type(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + self.assertIsInstance(self.manager._pools[pid], pool.Pool) + + def test_create_created_passed_in_pool_type(self): + pid = str(uuid.uuid4()) + + class FooPool(pool.Pool): + bar = True + + self.manager.create(pid, 10, 10, FooPool) + self.assertIsInstance(self.manager._pools[pid], FooPool) + + def test_create_passes_in_idle_ttl(self): + pid = str(uuid.uuid4()) + self.manager.create(pid, 12) + self.assertEqual(self.manager._pools[pid].idle_ttl, 12) + + def test_create_passes_in_max_size(self): + pid = str(uuid.uuid4()) + self.manager.create(pid, 10, 16) + self.assertEqual(self.manager._pools[pid].max_size, 16) + + def test_get_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + session = mock.Mock() + self.assertRaises(KeyError, self.manager.get, pid, session) + + def test_get_invokes_pool_get(self): + pid = str(uuid.uuid4()) + session = mock.Mock() + self.manager.create(pid) + self.manager._pools[pid].get = get = mock.Mock() + self.manager.get(pid, session) + get.assert_called_once_with(session) + + def test_free_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + psycopg2_conn = mock.Mock() + self.assertRaises(KeyError, self.manager.free, pid, psycopg2_conn) + + def test_free_invokes_pool_free(self): + pid = str(uuid.uuid4()) + psycopg2_conn = mock.Mock() + self.manager.create(pid) + self.manager._pools[pid].free = free = mock.Mock() + self.manager.free(pid, psycopg2_conn) + free.assert_called_once_with(psycopg2_conn) + + def test_has_connection_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + self.assertRaises(KeyError, self.manager.has_connection, pid, None) + + def test_has_idle_connection_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + self.assertRaises(KeyError, self.manager.has_idle_connection, pid) + + def test_has_connection_returns_false(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + self.assertFalse(self.manager.has_connection(pid, mock.Mock())) + + def test_has_connection_returns_true(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + psycopg2_conn = mock.Mock() + self.manager._pools[pid].connections[id(psycopg2_conn)] = psycopg2_conn + self.assertTrue(self.manager.has_connection(pid, psycopg2_conn)) + + def test_has_idle_connection_returns_false(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + with mock.patch('queries.pool.Pool.idle_connections', + new_callable=mock.PropertyMock) as idle_connections: + idle_connections.return_value = 0 + self.assertFalse(self.manager.has_idle_connection(pid)) + + def test_has_idle_connection_returns_true(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + with mock.patch('queries.pool.Pool.idle_connections', + new_callable=mock.PropertyMock) as idle_connections: + idle_connections.return_value = 5 + self.assertTrue(self.manager.has_idle_connection(pid)) + + def test_is_full_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + self.assertRaises(KeyError, self.manager.is_full, pid) + + def test_is_full_invokes_pool_is_full(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + with mock.patch('queries.pool.Pool.is_full', + new_callable=mock.PropertyMock) as is_full: + self.manager.is_full(pid) + is_full.assert_called_once_with() + + def test_lock_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + self.assertRaises(KeyError, self.manager.lock, pid, None, None) + + def test_lock_invokes_pool_lock(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + self.manager._pools[pid].lock = lock = mock.Mock() + psycopg2_conn = mock.Mock() + session = mock.Mock() + self.manager.lock(pid, psycopg2_conn, session) + lock.assert_called_once_with(psycopg2_conn, session) + + def test_remove_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + self.assertRaises(KeyError, self.manager.remove, pid) + + def test_remove_invokes_pool_close(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + self.manager._pools[pid].close = method = mock.Mock() + self.manager.remove(pid) + method.assert_called_once_with() + + def test_remove_deletes_pool(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + self.manager._pools[pid].close = mock.Mock() + self.manager.remove(pid) + self.assertNotIn(pid, self.manager._pools) + + def test_remove_connection_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + self.assertRaises(KeyError, self.manager.remove_connection, pid, None) + + def test_remove_connection_invokes_pool_remove(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + self.manager._pools[pid].remove = remove = mock.Mock() + psycopg2_conn = mock.Mock() + self.manager.remove_connection(pid, psycopg2_conn) + remove.assert_called_once_with(psycopg2_conn) + + def test_size_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + self.assertRaises(KeyError, self.manager.size, pid) + + def test_size_returns_pool_length(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + self.assertEqual(self.manager.size(pid), len(self.manager._pools[pid])) + + def test_set_idle_ttl_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + self.assertRaises(KeyError, self.manager.set_idle_ttl, pid, None) + + def test_set_idle_ttl_invokes_pool_set_idle_ttl(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + self.manager._pools[pid].set_idle_ttl = set_idle_ttl = mock.Mock() + self.manager.set_idle_ttl(pid, 256) + set_idle_ttl.assert_called_once_with(256) + + def test_set_max_size_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + self.assertRaises(KeyError, self.manager.set_idle_ttl, pid, None) + + def test_set_max_size_invokes_pool_set_max_size(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + self.manager._pools[pid].set_max_size = set_max_size = mock.Mock() + self.manager.set_max_size(pid, 128) + set_max_size.assert_called_once_with(128)

Add additional test coverage of PoolManager

.py

py

bsd-3-clause

gmr/queries

1590

<NME> pool_manager_tests.py <BEF> """ Tests for Manager class in the pool module """ import unittest import uuid import mock from queries import pool def mock_connection(): conn = mock.MagicMock('psycopg2.extensions.connection') conn.close = mock.Mock() conn.closed = True conn.isexecuting = mock.Mock(return_value=False) return conn class ManagerTests(unittest.TestCase): def setUp(self): self.manager = pool.PoolManager.instance() def tearDown(self): self.manager.shutdown() def test_singleton_behavior(self): self.assertEqual(pool.PoolManager.instance(), self.manager) def test_has_pool_false(self): self.assertNotIn(mock.Mock(), self.manager) def test_has_pool_true(self): pid = str(uuid.uuid4()) self.manager.create(pid) self.assertIn(pid, self.manager) def test_adding_to_pool(self): pid = str(uuid.uuid4()) self.manager.create(pid) def test_clean_ensures_pool_exists(self): pid = str(uuid.uuid4()) psycopg2_conn = mock.Mock() self.assertRaises(KeyError, self.manager.clean, pid) def test_shutdown_closes_all(self): pid1, pid2 = str(uuid.uuid4()), str(uuid.uuid4()) self.manager.create(pid1) self.manager._pools[pid1].shutdown = method1 = mock.Mock() self.manager.create(pid2) self.manager._pools[pid2].shutdown = method2 = mock.Mock() self.manager.shutdown() method1.assert_called_once_with() method2.assert_called_once_with() <MSG> Add additional test coverage of PoolManager <DFF> @@ -43,5 +43,197 @@ class ManagerTests(unittest.TestCase): def test_clean_ensures_pool_exists(self): pid = str(uuid.uuid4()) - psycopg2_conn = mock.Mock() self.assertRaises(KeyError, self.manager.clean, pid) + + def test_clean_invokes_pool_clean(self): + pid = str(uuid.uuid4()) + with mock.patch('queries.pool.Pool') as Pool: + self.manager._pools[pid] = Pool() + self.manager._pools[pid].clean = clean = mock.Mock() + self.manager.clean(pid) + clean.assert_called_once_with() + + def test_clean_removes_pool(self): + pid = str(uuid.uuid4()) + with mock.patch('queries.pool.Pool') as Pool: + self.manager._pools[pid] = Pool() + self.manager.clean(pid) + self.assertNotIn(pid, self.manager._pools) + + def test_create_prevents_duplicate_pool_id(self): + pid = str(uuid.uuid4()) + with mock.patch('queries.pool.Pool') as Pool: + self.manager._pools[pid] = Pool() + self.assertRaises(KeyError, self.manager.create, pid, 10, 10, Pool) + + def test_create_created_default_pool_type(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + self.assertIsInstance(self.manager._pools[pid], pool.Pool) + + def test_create_created_passed_in_pool_type(self): + pid = str(uuid.uuid4()) + + class FooPool(pool.Pool): + bar = True + + self.manager.create(pid, 10, 10, FooPool) + self.assertIsInstance(self.manager._pools[pid], FooPool) + + def test_create_passes_in_idle_ttl(self): + pid = str(uuid.uuid4()) + self.manager.create(pid, 12) + self.assertEqual(self.manager._pools[pid].idle_ttl, 12) + + def test_create_passes_in_max_size(self): + pid = str(uuid.uuid4()) + self.manager.create(pid, 10, 16) + self.assertEqual(self.manager._pools[pid].max_size, 16) + + def test_get_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + session = mock.Mock() + self.assertRaises(KeyError, self.manager.get, pid, session) + + def test_get_invokes_pool_get(self): + pid = str(uuid.uuid4()) + session = mock.Mock() + self.manager.create(pid) + self.manager._pools[pid].get = get = mock.Mock() + self.manager.get(pid, session) + get.assert_called_once_with(session) + + def test_free_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + psycopg2_conn = mock.Mock() + self.assertRaises(KeyError, self.manager.free, pid, psycopg2_conn) + + def test_free_invokes_pool_free(self): + pid = str(uuid.uuid4()) + psycopg2_conn = mock.Mock() + self.manager.create(pid) + self.manager._pools[pid].free = free = mock.Mock() + self.manager.free(pid, psycopg2_conn) + free.assert_called_once_with(psycopg2_conn) + + def test_has_connection_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + self.assertRaises(KeyError, self.manager.has_connection, pid, None) + + def test_has_idle_connection_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + self.assertRaises(KeyError, self.manager.has_idle_connection, pid) + + def test_has_connection_returns_false(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + self.assertFalse(self.manager.has_connection(pid, mock.Mock())) + + def test_has_connection_returns_true(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + psycopg2_conn = mock.Mock() + self.manager._pools[pid].connections[id(psycopg2_conn)] = psycopg2_conn + self.assertTrue(self.manager.has_connection(pid, psycopg2_conn)) + + def test_has_idle_connection_returns_false(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + with mock.patch('queries.pool.Pool.idle_connections', + new_callable=mock.PropertyMock) as idle_connections: + idle_connections.return_value = 0 + self.assertFalse(self.manager.has_idle_connection(pid)) + + def test_has_idle_connection_returns_true(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + with mock.patch('queries.pool.Pool.idle_connections', + new_callable=mock.PropertyMock) as idle_connections: + idle_connections.return_value = 5 + self.assertTrue(self.manager.has_idle_connection(pid)) + + def test_is_full_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + self.assertRaises(KeyError, self.manager.is_full, pid) + + def test_is_full_invokes_pool_is_full(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + with mock.patch('queries.pool.Pool.is_full', + new_callable=mock.PropertyMock) as is_full: + self.manager.is_full(pid) + is_full.assert_called_once_with() + + def test_lock_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + self.assertRaises(KeyError, self.manager.lock, pid, None, None) + + def test_lock_invokes_pool_lock(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + self.manager._pools[pid].lock = lock = mock.Mock() + psycopg2_conn = mock.Mock() + session = mock.Mock() + self.manager.lock(pid, psycopg2_conn, session) + lock.assert_called_once_with(psycopg2_conn, session) + + def test_remove_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + self.assertRaises(KeyError, self.manager.remove, pid) + + def test_remove_invokes_pool_close(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + self.manager._pools[pid].close = method = mock.Mock() + self.manager.remove(pid) + method.assert_called_once_with() + + def test_remove_deletes_pool(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + self.manager._pools[pid].close = mock.Mock() + self.manager.remove(pid) + self.assertNotIn(pid, self.manager._pools) + + def test_remove_connection_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + self.assertRaises(KeyError, self.manager.remove_connection, pid, None) + + def test_remove_connection_invokes_pool_remove(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + self.manager._pools[pid].remove = remove = mock.Mock() + psycopg2_conn = mock.Mock() + self.manager.remove_connection(pid, psycopg2_conn) + remove.assert_called_once_with(psycopg2_conn) + + def test_size_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + self.assertRaises(KeyError, self.manager.size, pid) + + def test_size_returns_pool_length(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + self.assertEqual(self.manager.size(pid), len(self.manager._pools[pid])) + + def test_set_idle_ttl_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + self.assertRaises(KeyError, self.manager.set_idle_ttl, pid, None) + + def test_set_idle_ttl_invokes_pool_set_idle_ttl(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + self.manager._pools[pid].set_idle_ttl = set_idle_ttl = mock.Mock() + self.manager.set_idle_ttl(pid, 256) + set_idle_ttl.assert_called_once_with(256) + + def test_set_max_size_ensures_pool_exists(self): + pid = str(uuid.uuid4()) + self.assertRaises(KeyError, self.manager.set_idle_ttl, pid, None) + + def test_set_max_size_invokes_pool_set_max_size(self): + pid = str(uuid.uuid4()) + self.manager.create(pid) + self.manager._pools[pid].set_max_size = set_max_size = mock.Mock() + self.manager.set_max_size(pid, 128) + set_max_size.assert_called_once_with(128)

Add additional test coverage of PoolManager

.py

py

bsd-3-clause

gmr/queries

1591

<NME> tornado_session_tests.py <BEF> """ Tests for functionality in the tornado_session module """ import unittest import mock # Out of order import to ensure psycopg2cffi is registered from queries import pool, tornado_session from psycopg2 import extras from tornado import concurrent, gen, ioloop, testing class ResultsTests(unittest.TestCase): def setUp(self): self.cursor = mock.Mock() self.fd = 10 self.cleanup = mock.Mock() self.obj = tornado_session.Results(self.cursor, self.cleanup, self.fd) def test_cursor_is_assigned(self): self.assertEqual(self.obj.cursor, self.cursor) def test_fd_is_assigned(self): self.assertEqual(self.obj._fd, self.fd) def test_cleanup_is_assigned(self): self.assertEqual(self.obj._cleanup, self.cleanup) @gen.coroutine def test_free_invokes_cleanup(self): yield self.obj.free() self.cleanup.assert_called_once_with(self.cursor, self.fd) class SessionInitTests(unittest.TestCase): def setUp(self): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): self.assertDictEqual(self.obj._futures, {}) def test_creates_empty_connections_dict(self): self.assertDictEqual(self.obj._connections, {}) def test_sets_default_cursor_factory(self): self.assertEqual(self.obj._cursor_factory, extras.RealDictCursor) def test_sets_tornado_ioloop_instance(self): self.assertEqual(self.obj._ioloop, ioloop.IOLoop.instance()) def test_sets_poolmananger_instance(self): self.assertEqual(self.obj._pool_manager, pool.PoolManager.instance()) def test_sets_uri(self): self.assertEqual(self.obj._uri, tornado_session.session.DEFAULT_URI) def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) def test_connection_is_none(self): self.assertIsNone(self.obj.connection) def test_cursor_is_none(self): self.assertIsNone(self.obj.cursor) class SessionConnectTests(testing.AsyncTestCase): def setUp(self): super(SessionConnectTests, self).setUp() self.conn = mock.Mock() self.conn.fileno = mock.Mock(return_value=10) self.obj = tornado_session.TornadoSession(io_loop=self.io_loop) def create_connection(future): future.set_result(self.conn) self.obj._create_connection = create_connection @testing.gen_test def test_connect_returns_new_connection(self): conn = yield self.obj._connect() self.assertEqual(conn, self.conn) @testing.gen_test def test_connect_returns_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) second_result = yield self.obj._connect() self.assertEqual(second_result, conn) @testing.gen_test def test_connect_gets_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: with mock.patch.object(self.io_loop, 'add_handler'): yield self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) @testing.gen_test def test_connect_pooled_connection_invokes_add_handler(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: get.return_value = self.conn with mock.patch.object(self.io_loop, 'add_handler') as add_handler: yield self.obj._connect() add_handler.assert_called_once_with(self.conn.fileno(), self.obj._on_io_events, ioloop.IOLoop.WRITE) def test_psycopg2_connect_invokes_psycopg2_connect(self): with mock.patch('psycopg2.connect') as connect: self.obj._psycopg2_connect({}) connect.assert_called_once_with(**{'async': True}) def test_on_io_events_returns_if_fd_not_present(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_not_called() def test_on_io_events_calls_poll_connection(self): self.obj._psycopg2_connect({}) connect.assert_called_once_with(async=True) class SessionPublicMethodTests(testing.AsyncTestCase): self.obj._connections[14] = conn = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) pm_free.assert_called_once_with(self.obj.pid, conn) def test_exec_cleanup_remove_handler_invoked(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler') as rh: self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) rh.assert_called_once_with(14) def test_exec_removes_connection(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._connections) def test_exec_removes_future(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._futures[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._futures) def test_pool_manager_add_failures_are_propagated(self): futures = [] def add_future(future, callback): futures.append((future, callback)) obj = tornado_session.TornadoSession() obj._ioloop = mock.Mock() obj._ioloop.add_future = add_future future = concurrent.Future() with mock.patch.object(obj._pool_manager, 'add') as add_method: add_method.side_effect = pool.PoolFullError(mock.Mock()) obj._create_connection(future) self.assertEqual(len(futures), 1) connected_future, callback = futures.pop() connected_future.set_result(True) callback(connected_future) self.assertIs(future.exception(), add_method.side_effect) class SessionPublicMethodTests(testing.AsyncTestCase): @testing.gen_test def test_callproc_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.callproc('foo', ['bar']) _execute.assert_called_once_with('callproc', 'foo', ['bar']) @testing.gen_test def test_query_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) """ @testing.gen_test def test_query_error_key_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): yield obj.query('SELECT * FROM foo WHERE bar=%(baz)s', {}) @testing.gen_test def test_query_error_index_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): r = yield obj.query('SELECT * FROM foo WHERE bar=%s', []) """ <MSG> Add a few more tests to bump over 90% \o/ <DFF> @@ -129,6 +129,17 @@ class SessionConnectTests(testing.AsyncTestCase): self.obj._psycopg2_connect({}) connect.assert_called_once_with(async=True) + def test_on_io_events_returns_if_fd_not_present(self): + with mock.patch.object(self.obj, '_poll_connection') as poll: + self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) + poll.assert_not_called() + + def test_on_io_events_calls_poll_connection(self): + with mock.patch.object(self.obj, '_poll_connection') as poll: + self.obj._connections[1337] = True + self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) + poll.assert_called_once_with(1337) + class SessionPublicMethodTests(testing.AsyncTestCase):

Add a few more tests to bump over 90% \o/

.py

py

bsd-3-clause

gmr/queries

1592

<NME> tornado_session_tests.py <BEF> """ Tests for functionality in the tornado_session module """ import unittest import mock # Out of order import to ensure psycopg2cffi is registered from queries import pool, tornado_session from psycopg2 import extras from tornado import concurrent, gen, ioloop, testing class ResultsTests(unittest.TestCase): def setUp(self): self.cursor = mock.Mock() self.fd = 10 self.cleanup = mock.Mock() self.obj = tornado_session.Results(self.cursor, self.cleanup, self.fd) def test_cursor_is_assigned(self): self.assertEqual(self.obj.cursor, self.cursor) def test_fd_is_assigned(self): self.assertEqual(self.obj._fd, self.fd) def test_cleanup_is_assigned(self): self.assertEqual(self.obj._cleanup, self.cleanup) @gen.coroutine def test_free_invokes_cleanup(self): yield self.obj.free() self.cleanup.assert_called_once_with(self.cursor, self.fd) class SessionInitTests(unittest.TestCase): def setUp(self): self.obj = tornado_session.TornadoSession() def test_creates_empty_callback_dict(self): self.assertDictEqual(self.obj._futures, {}) def test_creates_empty_connections_dict(self): self.assertDictEqual(self.obj._connections, {}) def test_sets_default_cursor_factory(self): self.assertEqual(self.obj._cursor_factory, extras.RealDictCursor) def test_sets_tornado_ioloop_instance(self): self.assertEqual(self.obj._ioloop, ioloop.IOLoop.instance()) def test_sets_poolmananger_instance(self): self.assertEqual(self.obj._pool_manager, pool.PoolManager.instance()) def test_sets_uri(self): self.assertEqual(self.obj._uri, tornado_session.session.DEFAULT_URI) def test_creates_pool_in_manager(self): self.assertIn(self.obj.pid, self.obj._pool_manager._pools) def test_connection_is_none(self): self.assertIsNone(self.obj.connection) def test_cursor_is_none(self): self.assertIsNone(self.obj.cursor) class SessionConnectTests(testing.AsyncTestCase): def setUp(self): super(SessionConnectTests, self).setUp() self.conn = mock.Mock() self.conn.fileno = mock.Mock(return_value=10) self.obj = tornado_session.TornadoSession(io_loop=self.io_loop) def create_connection(future): future.set_result(self.conn) self.obj._create_connection = create_connection @testing.gen_test def test_connect_returns_new_connection(self): conn = yield self.obj._connect() self.assertEqual(conn, self.conn) @testing.gen_test def test_connect_returns_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) second_result = yield self.obj._connect() self.assertEqual(second_result, conn) @testing.gen_test def test_connect_gets_pooled_connection(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: with mock.patch.object(self.io_loop, 'add_handler'): yield self.obj._connect() get.assert_called_once_with(self.obj.pid, self.obj) @testing.gen_test def test_connect_pooled_connection_invokes_add_handler(self): conn = yield self.obj._connect() self.obj._pool_manager.add(self.obj.pid, conn) with mock.patch.object(self.obj._pool_manager, 'get') as get: get.return_value = self.conn with mock.patch.object(self.io_loop, 'add_handler') as add_handler: yield self.obj._connect() add_handler.assert_called_once_with(self.conn.fileno(), self.obj._on_io_events, ioloop.IOLoop.WRITE) def test_psycopg2_connect_invokes_psycopg2_connect(self): with mock.patch('psycopg2.connect') as connect: self.obj._psycopg2_connect({}) connect.assert_called_once_with(**{'async': True}) def test_on_io_events_returns_if_fd_not_present(self): with mock.patch.object(self.obj, '_poll_connection') as poll: self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) poll.assert_not_called() def test_on_io_events_calls_poll_connection(self): self.obj._psycopg2_connect({}) connect.assert_called_once_with(async=True) class SessionPublicMethodTests(testing.AsyncTestCase): self.obj._connections[14] = conn = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) pm_free.assert_called_once_with(self.obj.pid, conn) def test_exec_cleanup_remove_handler_invoked(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler') as rh: self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) rh.assert_called_once_with(14) def test_exec_removes_connection(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._connections) def test_exec_removes_future(self): with mock.patch.object(self.obj._pool_manager, 'free'): with mock.patch.object(self.obj._ioloop, 'remove_handler'): self.obj._connections[14] = mock.Mock() self.obj._futures[14] = mock.Mock() self.obj._exec_cleanup(mock.Mock(), 14) self.assertNotIn(14, self.obj._futures) def test_pool_manager_add_failures_are_propagated(self): futures = [] def add_future(future, callback): futures.append((future, callback)) obj = tornado_session.TornadoSession() obj._ioloop = mock.Mock() obj._ioloop.add_future = add_future future = concurrent.Future() with mock.patch.object(obj._pool_manager, 'add') as add_method: add_method.side_effect = pool.PoolFullError(mock.Mock()) obj._create_connection(future) self.assertEqual(len(futures), 1) connected_future, callback = futures.pop() connected_future.set_result(True) callback(connected_future) self.assertIs(future.exception(), add_method.side_effect) class SessionPublicMethodTests(testing.AsyncTestCase): @testing.gen_test def test_callproc_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.callproc('foo', ['bar']) _execute.assert_called_once_with('callproc', 'foo', ['bar']) @testing.gen_test def test_query_invokes_execute(self): with mock.patch('queries.tornado_session.TornadoSession._execute') as \ _execute: future = concurrent.Future() future.set_result(True) _execute.return_value = future obj = tornado_session.TornadoSession(io_loop=self.io_loop) yield obj.query('SELECT 1') _execute.assert_called_once_with('execute', 'SELECT 1', None) """ @testing.gen_test def test_query_error_key_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): yield obj.query('SELECT * FROM foo WHERE bar=%(baz)s', {}) @testing.gen_test def test_query_error_index_error(self): obj = tornado_session.TornadoSession(io_loop=self.io_loop) with self.assertRaises(Exception): r = yield obj.query('SELECT * FROM foo WHERE bar=%s', []) """ <MSG> Add a few more tests to bump over 90% \o/ <DFF> @@ -129,6 +129,17 @@ class SessionConnectTests(testing.AsyncTestCase): self.obj._psycopg2_connect({}) connect.assert_called_once_with(async=True) + def test_on_io_events_returns_if_fd_not_present(self): + with mock.patch.object(self.obj, '_poll_connection') as poll: + self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) + poll.assert_not_called() + + def test_on_io_events_calls_poll_connection(self): + with mock.patch.object(self.obj, '_poll_connection') as poll: + self.obj._connections[1337] = True + self.obj._on_io_events(1337, ioloop.IOLoop.WRITE) + poll.assert_called_once_with(1337) + class SessionPublicMethodTests(testing.AsyncTestCase):

Add a few more tests to bump over 90% \o/

.py

py

bsd-3-clause

gmr/queries

1593

<NME> .travis.yml <BEF> sudo: false language: python dist: xenial env: global: - PATH=$HOME/.local/bin:$PATH - AWS_DEFAULT_REGION=us-east-1 - secure: "inURdx4ldkJqQXL1TyvKImC3EnL5TixC1DlNMBYi5ttygwAk+mSSSw8Yc7klB6D1m6q79xUlHRk06vbz23CsXTM4AClC5Emrk6XN2GlUKl5WI+z+A2skI59buEhLWe7e2KzhB/AVx2E3TfKa0oY7raM0UUnaOkpV1Cj+mHKPIT0=" - secure: "H32DV3713a6UUuEJujrG7SfUX4/5WrwQy/3DxeptC6L7YPlTYxHBdEsccTfN5z806EheIl4BdIoxoDtq7PU/tWQoG1Lp2ze60mpwrniHajhFnjk7zP6pHvkhGLr8flhSmAb6CQBreNFOHTLWBMGPfi7k1Q9Td9MHbRo/FsTxqsM=" stages: - test - name: coverage - name: deploy if: tag IS present services: - postgresql install: - pip install awscli - pip install -r requires/testing.txt - python setup.py develop script: nosetests after_success: - aws s3 cp .coverage "s3://com-gavinroy-travis/queries/$TRAVIS_BUILD_NUMBER/.coverage.${TRAVIS_PYTHON_VERSION}" jobs: include: - python: 2.7 - python: 3.4 - python: 3.5 - python: pypy - python: pypy3 - stage: upload coverage services: [] python: 3.6 install: install: - pip install awscli coverage codecov script: - mkdir coverage - aws s3 cp --recursive s3://com-gavinroy-travis/queries/$TRAVIS_BUILD_NUMBER/ coverage - cd coverage - coverage combine - cd .. - coverage report after_success: codecov - stage: deploy python: 3.6 services: [] install: true install: true script: true after_success: true deploy: distributions: sdist bdist_wheel provider: pypi user: crad on: tags: true all_branches: true password: secure: UWQWui+QhAL1cz6oW/vqjEEp6/EPn1YOlItNJcWHNOO/WMMOlaTVYVUuXp+y+m52B+8PtYZZCTHwKCUKe97Grh291FLxgd0RJCawA40f4v1gmOFYLNKyZFBGfbC69/amxvGCcDvOPtpChHAlTIeokS5EQneVcAhXg2jXct0HTfI= <MSG> Make parts of .travis.yml conditional <DFF> @@ -36,6 +36,7 @@ jobs: - python: pypy - python: pypy3 - stage: upload coverage + if: repo IS gmr/queries services: [] python: 3.6 install: @@ -51,6 +52,7 @@ jobs: - coverage report after_success: codecov - stage: deploy + if: repo IS gmr/queries python: 3.6 services: [] install: true

Make parts of .travis.yml conditional

.yml

travis

bsd-3-clause

gmr/queries

1594

<NME> .travis.yml <BEF> sudo: false language: python dist: xenial env: global: - PATH=$HOME/.local/bin:$PATH - AWS_DEFAULT_REGION=us-east-1 - secure: "inURdx4ldkJqQXL1TyvKImC3EnL5TixC1DlNMBYi5ttygwAk+mSSSw8Yc7klB6D1m6q79xUlHRk06vbz23CsXTM4AClC5Emrk6XN2GlUKl5WI+z+A2skI59buEhLWe7e2KzhB/AVx2E3TfKa0oY7raM0UUnaOkpV1Cj+mHKPIT0=" - secure: "H32DV3713a6UUuEJujrG7SfUX4/5WrwQy/3DxeptC6L7YPlTYxHBdEsccTfN5z806EheIl4BdIoxoDtq7PU/tWQoG1Lp2ze60mpwrniHajhFnjk7zP6pHvkhGLr8flhSmAb6CQBreNFOHTLWBMGPfi7k1Q9Td9MHbRo/FsTxqsM=" stages: - test - name: coverage - name: deploy if: tag IS present services: - postgresql install: - pip install awscli - pip install -r requires/testing.txt - python setup.py develop script: nosetests after_success: - aws s3 cp .coverage "s3://com-gavinroy-travis/queries/$TRAVIS_BUILD_NUMBER/.coverage.${TRAVIS_PYTHON_VERSION}" jobs: include: - python: 2.7 - python: 3.4 - python: 3.5 - python: pypy - python: pypy3 - stage: upload coverage services: [] python: 3.6 install: install: - pip install awscli coverage codecov script: - mkdir coverage - aws s3 cp --recursive s3://com-gavinroy-travis/queries/$TRAVIS_BUILD_NUMBER/ coverage - cd coverage - coverage combine - cd .. - coverage report after_success: codecov - stage: deploy python: 3.6 services: [] install: true install: true script: true after_success: true deploy: distributions: sdist bdist_wheel provider: pypi user: crad on: tags: true all_branches: true password: secure: UWQWui+QhAL1cz6oW/vqjEEp6/EPn1YOlItNJcWHNOO/WMMOlaTVYVUuXp+y+m52B+8PtYZZCTHwKCUKe97Grh291FLxgd0RJCawA40f4v1gmOFYLNKyZFBGfbC69/amxvGCcDvOPtpChHAlTIeokS5EQneVcAhXg2jXct0HTfI= <MSG> Make parts of .travis.yml conditional <DFF> @@ -36,6 +36,7 @@ jobs: - python: pypy - python: pypy3 - stage: upload coverage + if: repo IS gmr/queries services: [] python: 3.6 install: @@ -51,6 +52,7 @@ jobs: - coverage report after_success: codecov - stage: deploy + if: repo IS gmr/queries python: 3.6 services: [] install: true

Make parts of .travis.yml conditional

.yml

travis

bsd-3-clause

gmr/queries

1595

<NME> pool_tests.py <BEF> """ Tests for functionality in the pool module """ import time import unittest import uuid import mock from queries import pool MAX_POOL_SIZE = 100 def mock_connection(): conn = mock.MagicMock('psycopg2.extensions.connection') conn.close = mock.Mock() conn.closed = True conn.isexecuting = mock.Mock(return_value=False) return conn class PoolTests(unittest.TestCase): def test_id_is_set(self): pool_id = str(uuid.uuid4()) obj = pool.Pool(pool_id) self.assertEqual(obj._id, pool_id) def test_id_property(self): pool_id = str(uuid.uuid4()) obj = pool.Pool(pool_id) self.assertEqual(obj.id, pool_id) def test_idle_ttl_is_default(self): obj = pool.Pool(str(uuid.uuid4())) self.assertEqual(obj.idle_ttl, pool.DEFAULT_IDLE_TTL) def test_max_size_is_default(self): obj = pool.Pool(str(uuid.uuid4())) self.assertEqual(obj.max_size, pool.DEFAULT_MAX_SIZE) def test_idle_ttl_constructor_assignment(self): obj = pool.Pool(str(uuid.uuid4()), 10) self.assertEqual(obj.idle_ttl, 10) def test_max_size_constructor_assignment(self): obj = pool.Pool(str(uuid.uuid4()), max_size=10) self.assertEqual(obj.max_size, 10) def test_idle_ttl_assignment(self): obj = pool.Pool(str(uuid.uuid4())) obj.set_idle_ttl(10) self.assertEqual(obj.idle_ttl, 10) def test_max_size_assignment(self): obj = pool.Pool(str(uuid.uuid4())) obj.set_max_size(10) self.assertEqual(obj.max_size, 10) def test_pool_doesnt_contain_connection(self): obj = pool.Pool(str(uuid.uuid4())) self.assertNotIn('foo', obj) def test_default_connection_count(self): obj = pool.Pool(str(uuid.uuid4())) self.assertEqual(len(obj), 0) def test_add_new_connection(self): psycopg2_conn = mock.Mock() obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertIn(psycopg2_conn, obj) def test_connection_count_after_add(self): psycopg2_conn = mock.Mock() obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertEqual(len(obj), 1) def test_add_existing_connection_raises_on_second_add(self): psycopg2_conn = mock.Mock() obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertRaises(ValueError, obj.add, psycopg2_conn) def test_add_when_pool_is_full_raises(self): obj = pool.Pool(str(uuid.uuid4()), max_size=1) obj.add(mock.Mock()) mock_conn = mock.Mock() self.assertRaises(pool.PoolFullError, obj.add, mock_conn) def test_closed_conn_invokes_remove_on_clean(self): psycopg2_conn = mock.Mock() psycopg2_conn.closed = True obj = pool.Pool(str(uuid.uuid4())) obj.remove = mock.Mock() obj.add(psycopg2_conn) obj.clean() obj.remove.assert_called_once_with(psycopg2_conn) def test_clean_closes_all_when_idle(self): obj = pool.Pool(str(uuid.uuid4()), idle_ttl=10) obj.idle_start = time.time() - 20 obj.close = mock.Mock() obj.clean() psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] obj.close() obj.remove.assert_hass_calls(psycopg2_conns) def test_free_invokes_connection_free(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_calls = [mock.call(c) for c in psycopg2_conns] obj.remove.assert_has_calls(psycopg2_calls) def test_free_invokes_connection_free(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) self._connection = obj.connection_handle conn = self._connection(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conn) conn.free.assert_called_once_with() def test_free_raises_not_found_exception(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) conn = obj.connection_handle(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conn) conn.free.assert_called_once_with() def test_free_resets_idle_start(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): [obj.add(conn) for conn in psycopg2_conns] for psycopg2_conn in psycopg2_conns: conn = obj.connection_handle(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conns[1]) self.assertAlmostEqual(int(obj.idle_start), int(time.time())) def test_free_raises_on_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.free, mock.Mock()) def test_get_returns_first_psycopg2_conn(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] session = mock.Mock() self.assertEqual(obj.get(session), psycopg2_conns[0]) def test_get_locks_first_psycopg2_conn(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] lock = mock.Mock() with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False, lock=lock): session = mock.Mock() obj.get(session) lock.assert_called_once_with(session) def test_get_resets_idle_start_to_none(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): session = mock.Mock() obj.idle_start = time.time() obj.get(session) self.assertIsNone(obj.idle_start) def test_get_raises_when_no_idle_connections(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] session = mock.Mock() self.assertRaises(pool.NoIdleConnectionsError, obj.get, session) def test_idle_connections(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): self.assertListEqual([c.handle for c in obj.idle_connections], psycopg2_conns) def test_idle_duration_when_none(self): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = None self.assertEqual(obj.idle_duration, 0) def test_idle_duration_when_set(self): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = time.time() - 5 self.assertAlmostEqual(int(obj.idle_duration), 5) def test_is_full_property_when_full(self): obj = pool.Pool(str(uuid.uuid4()), max_size=2) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] self.assertTrue(obj.is_full) def test_is_full_property_when_not_full(self): obj = pool.Pool(str(uuid.uuid4()), max_size=3) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] self.assertFalse(obj.is_full) def test_connection_lock_is_called_when_lock_is(self): with mock.patch('queries.pool.Connection.lock') as lock: obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) session = mock.Mock() obj.lock(psycopg2_conn, session) lock.assert_called_once_with(session) def test_locks_raises_when_connection_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.lock, mock.Mock(), mock.Mock()) def test_lock_resets_idle_start(self): with mock.patch('queries.pool.Connection.lock'): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = time.time() psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.lock(psycopg2_conn, mock.Mock()) self.assertIsNone(obj.idle_start) def test_remove_removes_connection(self): with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.remove(psycopg2_conn) self.assertNotIn(psycopg2_conn, obj) def test_remove_closes_connection(self): close_method = mock.Mock() with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False, close=close_method): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.remove(psycopg2_conn) close_method.assert_called_once_with() def test_remove_raises_when_connection_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.remove, mock.Mock()) def test_remove_raises_when_connection_is_busy(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() psycopg2_conn.closed = False obj.add(psycopg2_conn) self.assertRaises(pool.ConnectionBusyError, obj.remove, psycopg2_conn) def test__connection_returns_handle(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) self.assertEqual( obj.connection_handle(psycopg2_conn).handle, psycopg2_conn) def test_shutdown_raises_when_executing(self): psycopg2_conn = mock_connection() psycopg2_conn.isexecuting.return_value = True obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertRaises(pool.ConnectionBusyError, obj.shutdown) <MSG> Merge pull request #7 from chrismcguire/pool-close-fixes Pool close fixes <DFF> @@ -108,7 +108,8 @@ class PoolTests(unittest.TestCase): psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] obj.close() - obj.remove.assert_hass_calls(psycopg2_conns) + psycopg2_calls = [mock.call(c) for c in psycopg2_conns] + obj.remove.assert_has_calls(psycopg2_calls) def test_free_invokes_connection_free(self): obj = pool.Pool(str(uuid.uuid4()))

Merge pull request #7 from chrismcguire/pool-close-fixes

.py

py

bsd-3-clause

gmr/queries

1596

<NME> pool_tests.py <BEF> """ Tests for functionality in the pool module """ import time import unittest import uuid import mock from queries import pool MAX_POOL_SIZE = 100 def mock_connection(): conn = mock.MagicMock('psycopg2.extensions.connection') conn.close = mock.Mock() conn.closed = True conn.isexecuting = mock.Mock(return_value=False) return conn class PoolTests(unittest.TestCase): def test_id_is_set(self): pool_id = str(uuid.uuid4()) obj = pool.Pool(pool_id) self.assertEqual(obj._id, pool_id) def test_id_property(self): pool_id = str(uuid.uuid4()) obj = pool.Pool(pool_id) self.assertEqual(obj.id, pool_id) def test_idle_ttl_is_default(self): obj = pool.Pool(str(uuid.uuid4())) self.assertEqual(obj.idle_ttl, pool.DEFAULT_IDLE_TTL) def test_max_size_is_default(self): obj = pool.Pool(str(uuid.uuid4())) self.assertEqual(obj.max_size, pool.DEFAULT_MAX_SIZE) def test_idle_ttl_constructor_assignment(self): obj = pool.Pool(str(uuid.uuid4()), 10) self.assertEqual(obj.idle_ttl, 10) def test_max_size_constructor_assignment(self): obj = pool.Pool(str(uuid.uuid4()), max_size=10) self.assertEqual(obj.max_size, 10) def test_idle_ttl_assignment(self): obj = pool.Pool(str(uuid.uuid4())) obj.set_idle_ttl(10) self.assertEqual(obj.idle_ttl, 10) def test_max_size_assignment(self): obj = pool.Pool(str(uuid.uuid4())) obj.set_max_size(10) self.assertEqual(obj.max_size, 10) def test_pool_doesnt_contain_connection(self): obj = pool.Pool(str(uuid.uuid4())) self.assertNotIn('foo', obj) def test_default_connection_count(self): obj = pool.Pool(str(uuid.uuid4())) self.assertEqual(len(obj), 0) def test_add_new_connection(self): psycopg2_conn = mock.Mock() obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertIn(psycopg2_conn, obj) def test_connection_count_after_add(self): psycopg2_conn = mock.Mock() obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertEqual(len(obj), 1) def test_add_existing_connection_raises_on_second_add(self): psycopg2_conn = mock.Mock() obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertRaises(ValueError, obj.add, psycopg2_conn) def test_add_when_pool_is_full_raises(self): obj = pool.Pool(str(uuid.uuid4()), max_size=1) obj.add(mock.Mock()) mock_conn = mock.Mock() self.assertRaises(pool.PoolFullError, obj.add, mock_conn) def test_closed_conn_invokes_remove_on_clean(self): psycopg2_conn = mock.Mock() psycopg2_conn.closed = True obj = pool.Pool(str(uuid.uuid4())) obj.remove = mock.Mock() obj.add(psycopg2_conn) obj.clean() obj.remove.assert_called_once_with(psycopg2_conn) def test_clean_closes_all_when_idle(self): obj = pool.Pool(str(uuid.uuid4()), idle_ttl=10) obj.idle_start = time.time() - 20 obj.close = mock.Mock() obj.clean() psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] obj.close() obj.remove.assert_hass_calls(psycopg2_conns) def test_free_invokes_connection_free(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_calls = [mock.call(c) for c in psycopg2_conns] obj.remove.assert_has_calls(psycopg2_calls) def test_free_invokes_connection_free(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) self._connection = obj.connection_handle conn = self._connection(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conn) conn.free.assert_called_once_with() def test_free_raises_not_found_exception(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) conn = obj.connection_handle(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conn) conn.free.assert_called_once_with() def test_free_resets_idle_start(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): [obj.add(conn) for conn in psycopg2_conns] for psycopg2_conn in psycopg2_conns: conn = obj.connection_handle(psycopg2_conn) conn.free = mock.Mock() obj.free(psycopg2_conns[1]) self.assertAlmostEqual(int(obj.idle_start), int(time.time())) def test_free_raises_on_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.free, mock.Mock()) def test_get_returns_first_psycopg2_conn(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] session = mock.Mock() self.assertEqual(obj.get(session), psycopg2_conns[0]) def test_get_locks_first_psycopg2_conn(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] lock = mock.Mock() with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False, lock=lock): session = mock.Mock() obj.get(session) lock.assert_called_once_with(session) def test_get_resets_idle_start_to_none(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): session = mock.Mock() obj.idle_start = time.time() obj.get(session) self.assertIsNone(obj.idle_start) def test_get_raises_when_no_idle_connections(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] session = mock.Mock() self.assertRaises(pool.NoIdleConnectionsError, obj.get, session) def test_idle_connections(self): obj = pool.Pool(str(uuid.uuid4()), max_size=100) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): self.assertListEqual([c.handle for c in obj.idle_connections], psycopg2_conns) def test_idle_duration_when_none(self): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = None self.assertEqual(obj.idle_duration, 0) def test_idle_duration_when_set(self): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = time.time() - 5 self.assertAlmostEqual(int(obj.idle_duration), 5) def test_is_full_property_when_full(self): obj = pool.Pool(str(uuid.uuid4()), max_size=2) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] self.assertTrue(obj.is_full) def test_is_full_property_when_not_full(self): obj = pool.Pool(str(uuid.uuid4()), max_size=3) psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] self.assertFalse(obj.is_full) def test_connection_lock_is_called_when_lock_is(self): with mock.patch('queries.pool.Connection.lock') as lock: obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) session = mock.Mock() obj.lock(psycopg2_conn, session) lock.assert_called_once_with(session) def test_locks_raises_when_connection_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.lock, mock.Mock(), mock.Mock()) def test_lock_resets_idle_start(self): with mock.patch('queries.pool.Connection.lock'): obj = pool.Pool(str(uuid.uuid4())) obj.idle_start = time.time() psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.lock(psycopg2_conn, mock.Mock()) self.assertIsNone(obj.idle_start) def test_remove_removes_connection(self): with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.remove(psycopg2_conn) self.assertNotIn(psycopg2_conn, obj) def test_remove_closes_connection(self): close_method = mock.Mock() with mock.patch.multiple('queries.pool.Connection', busy=False, closed=False, close=close_method): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) obj.remove(psycopg2_conn) close_method.assert_called_once_with() def test_remove_raises_when_connection_not_found(self): obj = pool.Pool(str(uuid.uuid4())) self.assertRaises(pool.ConnectionNotFoundError, obj.remove, mock.Mock()) def test_remove_raises_when_connection_is_busy(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() psycopg2_conn.closed = False obj.add(psycopg2_conn) self.assertRaises(pool.ConnectionBusyError, obj.remove, psycopg2_conn) def test__connection_returns_handle(self): obj = pool.Pool(str(uuid.uuid4())) psycopg2_conn = mock.Mock() obj.add(psycopg2_conn) self.assertEqual( obj.connection_handle(psycopg2_conn).handle, psycopg2_conn) def test_shutdown_raises_when_executing(self): psycopg2_conn = mock_connection() psycopg2_conn.isexecuting.return_value = True obj = pool.Pool(str(uuid.uuid4())) obj.add(psycopg2_conn) self.assertRaises(pool.ConnectionBusyError, obj.shutdown) <MSG> Merge pull request #7 from chrismcguire/pool-close-fixes Pool close fixes <DFF> @@ -108,7 +108,8 @@ class PoolTests(unittest.TestCase): psycopg2_conns = [mock.Mock(), mock.Mock()] [obj.add(conn) for conn in psycopg2_conns] obj.close() - obj.remove.assert_hass_calls(psycopg2_conns) + psycopg2_calls = [mock.call(c) for c in psycopg2_conns] + obj.remove.assert_has_calls(psycopg2_calls) def test_free_invokes_connection_free(self): obj = pool.Pool(str(uuid.uuid4()))

Merge pull request #7 from chrismcguire/pool-close-fixes

.py

py

bsd-3-clause

gmr/queries

1597

<NME> pool.py <BEF> """ Connection Pooling """ import datetime import logging import os import threading import time import weakref import psycopg2 LOGGER = logging.getLogger(__name__) DEFAULT_IDLE_TTL = 60 DEFAULT_MAX_SIZE = int(os.environ.get('QUERIES_MAX_POOL_SIZE', 1)) class Connection(object): """Contains the handle to the connection, the current state of the connection and methods for manipulating the state of the connection. """ _lock = threading.Lock() def __init__(self, handle): self.handle = handle self.used_by = None self.executions = 0 self.exceptions = 0 def close(self): """Close the connection :raises: ConnectionBusyError """ LOGGER.debug('Connection %s closing', self.id) if self.busy and not self.closed: raise ConnectionBusyError(self) with self._lock: if not self.handle.closed: try: self.handle.close() except psycopg2.InterfaceError as error: LOGGER.error('Error closing socket: %s', error) @property def closed(self): """Return if the psycopg2 connection is closed. :rtype: bool """ return self.handle.closed != 0 @property def busy(self): """Return if the connection is currently executing a query or is locked by a session that still exists. :rtype: bool """ if self.handle.isexecuting(): return True elif self.used_by is None: return False return not self.used_by() is None @property def executing(self): """Return if the connection is currently executing a query :rtype: bool """ return self.handle.isexecuting() def free(self): """Remove the lock on the connection if the connection is not active :raises: ConnectionBusyError """ LOGGER.debug('Connection %s freeing', self.id) if self.handle.isexecuting(): raise ConnectionBusyError(self) with self._lock: self.used_by = None LOGGER.debug('Connection %s freed', self.id) @property def id(self): """Return id of the psycopg2 connection object :rtype: int """ return id(self.handle) def lock(self, session): """Lock the connection, ensuring that it is not busy and storing a weakref for the session. :param queries.Session session: The session to lock the connection with :raises: ConnectionBusyError """ if self.busy: raise ConnectionBusyError(self) with self._lock: self.used_by = weakref.ref(session) LOGGER.debug('Connection %s locked', self.id) @property def locked(self): """Return if the connection is currently exclusively locked :rtype: bool """ return self.used_by is not None class Pool(object): """A connection pool for gaining access to and managing connections""" _lock = threading.Lock() idle_start = None idle_ttl = DEFAULT_IDLE_TTL max_size = DEFAULT_MAX_SIZE def __init__(self, pool_id, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): self.connections = {} self._id = pool_id self.idle_ttl = idle_ttl self.max_size = max_size self.time_method = time_method or time.time def __contains__(self, connection): """Return True if the pool contains the connection""" return id(connection) in self.connections def __len__(self): """Return the number of connections in the pool""" return len(self.connections) def add(self, connection): """Add a new connection to the pool :param connection: The connection to add to the pool :type connection: psycopg2.extensions.connection :raises: PoolFullError """ if id(connection) in self.connections: raise ValueError('Connection already exists in pool') if len(self.connections) == self.max_size: LOGGER.warning('Race condition found when adding new connection') try: connection.close() except (psycopg2.Error, psycopg2.Warning) as error: LOGGER.error('Error closing the conn that cant be used: %s', error) raise PoolFullError(self) with self._lock: self.connections[id(connection)] = Connection(connection) LOGGER.debug('Pool %s added connection %s', self.id, id(connection)) @property def busy_connections(self): """Return a list of active/busy connections :rtype: list """ return [c for c in self.connections.values() if c.busy and not c.closed] def clean(self): """Clean the pool by removing any closed connections and if the pool's idle has exceeded its idle TTL, remove all connections. """ LOGGER.debug('Cleaning the pool') for connection in [self.connections[k] for k in self.connections if self.connections[k].closed]: LOGGER.debug('Removing %s', connection.id) self.remove(connection.handle) if self.idle_duration > self.idle_ttl: self.close() LOGGER.debug('Pool %s cleaned', self.id) def close(self): """Close the pool by closing and removing all of the connections""" for cid in list(self.connections.keys()): self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) @property def closed_connections(self): """Return a list of closed connections :rtype: list """ return [c for c in self.connections.values() if c.closed] def connection_handle(self, connection): """Return a connection object for the given psycopg2 connection :param connection: The connection to return a parent for :type connection: psycopg2.extensions.connection :rtype: Connection """ return self.connections[id(connection)] @property def executing_connections(self): """Return a list of connections actively executing queries :rtype: list """ return [c for c in self.connections.values() if c.executing] def free(self, connection): """Free the connection from use by the session that was using it. :param connection: The connection to free :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ LOGGER.debug('Pool %s freeing connection %s', self.id, id(connection)) try: self.connection_handle(connection).free() except KeyError: raise ConnectionNotFoundError(self.id, id(connection)) if self.idle_connections == list(self.connections.values()): with self._lock: self.idle_start = self.time_method() LOGGER.debug('Pool %s freed connection %s', self.id, id(connection)) def get(self, session): """Return an idle connection and assign the session to the connection :param queries.Session session: The session to assign :rtype: psycopg2.extensions.connection :raises: NoIdleConnectionsError """ idle = self.idle_connections cid = id(connection) if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) conn = self._connection(connection) if conn.busy: raise ConnectionBusyError(cid) conn.close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) raise NoIdleConnectionsError(self.id) @property def id(self): """Return the ID for this pool :rtype: str """ return self._id @property def idle_connections(self): """Return a list of idle connections :rtype: list """ return [c for c in self.connections.values() if not c.busy and not c.closed] @property def idle_duration(self): """Return the number of seconds that the pool has had no active connections. :rtype: float """ if self.idle_start is None: return 0 return self.time_method() - self.idle_start @property def is_full(self): """Return True if there are no more open slots for connections. :rtype: bool """ return len(self.connections) >= self.max_size def lock(self, connection, session): """Explicitly lock the specified connection :type connection: psycopg2.extensions.connection :param connection: The connection to lock :param queries.Session session: The session to hold the lock """ cid = id(connection) try: self.connection_handle(connection).lock(session) except KeyError: raise ConnectionNotFoundError(self.id, cid) else: if self.idle_start: with self._lock: self.idle_start = None LOGGER.debug('Pool %s locked connection %s', self.id, cid) @property def locked_connections(self): """Return a list of all locked connections :rtype: list """ return [c for c in self.connections.values() if c.locked] def remove(self, connection): """Remove the connection from the pool :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError :raises: ConnectionBusyError """ cid = id(connection) if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) self.connection_handle(connection).close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) def report(self): """Return a report about the pool state and configuration. :rtype: dict """ return { 'connections': { 'busy': len(self.busy_connections), 'closed': len(self.closed_connections), 'executing': len(self.executing_connections), 'idle': len(self.idle_connections), 'locked': len(self.busy_connections) }, 'exceptions': sum([c.exceptions for c in self.connections.values()]), 'executions': sum([c.executions for c in self.connections.values()]), 'full': self.is_full, 'idle': { 'duration': self.idle_duration, 'ttl': self.idle_ttl }, 'max_size': self.max_size } def shutdown(self): """Forcefully shutdown the entire pool, closing all non-executing connections. :raises: ConnectionBusyError """ with self._lock: for cid in list(self.connections.keys()): if self.connections[cid].executing: raise ConnectionBusyError(cid) if self.connections[cid].locked: self.connections[cid].free() self.connections[cid].close() del self.connections[cid] def set_idle_ttl(self, ttl): """Set the idle ttl :param int ttl: The TTL when idle """ with self._lock: self.idle_ttl = ttl def set_max_size(self, size): """Set the maximum number of connections :param int size: The maximum number of connections """ with self._lock: self.max_size = size class PoolManager(object): """The connection pool object implements behavior around connections and their use in queries.Session objects. We carry a pool id instead of the connection URI so that we will not be carrying the URI in memory, creating a possible security issue. """ _lock = threading.Lock() _pools = {} def __contains__(self, pid): """Returns True if the pool exists :param str pid: The pool id to check for :rtype: bool """ return pid in self.__class__._pools @classmethod def instance(cls): """Only allow a single PoolManager instance to exist, returning the handle for it. :rtype: PoolManager """ if not hasattr(cls, '_instance'): with cls._lock: cls._instance = cls() return cls._instance @classmethod def add(cls, pid, connection): """Add a new connection and session to a pool. :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].add(connection) @classmethod def clean(cls, pid): """Clean the specified pool, removing any closed connections or stale locks. :param str pid: The pool id to clean """ with cls._lock: try: cls._ensure_pool_exists(pid) except KeyError: LOGGER.debug('Pool clean invoked against missing pool %s', pid) return cls._pools[pid].clean() cls._maybe_remove_pool(pid) @classmethod def create(cls, pid, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): """Create a new pool, with the ability to pass in values to override the default idle TTL and the default maximum size. A pool's idle TTL defines the amount of time that a pool can be open without any sessions before it is removed. A pool's max size defines the maximum number of connections that can be added to the pool to prevent unbounded open connections. :param str pid: The pool ID :param int idle_ttl: Time in seconds for the idle TTL :param int max_size: The maximum pool size :param callable time_method: Override the use of :py:meth:`time.time` method for time values. :raises: KeyError """ if pid in cls._pools: raise KeyError('Pool %s already exists' % pid) with cls._lock: LOGGER.debug("Creating Pool: %s (%i/%i)", pid, idle_ttl, max_size) cls._pools[pid] = Pool(pid, idle_ttl, max_size, time_method) @classmethod def free(cls, pid, connection): """Free a connection that was locked by a session :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection """ with cls._lock: LOGGER.debug('Freeing %s from pool %s', id(connection), pid) cls._ensure_pool_exists(pid) cls._pools[pid].free(connection) @classmethod def get(cls, pid, session): """Get an idle, unused connection from the pool. Once a connection has been retrieved, it will be marked as in-use until it is freed. :param str pid: The pool ID :param queries.Session session: The session to assign to the connection :rtype: psycopg2.extensions.connection """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].get(session) @classmethod def get_connection(cls, pid, connection): """Return the specified :class:`~queries.pool.Connection` from the pool. :param str pid: The pool ID :param connection: The connection to return for :type connection: psycopg2.extensions.connection :rtype: queries.pool.Connection """ with cls._lock: return cls._pools[pid].connection_handle(connection) @classmethod def has_connection(cls, pid, connection): """Check to see if a pool has the specified connection :param str pid: The pool ID :param connection: The connection to check for :type connection: psycopg2.extensions.connection :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return connection in cls._pools[pid] @classmethod def has_idle_connection(cls, pid): """Check to see if a pool has an idle connection :param str pid: The pool ID :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return bool(cls._pools[pid].idle_connections) @classmethod def is_full(cls, pid): """Return a bool indicating if the specified pool is full :param str pid: The pool id :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].is_full @classmethod def lock(cls, pid, connection, session): """Explicitly lock the specified connection in the pool :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool :param queries.Session session: The session to hold the lock """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].lock(connection, session) @classmethod def remove(cls, pid): """Remove a pool, closing all connections :param str pid: The pool ID """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].close() del cls._pools[pid] @classmethod def remove_connection(cls, pid, connection): """Remove a connection from the pool, closing it if is open. :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ cls._ensure_pool_exists(pid) cls._pools[pid].remove(connection) @classmethod def set_idle_ttl(cls, pid, ttl): """Set the idle TTL for a pool, after which it will be destroyed. :param str pid: The pool id :param int ttl: The TTL for an idle pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_idle_ttl(ttl) @classmethod def set_max_size(cls, pid, size): """Set the maximum number of connections for the specified pool :param str pid: The pool to set the size for :param int size: The maximum number of connections """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_max_size(size) @classmethod def shutdown(cls): """Close all connections on in all pools""" for pid in list(cls._pools.keys()): cls._pools[pid].shutdown() LOGGER.info('Shutdown complete, all pooled connections closed') @classmethod def size(cls, pid): """Return the number of connections in the pool :param str pid: The pool id :rtype int """ with cls._lock: cls._ensure_pool_exists(pid) return len(cls._pools[pid]) @classmethod def report(cls): """Return the state of the all of the registered pools. :rtype: dict """ return { 'timestamp': datetime.datetime.utcnow().isoformat(), 'process': os.getpid(), 'pools': dict([(i, p.report()) for i, p in cls._pools.items()]) } @classmethod def _ensure_pool_exists(cls, pid): """Raise an exception if the pool has yet to be created or has been removed. :param str pid: The pool ID to check for :raises: KeyError """ if pid not in cls._pools: raise KeyError('Pool %s has not been created' % pid) @classmethod def _maybe_remove_pool(cls, pid): """If the pool has no open connections, remove it :param str pid: The pool id to clean """ if not len(cls._pools[pid]): del cls._pools[pid] class QueriesException(Exception): """Base Exception for all other Queries exceptions""" pass class ConnectionException(QueriesException): def __init__(self, cid): self.cid = cid class PoolException(QueriesException): def __init__(self, pid): self.pid = pid class PoolConnectionException(PoolException): def __init__(self, pid, cid): self.pid = pid self.cid = cid class ActivePoolError(PoolException): """Raised when removing a pool that has active connections""" def __str__(self): return 'Pool %s has at least one active connection' % self.pid class ConnectionBusyError(ConnectionException): """Raised when trying to lock a connection that is already busy""" def __str__(self): return 'Connection %s is busy' % self.cid class ConnectionNotFoundError(PoolConnectionException): """Raised if a specific connection is not found in the pool""" def __str__(self): return 'Connection %s not found in pool %s' % (self.cid, self.pid) class NoIdleConnectionsError(PoolException): """Raised if a pool does not have any idle, open connections""" def __str__(self): return 'Pool %s has no idle connections' % self.pid class PoolFullError(PoolException): """Raised when adding a connection to a pool that has hit max-size""" def __str__(self): return 'Pool %s is at its maximum capacity' % self.pid <MSG> Simplify the remove close logic to fall through to Connection for busy validation <DFF> @@ -265,10 +265,7 @@ class Pool(object): cid = id(connection) if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) - conn = self._connection(connection) - if conn.busy: - raise ConnectionBusyError(cid) - conn.close() + self._connection(connection).close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid)

Simplify the remove close logic to fall through to Connection for busy validation

.py

py

bsd-3-clause

gmr/queries

1598

<NME> pool.py <BEF> """ Connection Pooling """ import datetime import logging import os import threading import time import weakref import psycopg2 LOGGER = logging.getLogger(__name__) DEFAULT_IDLE_TTL = 60 DEFAULT_MAX_SIZE = int(os.environ.get('QUERIES_MAX_POOL_SIZE', 1)) class Connection(object): """Contains the handle to the connection, the current state of the connection and methods for manipulating the state of the connection. """ _lock = threading.Lock() def __init__(self, handle): self.handle = handle self.used_by = None self.executions = 0 self.exceptions = 0 def close(self): """Close the connection :raises: ConnectionBusyError """ LOGGER.debug('Connection %s closing', self.id) if self.busy and not self.closed: raise ConnectionBusyError(self) with self._lock: if not self.handle.closed: try: self.handle.close() except psycopg2.InterfaceError as error: LOGGER.error('Error closing socket: %s', error) @property def closed(self): """Return if the psycopg2 connection is closed. :rtype: bool """ return self.handle.closed != 0 @property def busy(self): """Return if the connection is currently executing a query or is locked by a session that still exists. :rtype: bool """ if self.handle.isexecuting(): return True elif self.used_by is None: return False return not self.used_by() is None @property def executing(self): """Return if the connection is currently executing a query :rtype: bool """ return self.handle.isexecuting() def free(self): """Remove the lock on the connection if the connection is not active :raises: ConnectionBusyError """ LOGGER.debug('Connection %s freeing', self.id) if self.handle.isexecuting(): raise ConnectionBusyError(self) with self._lock: self.used_by = None LOGGER.debug('Connection %s freed', self.id) @property def id(self): """Return id of the psycopg2 connection object :rtype: int """ return id(self.handle) def lock(self, session): """Lock the connection, ensuring that it is not busy and storing a weakref for the session. :param queries.Session session: The session to lock the connection with :raises: ConnectionBusyError """ if self.busy: raise ConnectionBusyError(self) with self._lock: self.used_by = weakref.ref(session) LOGGER.debug('Connection %s locked', self.id) @property def locked(self): """Return if the connection is currently exclusively locked :rtype: bool """ return self.used_by is not None class Pool(object): """A connection pool for gaining access to and managing connections""" _lock = threading.Lock() idle_start = None idle_ttl = DEFAULT_IDLE_TTL max_size = DEFAULT_MAX_SIZE def __init__(self, pool_id, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): self.connections = {} self._id = pool_id self.idle_ttl = idle_ttl self.max_size = max_size self.time_method = time_method or time.time def __contains__(self, connection): """Return True if the pool contains the connection""" return id(connection) in self.connections def __len__(self): """Return the number of connections in the pool""" return len(self.connections) def add(self, connection): """Add a new connection to the pool :param connection: The connection to add to the pool :type connection: psycopg2.extensions.connection :raises: PoolFullError """ if id(connection) in self.connections: raise ValueError('Connection already exists in pool') if len(self.connections) == self.max_size: LOGGER.warning('Race condition found when adding new connection') try: connection.close() except (psycopg2.Error, psycopg2.Warning) as error: LOGGER.error('Error closing the conn that cant be used: %s', error) raise PoolFullError(self) with self._lock: self.connections[id(connection)] = Connection(connection) LOGGER.debug('Pool %s added connection %s', self.id, id(connection)) @property def busy_connections(self): """Return a list of active/busy connections :rtype: list """ return [c for c in self.connections.values() if c.busy and not c.closed] def clean(self): """Clean the pool by removing any closed connections and if the pool's idle has exceeded its idle TTL, remove all connections. """ LOGGER.debug('Cleaning the pool') for connection in [self.connections[k] for k in self.connections if self.connections[k].closed]: LOGGER.debug('Removing %s', connection.id) self.remove(connection.handle) if self.idle_duration > self.idle_ttl: self.close() LOGGER.debug('Pool %s cleaned', self.id) def close(self): """Close the pool by closing and removing all of the connections""" for cid in list(self.connections.keys()): self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) @property def closed_connections(self): """Return a list of closed connections :rtype: list """ return [c for c in self.connections.values() if c.closed] def connection_handle(self, connection): """Return a connection object for the given psycopg2 connection :param connection: The connection to return a parent for :type connection: psycopg2.extensions.connection :rtype: Connection """ return self.connections[id(connection)] @property def executing_connections(self): """Return a list of connections actively executing queries :rtype: list """ return [c for c in self.connections.values() if c.executing] def free(self, connection): """Free the connection from use by the session that was using it. :param connection: The connection to free :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ LOGGER.debug('Pool %s freeing connection %s', self.id, id(connection)) try: self.connection_handle(connection).free() except KeyError: raise ConnectionNotFoundError(self.id, id(connection)) if self.idle_connections == list(self.connections.values()): with self._lock: self.idle_start = self.time_method() LOGGER.debug('Pool %s freed connection %s', self.id, id(connection)) def get(self, session): """Return an idle connection and assign the session to the connection :param queries.Session session: The session to assign :rtype: psycopg2.extensions.connection :raises: NoIdleConnectionsError """ idle = self.idle_connections cid = id(connection) if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) conn = self._connection(connection) if conn.busy: raise ConnectionBusyError(cid) conn.close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) raise NoIdleConnectionsError(self.id) @property def id(self): """Return the ID for this pool :rtype: str """ return self._id @property def idle_connections(self): """Return a list of idle connections :rtype: list """ return [c for c in self.connections.values() if not c.busy and not c.closed] @property def idle_duration(self): """Return the number of seconds that the pool has had no active connections. :rtype: float """ if self.idle_start is None: return 0 return self.time_method() - self.idle_start @property def is_full(self): """Return True if there are no more open slots for connections. :rtype: bool """ return len(self.connections) >= self.max_size def lock(self, connection, session): """Explicitly lock the specified connection :type connection: psycopg2.extensions.connection :param connection: The connection to lock :param queries.Session session: The session to hold the lock """ cid = id(connection) try: self.connection_handle(connection).lock(session) except KeyError: raise ConnectionNotFoundError(self.id, cid) else: if self.idle_start: with self._lock: self.idle_start = None LOGGER.debug('Pool %s locked connection %s', self.id, cid) @property def locked_connections(self): """Return a list of all locked connections :rtype: list """ return [c for c in self.connections.values() if c.locked] def remove(self, connection): """Remove the connection from the pool :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError :raises: ConnectionBusyError """ cid = id(connection) if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) self.connection_handle(connection).close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) def report(self): """Return a report about the pool state and configuration. :rtype: dict """ return { 'connections': { 'busy': len(self.busy_connections), 'closed': len(self.closed_connections), 'executing': len(self.executing_connections), 'idle': len(self.idle_connections), 'locked': len(self.busy_connections) }, 'exceptions': sum([c.exceptions for c in self.connections.values()]), 'executions': sum([c.executions for c in self.connections.values()]), 'full': self.is_full, 'idle': { 'duration': self.idle_duration, 'ttl': self.idle_ttl }, 'max_size': self.max_size } def shutdown(self): """Forcefully shutdown the entire pool, closing all non-executing connections. :raises: ConnectionBusyError """ with self._lock: for cid in list(self.connections.keys()): if self.connections[cid].executing: raise ConnectionBusyError(cid) if self.connections[cid].locked: self.connections[cid].free() self.connections[cid].close() del self.connections[cid] def set_idle_ttl(self, ttl): """Set the idle ttl :param int ttl: The TTL when idle """ with self._lock: self.idle_ttl = ttl def set_max_size(self, size): """Set the maximum number of connections :param int size: The maximum number of connections """ with self._lock: self.max_size = size class PoolManager(object): """The connection pool object implements behavior around connections and their use in queries.Session objects. We carry a pool id instead of the connection URI so that we will not be carrying the URI in memory, creating a possible security issue. """ _lock = threading.Lock() _pools = {} def __contains__(self, pid): """Returns True if the pool exists :param str pid: The pool id to check for :rtype: bool """ return pid in self.__class__._pools @classmethod def instance(cls): """Only allow a single PoolManager instance to exist, returning the handle for it. :rtype: PoolManager """ if not hasattr(cls, '_instance'): with cls._lock: cls._instance = cls() return cls._instance @classmethod def add(cls, pid, connection): """Add a new connection and session to a pool. :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].add(connection) @classmethod def clean(cls, pid): """Clean the specified pool, removing any closed connections or stale locks. :param str pid: The pool id to clean """ with cls._lock: try: cls._ensure_pool_exists(pid) except KeyError: LOGGER.debug('Pool clean invoked against missing pool %s', pid) return cls._pools[pid].clean() cls._maybe_remove_pool(pid) @classmethod def create(cls, pid, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): """Create a new pool, with the ability to pass in values to override the default idle TTL and the default maximum size. A pool's idle TTL defines the amount of time that a pool can be open without any sessions before it is removed. A pool's max size defines the maximum number of connections that can be added to the pool to prevent unbounded open connections. :param str pid: The pool ID :param int idle_ttl: Time in seconds for the idle TTL :param int max_size: The maximum pool size :param callable time_method: Override the use of :py:meth:`time.time` method for time values. :raises: KeyError """ if pid in cls._pools: raise KeyError('Pool %s already exists' % pid) with cls._lock: LOGGER.debug("Creating Pool: %s (%i/%i)", pid, idle_ttl, max_size) cls._pools[pid] = Pool(pid, idle_ttl, max_size, time_method) @classmethod def free(cls, pid, connection): """Free a connection that was locked by a session :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection """ with cls._lock: LOGGER.debug('Freeing %s from pool %s', id(connection), pid) cls._ensure_pool_exists(pid) cls._pools[pid].free(connection) @classmethod def get(cls, pid, session): """Get an idle, unused connection from the pool. Once a connection has been retrieved, it will be marked as in-use until it is freed. :param str pid: The pool ID :param queries.Session session: The session to assign to the connection :rtype: psycopg2.extensions.connection """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].get(session) @classmethod def get_connection(cls, pid, connection): """Return the specified :class:`~queries.pool.Connection` from the pool. :param str pid: The pool ID :param connection: The connection to return for :type connection: psycopg2.extensions.connection :rtype: queries.pool.Connection """ with cls._lock: return cls._pools[pid].connection_handle(connection) @classmethod def has_connection(cls, pid, connection): """Check to see if a pool has the specified connection :param str pid: The pool ID :param connection: The connection to check for :type connection: psycopg2.extensions.connection :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return connection in cls._pools[pid] @classmethod def has_idle_connection(cls, pid): """Check to see if a pool has an idle connection :param str pid: The pool ID :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return bool(cls._pools[pid].idle_connections) @classmethod def is_full(cls, pid): """Return a bool indicating if the specified pool is full :param str pid: The pool id :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].is_full @classmethod def lock(cls, pid, connection, session): """Explicitly lock the specified connection in the pool :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool :param queries.Session session: The session to hold the lock """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].lock(connection, session) @classmethod def remove(cls, pid): """Remove a pool, closing all connections :param str pid: The pool ID """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].close() del cls._pools[pid] @classmethod def remove_connection(cls, pid, connection): """Remove a connection from the pool, closing it if is open. :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ cls._ensure_pool_exists(pid) cls._pools[pid].remove(connection) @classmethod def set_idle_ttl(cls, pid, ttl): """Set the idle TTL for a pool, after which it will be destroyed. :param str pid: The pool id :param int ttl: The TTL for an idle pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_idle_ttl(ttl) @classmethod def set_max_size(cls, pid, size): """Set the maximum number of connections for the specified pool :param str pid: The pool to set the size for :param int size: The maximum number of connections """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_max_size(size) @classmethod def shutdown(cls): """Close all connections on in all pools""" for pid in list(cls._pools.keys()): cls._pools[pid].shutdown() LOGGER.info('Shutdown complete, all pooled connections closed') @classmethod def size(cls, pid): """Return the number of connections in the pool :param str pid: The pool id :rtype int """ with cls._lock: cls._ensure_pool_exists(pid) return len(cls._pools[pid]) @classmethod def report(cls): """Return the state of the all of the registered pools. :rtype: dict """ return { 'timestamp': datetime.datetime.utcnow().isoformat(), 'process': os.getpid(), 'pools': dict([(i, p.report()) for i, p in cls._pools.items()]) } @classmethod def _ensure_pool_exists(cls, pid): """Raise an exception if the pool has yet to be created or has been removed. :param str pid: The pool ID to check for :raises: KeyError """ if pid not in cls._pools: raise KeyError('Pool %s has not been created' % pid) @classmethod def _maybe_remove_pool(cls, pid): """If the pool has no open connections, remove it :param str pid: The pool id to clean """ if not len(cls._pools[pid]): del cls._pools[pid] class QueriesException(Exception): """Base Exception for all other Queries exceptions""" pass class ConnectionException(QueriesException): def __init__(self, cid): self.cid = cid class PoolException(QueriesException): def __init__(self, pid): self.pid = pid class PoolConnectionException(PoolException): def __init__(self, pid, cid): self.pid = pid self.cid = cid class ActivePoolError(PoolException): """Raised when removing a pool that has active connections""" def __str__(self): return 'Pool %s has at least one active connection' % self.pid class ConnectionBusyError(ConnectionException): """Raised when trying to lock a connection that is already busy""" def __str__(self): return 'Connection %s is busy' % self.cid class ConnectionNotFoundError(PoolConnectionException): """Raised if a specific connection is not found in the pool""" def __str__(self): return 'Connection %s not found in pool %s' % (self.cid, self.pid) class NoIdleConnectionsError(PoolException): """Raised if a pool does not have any idle, open connections""" def __str__(self): return 'Pool %s has no idle connections' % self.pid class PoolFullError(PoolException): """Raised when adding a connection to a pool that has hit max-size""" def __str__(self): return 'Pool %s is at its maximum capacity' % self.pid <MSG> Simplify the remove close logic to fall through to Connection for busy validation <DFF> @@ -265,10 +265,7 @@ class Pool(object): cid = id(connection) if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) - conn = self._connection(connection) - if conn.busy: - raise ConnectionBusyError(cid) - conn.close() + self._connection(connection).close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid)

Simplify the remove close logic to fall through to Connection for busy validation

.py

py

bsd-3-clause

gmr/queries

1599

<NME> pool.py <BEF> """ Connection Pooling """ import datetime import logging import os import threading import time import weakref import psycopg2 LOGGER = logging.getLogger(__name__) DEFAULT_IDLE_TTL = 60 DEFAULT_MAX_SIZE = int(os.environ.get('QUERIES_MAX_POOL_SIZE', 1)) class Connection(object): """Contains the handle to the connection, the current state of the connection and methods for manipulating the state of the connection. """ _lock = threading.Lock() def __init__(self, handle): self.handle = handle self.used_by = None self.executions = 0 self.exceptions = 0 def close(self): """Close the connection :raises: ConnectionBusyError """ LOGGER.debug('Connection %s closing', self.id) if self.busy and not self.closed: raise ConnectionBusyError(self) with self._lock: if not self.handle.closed: try: self.handle.close() except psycopg2.InterfaceError as error: LOGGER.error('Error closing socket: %s', error) @property def closed(self): """Return if the psycopg2 connection is closed. :rtype: bool """ return self.handle.closed != 0 @property def busy(self): """Return if the connection is currently executing a query or is locked by a session that still exists. :rtype: bool """ if self.handle.isexecuting(): return True elif self.used_by is None: return False return not self.used_by() is None @property def executing(self): """Return if the connection is currently executing a query :rtype: bool """ return self.handle.isexecuting() def free(self): """Remove the lock on the connection if the connection is not active :raises: ConnectionBusyError """ LOGGER.debug('Connection %s freeing', self.id) if self.handle.isexecuting(): raise ConnectionBusyError(self) with self._lock: self.used_by = None LOGGER.debug('Connection %s freed', self.id) @property def id(self): """Return id of the psycopg2 connection object :rtype: int """ return id(self.handle) def lock(self, session): """Lock the connection, ensuring that it is not busy and storing a weakref for the session. :param queries.Session session: The session to lock the connection with :raises: ConnectionBusyError """ if self.busy: raise ConnectionBusyError(self) with self._lock: self.used_by = weakref.ref(session) LOGGER.debug('Connection %s locked', self.id) @property def locked(self): """Return if the connection is currently exclusively locked :rtype: bool """ return self.used_by is not None class Pool(object): """A connection pool for gaining access to and managing connections""" _lock = threading.Lock() idle_start = None idle_ttl = DEFAULT_IDLE_TTL max_size = DEFAULT_MAX_SIZE def __init__(self, pool_id, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): self.connections = {} self._id = pool_id self.idle_ttl = idle_ttl self.max_size = max_size self.time_method = time_method or time.time def __contains__(self, connection): """Return True if the pool contains the connection""" return id(connection) in self.connections def __len__(self): """Return the number of connections in the pool""" return len(self.connections) def add(self, connection): """Add a new connection to the pool def close(self): """Close the pool by closing and removing all of the connections""" for cid in self.connections: self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) raise ValueError('Connection already exists in pool') if len(self.connections) == self.max_size: LOGGER.warning('Race condition found when adding new connection') try: connection.close() except (psycopg2.Error, psycopg2.Warning) as error: LOGGER.error('Error closing the conn that cant be used: %s', error) raise PoolFullError(self) with self._lock: self.connections[id(connection)] = Connection(connection) LOGGER.debug('Pool %s added connection %s', self.id, id(connection)) @property def busy_connections(self): """Return a list of active/busy connections :rtype: list """ return [c for c in self.connections.values() if c.busy and not c.closed] def clean(self): """Clean the pool by removing any closed connections and if the pool's idle has exceeded its idle TTL, remove all connections. """ LOGGER.debug('Cleaning the pool') for connection in [self.connections[k] for k in self.connections if self.connections[k].closed]: LOGGER.debug('Removing %s', connection.id) self.remove(connection.handle) if self.idle_duration > self.idle_ttl: self.close() LOGGER.debug('Pool %s cleaned', self.id) def close(self): """Close the pool by closing and removing all of the connections""" for cid in list(self.connections.keys()): self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id) @property def closed_connections(self): """Return a list of closed connections :rtype: list """ return [c for c in self.connections.values() if c.closed] def connection_handle(self, connection): """Return a connection object for the given psycopg2 connection :param connection: The connection to return a parent for :type connection: psycopg2.extensions.connection :rtype: Connection """ return self.connections[id(connection)] @property def executing_connections(self): """Return a list of connections actively executing queries :rtype: list """ return [c for c in self.connections.values() if c.executing] def free(self, connection): """Free the connection from use by the session that was using it. :param connection: The connection to free :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ LOGGER.debug('Pool %s freeing connection %s', self.id, id(connection)) try: self.connection_handle(connection).free() except KeyError: raise ConnectionNotFoundError(self.id, id(connection)) if self.idle_connections == list(self.connections.values()): with self._lock: self.idle_start = self.time_method() LOGGER.debug('Pool %s freed connection %s', self.id, id(connection)) def get(self, session): """Return an idle connection and assign the session to the connection :param queries.Session session: The session to assign :rtype: psycopg2.extensions.connection :raises: NoIdleConnectionsError """ idle = self.idle_connections if idle: connection = idle.pop(0) connection.lock(session) if self.idle_start: with self._lock: self.idle_start = None return connection.handle raise NoIdleConnectionsError(self.id) @property def id(self): """Return the ID for this pool :rtype: str """ return self._id @property def idle_connections(self): """Return a list of idle connections :rtype: list """ return [c for c in self.connections.values() if not c.busy and not c.closed] @property def idle_duration(self): """Return the number of seconds that the pool has had no active connections. :rtype: float """ if self.idle_start is None: return 0 return self.time_method() - self.idle_start @property def is_full(self): """Return True if there are no more open slots for connections. :rtype: bool """ return len(self.connections) >= self.max_size def lock(self, connection, session): """Explicitly lock the specified connection :type connection: psycopg2.extensions.connection :param connection: The connection to lock :param queries.Session session: The session to hold the lock """ cid = id(connection) try: self.connection_handle(connection).lock(session) except KeyError: raise ConnectionNotFoundError(self.id, cid) else: if self.idle_start: with self._lock: self.idle_start = None LOGGER.debug('Pool %s locked connection %s', self.id, cid) @property def locked_connections(self): """Return a list of all locked connections :rtype: list """ return [c for c in self.connections.values() if c.locked] def remove(self, connection): """Remove the connection from the pool :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError :raises: ConnectionBusyError """ cid = id(connection) if cid not in self.connections: raise ConnectionNotFoundError(self.id, cid) self.connection_handle(connection).close() with self._lock: del self.connections[cid] LOGGER.debug('Pool %s removed connection %s', self.id, cid) def report(self): """Return a report about the pool state and configuration. :rtype: dict """ return { 'connections': { 'busy': len(self.busy_connections), 'closed': len(self.closed_connections), 'executing': len(self.executing_connections), 'idle': len(self.idle_connections), 'locked': len(self.busy_connections) }, 'exceptions': sum([c.exceptions for c in self.connections.values()]), 'executions': sum([c.executions for c in self.connections.values()]), 'full': self.is_full, 'idle': { 'duration': self.idle_duration, 'ttl': self.idle_ttl }, 'max_size': self.max_size } def shutdown(self): """Forcefully shutdown the entire pool, closing all non-executing connections. :raises: ConnectionBusyError """ with self._lock: for cid in list(self.connections.keys()): if self.connections[cid].executing: raise ConnectionBusyError(cid) if self.connections[cid].locked: self.connections[cid].free() self.connections[cid].close() del self.connections[cid] def set_idle_ttl(self, ttl): """Set the idle ttl :param int ttl: The TTL when idle """ with self._lock: self.idle_ttl = ttl def set_max_size(self, size): """Set the maximum number of connections :param int size: The maximum number of connections """ with self._lock: self.max_size = size class PoolManager(object): """The connection pool object implements behavior around connections and their use in queries.Session objects. We carry a pool id instead of the connection URI so that we will not be carrying the URI in memory, creating a possible security issue. """ _lock = threading.Lock() _pools = {} def __contains__(self, pid): """Returns True if the pool exists :param str pid: The pool id to check for :rtype: bool """ return pid in self.__class__._pools @classmethod def instance(cls): """Only allow a single PoolManager instance to exist, returning the handle for it. :rtype: PoolManager """ if not hasattr(cls, '_instance'): with cls._lock: cls._instance = cls() return cls._instance @classmethod def add(cls, pid, connection): """Add a new connection and session to a pool. :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].add(connection) @classmethod def clean(cls, pid): """Clean the specified pool, removing any closed connections or stale locks. :param str pid: The pool id to clean """ with cls._lock: try: cls._ensure_pool_exists(pid) except KeyError: LOGGER.debug('Pool clean invoked against missing pool %s', pid) return cls._pools[pid].clean() cls._maybe_remove_pool(pid) @classmethod def create(cls, pid, idle_ttl=DEFAULT_IDLE_TTL, max_size=DEFAULT_MAX_SIZE, time_method=None): """Create a new pool, with the ability to pass in values to override the default idle TTL and the default maximum size. A pool's idle TTL defines the amount of time that a pool can be open without any sessions before it is removed. A pool's max size defines the maximum number of connections that can be added to the pool to prevent unbounded open connections. :param str pid: The pool ID :param int idle_ttl: Time in seconds for the idle TTL :param int max_size: The maximum pool size :param callable time_method: Override the use of :py:meth:`time.time` method for time values. :raises: KeyError """ if pid in cls._pools: raise KeyError('Pool %s already exists' % pid) with cls._lock: LOGGER.debug("Creating Pool: %s (%i/%i)", pid, idle_ttl, max_size) cls._pools[pid] = Pool(pid, idle_ttl, max_size, time_method) @classmethod def free(cls, pid, connection): """Free a connection that was locked by a session :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection """ with cls._lock: LOGGER.debug('Freeing %s from pool %s', id(connection), pid) cls._ensure_pool_exists(pid) cls._pools[pid].free(connection) @classmethod def get(cls, pid, session): """Get an idle, unused connection from the pool. Once a connection has been retrieved, it will be marked as in-use until it is freed. :param str pid: The pool ID :param queries.Session session: The session to assign to the connection :rtype: psycopg2.extensions.connection """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].get(session) @classmethod def get_connection(cls, pid, connection): """Return the specified :class:`~queries.pool.Connection` from the pool. :param str pid: The pool ID :param connection: The connection to return for :type connection: psycopg2.extensions.connection :rtype: queries.pool.Connection """ with cls._lock: return cls._pools[pid].connection_handle(connection) @classmethod def has_connection(cls, pid, connection): """Check to see if a pool has the specified connection :param str pid: The pool ID :param connection: The connection to check for :type connection: psycopg2.extensions.connection :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return connection in cls._pools[pid] @classmethod def has_idle_connection(cls, pid): """Check to see if a pool has an idle connection :param str pid: The pool ID :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return bool(cls._pools[pid].idle_connections) @classmethod def is_full(cls, pid): """Return a bool indicating if the specified pool is full :param str pid: The pool id :rtype: bool """ with cls._lock: cls._ensure_pool_exists(pid) return cls._pools[pid].is_full @classmethod def lock(cls, pid, connection, session): """Explicitly lock the specified connection in the pool :param str pid: The pool id :type connection: psycopg2.extensions.connection :param connection: The connection to add to the pool :param queries.Session session: The session to hold the lock """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].lock(connection, session) @classmethod def remove(cls, pid): """Remove a pool, closing all connections :param str pid: The pool ID """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].close() del cls._pools[pid] @classmethod def remove_connection(cls, pid, connection): """Remove a connection from the pool, closing it if is open. :param str pid: The pool ID :param connection: The connection to remove :type connection: psycopg2.extensions.connection :raises: ConnectionNotFoundError """ cls._ensure_pool_exists(pid) cls._pools[pid].remove(connection) @classmethod def set_idle_ttl(cls, pid, ttl): """Set the idle TTL for a pool, after which it will be destroyed. :param str pid: The pool id :param int ttl: The TTL for an idle pool """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_idle_ttl(ttl) @classmethod def set_max_size(cls, pid, size): """Set the maximum number of connections for the specified pool :param str pid: The pool to set the size for :param int size: The maximum number of connections """ with cls._lock: cls._ensure_pool_exists(pid) cls._pools[pid].set_max_size(size) @classmethod def shutdown(cls): """Close all connections on in all pools""" for pid in list(cls._pools.keys()): cls._pools[pid].shutdown() LOGGER.info('Shutdown complete, all pooled connections closed') @classmethod def size(cls, pid): """Return the number of connections in the pool :param str pid: The pool id :rtype int """ with cls._lock: cls._ensure_pool_exists(pid) return len(cls._pools[pid]) @classmethod def report(cls): """Return the state of the all of the registered pools. :rtype: dict """ return { 'timestamp': datetime.datetime.utcnow().isoformat(), 'process': os.getpid(), 'pools': dict([(i, p.report()) for i, p in cls._pools.items()]) } @classmethod def _ensure_pool_exists(cls, pid): """Raise an exception if the pool has yet to be created or has been removed. :param str pid: The pool ID to check for :raises: KeyError """ if pid not in cls._pools: raise KeyError('Pool %s has not been created' % pid) @classmethod def _maybe_remove_pool(cls, pid): """If the pool has no open connections, remove it :param str pid: The pool id to clean """ if not len(cls._pools[pid]): del cls._pools[pid] class QueriesException(Exception): """Base Exception for all other Queries exceptions""" pass class ConnectionException(QueriesException): def __init__(self, cid): self.cid = cid class PoolException(QueriesException): def __init__(self, pid): self.pid = pid class PoolConnectionException(PoolException): def __init__(self, pid, cid): self.pid = pid self.cid = cid class ActivePoolError(PoolException): """Raised when removing a pool that has active connections""" def __str__(self): return 'Pool %s has at least one active connection' % self.pid class ConnectionBusyError(ConnectionException): """Raised when trying to lock a connection that is already busy""" def __str__(self): return 'Connection %s is busy' % self.cid class ConnectionNotFoundError(PoolConnectionException): """Raised if a specific connection is not found in the pool""" def __str__(self): return 'Connection %s not found in pool %s' % (self.cid, self.pid) class NoIdleConnectionsError(PoolException): """Raised if a pool does not have any idle, open connections""" def __str__(self): return 'Pool %s has no idle connections' % self.pid class PoolFullError(PoolException): """Raised when adding a connection to a pool that has hit max-size""" def __str__(self): return 'Pool %s is at its maximum capacity' % self.pid <MSG> queries.pool: Iterate over connection.keys() in close method. This commit alters pool.close() so that it iterates over connection.keys() rather than connection. This is to address an issue where the call to pool.remove() deletes from connections, which causes a RuntimeError for deleting while iterating over the dictionary. <DFF> @@ -156,7 +156,7 @@ class Pool(object): def close(self): """Close the pool by closing and removing all of the connections""" - for cid in self.connections: + for cid in self.connections.keys(): self.remove(self.connections[cid].handle) LOGGER.debug('Pool %s closed', self.id)

queries.pool: Iterate over connection.keys() in close method.

.py

py

bsd-3-clause

gmr/queries