Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Autodoc extension to pretty print canned SA queries

Project Description

author:Lele Gaifax
license:GNU General Public License version 3 or later

This is a very simple extension to Sphinx that injects the ability to recognize and pretty print SQLAlchemy statements into its automodule and autoclass directives.

To use it, first of all you must register the extension within the Sphinx environment, adding the full name of the package to the extensions list in the file, for example:

# Add any Sphinx extension module names here, as strings.
extensions = ['metapensiero.sphinx.autodoc_sa']

Without further settings it uses the default SQLAlchemy stringification strategy, but you can explicitly choose the right dialect by setting autodoc_sa_dialect to a string containing its fully qualified name, for example:

autodoc_sa_dialect = 'sqlalchemy.dialects.postgresql.dialect'

Otherwise, you can set it using the -D option of the sphinx-build command, e.g. adding -D autodoc_sa_dialect=my.own.dialect to the SPHINXOPTS of the Makefile created by sphinx-quickstart.

At this point, any documented SQLAlchemy core statement or ORM query, appearing either at the module level or as a class attribute, will be compiled into SQL, beautified using sqlparse.format() and added to the documentation wrapped within a code-block:: sql directive.

If you chose a specific SQLAlchemy dialect, by any chance you may want to select the right Pygments lexer to adjust the highlighting rules, instead of the default sql:

autodoc_sa_pygments_lang = 'postgresql'

If you are using PostgreSQL, you may prefer using the pg_query SQL prettifier over the default based on sqlparse:

autodoc_sa_prettifier = 'pg_query'


1.5 (2017-08-10)

  • New option autodoc_sa_prettifier_options to pass arbitrary keyword options to the prettifier function

1.4 (2017-08-09)

  • Replace the dynamic argument placeholders injected by SA with their literal values, leaving the developer’s explicit bindparams alone

1.3 (2017-08-08)

  • Handle also the pg_query SQL prettifier
  • New options, autodoc_sa_prettifier and autodoc_pygments_lang

1.2 (2017-03-22)

  • Minor tweak, no externally visible changes

1.1 (2017-01-17)

  • First release on PyPI

1.0 (unreleased)

  • Polished, tested and extended to support class’ attributes as well
  • Extracted from metapensiero.sphinx.patchdb

Release History

This version
History Node


History Node


History Node


History Node


History Node


Download Files

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

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
(9.0 kB) Copy SHA256 Hash SHA256
Source None Aug 10, 2017

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers