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

{pyramid_debugtoolbar_api_performance-1.0.0 → pyramid_debugtoolbar_api_performance-1.1.0}/CHANGES.txt

@@ -1,3 +1,6 @@
+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.

{pyramid_debugtoolbar_api_performance-1.0.0/src/pyramid_debugtoolbar_api_performance.egg-info → pyramid_debugtoolbar_api_performance-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyramid_debugtoolbar_api_performance
-Version: 1.0.0
+Version: 1.1.0
 Summary: performance csv exporting for pyramid_debugtoolbar
 Home-page: https://github.com/jvanasco/pyramid_debugtoolbar_api_performance
 Author: Jonathan Vanasco

{pyramid_debugtoolbar_api_performance-1.0.0 → pyramid_debugtoolbar_api_performance-1.1.0}/src/pyramid_debugtoolbar_api_performance/_version.py

@@ -1,3 +1,3 @@
 """Package version shared by runtime and build metadata."""
 
-__VERSION__ = "1.0.0"
+__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.0.0 → pyramid_debugtoolbar_api_performance-1.1.0}/src/pyramid_debugtoolbar_api_performance/views.py

@@ -12,9 +12,10 @@ from pyramid.view import view_config
 from pyramid.exceptions import NotFound
 
 # Python 2's csv module requires a byte buffer.
-from six import StringIO
+from six import PY2, StringIO, binary_type
 
 # local
+from .spreadsheet_utils import sanitize_spreadsheet_cell
 from .utils import get_performance_panel
 
 
@@ -40,11 +41,21 @@ def _standardized_setup(request):
     return request_id, panel
 
 
-def _csv_response(csvfile, report, request_id):
-    # type: (StringIO, str, str) -> Response
+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)
-    filename = "performance-%s-%s.csv" % (report, safe_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
     )
@@ -59,19 +70,14 @@ def csv_timing(request):
     """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 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)
+    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")
@@ -80,11 +86,15 @@ def csv_function_calls(request):
     """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"],
@@ -92,7 +102,7 @@ def csv_function_calls(request):
                     row["percall"],
                     row["cumtime"],
                     row["percall_cum"],
-                    row["filename_long"],
+                    filename,
                 )
             )
-    return _csv_response(csvfile, "function_calls", request_id)
+    return _csv_response(csvfile, "function_calls", request_id, spreadsheet)

{pyramid_debugtoolbar_api_performance-1.0.0 → pyramid_debugtoolbar_api_performance-1.1.0/src/pyramid_debugtoolbar_api_performance.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyramid_debugtoolbar_api_performance
-Version: 1.0.0
+Version: 1.1.0
 Summary: performance csv exporting for pyramid_debugtoolbar
 Home-page: https://github.com/jvanasco/pyramid_debugtoolbar_api_performance
 Author: Jonathan Vanasco

{pyramid_debugtoolbar_api_performance-1.0.0 → pyramid_debugtoolbar_api_performance-1.1.0}/src/pyramid_debugtoolbar_api_performance.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ setup.cfg
 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

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

@@ -172,3 +172,49 @@ class TestDebugtoolbarPanel(unittest.TestCase):
             )
             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"'
+                        )
+                    )