pyramid-debugtoolbar-api-sqlalchemy 0.3.0__tar.gz → 1.0.0__tar.gz

pyramid_debugtoolbar_api_sqlalchemy-1.0.0/CHANGES.txt

@@ -0,0 +1,47 @@
+v1.0.0
+* Add a spreadsheet=1 CSV option that prefixes formula-like text fields.
+* Harden CSV download headers and preserve Unicode SQL in Python 3 exports.
+* Consolidate packaging and tox settings and extend CI through Python 3.15.
+* add tests/__init__.py
+
+v0.3.1
+* packaging
+
+v0.3.0
+* updated debugtoolbar includes
+* improved tests
+* black & upgraded black; 20.8b1
+* integrated with pre-commit
+* tox and tests
+* migrated README to rst
+
+
+v0.2.1 | 2019.05.01
+includeme registers the panel via the api method `config.add_debugtoolbar_panel()`
+
+v0.2.0 | 2019.04.29
+* python3 support
+
+v0.1.2 | 2017.12.06
+* ported a functionality to current debugtoolbar api
+* store version as __VERSION__ in /__init__.py
+
+v0.1.1 | 2017.05.10
+* changes after making a performance version of this panel
+* renamed the route
+* making data visible to the template
+* packaging fix, the templates weren't distributing
+
+v0.1.0 | 2017.05.10
+* this works off the new pyramid_debutoolbar>=4.0 api.  no longer a dirty hack!
+* please use `debugtoolbar.includes`
+* changed the url for queries
+* renamed to pyramid_debugtoolbar_api_sqlalchemy
+
+v0.0.2 | 2014.12.16
+* fixed namings to `pyramid_debugtoolbar_api_sqla`
+
+v0.0.1 | 2014.12.16
+* initial import
+
+

pyramid_debugtoolbar_api_sqlalchemy-1.0.0/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 jvanasco
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

pyramid_debugtoolbar_api_sqlalchemy-1.0.0/MANIFEST.in

@@ -0,0 +1,10 @@
+graft src
+graft tests
+
+include setup.cfg pyproject.toml
+include CHANGES.txt
+include LICENSE
+include README.rst
+include TODO.txt
+
+recursive-exclude * __pycache__ *.py[cod] .DS_Store

pyramid_debugtoolbar_api_sqlalchemy-1.0.0/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: pyramid_debugtoolbar_api_sqlalchemy
+Version: 1.0.0
+Summary: SQLAlchemy CSV exporting for pyramid_debugtoolbar
+Home-page: https://github.com/jvanasco/pyramid_debugtoolbar_api_sqlalchemy
+Author: Jonathan Vanasco
+Author-email: jvanasco@2xlp.com
+License: MIT
+Keywords: web,pyramid,sqlalchemy
+Classifier: Intended Audience :: Developers
+Classifier: Framework :: Pyramid
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Requires-Python: !=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: pyramid
+Requires-Dist: pyramid_debugtoolbar>=4.0
+Requires-Dist: six
+Requires-Dist: sqlalchemy
+Requires-Dist: setuptools<82; python_version >= "3.7" and python_version < "3.10"
+Provides-Extra: testing
+Requires-Dist: coverage; extra == "testing"
+Requires-Dist: pytest; extra == "testing"
+Dynamic: license-file
+
+pyramid_debugtoolbar_api_sqlalchemy
+===================================
+
+.. image:: https://github.com/jvanasco/pyramid_debugtoolbar_api_sqlalchemy/workflows/Python%20package/badge.svg
+        :alt: Build Status
+
+`pyramid_debugtoolbar_api_sqlalchemy` extends the existing `pyramid_debugtoolbar`
+SQLAlchemy Panel to support downloadable CSV files of profiling data.
+
+This package does not replace the default panel, and requires it to be active.
+
+This package is designed for application profile and to be a useful part of test
+suites, allowing developers to run a series of tests and log the SQLAlchemy
+performance.
+
+If you are using the debugtoolbar directly:
+
+* If SQLAlchemy queries exist on the request, a "SQLAlchemy CSV" tab will appear.
+  That will prompt you for queries.
+
+If you are scripting:
+
+* The urls are generated in a machine-friendly format, so you can regex the
+  `request_id` off a page and pull it from the API.  this is explained below:
+
+
+NOTES:
+======
+
+This packages requires pyramid_debugtoolbar 4.0 or newer
+
+
+How to use this package
+=======================
+
+
+Update your ENVIRONMENT.ini file
+
+.. code-block:: python
+
+    debugtoolbar.includes = pyramid_debugtoolbar_api_sqlalchemy
+
+You MUST be using `pyramid_debugtoolbar` with the SQLAlchemy panel enabled.
+This just piggybacks on the existing module's work to log queries.
+
+You MUST use `debugtoolbar.includes`.  This will not work properly via `pyramid.includes`
+
+You can access a csv of the SQLAlchemy report via the following url hack:
+
+.. code-block:: python
+
+    url_html = '/_debug_toolbar/{request_id}'
+    url_api =  '/_debug_toolbar/api-sqlalchemy/sqlalchemy-{request_id}.csv'
+    
+The file will be downloaded and offer a content-disposition as:
+
+    sqlalchemy-{request_id}.csv
+
+The CSV columns are:
+
+* execution timing
+* SQLAlchemy query
+* query params (json encoded)
+
+
+Configuration
+=======================
+
+By default, this package writes CSV files using "UTF-8" encoding.
+
+To change this, use the environment variable `pyramid_debugtoolbar_api_sqlalchemy_encoding`
+
+.. code-block:: shell
+
+	export pyramid_debugtoolbar_api_sqlalchemy_encoding=ascii

pyramid_debugtoolbar_api_sqlalchemy-1.0.0/pyproject.toml

@@ -0,0 +1,7 @@
+[build-system]
+requires = ["setuptools>=40.8", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.black]
+target-version = ['py35']
+

pyramid_debugtoolbar_api_sqlalchemy-1.0.0/setup.cfg

@@ -0,0 +1,68 @@
+[metadata]
+name = pyramid_debugtoolbar_api_sqlalchemy
+version = attr: pyramid_debugtoolbar_api_sqlalchemy._version.__VERSION__
+description = SQLAlchemy CSV exporting for pyramid_debugtoolbar
+long_description = file: README.rst
+long_description_content_type = text/x-rst
+author = Jonathan Vanasco
+author_email = jvanasco@2xlp.com
+url = https://github.com/jvanasco/pyramid_debugtoolbar_api_sqlalchemy
+keywords = web, pyramid, sqlalchemy
+license = MIT
+license_file = LICENSE
+classifiers = 
+	Intended Audience :: Developers
+	Framework :: Pyramid
+	Programming Language :: Python
+	Programming Language :: Python :: 2.7
+	Programming Language :: Python :: 3.5
+	Programming Language :: Python :: 3.6
+	Programming Language :: Python :: 3.7
+	Programming Language :: Python :: 3.8
+	Programming Language :: Python :: 3.9
+	Programming Language :: Python :: 3.10
+	Programming Language :: Python :: 3.11
+	Programming Language :: Python :: 3.12
+	Programming Language :: Python :: 3.13
+	Programming Language :: Python :: 3.14
+	Programming Language :: Python :: 3.15
+
+[options]
+packages = find:
+package_dir = 
+	= src
+include_package_data = False
+zip_safe = False
+python_requires = >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
+install_requires = 
+	pyramid
+	pyramid_debugtoolbar>=4.0
+	six
+	sqlalchemy
+	setuptools<82; python_version >= "3.7" and python_version < "3.10"
+
+[options.packages.find]
+where = src
+
+[options.package_data]
+pyramid_debugtoolbar_api_sqlalchemy = templates/*.dbtmako
+
+[options.extras_require]
+testing = 
+	coverage
+	pytest
+
+[tox:tox]
+envlist = py27, py35, py36, py37, py38, py39, py310, py311, py312, py313, py314, py315
+
+[testenv]
+extras = testing
+commands = 
+	python --version
+	python -m coverage run --source=pyramid_debugtoolbar_api_sqlalchemy -m pytest {posargs:}
+	python -m coverage html -d {envtmpdir}/coverage
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

{pyramid_debugtoolbar_api_sqlalchemy-0.3.0 → pyramid_debugtoolbar_api_sqlalchemy-1.0.0/src}/pyramid_debugtoolbar_api_sqlalchemy/__init__.py

@@ -1,8 +1,4 @@
-# local
-from .panels import SqlalchemyCsvDebugPanel
-
-
-__VERSION__ = "0.3.0"
+from ._version import __VERSION__
 
 
 # ==============================================================================
@@ -16,6 +12,9 @@ def includeme(config):
 
         debugtoolbar.includes = pyramid_debugtoolbar_api_sqlalchemy
     """
+    # Legacy setuptools imports this package to discover the version.
+    from .panels import SqlalchemyCsvDebugPanel
+
     config.add_debugtoolbar_panel(SqlalchemyCsvDebugPanel)
     config.add_route(
         "debugtoolbar.api_sqlalchemy.queries.csv",

pyramid_debugtoolbar_api_sqlalchemy-1.0.0/src/pyramid_debugtoolbar_api_sqlalchemy/_version.py

@@ -0,0 +1,3 @@
+"""Package version shared by runtime and build metadata."""
+
+__VERSION__ = "1.0.0"

pyramid_debugtoolbar_api_sqlalchemy-1.0.0/src/pyramid_debugtoolbar_api_sqlalchemy/spreadsheet_utils.py

@@ -0,0 +1,14 @@
+"""Helpers for exporting text fields to spreadsheet CSV files."""
+
+from six import text_type
+
+
+def sanitize_spreadsheet_cell(value):
+    # type: (text_type) -> text_type
+    """Prefix formula-like text with a spreadsheet text marker."""
+    stripped = value.lstrip()
+    if value.startswith((u"\t", u"\r", u"\n")) or stripped.startswith(
+        (u"=", u"+", u"-", u"@", u"\uff1d", u"\uff0b", u"\uff0d", u"\uff20")
+    ):
+        return u"'" + value
+    return value

pyramid_debugtoolbar_api_sqlalchemy-1.0.0/src/pyramid_debugtoolbar_api_sqlalchemy/views.py

@@ -0,0 +1,60 @@
+import csv
+import os
+import re
+
+from pyramid.exceptions import NotFound
+from pyramid.request import Request
+from pyramid.response import Response
+from pyramid.view import view_config
+from six import PY2, StringIO, binary_type, text_type
+
+from .spreadsheet_utils import sanitize_spreadsheet_cell
+from .utils import get_sqlalchemy_panel
+
+
+ENCODING = os.environ.get("pyramid_debugtoolbar_api_sqlalchemy_encoding", "utf-8")
+
+
+@view_config(route_name="debugtoolbar.api_sqlalchemy.queries.csv")
+def queries_api_csv(request):
+    # type: (Request) -> Response
+    """Export the recorded SQL queries for the requested toolbar entry."""
+    request_id = request.matchdict["request_id"]
+    toolbar = request.pdtb_history.get(request_id, None)
+    if toolbar is None:
+        raise NotFound
+
+    panel = get_sqlalchemy_panel(toolbar.panels)
+    if panel is None:
+        raise NotFound
+
+    spreadsheet = request.GET.get("spreadsheet") == "1"
+    csvfile = StringIO()
+    writer = csv.writer(csvfile)
+    for query in panel.data.get("queries", ()):
+        sql = query["raw_sql"]
+        parameters = query["parameters"]
+        if spreadsheet:
+            sql = sanitize_spreadsheet_cell(sql)
+            if parameters is not None:
+                if isinstance(parameters, binary_type):
+                    parameters = parameters.decode(ENCODING, "replace")
+                else:
+                    parameters = text_type(parameters)
+                parameters = sanitize_spreadsheet_cell(parameters)
+                if PY2:
+                    parameters = parameters.encode(ENCODING)
+        if PY2:
+            sql = sql.encode(ENCODING)
+        writer.writerow((query["duration"], sql, parameters))
+
+    response = Response(
+        content_type="text/csv", body=csvfile.getvalue(), charset=ENCODING
+    )
+    safe_id = re.sub(r"[^a-zA-Z0-9_-]", "_", request_id)
+    suffix = "-spreadsheet" if spreadsheet else ""
+    response.headers["Content-Disposition"] = str(
+        'attachment; filename="sqlalchemy-%s%s.csv"' % (safe_id, suffix)
+    )
+    response.cache_control.no_store = True
+    return response

pyramid_debugtoolbar_api_sqlalchemy-1.0.0/src/pyramid_debugtoolbar_api_sqlalchemy.egg-info/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: pyramid_debugtoolbar_api_sqlalchemy
+Version: 1.0.0
+Summary: SQLAlchemy CSV exporting for pyramid_debugtoolbar
+Home-page: https://github.com/jvanasco/pyramid_debugtoolbar_api_sqlalchemy
+Author: Jonathan Vanasco
+Author-email: jvanasco@2xlp.com
+License: MIT
+Keywords: web,pyramid,sqlalchemy
+Classifier: Intended Audience :: Developers
+Classifier: Framework :: Pyramid
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Requires-Python: !=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: pyramid
+Requires-Dist: pyramid_debugtoolbar>=4.0
+Requires-Dist: six
+Requires-Dist: sqlalchemy
+Requires-Dist: setuptools<82; python_version >= "3.7" and python_version < "3.10"
+Provides-Extra: testing
+Requires-Dist: coverage; extra == "testing"
+Requires-Dist: pytest; extra == "testing"
+Dynamic: license-file
+
+pyramid_debugtoolbar_api_sqlalchemy
+===================================
+
+.. image:: https://github.com/jvanasco/pyramid_debugtoolbar_api_sqlalchemy/workflows/Python%20package/badge.svg
+        :alt: Build Status
+
+`pyramid_debugtoolbar_api_sqlalchemy` extends the existing `pyramid_debugtoolbar`
+SQLAlchemy Panel to support downloadable CSV files of profiling data.
+
+This package does not replace the default panel, and requires it to be active.
+
+This package is designed for application profile and to be a useful part of test
+suites, allowing developers to run a series of tests and log the SQLAlchemy
+performance.
+
+If you are using the debugtoolbar directly:
+
+* If SQLAlchemy queries exist on the request, a "SQLAlchemy CSV" tab will appear.
+  That will prompt you for queries.
+
+If you are scripting:
+
+* The urls are generated in a machine-friendly format, so you can regex the
+  `request_id` off a page and pull it from the API.  this is explained below:
+
+
+NOTES:
+======
+
+This packages requires pyramid_debugtoolbar 4.0 or newer
+
+
+How to use this package
+=======================
+
+
+Update your ENVIRONMENT.ini file
+
+.. code-block:: python
+
+    debugtoolbar.includes = pyramid_debugtoolbar_api_sqlalchemy
+
+You MUST be using `pyramid_debugtoolbar` with the SQLAlchemy panel enabled.
+This just piggybacks on the existing module's work to log queries.
+
+You MUST use `debugtoolbar.includes`.  This will not work properly via `pyramid.includes`
+
+You can access a csv of the SQLAlchemy report via the following url hack:
+
+.. code-block:: python
+
+    url_html = '/_debug_toolbar/{request_id}'
+    url_api =  '/_debug_toolbar/api-sqlalchemy/sqlalchemy-{request_id}.csv'
+    
+The file will be downloaded and offer a content-disposition as:
+
+    sqlalchemy-{request_id}.csv
+
+The CSV columns are:
+
+* execution timing
+* SQLAlchemy query
+* query params (json encoded)
+
+
+Configuration
+=======================
+
+By default, this package writes CSV files using "UTF-8" encoding.
+
+To change this, use the environment variable `pyramid_debugtoolbar_api_sqlalchemy_encoding`
+
+.. code-block:: shell
+
+	export pyramid_debugtoolbar_api_sqlalchemy_encoding=ascii

pyramid_debugtoolbar_api_sqlalchemy-1.0.0/src/pyramid_debugtoolbar_api_sqlalchemy.egg-info/SOURCES.txt

@@ -0,0 +1,22 @@
+CHANGES.txt
+LICENSE
+MANIFEST.in
+README.rst
+TODO.txt
+pyproject.toml
+setup.cfg
+src/pyramid_debugtoolbar_api_sqlalchemy/__init__.py
+src/pyramid_debugtoolbar_api_sqlalchemy/_version.py
+src/pyramid_debugtoolbar_api_sqlalchemy/panels.py
+src/pyramid_debugtoolbar_api_sqlalchemy/spreadsheet_utils.py
+src/pyramid_debugtoolbar_api_sqlalchemy/utils.py
+src/pyramid_debugtoolbar_api_sqlalchemy/views.py
+src/pyramid_debugtoolbar_api_sqlalchemy.egg-info/PKG-INFO
+src/pyramid_debugtoolbar_api_sqlalchemy.egg-info/SOURCES.txt
+src/pyramid_debugtoolbar_api_sqlalchemy.egg-info/dependency_links.txt
+src/pyramid_debugtoolbar_api_sqlalchemy.egg-info/not-zip-safe
+src/pyramid_debugtoolbar_api_sqlalchemy.egg-info/requires.txt
+src/pyramid_debugtoolbar_api_sqlalchemy.egg-info/top_level.txt
+src/pyramid_debugtoolbar_api_sqlalchemy/templates/sqlalchemy_csv.dbtmako
+tests/__init__.py
+tests/test_config.py

pyramid_debugtoolbar_api_sqlalchemy-1.0.0/src/pyramid_debugtoolbar_api_sqlalchemy.egg-info/requires.txt

@@ -0,0 +1,11 @@
+pyramid
+pyramid_debugtoolbar>=4.0
+six
+sqlalchemy
+
+[:python_version >= "3.7" and python_version < "3.10"]
+setuptools<82
+
+[testing]
+coverage
+pytest

pyramid_debugtoolbar_api_sqlalchemy-1.0.0/tests/test_config.py

@@ -0,0 +1,197 @@
+# coding=utf-8
+from __future__ import print_function
+from __future__ import unicode_literals
+
+# stdlib
+import re
+import unittest
+
+# pyramid testing requirements
+from pyramid import testing
+from pyramid.exceptions import ConfigurationError
+from pyramid.response import Response
+from pyramid.request import Request
+
+import sqlalchemy
+
+
+# ------------------------------------------------------------------------------
+
+
+# used to ensure the toolbar link is injected into requests
+re_toolbar_link = re.compile(r'(?:href="http://localhost)(/_debug_toolbar/[\d]+)"')
+re_csv_link = re.compile(
+    r'href="(/_debug_toolbar/api-sqlalchemy/sqlalchemy-([\d]+).csv)"'
+)
+
+
+class TestDebugtoolbarPanel_NoSqlAlchemy(unittest.TestCase):
+    def setUp(self):
+        def view_no_sqlalchemy(request):
+            return Response(
+                "<html><head></head><body>OK</body></html>", content_type="text/html"
+            )
+
+        self.config = config = testing.setUp()
+        config.add_settings(
+            {"debugtoolbar.includes": ["pyramid_debugtoolbar_api_sqlalchemy"]}
+        )
+        config.include("pyramid_debugtoolbar")
+        self.settings = config.registry.settings
+
+        config.add_view(view_no_sqlalchemy)
+
+    def tearDown(self):
+        testing.tearDown()
+
+    def test_panel_injected(self):
+
+        # make the app
+        app = self.config.make_wsgi_app()
+        # make a request
+        req1 = Request.blank("/")
+        req1.remote_addr = "127.0.0.1"
+        resp1 = req1.get_response(app)
+        self.assertEqual(resp1.status_code, 200)
+        self.assertIn("http://localhost/_debug_toolbar/", resp1.text)
+
+        # check the toolbar
+        links = re_toolbar_link.findall(resp1.text)
+        self.assertIsNotNone(links)
+        self.assertIsInstance(links, list)
+        self.assertEqual(len(links), 1)
+        toolbar_link = links[0]
+
+        req2 = Request.blank(toolbar_link)
+        req2.remote_addr = "127.0.0.1"
+        resp2 = req2.get_response(app)
+        self.assertEqual(resp2.status_code, 200)
+
+        self.assertIn(
+            '<li class="disabled" id="pDebugPanel-sqlalchemy-csv">', resp2.text
+        )
+        self.assertNotIn(
+            '<div id="pDebugPanel-sqlalchemy-csv-content"',
+            resp2.text,
+        )
+
+
+class TestDebugtoolbarPanel_HasSqlAlchemy(unittest.TestCase):
+    def setUp(self):
+        def view_has_sqlalchemy(request):
+
+            engine = sqlalchemy.create_engine("sqlite://")
+            conn = engine.connect()
+            result = conn.execute(sqlalchemy.sql.text("-- CSV marker\nSELECT NULL;"))
+            # toss in another select statement with a unicode party hat
+            result = conn.execute(sqlalchemy.sql.text("SELECT NULL; -- 🎉"))
+            # make sure we encode bindparams correctly
+            stmt = sqlalchemy.sql.text(
+                "SELECT NULL = :party_hat or :int or :float or :text or :bool;"
+            )
+            stmt = stmt.bindparams(
+                party_hat="🎉",
+                int=1,
+                float=1.0,
+                text="text",
+                bool=False,
+            )
+            result = conn.execute(stmt)
+            return Response(
+                "<html><head></head><body>OK</body></html>", content_type="text/html"
+            )
+
+        self.config = config = testing.setUp()
+        config.add_settings(
+            {"debugtoolbar.includes": ["pyramid_debugtoolbar_api_sqlalchemy"]}
+        )
+        config.include("pyramid_debugtoolbar")
+        self.settings = config.registry.settings
+
+        config.add_view(view_has_sqlalchemy)
+        config.add_notfound_view(lambda request: Response(status=404))
+
+    def tearDown(self):
+        testing.tearDown()
+
+    def test_panel_injected(self):
+
+        # make the app
+        app = self.config.make_wsgi_app()
+        # make a request
+        req1 = Request.blank("/")
+        req1.remote_addr = "127.0.0.1"
+        resp1 = req1.get_response(app)
+        self.assertEqual(resp1.status_code, 200)
+        self.assertIn("http://localhost/_debug_toolbar/", resp1.text)
+
+        # check the toolbar
+        links = re_toolbar_link.findall(resp1.text)
+        self.assertIsNotNone(links)
+        self.assertIsInstance(links, list)
+        self.assertEqual(len(links), 1)
+        toolbar_link = links[0]
+
+        req2 = Request.blank(toolbar_link)
+        req2.remote_addr = "127.0.0.1"
+        resp2 = req2.get_response(app)
+        self.assertEqual(resp2.status_code, 200)
+        self.assertIn('<li class="" id="pDebugPanel-sqlalchemy-csv">', resp2.text)
+        self.assertIn(
+            '<div id="pDebugPanel-sqlalchemy-csv-content"',
+            resp2.text,
+        )
+        self.assertIn(
+            "SqlAclhemy queries are available for this request as a CSV via the link below:",
+            resp2.text,
+        )
+
+        # csv
+        match = re_csv_link.search(resp2.text)
+        self.assertTrue(match)
+        (_csv_link, _id) = match.groups()
+        req3 = Request.blank(_csv_link)
+        req3.remote_addr = "127.0.0.1"
+        resp3 = req3.get_response(app)
+        self.assertEqual(resp3.status_code, 200)
+        self.assertIn("SELECT NULL;", resp3.text)
+        self.assertIn("SELECT NULL; -- 🎉", resp3.text)
+        self.assertEqual(
+            resp3.headers["Content-Disposition"],
+            'attachment; filename="sqlalchemy-%s.csv"' % _id,
+        )
+        self.assertTrue(resp3.cache_control.no_store)
+        spreadsheet = Request.blank(_csv_link + "?spreadsheet=1")
+        spreadsheet.remote_addr = "127.0.0.1"
+        exported = spreadsheet.get_response(app)
+        self.assertEqual(exported.status_code, 200)
+        self.assertTrue(exported.cache_control.no_store)
+        self.assertIn("-spreadsheet.csv", exported.headers["Content-Disposition"])
+        self.assertIn(',"-- CSV marker', resp3.text)
+        self.assertIn(",\"'-- CSV marker", exported.text)
+        self.assertIn("SELECT NULL; -- 🎉", exported.text)
+
+        denied = Request.blank(_csv_link)
+        denied.remote_addr = "192.0.2.1"
+        self.assertEqual(denied.get_response(app).status_code, 404)
+
+    def test_csv_missing_history(self):
+        # type: () -> None
+        """Return 404 for a request absent from toolbar history."""
+        app = self.config.make_wsgi_app()
+        request = Request.blank("/_debug_toolbar/api-sqlalchemy/sqlalchemy-missing.csv")
+        request.remote_addr = "127.0.0.1"
+        self.assertEqual(request.get_response(app).status_code, 404)
+
+
+class TestSpreadsheetCell(unittest.TestCase):
+    def test_formula_like_text(self):
+        """Prefix formula-like text while preserving ordinary SQL."""
+        from pyramid_debugtoolbar_api_sqlalchemy.spreadsheet_utils import (
+            sanitize_spreadsheet_cell,
+        )
+
+        for value in ("=1", " +1", "-1", "@x", "\ttext", "\rtext", "\ntext", "\uff1d1"):
+            self.assertEqual(sanitize_spreadsheet_cell(value), "'" + value)
+        for value in ("", "SELECT 1", 'SELECT "a,b"'):
+            self.assertEqual(sanitize_spreadsheet_cell(value), value)

pyramid_debugtoolbar_api_sqlalchemy-0.3.0/MANIFEST.in

@@ -1,2 +0,0 @@
-include README.md
-include pyramid_debugtoolbar_api_sqlalchemy/templates/*

pyramid_debugtoolbar_api_sqlalchemy-0.3.0/PKG-INFO

@@ -1,93 +0,0 @@
-Metadata-Version: 2.1
-Name: pyramid_debugtoolbar_api_sqlalchemy
-Version: 0.3.0
-Summary: SQLAlchemy CSV exporting for pyramid_debugtoolbar
-Home-page: https://github.com/jvanasco/pyramid_debugtoolbar_api_sqlalchemy
-Author: Jonathan Vanasco
-Author-email: jonathan@findmeon.com
-License: MIT
-Description: pyramid_debugtoolbar_api_sqlalchemy
-        ===================================
-        
-        .. image:: https://github.com/jvanasco/pyramid_debugtoolbar_api_sqlalchemy/workflows/Python%20package/badge.svg
-                :alt: Build Status
-        
-        `pyramid_debugtoolbar_api_sqlalchemy` extends the existing `pyramid_debugtoolbar`
-        SQLAlchemy Panel to support downloadable CSV files of profiling data.
-        
-        This package does not replace the default panel, and requires it to be active.
-        
-        This package is designed for application profile and to be a useful part of test
-        suites, allowing developers to run a series of tests and log the SQLAlchemy
-        performance.
-        
-        If you are using the debugtoolbar directly:
-        
-        * If SQLAlchemy queries exist on the request, a "SQLAlchemy CSV" tab will appear.
-          That will prompt you for queries.
-        
-        If you are scripting:
-        
-        * The urls are generated in a machine-friendly format, so you can regex the
-          `request_id` off a page and pull it from the API.  this is explained below:
-        
-        
-        NOTES:
-        ======
-        
-        This packages requires pyramid_debugtoolbar 4.0 or newer
-        
-        
-        How to use this package
-        =======================
-        
-        
-        Update your ENVIRONMENT.ini file
-        
-        .. code-block:: python
-        
-            debugtoolbar.includes = pyramid_debugtoolbar_api_sqlalchemy
-        
-        You MUST be using `pyramid_debugtoolbar` with the SQLAlchemy panel enabled.
-        This just piggybacks on the existing module's work to log queries.
-        
-        You MUST use `debugtoolbar.includes`.  This will not work properly via `pyramid.includes`
-        
-        You can access a csv of the SQLAlchemy report via the following url hack:
-        
-        .. code-block:: python
-        
-            url_html = '/_debug_toolbar/{request_id}'
-            url_api =  '/_debug_toolbar/api-sqlalchemy/sqlalchemy-{request_id}.csv'
-            
-        The file will be downloaded and offer a content-disposition as:
-        
-            sqlalchemy-{request_id}.csv
-        
-        The CSV columns are:
-        
-        * execution timing
-        * SQLAlchemy query
-        * query params (json encoded)
-        
-        
-        Configuration
-        =======================
-        
-        By default, this package writes CSV files using "UTF-8" encoding.
-        
-        To change this, use the environment variable `pyramid_debugtoolbar_api_sqlalchemy_encoding`
-        
-        .. code-block:: shell
-        
-        	export pyramid_debugtoolbar_api_sqlalchemy_encoding=ascii
-        
-Keywords: web pyramid sqlalchemy
-Platform: UNKNOWN
-Classifier: Intended Audience :: Developers
-Classifier: Framework :: Pyramid
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 2
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Provides-Extra: testing

pyramid_debugtoolbar_api_sqlalchemy-0.3.0/pyproject.toml

@@ -1,3 +0,0 @@
-[tool.black]
-target-version = ['py27', 'py38']
-

pyramid_debugtoolbar_api_sqlalchemy-0.3.0/pyramid_debugtoolbar_api_sqlalchemy/views.py

@@ -1,65 +0,0 @@
-# stdlib
-import csv
-
-# pyramid
-from pyramid.response import Response
-from pyramid.view import view_config
-from pyramid.exceptions import NotFound
-
-# pypi
-import six
-
-# from six import BytesIO
-from six import StringIO
-
-import os
-
-# lcoal
-from .utils import get_sqlalchemy_panel
-
-
-# encoding used to write filedata
-ENCODING = os.environ.get("pyramid_debugtoolbar_api_sqlalchemy_encoding", "utf-8")
-
-
-# ==============================================================================
-
-
-@view_config(route_name="debugtoolbar.api_sqlalchemy.queries.csv")
-def queries_api_csv(request):
-
-    history = request.pdtb_history
-    try:
-        last_request_pair = history.last(1)[0]
-    except IndexError:
-        last_request_pair = None
-        last_request_id = None
-    else:
-        last_request_id = last_request_pair[0]
-
-    request_id = request.matchdict.get("request_id", last_request_id)
-    toolbar = history.get(request_id, None)
-
-    if not toolbar:
-        raise NotFound
-
-    sqla_panel = get_sqlalchemy_panel(toolbar.panels)
-    if not sqla_panel:
-        raise NotFound
-
-    csvfile = StringIO()
-    csvwriter = csv.writer(csvfile)
-    for query in sqla_panel.data["queries"]:
-        # we need to encode the query in Python2 if we use StringIO
-        # we need to encode them in Python3 if we use BytesIO
-        csvwriter.writerow(
-            (query["duration"], query["raw_sql"].encode(ENCODING), query["parameters"])
-        )
-    csvfile.seek(0)
-    as_csv = Response(
-        content_type="text/csv", body=csvfile.read(), status=200, charset=ENCODING
-    )
-    as_csv.headers["Content-Disposition"] = str(
-        "attachment; filename= sqlalchemy-%s.csv" % request_id
-    )
-    return as_csv

pyramid_debugtoolbar_api_sqlalchemy-0.3.0/pyramid_debugtoolbar_api_sqlalchemy.egg-info/PKG-INFO

@@ -1,93 +0,0 @@
-Metadata-Version: 2.1
-Name: pyramid-debugtoolbar-api-sqlalchemy
-Version: 0.3.0
-Summary: SQLAlchemy CSV exporting for pyramid_debugtoolbar
-Home-page: https://github.com/jvanasco/pyramid_debugtoolbar_api_sqlalchemy
-Author: Jonathan Vanasco
-Author-email: jonathan@findmeon.com
-License: MIT
-Description: pyramid_debugtoolbar_api_sqlalchemy
-        ===================================
-        
-        .. image:: https://github.com/jvanasco/pyramid_debugtoolbar_api_sqlalchemy/workflows/Python%20package/badge.svg
-                :alt: Build Status
-        
-        `pyramid_debugtoolbar_api_sqlalchemy` extends the existing `pyramid_debugtoolbar`
-        SQLAlchemy Panel to support downloadable CSV files of profiling data.
-        
-        This package does not replace the default panel, and requires it to be active.
-        
-        This package is designed for application profile and to be a useful part of test
-        suites, allowing developers to run a series of tests and log the SQLAlchemy
-        performance.
-        
-        If you are using the debugtoolbar directly:
-        
-        * If SQLAlchemy queries exist on the request, a "SQLAlchemy CSV" tab will appear.
-          That will prompt you for queries.
-        
-        If you are scripting:
-        
-        * The urls are generated in a machine-friendly format, so you can regex the
-          `request_id` off a page and pull it from the API.  this is explained below:
-        
-        
-        NOTES:
-        ======
-        
-        This packages requires pyramid_debugtoolbar 4.0 or newer
-        
-        
-        How to use this package
-        =======================
-        
-        
-        Update your ENVIRONMENT.ini file
-        
-        .. code-block:: python
-        
-            debugtoolbar.includes = pyramid_debugtoolbar_api_sqlalchemy
-        
-        You MUST be using `pyramid_debugtoolbar` with the SQLAlchemy panel enabled.
-        This just piggybacks on the existing module's work to log queries.
-        
-        You MUST use `debugtoolbar.includes`.  This will not work properly via `pyramid.includes`
-        
-        You can access a csv of the SQLAlchemy report via the following url hack:
-        
-        .. code-block:: python
-        
-            url_html = '/_debug_toolbar/{request_id}'
-            url_api =  '/_debug_toolbar/api-sqlalchemy/sqlalchemy-{request_id}.csv'
-            
-        The file will be downloaded and offer a content-disposition as:
-        
-            sqlalchemy-{request_id}.csv
-        
-        The CSV columns are:
-        
-        * execution timing
-        * SQLAlchemy query
-        * query params (json encoded)
-        
-        
-        Configuration
-        =======================
-        
-        By default, this package writes CSV files using "UTF-8" encoding.
-        
-        To change this, use the environment variable `pyramid_debugtoolbar_api_sqlalchemy_encoding`
-        
-        .. code-block:: shell
-        
-        	export pyramid_debugtoolbar_api_sqlalchemy_encoding=ascii
-        
-Keywords: web pyramid sqlalchemy
-Platform: UNKNOWN
-Classifier: Intended Audience :: Developers
-Classifier: Framework :: Pyramid
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 2
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Provides-Extra: testing

pyramid_debugtoolbar_api_sqlalchemy-0.3.0/pyramid_debugtoolbar_api_sqlalchemy.egg-info/SOURCES.txt

@@ -1,16 +0,0 @@
-MANIFEST.in
-README.rst
-pyproject.toml
-setup.cfg
-setup.py
-pyramid_debugtoolbar_api_sqlalchemy/__init__.py
-pyramid_debugtoolbar_api_sqlalchemy/panels.py
-pyramid_debugtoolbar_api_sqlalchemy/utils.py
-pyramid_debugtoolbar_api_sqlalchemy/views.py
-pyramid_debugtoolbar_api_sqlalchemy.egg-info/PKG-INFO
-pyramid_debugtoolbar_api_sqlalchemy.egg-info/SOURCES.txt
-pyramid_debugtoolbar_api_sqlalchemy.egg-info/dependency_links.txt
-pyramid_debugtoolbar_api_sqlalchemy.egg-info/not-zip-safe
-pyramid_debugtoolbar_api_sqlalchemy.egg-info/requires.txt
-pyramid_debugtoolbar_api_sqlalchemy.egg-info/top_level.txt
-pyramid_debugtoolbar_api_sqlalchemy/templates/sqlalchemy_csv.dbtmako

pyramid_debugtoolbar_api_sqlalchemy-0.3.0/pyramid_debugtoolbar_api_sqlalchemy.egg-info/requires.txt

@@ -1,7 +0,0 @@
-pyramid
-pyramid_debugtoolbar>=4.0
-six
-sqlalchemy
-
-[testing]
-pytest

pyramid_debugtoolbar_api_sqlalchemy-0.3.0/setup.cfg

@@ -1,7 +0,0 @@
-[easy_install]
-zip_ok = false
-
-[egg_info]
-tag_build = 
-tag_date = 0
-

pyramid_debugtoolbar_api_sqlalchemy-0.3.0/setup.py

@@ -1,58 +0,0 @@
-"""pyramid_debugtoolbar_api_sqlalchemy installation script.
-"""
-import os
-from setuptools import setup
-from setuptools import find_packages
-
-# store version in the init.py
-import re
-
-with open(
-    os.path.join(
-        os.path.dirname(__file__), "pyramid_debugtoolbar_api_sqlalchemy", "__init__.py"
-    )
-) as v_file:
-    VERSION = re.compile(r'.*__VERSION__ = "(.*?)"', re.S).match(v_file.read()).group(1)
-
-here = os.path.abspath(os.path.dirname(__file__))
-README = open(os.path.join(here, "README.rst")).read()
-
-requires = [
-    "pyramid",
-    "pyramid_debugtoolbar>=4.0",
-    "six",
-    "sqlalchemy",
-]
-tests_require = [
-    "pytest",
-]
-testing_extras = tests_require + []
-
-setup(
-    name="pyramid_debugtoolbar_api_sqlalchemy",
-    author="Jonathan Vanasco",
-    author_email="jonathan@findmeon.com",
-    url="https://github.com/jvanasco/pyramid_debugtoolbar_api_sqlalchemy",
-    version=VERSION,
-    description="SQLAlchemy CSV exporting for pyramid_debugtoolbar",
-    long_description=README,
-    keywords="web pyramid sqlalchemy",
-    license="MIT",
-    classifiers=[
-        "Intended Audience :: Developers",
-        "Framework :: Pyramid",
-        "Programming Language :: Python",
-        "Programming Language :: Python :: 2",
-        "Programming Language :: Python :: 3",
-        "License :: OSI Approved :: MIT License",
-    ],
-    packages=find_packages(),
-    include_package_data=True,
-    zip_safe=False,
-    install_requires=requires,
-    tests_require=tests_require,
-    extras_require={
-        "testing": testing_extras,
-    },
-    test_suite="tests",
-)