Improve python api type hints

Author: negasora

python/binaryview.py

@@ -80,14 +80,12 @@
 from . import deprecation
 from . import typecontainer
 from . import externallibrary
-from . import project
 from . import undo
 from . import stringrecognizer
 
 
 PathType = Union[str, os.PathLike]
 InstructionsType = Generator[Tuple[List['_function.InstructionTextToken'], int], None, None]
-NotificationType = Mapping['BinaryDataNotification', 'BinaryDataNotificationCallbacks']
 ProgressFuncType = Callable[[int, int], bool]
 DataMatchCallbackType = Callable[[int, 'databuffer.DataBuffer'], bool]
 LineMatchCallbackType = Callable[[int, 'lineardisassembly.LinearDisassemblyLine'], bool]
@@ -127,10 +125,10 @@ def llil(self) -> Optional[lowlevelil.LowLevelILInstruction]:
 		return self.function.get_low_level_il_at(self.address, self.arch)
 
 	@property
-	def llils(self) -> Iterator[lowlevelil.LowLevelILInstruction]:
+	def llils(self) -> List[lowlevelil.LowLevelILInstruction]:
 		"""Returns the low level il instructions at the current location if any exists"""
 		if self.function is None or self.arch is None:
-			return
+			return []
 		return self.function.get_low_level_ils_at(self.address, self.arch)
 
 	@property
@@ -306,7 +304,7 @@ class BinaryDataNotification:
 	>>>
 	"""
 
-	def __init__(self, notifications: NotificationType = None):
+	def __init__(self, notifications: Optional[NotificationType] = None):
 		self.notifications = notifications
 
 	def notification_barrier(self, view: 'BinaryView') -> int:
@@ -826,7 +824,7 @@ def __init__(self, view: 'BinaryView', notify: 'BinaryDataNotification'):
 		self._notify = notify
 		self._cb = core.BNBinaryDataNotification()
 		self._cb.context = 0
-		if (not hasattr(notify, 'notifications')) or (hasattr(notify, 'notifications') and notify.notifications is None):
+		if (not hasattr(notify, 'notifications')) or (notify.notifications is None):
 			self._cb.notificationBarrier = self._cb.notificationBarrier
 			self._cb.dataWritten = self._cb.dataWritten.__class__(self._data_written)
 			self._cb.dataInserted = self._cb.dataInserted.__class__(self._data_inserted)
@@ -9369,7 +9367,7 @@ def find_next_constant(
 		return result.value
 
 	class QueueGenerator:
-		def __init__(self, t, results):
+		def __init__(self, t: threading.Thread, results: queue.Queue):
 			self.thread = t
 			self.results = results
 			t.start()
@@ -9388,7 +9386,7 @@ def __next__(self):
 	def find_all_data(
 	    self, start: int, end: int, data: bytes, flags: FindFlag = FindFlag.FindCaseSensitive,
 	    progress_func: Optional[ProgressFuncType] = None, match_callback: Optional[DataMatchCallbackType] = None
-	) -> QueueGenerator:
+	) -> Union[QueueGenerator, bool]:
 		"""
 		``find_all_data`` searches for the bytes ``data`` starting at the virtual address ``start``
 		until the virtual address ``end``. Once a match is found, the ``match_callback`` is called.
@@ -9464,7 +9462,7 @@ def find_all_text(
 	    self, start: int, end: int, text: str, settings: Optional[_function.DisassemblySettings] = None,
 	    flags=FindFlag.FindCaseSensitive, graph_type: _function.FunctionViewTypeOrName = FunctionGraphType.NormalFunctionGraph, progress_func=None,
 	    match_callback=None
-	) -> QueueGenerator:
+	) -> Union[QueueGenerator, bool]:
 		"""
 		``find_all_text`` searches for string ``text`` occurring in the linear view output starting
 		at the virtual address ``start`` until the virtual address ``end``. Once a match is found,
@@ -9559,7 +9557,7 @@ def find_all_constant(
 	    self, start: int, end: int, constant: int, settings: Optional[_function.DisassemblySettings] = None,
 	    graph_type: _function.FunctionViewTypeOrName = FunctionGraphType.NormalFunctionGraph, progress_func: Optional[ProgressFuncType] = None,
 	    match_callback: Optional[LineMatchCallbackType] = None
-	) -> QueueGenerator:
+	) -> Union[QueueGenerator, bool]:
 		"""
 		``find_all_constant`` searches for the integer constant ``constant`` starting at the
 		virtual address ``start`` until the virtual address ``end``. Once a match is found,
@@ -9632,8 +9630,8 @@ def find_all_constant(
 
 			return self.QueueGenerator(t, results)
 
-	def search(self, pattern: str, start: int = None, end: int = None, raw: bool = False, ignore_case: bool = False, overlap: bool = False, align: int = 1,
-		limit: int = None, progress_callback: Optional[ProgressFuncType] = None, match_callback: Optional[DataMatchCallbackType] = None) -> QueueGenerator:
+	def search(self, pattern: str, start: Optional[int] = None, end: Optional[int] = None, raw: bool = False, ignore_case: bool = False, overlap: bool = False, align: int = 1,
+		limit: Optional[int] = None, progress_callback: Optional[ProgressFuncType] = None, match_callback: Optional[DataMatchCallbackType] = None) -> QueueGenerator:
 		r"""
 		Searches for matches of the specified ``pattern`` within this BinaryView with an optionally provided address range specified by ``start`` and ``end``.
 		This is the API used by the advanced binary search UI option. The search pattern can be interpreted in various ways:
@@ -11355,7 +11353,10 @@ def value(self, data: Union[bytes, int, float]) -> None:
 			if isinstance(self.type, (_types.IntegerType, _types.IntegerBuilder)):
 				signed = bool(self.type.signed)
 			to_write = data.to_bytes(len(self), TypedDataAccessor.byte_order(self.endian), signed=signed)  # type: ignore
-		elif isinstance(data, float) and isinstance(self.type, (_types.FloatType, _types.FloatBuilder)):
+		elif isinstance(data, float):
+			if not isinstance(self.type, (_types.FloatType, _types.FloatBuilder)):
+				raise TypeError(f"Can't set the value of type {type(self.type)} to float value")
+
 			endian = "<" if self.endian == Endianness.LittleEndian else ">"
 			if self.type.width == 2:
 				code = "e"

python/datarender.py

@@ -20,6 +20,7 @@
 
 import traceback
 import ctypes
+from typing import List, Optional
 
 import binaryninja
 from . import _binaryninjacore as core
@@ -34,7 +35,7 @@
 
 
 class TypeContext:
-	def __init__(self, _type, _offset):
+	def __init__(self, _type: types.Type, _offset: int):
 		self._type = _type
 		self._offset = _offset
 
@@ -85,7 +86,7 @@ def __del__(self):
 	"""
 	_registered_renderers = []
 
-	def __init__(self, context=None):
+	def __init__(self, context: Optional[TypeContext] = None):
 		self._cb = core.BNCustomDataRenderer()
 		self._cb.context = context
 		self._cb.freeObject = self._cb.freeObject.__class__(self._free_object)
@@ -137,7 +138,7 @@ def _get_lines_for_data(self, ctxt, view, addr, type, prefix, prefixCount, width
 			type = types.Type.create(handle=core.BNNewTypeReference(type))
 
 			prefixTokens = function.InstructionTextToken._from_core_struct(prefix, prefixCount)
-			pycontext = []
+			pycontext: List[TypeContext] = []
 			for i in range(ctxCount):
 				pycontext.append(
 				    TypeContext(types.Type.create(core.BNNewTypeReference(typeCtx[i].type)), typeCtx[i].offset)
@@ -184,13 +185,13 @@ def _free_lines(self, ctxt, lines, count):
 	def perform_free_object(self, ctxt):
 		pass
 
-	def perform_is_valid_for_data(self, ctxt, view, addr, type, context):
+	def perform_is_valid_for_data(self, ctxt, view: binaryview.BinaryView, addr: int, type: types.Type, context: List[TypeContext]) -> bool:
 		return False
 
-	def perform_get_lines_for_data(self, ctxt, view, addr, type, prefix, width, context):
+	def perform_get_lines_for_data(self, ctxt, view: binaryview.BinaryView, addr: int, type: types.Type, prefix: List[function.InstructionTextToken], width: int, context: List[TypeContext]) -> List['function.DisassemblyTextLine']:
 		return []
 
-	def perform_get_lines_for_data_with_language(self, ctxt, view, addr, type, prefix, width, context, language):
+	def perform_get_lines_for_data_with_language(self, ctxt, view: binaryview.BinaryView, addr: int, type: types.Type, prefix: List[function.InstructionTextToken], width: int, context: List[TypeContext], language: str) -> List['function.DisassemblyTextLine']:
 		return self.perform_get_lines_for_data(ctxt, view, addr, type, prefix, width, context)
 
 	def __del__(self):

python/enterprise.py

@@ -320,7 +320,7 @@ class LicenseCheckout:
 	"""
 	Helper class for scripts to make use of a license checkout in a scope.
 
-	:param duration: Duration between refreshes
+	:param duration: Duration in seconds between refreshes
 	:param _cache: Deprecated but left in for compatibility
 	:param release: If the license should be released at the end of scope. If `False`, you
 					can either manually release it later or it will expire after `duration`.
@@ -334,11 +334,11 @@ class LicenseCheckout:
 		... 		print(hex(bv.start))
 		# License is released at end of scope
 	"""
-	def __init__(self, duration=900, _cache=True, release=True):
+	def __init__(self, duration: int = 900, _cache: bool = True, release: bool = True):
 		"""
 		Get a new license checkout
 
-		:param duration: Duration between refreshes
+		:param duration: Duration in seconds between refreshes
 		:param _cache: Deprecated but left in for compatibility
 		:param release: If the license should be released at the end of scope. If `False`, you
 		                can either manually release it later or it will expire after `duration`.

python/flowgraph.py

@@ -21,7 +21,7 @@
 import ctypes
 import threading
 import traceback
-from typing import List, Optional, Tuple
+from typing import List, Optional, Tuple, Union
 
 # Binary Ninja components
 import binaryninja
@@ -41,7 +41,7 @@
 
 
 class FlowGraphEdge:
-	def __init__(self, branch_type, source, target, points, back_edge, style):
+	def __init__(self, branch_type: Union[BranchType, int], source: 'FlowGraphNode', target: 'FlowGraphNode', points: List[Tuple[float, float]], back_edge: bool, style: 'EdgeStyle'):
 		self.type = BranchType(branch_type)
 		self.source = source
 		self.target = target
@@ -85,7 +85,7 @@ def __hash__(self):
 
 
 class FlowGraphNode:
-	def __init__(self, graph=None, handle=None):
+	def __init__(self, graph: Optional['FlowGraph'] = None, handle=None):
 		_handle = handle
 		if _handle is None:
 			if graph is None:
@@ -343,7 +343,7 @@ def set_outgoing_edge_points(self, edge_num: int, points: List[Tuple[float, floa
 
 
 class FlowGraphLayoutRequest:
-	def __init__(self, graph, callback=None):
+	def __init__(self, graph: 'FlowGraph', callback=None):
 		self.on_complete = callback
 		self._cb = ctypes.CFUNCTYPE(None, ctypes.c_void_p)(self._complete)
 		self.handle = core.BNStartFlowGraphLayout(graph.handle, None, self._cb)