Skip to main content

CherryPy tool to manage Psycopg 2 database connections

Project description

CherryPy-Psycopg2

CherryPy-Psycopg2 is a simple CherryPy Tool to manage a (thread-safe) pool of database connections and make them available to handlers.

Import cherrypy_psycopg2 to make the tool available in CherryPy's default toolbox.

The following configuration settings are understood:

  • tools.psycopg2.minconn - passed to the psycopg2 pool constructor
  • tools.psycopg2.maxconn - passed to the psycopg2 pool constructor
  • tools.psycopg2.dsn - passed to the psycopg2 pool constructor
  • tools.psycopg2.cursor_factory - passed to the psycopg2 connection's cursor() method

When the tool is enabled on a handler, it will collect a database connection from the pool, expose a cursor as cherrypy.request.psycopg2_cursor, execute the handler and then commit the transaction (if the handler was successful or raised one of the cherrypy_psycopg2.COMMITTABLE_HANDLER_EXCEPTIONS), or rollback the transaction if the handler raised any other exception.

For example:

class Root:
    @cherrypy.expose
    @cherrypy.tools.psycopg2()
    def index(self):
        cursor = cherrypy.request.psycopg2_cursor
        cursor.execute("SELECT now()")

        return cursor.fetchone()[0]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cherrypy-psycopg2-2.0.tar.gz (7.5 kB view hashes)

Uploaded Source

Built Distribution

cherrypy_psycopg2-2.0-py3-none-any.whl (7.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page