pyramid-debugtoolbar-api-sqlalchemy 1.0.0__py3-none-any.whl

pyramid_debugtoolbar_api_sqlalchemy/__init__.py

@@ -0,0 +1,27 @@
+from ._version import __VERSION__
+
+
+# ==============================================================================
+
+
+def includeme(config):
+    """
+    Pyramid hook to install this debugtoolbar plugin.
+
+    Update your ENVIRONMENT.ini file
+
+        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",
+        "/api-sqlalchemy/sqlalchemy-{request_id}.csv",
+    )
+    config.scan("pyramid_debugtoolbar_api_sqlalchemy.views")
+    config.commit()
+
+
+# ==============================================================================

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/panels.py

@@ -0,0 +1,72 @@
+# stdlib
+
+# pyramid
+from pyramid.threadlocal import get_current_request
+from pyramid.decorator import reify
+
+# pyramid_debugtoolbar
+from pyramid_debugtoolbar.panels import DebugPanel
+from pyramid_debugtoolbar.utils import STATIC_PATH
+from pyramid_debugtoolbar.utils import ROOT_ROUTE_NAME
+
+# local
+from .utils import get_sqlalchemy_panel
+
+# ==============================================================================
+
+
+_ = lambda x: x
+
+
+class SqlalchemyCsvDebugPanel(DebugPanel):
+    """
+    Panel that displays a link to SQLACSV download
+    """
+
+    name = "sqlalchemy-csv"
+    template = "pyramid_debugtoolbar_api_sqlalchemy:templates/sqlalchemy_csv.dbtmako"
+    title = _("SQLAlchemy Queries CSV")
+    nav_title = _("SQLAlchemy CSV")
+
+    def __init__(self, original_request):
+        self.token = original_request.registry.pdtb_token
+        self.pdtb_id = original_request.pdtb_id
+
+    @reify
+    def _sqlalchemy_panel(self):
+        # utility for when we can't explicitly access the request
+        request = get_current_request()
+        sqlalchemy_panel = get_sqlalchemy_panel(request.toolbar_panels.values())
+        return sqlalchemy_panel
+
+    @property
+    def has_content(self):
+        sqlalchemy_panel = self._sqlalchemy_panel
+        if sqlalchemy_panel and sqlalchemy_panel.queries:
+            return True
+        return False
+
+    @property
+    def nav_subtitle(self):
+        sqlalchemy_panel = self._sqlalchemy_panel
+        if sqlalchemy_panel and sqlalchemy_panel.queries:
+            return len(sqlalchemy_panel.queries)
+        return ""
+
+    def render_content(self, request):
+        sqlalchemy_panel = get_sqlalchemy_panel(request.toolbar_panels.values())
+        if not sqlalchemy_panel:
+            return "No `sqlalchemy` panel in request."
+        if not sqlalchemy_panel.queries:
+            return "No queries in executed in request."
+        # our template might want to reference this for button visibility
+        self.data = sqlalchemy_panel.data
+        return super(SqlalchemyCsvDebugPanel, self).render_content(request)
+
+    def render_vars(self, request):
+        return {
+            "route_url": request.route_url,
+            "static_path": request.static_url(STATIC_PATH),
+            "root_path": request.route_url(ROOT_ROUTE_NAME),
+            "pdtb_id": self.pdtb_id,
+        }

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/templates/sqlalchemy_csv.dbtmako

@@ -0,0 +1,13 @@
+<p>
+	SqlAclhemy queries are available for this request as a CSV via the link below:
+</p>
+
+<p>
+	<a 	href="/_debug_toolbar/api-sqlalchemy/sqlalchemy-${pdtb_id}.csv"
+	    class="btn btn-primary"
+	>
+		<span class="glyphicon glyphicon-download" aria-hidden="true"></span>
+		&nbsp;
+		Download Queries as CSV
+	</a>
+</p>

pyramid_debugtoolbar_api_sqlalchemy/utils.py

@@ -0,0 +1,13 @@
+# pyramid_debugtoolbar
+from pyramid_debugtoolbar.panels.sqla import SQLADebugPanel
+
+
+# ==============================================================================
+
+
+def get_sqlalchemy_panel(toolbar_panels):
+    # PY3 - `toolbar_panels` is a view, not a list
+    for panel in toolbar_panels:
+        if isinstance(panel, SQLADebugPanel):
+            return panel
+    return None

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.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,12 @@
+pyramid_debugtoolbar_api_sqlalchemy/__init__.py,sha256=y9FeEwP0dnQHpDyT8K73JDS7I-tbsJJvqM1psCKXbbc,795
+pyramid_debugtoolbar_api_sqlalchemy/_version.py,sha256=PSFTHx0_-pj-uJ6XCRWQ4yUYRx0g1iTOGcVOTVJLZx4,83
+pyramid_debugtoolbar_api_sqlalchemy/panels.py,sha256=bdKXgXCBTp4orunzdJ-WzS2AVp5KfbGgKParp0QXLGs,2331
+pyramid_debugtoolbar_api_sqlalchemy/spreadsheet_utils.py,sha256=ORjcJdfiZRh8rIMBSGIT9vRdLxYZs2TM5NVoPA3Y3KY,467
+pyramid_debugtoolbar_api_sqlalchemy/utils.py,sha256=Go4XfCMdwfkBnrBxur4J9c785d3TUt53QYwrMR_T8Rk,381
+pyramid_debugtoolbar_api_sqlalchemy/views.py,sha256=BPqeuRtfjL8uCKcO5SP7F6RLcwpAksJ-48rL4L_FTDg,2105
+pyramid_debugtoolbar_api_sqlalchemy/templates/sqlalchemy_csv.dbtmako,sha256=B9iZhinOYS6kwwsJvAsySP5BsGSX-qBs-bAcPF4B7Ak,312
+pyramid_debugtoolbar_api_sqlalchemy-1.0.0.dist-info/licenses/LICENSE,sha256=q2DhemYY9D6Z_XL2IvP5QjkXi3KDIc_GRHwBBpAPX8c,1076
+pyramid_debugtoolbar_api_sqlalchemy-1.0.0.dist-info/METADATA,sha256=KH0MFglpfEVnN6_E4y0uyuyOIY9cHIncrv-oG6mC-6c,3627
+pyramid_debugtoolbar_api_sqlalchemy-1.0.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+pyramid_debugtoolbar_api_sqlalchemy-1.0.0.dist-info/top_level.txt,sha256=MGld_Ap4yJUAEtiX6vKEc_vZ1PmOvJ2VyKbkStUPWkY,36
+pyramid_debugtoolbar_api_sqlalchemy-1.0.0.dist-info/RECORD,,

pyramid_debugtoolbar_api_sqlalchemy-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pyramid_debugtoolbar_api_sqlalchemy-1.0.0.dist-info/licenses/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.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyramid_debugtoolbar_api_sqlalchemy