run pre-commit

Author: guillesd

duckdb/query_graph/__init__.py

@@ -1,3 +1,3 @@
-from .__main__ import translate_json_to_html
+from .__main__ import translate_json_to_html  # noqa: D104
 
-__all__ = ["translate_json_to_html"]
+__all__ = ["translate_json_to_html"]

duckdb/query_graph/__main__.py

@@ -264,7 +264,7 @@
     color: #b3b3b3;
   }
 }
-"""
+"""  # noqa: W293
 
 
 class NodeTiming:  # noqa: D101
@@ -325,8 +325,7 @@ def get_child_timings(top_node: object, query_timings: object, depth: int = 0) -
 
 
 def get_f7fff0_shade_hex(fraction: float) -> str:
-    """
-    Returns a shade between very light (#f7fff0) and a slightly darker green-yellow,
+    """Returns a shade between very light (#f7fff0) and a slightly darker green-yellow,
     depending on the fraction (0..1)
     """
     fraction = max(0, min(1, fraction))
@@ -345,10 +344,8 @@ def get_f7fff0_shade_hex(fraction: float) -> str:
 
 def get_node_body(
     name: str, result: str, cpu_time: float, card: int, est: int, result_size: int, extra_info: str
-) -> str:  # noqa: D103
-    """
-    Generate the HTML body for a single node in the tree.
-    """
+) -> str:
+    """Generate the HTML body for a single node in the tree."""
     node_style = f"background-color: {get_f7fff0_shade_hex(float(result) / cpu_time)};"
     new_name = "BRIDGE" if (name == "INVALID") else name.replace("_", " ")
     formatted_num = f"{float(result):.4f}"
@@ -362,7 +359,7 @@ def get_node_body(
         body += f"<p>estimate: {est}</p>"
         body += f"<p>result size: {result_size} bytes</p>"
     body += "<details>"
-    body += f"<summary>Extra info</summary>"
+    body += "<summary>Extra info</summary>"
     body += '<div class="node-details">'
     body += f"<p>{extra_info}</p>"
     # TODO: Expand on timing. Usually available from a detailed profiling  # noqa: TD002, TD003
@@ -411,6 +408,7 @@ def generate_tree_recursive(json_graph: object, cpu_time: float) -> str:  # noqa
 
 # For generating the table in the top left with expandable phases
 def generate_timing_html(graph_json: object, query_timings: object) -> object:
+    """Generates timing HTML table with expandable phases."""
     json_graph = json.loads(graph_json)
     gather_timing_information(json_graph, query_timings)
     table_head = """
@@ -500,7 +498,7 @@ def generate_metric_grid_html(graph_json: str) -> str:  # noqa: D103
         else "N/A",
     }
     metric_grid_html = """<div class="metrics-grid">"""
-    for key in metrics.keys():
+    for key in metrics:
         metric_grid_html += f"""
         <div class="metric-box">
             <div class="metric-title">{key}</div>

src/duckdb_py/duckdb_python.cpp

@@ -132,8 +132,8 @@ static void InitializeConnectionMethods(py::module_ &m) {
 		    }
 		    return conn->GetProfilingInformation(format);
 	    },
-	    "Get profiling information from a query", py::kw_only(), py::arg("format") = "json", 
-		py::arg("connection") = py::none());
+	    "Get profiling information from a query", py::kw_only(), py::arg("format") = "json",
+	    py::arg("connection") = py::none());
 	m.def(
 	    "enable_profiling",
 	    [](shared_ptr<DuckDBPyConnection> conn = nullptr) {

src/duckdb_py/pyconnection.cpp

@@ -286,7 +286,8 @@ static void InitializeConnectionMethods(py::class_<DuckDBPyConnection, shared_pt
 	      py::arg("extension"), py::kw_only(), py::arg("force_install") = false, py::arg("repository") = py::none(),
 	      py::arg("repository_url") = py::none(), py::arg("version") = py::none());
 	m.def("load_extension", &DuckDBPyConnection::LoadExtension, "Load an installed extension", py::arg("extension"));
-	m.def("get_profiling_information", &DuckDBPyConnection::GetProfilingInformation, "Get profiling information for a query", py::arg("format") = "json");
+	m.def("get_profiling_information", &DuckDBPyConnection::GetProfilingInformation,
+	      "Get profiling information for a query", py::arg("format") = "json");
 	m.def("enable_profiling", &DuckDBPyConnection::EnableProfiling, "Enable profiling for subsequent queries");
 	m.def("disable_profiling", &DuckDBPyConnection::DisableProfiling, "Disable profiling for subsequent queries");
 } // END_OF_CONNECTION_METHODS
@@ -351,7 +352,9 @@ py::str DuckDBPyConnection::GetProfilingInformation(const py::str &format) {
 	} else if (format == "graphviz") {
 		format_enum = ProfilerPrintFormat::GRAPHVIZ;
 	} else {
-		throw InvalidInputException("Invalid ProfilerPrintFormat string: " + std::string(format) + ". Valid options are: query_tree, json, query_tree_optimizer, no_output, html, graphviz.");
+		throw InvalidInputException(
+		    "Invalid ProfilerPrintFormat string: " + std::string(format) +
+		    ". Valid options are: query_tree, json, query_tree_optimizer, no_output, html, graphviz.");
 	}
 	auto &connection = con.GetConnection();
 	py::str profiling_info = connection.GetProfilingInformation(format_enum);

tests/fast/test_profiler.py

@@ -1,8 +1,11 @@
-import pytest
 import json
+
+import pytest
+
 import duckdb
 from duckdb.query_graph import translate_json_to_html
 
+
 @pytest.fixture(scope="session")
 def profiling_connection():
     con = duckdb.connect()
@@ -11,19 +14,35 @@ def profiling_connection():
     yield con
     con.close()
 
+
 class TestProfiler:
-    def test_profiler_matches_expected_format(self, profiling_connection, tmp_path_factory):        
+    def test_profiler_matches_expected_format(self, profiling_connection, tmp_path_factory):
         # Test String returned
         profiling_info_json = profiling_connection.get_profiling_information(format="json")
         assert isinstance(profiling_info_json, str)
-        
+
         # Test expected metrics are there and profiling is json loadable
         profiling_dict = json.loads(profiling_info_json)
-        expected_keys = {'query_name', 'total_bytes_written', 'total_bytes_read', 'system_peak_temp_dir_size', 'system_peak_buffer_memory', 'rows_returned', 'result_set_size', 'latency', 'cumulative_rows_scanned', 'cumulative_cardinality', 'cpu_time', 'extra_info', 'blocked_thread_time', 'children'}
+        expected_keys = {
+            "query_name",
+            "total_bytes_written",
+            "total_bytes_read",
+            "system_peak_temp_dir_size",
+            "system_peak_buffer_memory",
+            "rows_returned",
+            "result_set_size",
+            "latency",
+            "cumulative_rows_scanned",
+            "cumulative_cardinality",
+            "cpu_time",
+            "extra_info",
+            "blocked_thread_time",
+            "children",
+        }
         assert profiling_dict.keys() == expected_keys
 
     def test_profiler_html_output(self, profiling_connection, tmp_path_factory):
         tmp_dir = tmp_path_factory.mktemp("profiler", numbered=True)
         profiling_info_json = profiling_connection.get_profiling_information(format="json")
         # Test HTML execution works, nothing to assert!
-        translate_json_to_html(input_text = profiling_info_json, output_file = f"{tmp_dir}/profiler_output.html")
+        translate_json_to_html(input_text=profiling_info_json, output_file=f"{tmp_dir}/profiler_output.html")