pyramid-debugtoolbar-api-performance 0.3.1__tar.gz → 1.1.0__tar.gz

pyramid_debugtoolbar_api_performance-1.1.0/CHANGES.txt

@@ -0,0 +1,35 @@
+v1.1.0
+* Add spreadsheet=1 to both performance CSV routes to prefix formula-like text.
+
+v1.0.0
+* Explicitly package the CSV template as data to avoid setuptools package discovery warnings.
+* Keep runtime dependencies out of version discovery on legacy setuptools.
+* Consolidate package and tox configuration and extend CI through Python 3.15.
+* Harden CSV download headers and disable caching for profiling exports.
+* Return 404 when a request or its performance data is unavailable.
+* added tests/__init__.py
+
+v0.3.1
+* packaging
+
+v0.3.0
+* updated debugtoolbar includes
+
+v0.2.2dev unreleased
+* black
+  * upgraded black; 20.8b1
+  * integrated with pre-commit
+
+v0.2.1
+* bugfixes
+  * includeme registers the panel via the api method `config.add_debugtoolbar_panel()`
+
+v0.2.0 | 2019.04.29
+* python3 support
+
+v0.1.1 | 2017.12.06
+* ported a functionality to current debugtoolbar api
+* store version as __VERSION__ in /__init__.py
+
+v0.1.0 | 2017.05.10
+* initial

{pyramid_debugtoolbar_api_performance-0.3.1 → pyramid_debugtoolbar_api_performance-1.1.0}/MANIFEST.in

@@ -2,7 +2,6 @@ graft src
 graft tests
 
 include setup.cfg pyproject.toml
-include tox.ini
 include CHANGES.txt
 include LICENSE
 include README.rst

pyramid_debugtoolbar_api_performance-1.1.0/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: pyramid_debugtoolbar_api_performance
+Version: 1.1.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.1.0/pyproject.toml

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

pyramid_debugtoolbar_api_performance-1.1.0/setup.cfg

@@ -0,0 +1,67 @@
+[metadata]
+name = pyramid_debugtoolbar_api_performance
+version = attr: pyramid_debugtoolbar_api_performance._version.__VERSION__
+description = performance 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_performance
+keywords = web, pyramid
+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
+	setuptools<82; python_version >= "3.7" and python_version < "3.10"
+
+[options.packages.find]
+where = src
+
+[options.package_data]
+pyramid_debugtoolbar_api_performance = 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_performance -m pytest {posargs:}
+	python -m coverage html -d {envtmpdir}/coverage
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

{pyramid_debugtoolbar_api_performance-0.3.1 → pyramid_debugtoolbar_api_performance-1.1.0}/src/pyramid_debugtoolbar_api_performance/__init__.py

@@ -1,14 +1,16 @@
-# local
-from .panels import PerformanceCsvDebugPanel
-
-
-__VERSION__ = "0.3.1"
+# 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",

pyramid_debugtoolbar_api_performance-1.1.0/src/pyramid_debugtoolbar_api_performance/_version.py

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

pyramid_debugtoolbar_api_performance-1.1.0/src/pyramid_debugtoolbar_api_performance/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_performance-1.1.0/src/pyramid_debugtoolbar_api_performance/views.py

@@ -0,0 +1,108 @@
+# 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 PY2, StringIO, binary_type
+
+# local
+from .spreadsheet_utils import sanitize_spreadsheet_cell
+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 _spreadsheet_text(value):
+    # type: (str) -> str
+    """Sanitize a CSV text field using the export's encoding."""
+    if isinstance(value, binary_type):
+        value = value.decode(ENCODING)
+    value = sanitize_spreadsheet_cell(value)
+    return value.encode(ENCODING) if PY2 else value
+
+
+def _csv_response(csvfile, report, request_id, spreadsheet):
+    # type: (StringIO, str, str, bool) -> Response
+    """Return a CSV attachment with a header-safe filename."""
+    safe_id = re.sub(r"[^a-zA-Z0-9_-]", "_", request_id)
+    suffix = "-spreadsheet" if spreadsheet else ""
+    filename = "performance-%s-%s%s.csv" % (report, safe_id, suffix)
+    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)
+
+    spreadsheet = request.GET.get("spreadsheet") == "1"
+    csvfile = StringIO()
+    csvwriter = csv.writer(csvfile)
+    for label, timing in panel.data["timing_rows"]:
+        if spreadsheet:
+            label = _spreadsheet_text(label)
+        csvwriter.writerow((label, timing))
+    return _csv_response(csvfile, "timing", request_id, spreadsheet)
+
+
+@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)
+
+    spreadsheet = request.GET.get("spreadsheet") == "1"
+    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"]:
+            filename = row["filename_long"]
+            if spreadsheet:
+                filename = _spreadsheet_text(filename)
+            csvwriter.writerow(
+                (
+                    row["ncalls"],
+                    row["tottime"],
+                    row["percall"],
+                    row["cumtime"],
+                    row["percall_cum"],
+                    filename,
+                )
+            )
+    return _csv_response(csvfile, "function_calls", request_id, spreadsheet)

pyramid_debugtoolbar_api_performance-1.1.0/src/pyramid_debugtoolbar_api_performance.egg-info/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: pyramid_debugtoolbar_api_performance
+Version: 1.1.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-0.3.1 → pyramid_debugtoolbar_api_performance-1.1.0}/src/pyramid_debugtoolbar_api_performance.egg-info/SOURCES.txt

@@ -5,10 +5,10 @@ README.rst
 TODO.txt
 pyproject.toml
 setup.cfg
-setup.py
-tox.ini
 src/pyramid_debugtoolbar_api_performance/__init__.py
+src/pyramid_debugtoolbar_api_performance/_version.py
 src/pyramid_debugtoolbar_api_performance/panels.py
+src/pyramid_debugtoolbar_api_performance/spreadsheet_utils.py
 src/pyramid_debugtoolbar_api_performance/utils.py
 src/pyramid_debugtoolbar_api_performance/views.py
 src/pyramid_debugtoolbar_api_performance.egg-info/PKG-INFO
@@ -18,4 +18,5 @@ src/pyramid_debugtoolbar_api_performance.egg-info/not-zip-safe
 src/pyramid_debugtoolbar_api_performance.egg-info/requires.txt
 src/pyramid_debugtoolbar_api_performance.egg-info/top_level.txt
 src/pyramid_debugtoolbar_api_performance/templates/performance_csv.dbtmako
+tests/__init__.py
 tests/test_config.py

pyramid_debugtoolbar_api_performance-1.1.0/src/pyramid_debugtoolbar_api_performance.egg-info/requires.txt

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

{pyramid_debugtoolbar_api_performance-0.3.1 → pyramid_debugtoolbar_api_performance-1.1.0}/tests/test_config.py

@@ -7,7 +7,6 @@ import unittest
 
 # pyramid testing requirements
 from pyramid import testing
-from pyramid.exceptions import ConfigurationError
 from pyramid.response import Response
 from pyramid.request import Request
 
@@ -41,6 +40,7 @@ class TestDebugtoolbarPanel(unittest.TestCase):
             )
 
         config.add_view(empty_view)
+        config.add_notfound_view(lambda request: Response(status=404))
 
     def tearDown(self):
         testing.tearDown()
@@ -132,6 +132,14 @@ class TestDebugtoolbarPanel(unittest.TestCase):
         req3.remote_addr = "127.0.0.1"
         resp3 = req3.get_response(app)
         self.assertEqual(resp3.status_code, 200)
+        self.assertEqual(
+            resp3.headers["Content-Disposition"],
+            'attachment; filename="performance-timing-%s.csv"' % _id,
+        )
+        self.assertTrue(resp3.cache_control.no_store)
+        denied = Request.blank(_timing_link)
+        denied.remote_addr = "192.0.2.1"
+        self.assertEqual(denied.get_response(app).status_code, 404)
         self.assertTrue(resp3.text.startswith("User CPU time,"))
 
         # function csv
@@ -142,6 +150,71 @@ class TestDebugtoolbarPanel(unittest.TestCase):
         req4.remote_addr = "127.0.0.1"
         resp4 = req4.get_response(app)
         self.assertEqual(resp4.status_code, 200)
+        self.assertEqual(
+            resp4.headers["Content-Disposition"],
+            'attachment; filename="performance-function_calls-%s.csv"' % _id,
+        )
+        self.assertTrue(resp4.cache_control.no_store)
+        denied = Request.blank(_function_link)
+        denied.remote_addr = "192.0.2.1"
+        self.assertEqual(denied.get_response(app).status_code, 404)
         self.assertTrue(
             resp4.text.startswith("Calls,Total,Percall,Cumu,CumuPer,Func\r\n")
         )
+
+    def test_csv_missing_history(self):
+        # type: () -> None
+        """Both CSV routes return 404 when the request is absent from history."""
+        app = self.config.make_wsgi_app()
+        for report in ("timing", "function_calls"):
+            request = Request.blank(
+                "/_debug_toolbar/api-performance/%s-missing.csv" % report
+            )
+            request.remote_addr = "127.0.0.1"
+            self.assertEqual(request.get_response(app).status_code, 404)
+
+
+    def test_spreadsheet_exports(self):
+        # type: () -> None
+        """Protect both CSV text fields while preserving default output."""
+        from pyramid_debugtoolbar.panels.performance import PerformanceDebugPanel
+
+        app = self.config.make_wsgi_app()
+        initial = Request.blank("/")
+        initial.remote_addr = "127.0.0.1"
+        initial.get_response(app)
+        request_id, toolbar = self.config.registry.pdtb_history.last(1)[0]
+        panel = next(p for p in toolbar.panels if isinstance(p, PerformanceDebugPanel))
+        panel.data.update(
+            timing_rows=[(str("=label"), str("-2 msec"))],
+            stats=True,
+            function_calls=[
+                dict(
+                    ncalls="1",
+                    tottime="-2",
+                    percall="3",
+                    cumtime="4",
+                    percall_cum="5",
+                    filename_long=" @module",
+                )
+            ],
+        )
+
+        for report, raw, safe in (
+            ("timing", "=label,-2 msec", "'=label,-2 msec"),
+            ("function_calls", "1,-2,3,4,5, @module", "1,-2,3,4,5,' @module"),
+        ):
+            path = "/_debug_toolbar/api-performance/%s-%s.csv" % (report, request_id)
+            for query, row in (("", raw), ("?spreadsheet=1", safe)):
+                request = Request.blank(path + query)
+                request.remote_addr = "127.0.0.1"
+                response = request.get_response(app)
+                self.assertEqual(response.status_code, 200)
+                self.assertIn(row + "\r\n", response.text)
+                self.assertTrue(response.cache_control.no_store)
+                if query:
+                    self.assertTrue(
+                        response.headers["Content-Disposition"].endswith(
+                            '-spreadsheet.csv"'
+                        )
+                    )

pyramid_debugtoolbar_api_performance-0.3.1/CHANGES.txt

@@ -1,28 +0,0 @@
-v0.3.1
-* packaging
-
-v0.3.0
-* updated debugtoolbar includes
-
-v0.2.2dev unreleased
-black
-	* upgraded black; 20.8b1
-	* integrated with pre-commit
-
-v0.2.1
-bugfixes
-includeme registers the panel via the api method `config.add_debugtoolbar_panel()`
-
-v0.2.0
-2019.04.29
-* python3 support
-
-v0.1.1
-2017.12.06
-* ported a functionality to current debugtoolbar api
-* store version as __VERSION__ in /__init__.py
-
-v0.1.0
-2017.05.10
-* initial
-

pyramid_debugtoolbar_api_performance-0.3.1/PKG-INFO

@@ -1,91 +0,0 @@
-Metadata-Version: 2.1
-Name: pyramid_debugtoolbar_api_performance
-Version: 0.3.1
-Summary: performance csv exporting for pyramid_debugtoolbar
-Home-page: https://github.com/jvanasco/pyramid_debugtoolbar_api_performance
-Author: Jonathan Vanasco
-Author-email: jonathan@findmeon.com
-License: MIT
-Description: 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
-        
-Keywords: web pyramid
-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
-Description-Content-Type: text/markdown
-Provides-Extra: testing

pyramid_debugtoolbar_api_performance-0.3.1/pyproject.toml

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

pyramid_debugtoolbar_api_performance-0.3.1/setup.cfg

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

pyramid_debugtoolbar_api_performance-0.3.1/setup.py

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

pyramid_debugtoolbar_api_performance-0.3.1/src/pyramid_debugtoolbar_api_performance/views.py

@@ -1,103 +0,0 @@
-# stdlib
-import csv
-import os
-
-# 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
-
-# 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):
-    """returns panel after some processing"""
-    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
-
-    panel = get_performance_panel(toolbar.panels)
-    if not panel:
-        raise NotFound
-
-    return request_id, panel
-
-
-@view_config(route_name="debugtoolbar.api_performance_csv.timing")
-def csv_timing(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)
-    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= performance-timing-%s.csv" % request_id
-    )
-    return as_csv
-
-
-@view_config(route_name="debugtoolbar.api_performance_csv.function_calls")
-def csv_function_calls(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"],
-                )
-            )
-    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= performance-function_calls-%s.csv" % request_id
-    )
-    return as_csv

pyramid_debugtoolbar_api_performance-0.3.1/src/pyramid_debugtoolbar_api_performance.egg-info/PKG-INFO

@@ -1,91 +0,0 @@
-Metadata-Version: 2.1
-Name: pyramid-debugtoolbar-api-performance
-Version: 0.3.1
-Summary: performance csv exporting for pyramid_debugtoolbar
-Home-page: https://github.com/jvanasco/pyramid_debugtoolbar_api_performance
-Author: Jonathan Vanasco
-Author-email: jonathan@findmeon.com
-License: MIT
-Description: 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
-        
-Keywords: web pyramid
-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
-Description-Content-Type: text/markdown
-Provides-Extra: testing

pyramid_debugtoolbar_api_performance-0.3.1/src/pyramid_debugtoolbar_api_performance.egg-info/requires.txt

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

pyramid_debugtoolbar_api_performance-0.3.1/tox.ini

@@ -1,12 +0,0 @@
-[tox]
-envlist =
-	lint,
-	py27,
-	py35,py36,py37,py38
-
-[testenv]
-extras =
-    testing
-commands =
-    python --version
-    pytest {posargs:}