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

pyramid_debugtoolbar_api_performance/__init__.py

@@ -0,0 +1,27 @@
+# type: from pyramid.config import Configurator
+from ._version import __VERSION__
+
+
+# ==============================================================================
+
+
+def includeme(config):
+    # type: (Configurator) -> None
+    """Register the CSV panel and routes with the debug toolbar."""
+    # Older setuptools imports this package to read its version at build time.
+    from .panels import PerformanceCsvDebugPanel
+
+    config.add_debugtoolbar_panel(PerformanceCsvDebugPanel)
+    config.add_route(
+        "debugtoolbar.api_performance_csv.function_calls",
+        "/api-performance/function_calls-{request_id}.csv",
+    )
+    config.add_route(
+        "debugtoolbar.api_performance_csv.timing",
+        "/api-performance/timing-{request_id}.csv",
+    )
+    config.scan("pyramid_debugtoolbar_api_performance.views")
+    config.commit()
+
+
+# ==============================================================================

pyramid_debugtoolbar_api_performance/_version.py

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

pyramid_debugtoolbar_api_performance/panels.py

@@ -0,0 +1,69 @@
+# 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_performance_panel
+
+# ==============================================================================
+
+
+_ = lambda x: x
+
+
+class PerformanceCsvDebugPanel(DebugPanel):
+    """
+    Panel that displays a link to Performance downloads
+    """
+
+    name = "performance-csv"
+    template = "pyramid_debugtoolbar_api_performance:templates/performance_csv.dbtmako"
+    title = _("Performance CSV")
+    nav_title = _("Performance CSV")
+
+    def __init__(self, original_request):
+        self.token = original_request.registry.pdtb_token
+        self.pdtb_id = original_request.pdtb_id
+
+    @reify
+    def _performance_panel(self):
+        # utility for when we can't explicitly access the request
+        request = get_current_request()
+        performance_panel = get_performance_panel(request.toolbar_panels.values())
+        return performance_panel
+
+    @property
+    def has_content(self):
+        performance_panel = self._performance_panel
+        if performance_panel and performance_panel.data:
+            return True
+        return False
+
+    @property
+    def nav_subtitle(self):
+        return ""
+
+    def render_content(self, request):
+        performance_panel = get_performance_panel(request.toolbar_panels.values())
+        if not performance_panel:
+            return "No `performance` panel in request."
+        if not performance_panel.data:
+            return "No data in executed in request."
+        # our template might want to reference this for button visibility
+        self.data = performance_panel.data
+        return super(PerformanceCsvDebugPanel, 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_performance/templates/performance_csv.dbtmako

@@ -0,0 +1,31 @@
+<p>
+	performance logging is available for this request as a CSV via the link below:
+</p>
+
+
+<h5>Timing</h5>
+<p>
+	<a 	href="/_debug_toolbar/api-performance/timing-${pdtb_id}.csv"
+	    class="btn btn-primary"
+	>
+		<span class="glyphicon glyphicon-download" aria-hidden="true"></span>
+		&nbsp;
+		Download Timing as CSV
+	</a>
+</p>
+<hr/>
+
+<h5>Function Calls</h5>
+<p>
+	% if stats:
+		<a 	href="/_debug_toolbar/api-performance/function_calls-${pdtb_id}.csv"
+			class="btn btn-primary"
+		>
+			<span class="glyphicon glyphicon-download" aria-hidden="true"></span>
+			&nbsp;
+			Download Function Calls as CSV
+		</a>
+	% else:
+		The profiler was not activated for this request. Activate the checkbox in the toolbar to use it.
+	% endif
+</p>

pyramid_debugtoolbar_api_performance/utils.py

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

pyramid_debugtoolbar_api_performance/views.py

@@ -0,0 +1,98 @@
+# stdlib
+import csv
+import os
+import re
+
+# pyramid
+from pyramid.response import Response
+
+from pyramid.request import Request
+from pyramid_debugtoolbar.panels.performance import PerformanceDebugPanel
+from pyramid.view import view_config
+from pyramid.exceptions import NotFound
+
+# Python 2's csv module requires a byte buffer.
+from six import StringIO
+
+# local
+from .utils import get_performance_panel
+
+
+# encoding used to write filedata
+ENCODING = os.environ.get("pyramid_debugtoolbar_api_sqlalchemy_encoding", "utf-8")
+
+
+# ==============================================================================
+
+
+def _standardized_setup(request):
+    # type: (Request) -> tuple[str, PerformanceDebugPanel]
+    """Resolve the performance panel for the requested history entry."""
+    request_id = request.matchdict["request_id"]
+    toolbar = request.pdtb_history.get(request_id, None)
+    if toolbar is None:
+        raise NotFound
+
+    panel = get_performance_panel(toolbar.panels)
+    if panel is None or not panel.data:
+        raise NotFound
+
+    return request_id, panel
+
+
+def _csv_response(csvfile, report, request_id):
+    # type: (StringIO, str, str) -> Response
+    """Return a CSV attachment with a header-safe filename."""
+    safe_id = re.sub(r"[^a-zA-Z0-9_-]", "_", request_id)
+    filename = "performance-%s-%s.csv" % (report, safe_id)
+    response = Response(
+        content_type="text/csv", body=csvfile.getvalue(), charset=ENCODING
+    )
+    response.headers["Content-Disposition"] = str('attachment; filename="%s"' % filename)
+    response.cache_control.no_store = True
+    return response
+
+
+@view_config(route_name="debugtoolbar.api_performance_csv.timing")
+def csv_timing(request):
+    # type: (Request) -> Response
+    """Export timing rows for a recorded request."""
+    (request_id, panel) = _standardized_setup(request)
+
+    csvfile = StringIO()
+    csvwriter = csv.writer(csvfile)
+    for row in panel.data["timing_rows"]:
+        # row is `label, timing`
+        # example:
+        # 'timing_rows': (('User CPU time', '119.678 msec'),
+        #                 ('System CPU time', '64.695 msec'),
+        #                 ('Total CPU time', '184.373 msec'),
+        #                 ('Elapsed time', '205.099 msec'),
+        #                 ('Context switches', '19 voluntary, 1233 involuntary')
+        #                 )
+        csvwriter.writerow(row)
+    return _csv_response(csvfile, "timing", request_id)
+
+
+@view_config(route_name="debugtoolbar.api_performance_csv.function_calls")
+def csv_function_calls(request):
+    # type: (Request) -> Response
+    """Export profiler rows for a recorded request."""
+    (request_id, panel) = _standardized_setup(request)
+
+    csvfile = StringIO()
+    csvwriter = csv.writer(csvfile)
+    if panel.data["stats"]:
+        csvwriter.writerow(("Calls", "Total", "Percall", "Cumu", "CumuPer", "Func"))
+        for row in panel.data["function_calls"]:
+            csvwriter.writerow(
+                (
+                    row["ncalls"],
+                    row["tottime"],
+                    row["percall"],
+                    row["cumtime"],
+                    row["percall_cum"],
+                    row["filename_long"],
+                )
+            )
+    return _csv_response(csvfile, "function_calls", request_id)

pyramid_debugtoolbar_api_performance-1.0.0.dist-info/METADATA

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: pyramid_debugtoolbar_api_performance
+Version: 1.0.0
+Summary: performance csv exporting for pyramid_debugtoolbar
+Home-page: https://github.com/jvanasco/pyramid_debugtoolbar_api_performance
+Author: Jonathan Vanasco
+Author-email: jvanasco@2xlp.com
+License: MIT
+Keywords: web,pyramid
+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: 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_performance
+====================================
+
+.. image:: https://github.com/jvanasco/pyramid_debugtoolbar_api_performance/workflows/Python%20package/badge.svg
+        :alt: Build Status
+
+`pyramid_debugtoolbar_api_performance` extends the existing `pyramid_debugtoolbar`
+Performance 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 Performance
+performance.
+
+The package exposes two routes for CSV data:
+
+* timing
+* function_calls
+
+Both correlate to the official Performance panel data.
+
+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_performance
+
+You MUST be using `pyramid_debugtoolbar` with the Performance panel enabled.
+This package simply 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 Profiling report via the following url hack:
+
+.. code-block:: python
+
+    url_html = '/_debug_toolbar/{request_id}'
+    url_api =  '/_debug_toolbar/api-performance/timing-{request_id}.csv'
+    url_api =  '/_debug_toolbar/api-performance/function_calls-{request_id}.csv'
+    
+    
+The file will be downloaded and offer a content-disposition as:
+
+.. code-block:: shell
+
+    performance-{request_id}.csv
+
+Configuration
+=======================
+
+By default, this package writes CSV files using "UTF-8" encoding.
+
+To change this, use the environment variable `pyramid_debugtoolbar_api_performance_encoding`
+
+.. code-block:: shell
+
+	export pyramid_debugtoolbar_api_performance_encoding=ascii

pyramid_debugtoolbar_api_performance-1.0.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+pyramid_debugtoolbar_api_performance/__init__.py,sha256=mjD0CY3hHFFQ-0ymF0CYSUwCTS9IudmIH7iE8LLxjdA,925
+pyramid_debugtoolbar_api_performance/_version.py,sha256=PSFTHx0_-pj-uJ6XCRWQ4yUYRx0g1iTOGcVOTVJLZx4,83
+pyramid_debugtoolbar_api_performance/panels.py,sha256=i17kEMiWRdp_WhQ6ifBIP5qCwcnFM-9I6NqG2Sj88vw,2184
+pyramid_debugtoolbar_api_performance/utils.py,sha256=0IOvkGZaZ6L4ONSFZ4-jxbjLrbFdVodlmkapKXAtcJM,403
+pyramid_debugtoolbar_api_performance/views.py,sha256=D-CMrpihXs8HiEgz-OFIMy-Bjgdp15qX2m4LEE2-Rl8,3284
+pyramid_debugtoolbar_api_performance/templates/performance_csv.dbtmako,sha256=lsCQMT-mnmtXN_LklD10vbbZFhh-_lbxc7zKIEdxQgM,726
+pyramid_debugtoolbar_api_performance-1.0.0.dist-info/licenses/LICENSE,sha256=C8rdTK7bsKZPlhmxryyAmq-_MWb71oIl8QodzMeyF2E,1076
+pyramid_debugtoolbar_api_performance-1.0.0.dist-info/METADATA,sha256=tWO2ghv0KS75kHS4O6yI6NH9TMgktt0FPpiqan889co,3567
+pyramid_debugtoolbar_api_performance-1.0.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+pyramid_debugtoolbar_api_performance-1.0.0.dist-info/top_level.txt,sha256=g7tWBwH3nHGxZXkzZ5g5__TuCJHNEBVbyB9SL3OUFxY,37
+pyramid_debugtoolbar_api_performance-1.0.0.dist-info/RECORD,,

pyramid_debugtoolbar_api_performance-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_performance-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 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_performance-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyramid_debugtoolbar_api_performance