Prepare 0.6.3 release

Fix import for Flask-SQLAlchemy 0.16
Use the "flask.ext" import for compatibility with old and new versions
2025-12-31 10:39:33 -06:00 · 2012-04-16 13:15:26 -07:00 · 2012-04-16 13:12:26 -07:00 · 2012-02-23 09:23:22 -08:00 · 2012-02-23 18:15:16 +01:00 · 2012-02-23 18:14:02 +01:00
35 changed files with 718 additions and 166 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,4 @@
 *.pyc
 build/
 dist/
+docs/_build
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -0,0 +1,47 @@
+Changes
+=======
+
+0.6.2 (2012-02-18)
+------------------
+
+Fixes:
+
+- Installation issue on Windows with trailing slashes in MANIFEST.in
+
+- JavaScript error when using conditional comments for ``<html>`` tag
+  (like in HTML5 Boilerplate)
+
+
+0.6.1 (2012-02-15)
+------------------
+
+Fixes:
+
+- Memory leak when toolbar was enabled
+
+- UnicodeDecodeError when request data contained binary data (e.g. session values)
+
+
+Enhancements:
+
+- ``DEBUG_TB_ENABLED`` config setting to explicitly enable or disable the toolbar
+
+- ``DEBUG_TB_HOSTS`` config setting to enable toolbar only for specific remote hosts
+
+- New logo for Flask instead of Django
+
+- Monospaced font on table data
+
+Thanks to kennethreitz and joeshaw for their contributions.
+
+
+0.6 (2012-01-04)
+----------------
+
+Flask 0.8 or higher is required
+
+Enhancements:
+
+- Flask 0.8 compatibility
+
+Thanks to mvantellingen
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,2 +1,2 @@
-recursive-include flask_debugtoolbar/templates/ *.html
-recursive-include flask_debugtoolbar/static/ *
+recursive-include flask_debugtoolbar/templates *.html
+recursive-include flask_debugtoolbar/static *
--- a/12
+++ b/12
@@ -1,12 +0,0 @@
-Flask Debug-toolbar
-
-A port of the django-debug toolbar (github.com/robhudson/django-debug-toolbar)
-to Flask.
-
-Usage::
-
- from flask import Flask
- from flask_debugtoolbar import DebugToolbarExtension
-
- app = Flask(__name__)
- toolbar = DebugToolbarExtension(app)
--- a/README.rst
+++ b/README.rst
@@ -0,0 +1,40 @@
+Flask Debug-toolbar
+===================
+
+This is a port of the excellent `django-debug-toolbar <https://github.com/django-debug-toolbar/django-debug-toolbar>`_
+for Flask applications.
+
+
+Installation
+------------
+
+Installing is simple with pip::
+
+    $ pip install flask-debugtoolbar
+
+
+Usage
+-----
+
+Setting up the debug toolbar is simple::
+
+    from flask import Flask
+    from flask_debugtoolbar import DebugToolbarExtension
+
+    app = Flask(__name__)
+
+    # the toolbar is only enabled in debug mode:
+    app.debug = True
+
+    # set a 'SECRET_KEY' to enable the Flask session cookies
+    app.config['SECRET_KEY'] = '<replace with a secret key>'
+
+    toolbar = DebugToolbarExtension(app)
+
+
+The toolbar will automatically be injected into Jinja templates when debug mode is on.
+In production, setting ``app.debug = False`` will disable the toolbar.
+
+See the `documentation`_ for more information.
+
+.. _documentation: http://flask-debugtoolbar.readthedocs.org
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Flask-DebugToolbar.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Flask-DebugToolbar.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/Flask-DebugToolbar"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Flask-DebugToolbar"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
--- a/docs/_static/.gitignore
+++ b/docs/_static/.gitignore
--- a/docs/_templates/.gitignore
+++ b/docs/_templates/.gitignore
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -0,0 +1,242 @@
+# -*- coding: utf-8 -*-
+#
+# Flask-DebugToolbar documentation build configuration file, created by
+# sphinx-quickstart on Wed Feb 15 18:08:39 2012.
+#
+# 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, os
+
+# 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.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'Flask-DebugToolbar'
+copyright = u'2012, Matt Good'
+
+# 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.
+#
+# The short X.Y version.
+version = '0.6'
+# The full version, including alpha/beta/rc tags.
+release = '0.6.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 = []
+
+
+# -- 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']
+
+# 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 = 'Flask-DebugToolbardoc'
+
+
+# -- 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]).
+latex_documents = [
+  ('index', 'Flask-DebugToolbar.tex', u'Flask-DebugToolbar Documentation',
+   u'Matt Good', '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', 'flask-debugtoolbar', u'Flask-DebugToolbar Documentation',
+     [u'Matt Good'], 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', 'Flask-DebugToolbar', u'Flask-DebugToolbar Documentation',
+   u'Matt Good', 'Flask-DebugToolbar', 'One line description of project.',
+   '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'
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -0,0 +1,74 @@
+.. Flask-DebugToolbar documentation master file, created by
+   sphinx-quickstart on Wed Feb 15 18:08:39 2012.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Flask-DebugToolbar's documentation!
+==============================================
+
+This is a port of the excellent `django-debug-toolbar <https://github.com/django-debug-toolbar/django-debug-toolbar>`_
+for Flask applications.
+
+Installation
+------------
+
+Installing is simple with pip::
+
+    $ pip install flask-debugtoolbar
+
+
+Usage
+-----
+
+Setting up the debug toolbar is simple::
+
+    from flask import Flask
+    from flask_debugtoolbar import DebugToolbarExtension
+
+    app = Flask(__name__)
+
+    # the toolbar is only enabled in debug mode:
+    app.debug = True
+
+    # set a 'SECRET_KEY' to enable the Flask session cookies
+    app.config['SECRET_KEY'] = '<replace with a secret key>'
+
+    toolbar = DebugToolbarExtension(app)
+
+
+The toolbar will automatically be injected into Jinja templates when debug mode is on.
+In production, setting ``app.debug = False`` will disable the toolbar.
+
+
+Configuration
+-------------
+
+The toolbar support several configuration options:
+
+================================  =====================================   ==========================
+Name                              Description                             Default
+================================  =====================================   ==========================
+``DEBUG_TB_ENABLED``              Enable the toolbar?                     ``app.debug``
+``DEBUG_TB_HOSTS``                Whitelist of hosts to display toolbar   any host
+``DEBUG_TB_INTERCEPT_REDIRECTS``  Should intercept redirects?             ``True``
+``DEBUG_TB_PANELS``               List of module/class names of panels    enable all built-in panels
+================================  =====================================   ==========================
+
+To change one of the config options, set it in the Flask app's config like::
+
+    app.config['DEBUG_TB_INTERCEPT_REDIRECTS'] = False
+
+
+Contributing
+------------
+
+Fork us `on GitHub <https://github.com/mgood/flask-debugtoolbar>`_
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
--- a/example/example.py
+++ b/example/example.py
@@ -14,6 +14,7 @@ app.config['DEBUG_TB_INTERCEPT_REDIRECTS'] = True
 #    'flask_debugtoolbar.panels.logger.LoggingPanel',
 #    'flask_debugtoolbar.panels.timer.TimerDebugPanel',
 #)
+#app.config['DEBUG_TB_HOSTS'] = ('127.0.0.1', '::1' )
 app.config['SECRET_KEY'] = 'asd'
 app.config['DEBUG'] = True
 app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:////tmp/test.db'
--- a/flask_debugtoolbar/init.py
+++ b/flask_debugtoolbar/init.py
@@ -25,6 +25,15 @@ def replace_insensitive(string, target, replacement):
        return string


+def _printable(value):
+    if isinstance(value, unicode):
+        return value.encode('unicode_escape')
+    elif isinstance(value, str):
+        return value.encode('string_escape')
+    else:
+        return repr(value)
+
+
 class DebugToolbarExtension(object):
    _static_dir = os.path.realpath(
        os.path.join(os.path.dirname(__file__), 'static'))
@@ -34,8 +43,9 @@ class DebugToolbarExtension(object):
    def __init__(self, app):
        self.app = app
        self.debug_toolbars = {}
+        self.hosts = ()

-        if not app.debug:
+        if not app.config.get('DEBUG_TB_ENABLED', app.debug):
            return

        if not app.config.get('SECRET_KEY'):
@@ -45,8 +55,11 @@ class DebugToolbarExtension(object):

        DebugToolbar.load_panels(app)

+        self.hosts = app.config.get('DEBUG_TB_HOSTS', ())
+
        self.app.before_request(self.process_request)
        self.app.after_request(self.process_response)
+        self.app.teardown_request(self.teardown_request)

        # Monkey-patch the Flask.dispatch_request method
        app.dispatch_request = self.dispatch_request
@@ -58,6 +71,7 @@ class DebugToolbarExtension(object):
            extensions=['jinja2.ext.i18n'],
            loader=PackageLoader(__name__, 'templates'))
        self.jinja_env.filters['urlencode'] = url_quote_plus
+        self.jinja_env.filters['printable'] = _printable

        app.add_url_rule('/_debug_toolbar/static/<path:filename>',
            '_debug_toolbar.static', self.send_static_file)
@@ -90,6 +104,10 @@ class DebugToolbarExtension(object):
        """Return a boolean to indicate if we need to show the toolbar."""
        if request.path.startswith('/_debug_toolbar/'):
            return False
+
+        if self.hosts and request.remote_addr not in self.hosts:
+            return False
+
        return True

    def send_static_file(self, filename):
@@ -160,6 +178,9 @@ class DebugToolbarExtension(object):

        return response

+    def teardown_request(self, exc):
+        self.debug_toolbars.pop(request._get_current_object(), None)
+
    def render(self, template_name, context):
        template = self.jinja_env.get_template(template_name)
        return template.render(**context)
--- a/flask_debugtoolbar/panels/sqlalchemy.py
+++ b/flask_debugtoolbar/panels/sqlalchemy.py
@@ -1,7 +1,7 @@
 import hashlib

 try:
-    from flaskext.sqlalchemy import get_debug_queries, SQLAlchemy
+    from flask.ext.sqlalchemy import get_debug_queries, SQLAlchemy
 except ImportError:
    sqlalchemy_available = False
    get_debug_queries = SQLAlchemy = None
--- a/flask_debugtoolbar/static/css/toolbar.css
+++ b/flask_debugtoolbar/static/css/toolbar.css
@@ -1,5 +1,4 @@
 /* Debug Toolbar CSS Reset, adapted from Eric Meyer's CSS Reset */
-#flDebug {color:#000;background:#FFF;}
 #flDebug, #flDebug div, #flDebug span, #flDebug applet, #flDebug object, #flDebug iframe,
 #flDebug h1, #flDebug h2, #flDebug h3, #flDebug h4, #flDebug h5, #flDebug h6, #flDebug p, #flDebug blockquote, #flDebug pre,
 #flDebug a, #flDebug abbr, #flDebug acronym, #flDebug address, #flDebug big, #flDebug cite, #flDebug code,
@@ -18,10 +17,16 @@
 	color:#000;
 	vertical-align:baseline;
 	background:transparent;
-	font-family:sans-serif;
+	font-family: inherit;
 	text-align:left;
 }

+#flDebug { font-family: sans-serif; color: #000; background: #fff; }
+
+#flDebug tbody, #flDebug code {
+  font-family: Consolas, Monaco, "Bitstream Vera Sans Mono", "Lucida Console", monospace;
+}
+
 #flDebug #flDebugToolbar {
 	background:#111;
 	width:200px;
@@ -152,7 +157,6 @@

 #flDebug code {
 	display:block;
-	font-family:Consolas, Monaco, "Bitstream Vera Sans Mono", "Lucida Console", monospace;
 	white-space:pre;
 	overflow:auto;
 }
--- a/flask_debugtoolbar/static/img/back.png
+++ b/flask_debugtoolbar/static/img/back.png
--- a/flask_debugtoolbar/static/img/back_hover.png
+++ b/flask_debugtoolbar/static/img/back_hover.png
--- a/flask_debugtoolbar/static/img/close.png
+++ b/flask_debugtoolbar/static/img/close.png
--- a/flask_debugtoolbar/static/img/close_hover.png
+++ b/flask_debugtoolbar/static/img/close_hover.png
--- a/flask_debugtoolbar/static/img/djdt_vertical.png
+++ b/flask_debugtoolbar/static/img/djdt_vertical.png
--- a/flask_debugtoolbar/static/img/indicator.png
+++ b/flask_debugtoolbar/static/img/indicator.png
--- a/flask_debugtoolbar/static/img/panel_bg.png
+++ b/flask_debugtoolbar/static/img/panel_bg.png
--- a/flask_debugtoolbar/static/img/tick-red.png
+++ b/flask_debugtoolbar/static/img/tick-red.png
--- a/flask_debugtoolbar/static/img/tick.png
+++ b/flask_debugtoolbar/static/img/tick.png
--- a/flask_debugtoolbar/static/js/toolbar.js
+++ b/flask_debugtoolbar/static/js/toolbar.js
@@ -1,19 +1,4 @@
-(function(window, document, version, callback) {
-	var j, d;
-	var loaded = false;
-	if (!(j = window.jQuery) || version > j.fn.jquery || callback(j)) {
-		var script = document.createElement("script");
-		script.type = "text/javascript";
-		script.src = DEBUG_TOOLBAR_STATIC_PATH + "js/jquery.js";
-		script.onload = script.onreadystatechange = function() {
-			if (!loaded && (!(d = this.readyState) || d == "loaded" || d == "complete")) {
-				callback((j = window.jQuery).noConflict(1), loaded = true);
-				j(script).remove();
-			}
-		};
-		document.documentElement.childNodes[0].appendChild(script)
-	}
-})(window, document, "1.3", function($, jquery_loaded) {
+(function($) {
    $.cookie = function(name, value, options) { if (typeof value != 'undefined') { options = options || {}; if (value === null) { value = ''; options.expires = -1; } var expires = ''; if (options.expires && (typeof options.expires == 'number' || options.expires.toUTCString)) { var date; if (typeof options.expires == 'number') { date = new Date(); date.setTime(date.getTime() + (options.expires * 24 * 60 * 60 * 1000)); } else { date = options.expires; } expires = '; expires=' + date.toUTCString(); } var path = options.path ? '; path=' + (options.path) : ''; var domain = options.domain ? '; domain=' + (options.domain) : ''; var secure = options.secure ? '; secure' : ''; document.cookie = [name, '=', encodeURIComponent(value), expires, path, domain, secure].join(''); } else { var cookieValue = null; if (document.cookie && document.cookie != '') { var cookies = document.cookie.split(';'); for (var i = 0; i < cookies.length; i++) { var cookie = $.trim(cookies[i]); if (cookie.substring(0, name.length + 1) == (name + '=')) { cookieValue = decodeURIComponent(cookie.substring(name.length + 1)); break; } } } return cookieValue; } };
    $('head').append('<link rel="stylesheet" href="'+DEBUG_TOOLBAR_STATIC_PATH+'css/toolbar.css?'+ Math.random() +'" type="text/css" />');
 	var COOKIE_NAME = 'fldt';
@@ -181,4 +166,4 @@
 		fldt.init();
 	});

-});
+})(jQuery.noConflict(true));
--- a/flask_debugtoolbar/templates/base.html
+++ b/flask_debugtoolbar/templates/base.html
@@ -1,5 +1,6 @@
 <div id="flDebug" style="display:none;">
    <script type="text/javascript">var DEBUG_TOOLBAR_STATIC_PATH = '{{ static_path }}'</script>
+    <script type="text/javascript" src="{{ static_path }}js/jquery.js"></script>
    <script type="text/javascript" src="{{ static_path }}js/toolbar.js"></script>

    <div style="display: none;" id="flDebugToolbar">
--- a/flask_debugtoolbar/templates/panels/headers.html
+++ b/flask_debugtoolbar/templates/panels/headers.html
@@ -7,7 +7,7 @@
 	</thead>
 	<tbody>
 		{% for key, value in headers.iteritems() %}
-			<tr class="{{ loop.cycle('djDebugOdd' 'djDebugEven') }}">
+			<tr class="{{ loop.cycle('flDebugOdd', 'flDebugEven') }}">
 				<td>{{ key|escape }}</td>
 				<td>{{ value|escape }}</td>
 			</tr>
--- a/flask_debugtoolbar/templates/panels/logger.html
+++ b/flask_debugtoolbar/templates/panels/logger.html
@@ -10,7 +10,7 @@
 		</thead>
 		<tbody>
 			{% for record in records %}
-				<tr class="{{ loop.cycle('fjDebugOdd' 'fjDebugEven') }}">
+				<tr class="{{ loop.cycle('flDebugOdd', 'flDebugEven') }}">
 					<td>{{ record.level }}</td>
 					<td>{{ record.time }}</td>
 					<td>{{ record.message }}</td>
--- a/flask_debugtoolbar/templates/panels/profiler.html
+++ b/flask_debugtoolbar/templates/panels/profiler.html
@@ -11,7 +11,7 @@
 	</thead>
 	<tbody>
        {% for row in function_calls %}
-			<tr class="{{ loop.cycle('flDebugOdd' 'flDebugEven') }}">
+			<tr class="{{ loop.cycle('flDebugOdd', 'flDebugEven') }}">
 				<td>{{ row.ncalls }}</td>
 				<td>{{ row.tottime }}</td>
 				<td>{{ '%.4f'|format(row.percall) }}</td>
--- a/flask_debugtoolbar/templates/panels/request_vars.html
+++ b/flask_debugtoolbar/templates/panels/request_vars.html
@@ -1,123 +1,104 @@

 <h4>View information</h4>
 <table>
-	<thead>
-		<tr>
-			<th>View Function</th>
-			<th>args</th>
-			<th>kwargs</th>
-		</tr>
-	</thead>
-	<tbody>
-		<tr>
-			<td>{{ view_func }}</td>
-			<td>{{ view_args|default("None") }}</td>
-			<td>
-			{% if view_kwargs.items() %}
-				{% for k, v in view_kwargs.items() %}
-					{{ k }}={{ v }}{% if not loop.last %}, {% endif %}
-				{% endfor %}
-			{% else %}
-				None
-			{% endif %}
-			</td>
-		</tr>
-	</tbody>
+    <thead>
+        <tr>
+            <th>View Function</th>
+            <th>args</th>
+            <th>kwargs</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>{{ view_func }}</td>
+            <td>{{ view_args|default("None") }}</td>
+            <td>
+            {% if view_kwargs.items() %}
+                {% for k, v in view_kwargs.items() %}
+                    {{ k }}={{ v }}{% if not loop.last %}, {% endif %}
+                {% endfor %}
+            {% else %}
+                None
+            {% endif %}
+            </td>
+        </tr>
+    </tbody>
 </table>

+{% macro show_map(map) %}
+    <table>
+        <colgroup>
+            <col style="width:20%"/>
+            <col/>
+        </colgroup>
+        <thead>
+            <tr>
+                <th>Variable</th>
+                <th>Value</th>
+            </tr>
+        </thead>
+        <tbody>
+            {% for key, value in map %}
+                <tr class="{{ loop.cycle('flDebugOdd', 'flDebugEven') }}">
+                    <td>{{ key|printable }}</td>
+                    <td>{{ value|printable }}</td>
+                </tr>
+            {% endfor %}
+        </tbody>
+    </table>
+{% endmacro %}
+
+
 <h4>COOKIES Variables</h4>
 {% if cookies %}
-	<table>
-		<colgroup>
-			<col style="width:20%"/>
-			<col/>
-		</colgroup>
-		<thead>
-			<tr>
-				<th>Variable</th>
-				<th>Value</th>
-			</tr>
-		</thead>
-		<tbody>
-			{% for key, value in cookies %}
-				<tr class="{{ loop.cycle('flDebugOdd' 'flDebugEven') }}">
-					<td>{{ key|escape }}</td>
-					<td>{{ value|escape }}</td>
-				</tr>
-			{% endfor %}
-		</tbody>
-	</table>
+    {{ show_map(cookies) }}
 {% else %}
-	<p>No COOKIE data</p>
+    <p>No COOKIE data</p>
 {% endif %}

 <h4>SESSION Variables</h4>
 {% if session %}
-	<table>
-		<colgroup>
-			<col style="width:20%"/>
-			<col/>
-		</colgroup>
-		<thead>
-			<tr>
-				<th>Variable</th>
-				<th>Value</th>
-			</tr>
-		</thead>
-		<tbody>
-			{% for key, value in session %}
-				<tr class="{{ loop.cycle('flDebugOdd' 'flDebugEven') }}">
-					<td>{{ key|escape }}</td>
-					<td>{{ value|escape }}</td>
-				</tr>
-			{% endfor %}
-		</tbody>
-	</table>
+    {{ show_map(session) }}
 {% else %}
-	<p>No SESSION data</p>
+    <p>No SESSION data</p>
 {% endif %}

+
+{% macro show_multi_map(map) %}
+    <table>
+        <thead>
+            <tr>
+                <th>Variable</th>
+                <th>Value</th>
+            </tr>
+        </thead>
+        <tbody>
+            {% for key, value in map %}
+                <tr class="{{ loop.cycle('flDebugOdd', 'flDebugEven') }}">
+                    <td>{{ key|printable }}</td>
+                    <td>
+                      {%- set sep = joiner() -%}
+                      {%- for v in value -%}
+                          {{ sep() }}{{ v|printable }}
+                      {%- endfor -%}
+                    </td>
+                </tr>
+            {% endfor %}
+        </tbody>
+    </table>
+{% endmacro %}
+
+
 <h4>GET Variables</h4>
 {% if get %}
-	<table>
-		<thead>
-			<tr>
-				<th>Variable</th>
-				<th>Value</th>
-			</tr>
-		</thead>
-		<tbody>
-			{% for key, value in get %}
-				<tr class="{{ loop.cycle('flDebugOdd' 'flDebugEven') }}">
-					<td>{{ key|escape }}</td>
-					<td>{{ value|join(", ")|escape }}</td>
-				</tr>
-			{% endfor %}
-		</tbody>
-	</table>
+    {{ show_multi_map(get) }}
 {% else %}
-	<p>No GET data</p>
+    <p>No GET data</p>
 {% endif %}

 <h4>POST Variables</h4>
 {% if post %}
-	<table>
-		<thead>
-			<tr>
-				<th>Variable</th>
-				<th>Value</th>
-			</tr>
-		</thead>
-		<tbody>
-			{% for key, value in post %}
-				<tr class="{{ loop.cycle('row1' 'row2') }}">
-					<td>{{ key|escape }}</td>
-					<td>{{ value|join(", ")|escape }}</td>
-				</tr>
-			{% endfor %}
-		</tbody>
-	</table>
+    {{ show_multi_map(post) }}
 {% else %}
-	<p>No POST data</p>
+    <p>No POST data</p>
 {% endif %}
-
--- a/flask_debugtoolbar/templates/panels/sqlalchemy.html
+++ b/flask_debugtoolbar/templates/panels/sqlalchemy.html
@@ -9,7 +9,7 @@
 	</thead>
 	<tbody>
 		{% for query in queries %}
-			<tr class="{{ loop.cycle('flDebugOdd' 'flDebugEven') }}">
+			<tr class="{{ loop.cycle('flDebugOdd', 'flDebugEven') }}">
 				<td>{{ '%.4f'|format(query.duration) }}</td>
 				<td>
 				{% if query.params %}
@@ -26,7 +26,7 @@
                    {{ query.context }}
 				</td>
 				<td class="syntax">
-					<div class="djDebugSqlWrap">
+					<div class="flDebugSqlWrap">
 						<div class="flDebugSql">{{ query.sql|safe }}</div>
                        {#
 						{% if query.stacktrace %}
--- a/flask_debugtoolbar/templates/panels/sqlalchemy_explain.html
+++ b/flask_debugtoolbar/templates/panels/sqlalchemy_explain.html
@@ -10,7 +10,7 @@
 			<dt>Time</dt>
 			<dd>{{ '%.4f'|format(duration) }} ms</dd>
 		</dl>
-		<table class="djSqlExplain">
+		<table class="flSqlExplain">
 			<thead>
 				<tr>
 					{% for h in headers %}
@@ -20,7 +20,7 @@
 			</thead>
 			<tbody>
 				{% for row in result %}
-				    <tr class="{{ loop.cycle('fjDebugOdd' 'fjDebugEven') }}">
+				    <tr class="{{ loop.cycle('fjDebugOdd', 'fjDebugEven') }}">
 						{% for column in row %}
 							<td>{{ column }}</td>
 						{% endfor %}
--- a/flask_debugtoolbar/templates/panels/sqlalchemy_select.html
+++ b/flask_debugtoolbar/templates/panels/sqlalchemy_select.html
@@ -21,7 +21,7 @@
 			</thead>
 			<tbody>
 				{% for row in result %}
-				    <tr class="{{ loop.cycle('fjDebugOdd' 'fjDebugEven') }}">
+				    <tr class="{{ loop.cycle('flDebugOdd', 'flDebugEven') }}">
 						{% for column in row %}
 							<td>{{ column }}</td>
 						{% endfor %}
--- a/flask_debugtoolbar/templates/panels/template.html
+++ b/flask_debugtoolbar/templates/panels/template.html
@@ -1,22 +1,23 @@
 {% if templates %}
-	<table>
-		<thead>
-			<tr>
-				<th>Filename</th>
-				<th>Context vars</th>
-			</tr>
-		</thead>
-		<tbody>
-			{% for template in templates %}
-				<tr class="{{ loop.cycle('fjDebugOdd' 'fjDebugEven') }}">
-					<td>{{ template.template.name }}</td>
-					<td>{{ template.context.keys()|join(', ') }}</td>
-				</tr>
-			{% endfor %}
-		</tbody>
-	</table>
+    {% for template in templates %}
+        <h4>{{ template.template.name }}</h4>
+        <table>
+            <thead>
+            <tr>
+                <th>Variable</th>
+                <th>Value</th>
+            </tr>
+            </thead>
+            <tbody>
+            {% for k, v in template.context|dictsort %}
+                <tr class="{{ loop.cycle('flDebugOdd', 'flDebugEven') }}">
+                    <td>{{ k }}</td>
+                    <td>{{ v|printable }}</td>
+                </tr>
+            {% endfor %}
+            </tbody>
+        </table>
+    {% endfor %}
 {% else %}
-	<p>No templates rendered.</p>
+    <p>No template rendered</p>
 {% endif %}
-
-
--- a/flask_debugtoolbar/toolbar.py
+++ b/flask_debugtoolbar/toolbar.py
@@ -1,3 +1,5 @@
+import urllib
+
 from flask import url_for, current_app


@@ -52,7 +54,8 @@ class DebugToolbar(object):
        """
        Populate debug panels
        """
-        activated = self.request.cookies.get('fldt_active', '').split(';')
+        activated = self.request.cookies.get('fldt_active', '')
+        activated = urllib.unquote(activated).split(';')

        for panel_class in self.panel_classes:
            panel_instance = panel_class(
--- a/setup.py
+++ b/setup.py
@@ -1,9 +1,20 @@
+import os
 from setuptools import setup, find_packages


+here = os.path.abspath(os.path.dirname(__file__))
+
+try:
+    README = open(os.path.join(here, 'README.rst')).read()
+    CHANGES = open(os.path.join(here, 'CHANGES.rst')).read()
+except:
+    README = ''
+    CHANGES = ''
+
+
 setup(
    name='Flask-DebugToolbar',
-    version='0.6',
+    version='0.6.3',
    url='http://github.com/mgood/flask-debugtoolbar',
    license='BSD',
    author='Michael van Tellingen',
@@ -11,7 +22,7 @@ setup(
    maintainer='Matt Good',
    maintainer_email='matt@matt-good.net',
    description='A port of the Django debug toolbar to Flask',
-    long_description=__doc__,
+    long_description=README + '\n\n' + CHANGES,
    zip_safe=False,
    platforms='any',
    include_package_data=True,
@@ -19,7 +30,6 @@ setup(
              'flask_debugtoolbar.panels'
    ],
    install_requires=[
-        'setuptools',
        'Flask>=0.8',
        'Blinker',
    ],
Author	SHA1	Message	Date
Matt Good	f84087156a	Prepare 0.6.3 release	2012-04-16 13:15:26 -07:00
Matt Good	56be56de86	Fix import for Flask-SQLAlchemy 0.16 Use the "flask.ext" import for compatibility with old and new versions	2012-04-16 13:12:26 -07:00
Matt Good	7e8a8e280e	Merge pull request #18 from mattoufoutu/master display context variables values in the "templates" panel	2012-02-23 09:23:22 -08:00
Mathieu D. (MatToufoutu)	672fdb59e6	remove unused outer_loop variable	2012-02-23 18:15:16 +01:00
Mathieu D. (MatToufoutu)	b5a6fbe839	use dictsort instead of items() to display variables alphabetically ordered	2012-02-23 18:14:02 +01:00
Mathieu D. (MatToufoutu)	824f73d9aa	minor fixes in the templates	2012-02-23 14:40:02 +01:00
Mathieu D. (MatToufoutu)	d8d2fb7a85	display context variable values in the templates panel	2012-02-23 14:33:42 +01:00
Matt Good	8a922a2a5c	Cookie for list of "active" panels needs decoded before splitting	2012-02-20 14:14:53 -08:00
Matt Good	ba56f81d19	Preparse 0.6.2 release	2012-02-18 14:22:04 -08:00
Matt Good	002dea199e	Simplify jQuery.noConflict mode to fix #16	2012-02-18 14:18:41 -08:00
Matt Good	bb99b48833	Remove trailing slashes in MANIFEST.in since Windows doesn't like them (fixes #17)	2012-02-18 13:41:17 -08:00
Matt Good	210dfb48fc	Link from docs to GitHub project	2012-02-15 18:54:12 -08:00
Matt Good	7e83d45d6c	Add some basic Sphinx docs (fixes #12 )	2012-02-15 18:49:03 -08:00
Matt Good	6d268ba00b	Add skeleton for Sphinx docs (re #12 )	2012-02-15 18:15:41 -08:00
Matt Good	e92c102bc9	Prepare 0.6.1 release	2012-02-15 12:35:58 -08:00
Matt Good	20a302c3b4	Fix request vars display for non-string values (fixes #14 )	2012-02-15 12:28:28 -08:00
Matt Good	bdbc570c91	Fix memory leak from holding reference to toolbar (fixes #10 )	2012-02-14 23:56:36 -08:00
Matt Good	17b629742d	Add protocol to django-debug-toolbar link in readme	2012-02-14 19:17:49 -08:00
Matt Good	54a18b8cf2	Improve the readme example (fixes #8 )	2012-02-14 19:14:37 -08:00
Matt Good	a48efe822a	Escape non-printable values in request vars panel (fixes #9 )	2012-02-14 18:51:21 -08:00
Matt Good	45ce65c058	Merge branch 'mono-fonts'	2012-01-31 11:03:38 -08:00
Matt Good	89fbe2e6b5	Let DEBUG_TB_ENABLED take precedence over app.debug	2012-01-31 11:02:30 -08:00
Matt Good	e5feff5884	Merge pull request #7 from joeshaw/joeshaw-enabled-setting add DEBUG_TB_ENABLED setting which overrides app.debug check	2012-01-31 10:59:32 -08:00
Matt Good	93008a8e53	Make table bodies use mono-spaced font	2012-01-31 10:52:55 -08:00
Matt Good	8bb829e1e4	Make font reset easier to override	2012-01-31 10:25:17 -08:00
Matt Good	70478ffcc2	Merge pull request #5 from kennethreitz/patch-1 Requiring setuptools is evil :)	2012-01-31 00:50:27 -08:00
Joe Shaw	6f6b1cb47d	add DEBUG_TB_ENABLED setting which overrides app.debug check	2012-01-30 23:41:43 -05:00
Kenneth Reitz	1834443246	Requiring setuptools is evil :)	2012-01-30 22:26:37 -05:00
Matt Good	c3c2714ace	Merge pull request #3 from kennethreitz/readme Updated Readme	2012-01-30 17:50:38 -08:00
Kenneth Reitz	884451669c	(sp)	2012-01-30 20:48:03 -05:00
Matt Good	0bdc3f7e59	Merge pull request #2 from kennethreitz/logo Flask Logo	2012-01-30 17:47:45 -08:00
Kenneth Reitz	43b069905d	readme fix	2012-01-30 20:46:41 -05:00
Kenneth Reitz	d85ce273af	squash all the PNGs	2012-01-30 20:42:00 -05:00
Kenneth Reitz	69d137c2d7	new django flask icon	2012-01-30 20:41:50 -05:00
Kenneth Reitz	7988e5f472	new read me	2012-01-30 20:29:57 -05:00
Matt Good	1c8465cdd9	Minor style update (trailing whitespace and "if len()")	2012-01-04 08:49:25 -08:00
Matt Good	f59705a7e7	Merge commit 'd886f5a606f26d78df457e7041c5666e0e5bbc6d'	2012-01-04 08:42:21 -08:00
Dmitry Ishutkin	d886f5a606	add hosts setting app.config['DEBUG_TB_HOSTS'] Example: app.config['DEBUG_TB_HOSTS'] = ( '127.0.0.1', '::1' ) If the request’s REMOTE_ADDR is not in this list, the toolbar will not be displayed and the exception handler will not be active. This should be a tuple. Default: (). Empty list remains backward compatibility. If DEBUG_TB_HOSTS not specified in app.config, the debug toolbar is shown for all addresses.	2011-09-30 18:30:56 +08:00