gnatdbg: add type hints

Change-Id: Ib0f0cafe4927fc3c581f58d2e90a502b5b3a1544
TN: V707-013

Author: pmderodat

gnatdbg/__init__.py

@@ -29,7 +29,7 @@
 _printers = None
 
 
-def create_printers(name="gnat-runtime"):
+def create_printers(name: str = "gnat-runtime") -> GDBPrettyPrinters:
     """
     Instantiate GDBPrettyPrinters with the given name and register all
     pretty-printers for the GNAT runtime in it. Return this instance.
@@ -60,7 +60,7 @@ def create_printers(name="gnat-runtime"):
     return printers
 
 
-def setup(name="gnat-runtime", globally=True):
+def setup(name: str = "gnat-runtime", globally: bool = True) -> None:
     """
     Instantiate pretty-printers for the GNAT runtime with the given name and
     register them.

gnatdbg/big_numbers.py

@@ -13,21 +13,21 @@ class BigInteger:
     Helper class to inspect Big_Integer values.
     """
 
-    def __init__(self, value):
+    def __init__(self, value: gdb.Value):
         self.value = value
 
     @property
-    def _bignum_address(self):
+    def _bignum_address(self) -> gdb.Value:
         return self.value["value"]["c"]
 
     @property
-    def is_valid(self):
+    def is_valid(self) -> bool:
         """
         Return whether this big integer is valid.
         """
         return bool(self._bignum_address)
 
-    def get(self):
+    def get(self) -> int:
         # The data structure used to store big numbers is
         # System.Shared_Bignums.Bignum_Data. Unfortunately, in most cases we
         # don't have debug info for this type, so we have to poke blindly at
@@ -54,7 +54,7 @@ def get(self):
         data_array = data_ptr.cast(array_ptr_type).dereference()
 
         result = 0
-        for i in range(length):
+        for i in range(int(length)):
             result = result << 32 | int(data_array[i + 1])
 
         if neg:
@@ -68,19 +68,19 @@ class BigReal:
     Helper class to inspect Big_Real values.
     """
 
-    def __init__(self, value):
+    def __init__(self, value: gdb.Value):
         self.value = value
         self.numerator = BigInteger(value["num"])
         self.denominator = BigInteger(value["den"])
 
     @property
-    def is_valid(self):
+    def is_valid(self) -> bool:
         return self.numerator.is_valid and self.denominator.is_valid
 
-    def get_numerator(self):
+    def get_numerator(self) -> int:
         return self.numerator.get()
 
-    def get_denominator(self):
+    def get_denominator(self) -> int:
         return self.denominator.get()
 
 
@@ -90,7 +90,7 @@ class BigIntegerPrinter(PrettyPrinter):
     name = "Big_Integer"
     type_pretty_name = "ada.numerics.big_numbers.big_integers.big_integer"
 
-    def to_string(self):
+    def to_string(self) -> str:
         val = BigInteger(self.value)
         value = None
         try:
@@ -110,7 +110,7 @@ class BigRealPrinter(PrettyPrinter):
     name = "Big_Real"
     type_pretty_name = "ada.numerics.big_numbers.big_reals.big_real"
 
-    def to_string(self):
+    def to_string(self) -> str:
         val = BigReal(self.value)
         try:
             value_repr = (

gnatdbg/debug.py

@@ -2,23 +2,26 @@
 Helpers to ease the discovery/debugging of GDB's Python API.
 """
 
+from __future__ import annotations
+
 import itertools
+from typing import Dict, Tuple
 
 import gdb
 
 from gnatdbg.utils import gdb_code_names
 
 
-def print_type_tree(typeobj):
+def print_type_tree(typeobj: gdb.Type) -> None:
     """
     Print a GDB type as a tree on the standard output.
 
     :param gdb.Type typeobj: Root type for the tree to print.
     """
     counter = iter(itertools.count(0))
-    visited = {}
+    visited: Dict[Tuple[int, str, str], int] = {}
 
-    def helper(t, indent=1):
+    def helper(t: gdb.Type, indent: int = 1) -> str:
         indent_str = "  " * indent
         code_name = gdb_code_names[t.code]
 
@@ -65,10 +68,10 @@ class PrintGDBTypeTreeCommand(gdb.Command):
     GDB view of user types, i.e. trees of gdb.Type instances.
     """
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__("dbgtype", gdb.COMMAND_NONE, gdb.COMPLETE_SYMBOL)
 
-    def invoke(self, arg, from_tty):
+    def invoke(self, arg: str, from_tty: bool) -> None:
         argv = gdb.string_to_argv(arg)
         typeobj = gdb.parse_and_eval(argv[0]).type
         print_type_tree(typeobj)