From 8f7a432d365c19ba2f143b5163ebc83d62fa6674 Mon Sep 17 00:00:00 2001
From: Bradley Dice <bdice@bradleydice.com>
Date: Tue, 11 Oct 2022 12:17:07 -0500
Subject: [PATCH] Format gdb script. (#1127)

This applies rmm's configured pre-commit hooks to format the gdb pretty printer script that was recently added (#1088). I would like to move rmm to use pre-commit for all style checks (as was recently done for cudf) and this is a prerequisite step.

Authors:
  - Bradley Dice (https://github.com/bdice)

Approvers:
  - GALI PREM SAGAR (https://github.com/galipremsagar)
  - Mark Harris (https://github.com/harrism)

URL: https://github.com/rapidsai/rmm/pull/1127
---
 scripts/gdb-pretty-printers.py | 35 +++++++++++++++++++++-------------
 1 file changed, 22 insertions(+), 13 deletions(-)

diff --git a/scripts/gdb-pretty-printers.py b/scripts/gdb-pretty-printers.py
index df6a662ee..f541b0c2e 100644
--- a/scripts/gdb-pretty-printers.py
+++ b/scripts/gdb-pretty-printers.py
@@ -38,7 +38,7 @@ def __next__(self):
 
 
 class DeviceIterator:
-    """Iterates over arrays in device memory by copying chunks into host memory."""
+    """Iterates over device arrays by copying chunks to the host."""
 
     def __init__(self, start, size):
         self.exec = exec
@@ -49,27 +49,33 @@ def __init__(self, start, size):
         self.sizeof = self.item.dereference().type.sizeof
         self.buffer_start = 0
         # At most 1 MB or size, at least 1
-        self.buffer_size = min(size, max(1, 2 ** 20 // self.sizeof))
-        self.buffer = gdb.parse_and_eval(f"(void*)malloc({self.buffer_size * self.sizeof})")
+        self.buffer_size = min(size, max(1, 2**20 // self.sizeof))
+        self.buffer = gdb.parse_and_eval(
+            f"(void*)malloc({self.buffer_size * self.sizeof})"
+        )
         self.buffer.fetch_lazy()
         self.buffer_count = self.buffer_size
         self.update_buffer()
 
     def update_buffer(self):
         if self.buffer_count >= self.buffer_size:
-            self.buffer_item = gdb.parse_and_eval(
-                hex(self.buffer)).cast(self.item.type)
+            self.buffer_item = gdb.parse_and_eval(hex(self.buffer)).cast(
+                self.item.type
+            )
             self.buffer_count = 0
             self.buffer_start = self.count
             device_addr = hex(self.item.dereference().address)
             buffer_addr = hex(self.buffer)
-            size = min(self.buffer_size, self.size -
-                        self.buffer_start) * self.sizeof
+            size = (
+                min(self.buffer_size, self.size - self.buffer_start)
+                * self.sizeof
+            )
             status = gdb.parse_and_eval(
-                f"(cudaError)cudaMemcpy({buffer_addr}, {device_addr}, {size}, cudaMemcpyDeviceToHost)")
+                f"(cudaError)cudaMemcpy({buffer_addr}, {device_addr}, {size}, "
+                "cudaMemcpyDeviceToHost)"
+            )
             if status != 0:
-                raise gdb.MemoryError(
-                    f"memcpy from device failed: {status}")
+                raise gdb.MemoryError(f"memcpy from device failed: {status}")
 
     def __del__(self):
         gdb.parse_and_eval(f"(void)free({hex(self.buffer)})").fetch_lazy()
@@ -101,16 +107,19 @@ def __init__(self, val):
         self.capacity = int(val["_storage"]["_capacity"]) // el_type.sizeof
 
     def children(self):
-        return DeviceIterator(self.pointer, self.size)        
+        return DeviceIterator(self.pointer, self.size)
 
     def to_string(self):
-        return (f"{self.val.type} of length {self.size}, capacity {self.capacity}")
+        return (
+            f"{self.val.type} of length {self.size}, capacity {self.capacity}"
+        )
 
     def display_hint(self):
         return "array"
 
 
-# Workaround to avoid using the pretty printer on things like std::vector<int>::iterator
+# Workaround to avoid using the pretty printer on things like
+# std::vector<int>::iterator
 def is_template_type_not_alias(typename):
     loc = typename.find("<")
     if loc is None: