summaryrefslogtreecommitdiff
path: root/python/project.py
diff options
context:
space:
mode:
authorPeter LaFosse <peter@vector35.com>2026-01-16 10:36:58 -0500
committerPeter LaFosse <peter@vector35.com>2026-01-16 11:51:23 -0500
commitdd31558a0a1600342da23e2d0745be01ad19202b (patch)
tree7f04ed5998d798aeb518d4956fac495e2b7c4a1a /python/project.py
parentf327d9565f49b047d38bc1a7583e5f4e3776261a (diff)
Add get_metadata() method and make query_metadata() raise KeyError consistently
Introduces a Pythonic get_metadata() method to BinaryView, Function, Project, TypeArchive, and TypeLibrary classes. This method behaves like dict.get(), returning a default value (None by default) when a key doesn't exist, instead of raising a KeyError. Additionally, updates query_metadata() in TypeArchive and TypeLibrary to raise KeyError when a key is not found, making them consistent with BinaryView, Function, and Project. Previously these two classes returned None on missing keys. This breaking change is documented in the method docstrings. This provides a more consistent and Pythonic API for querying metadata across all metadata-supporting classes. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Diffstat (limited to 'python/project.py')
-rw-r--r--python/project.py29
1 files changed, 28 insertions, 1 deletions
diff --git a/python/project.py b/python/project.py
index c3504dd4..ba7cf2d3 100644
--- a/python/project.py
+++ b/python/project.py
@@ -22,7 +22,7 @@ import ctypes
from contextlib import contextmanager
from os import PathLike
-from typing import Callable, List, Optional, Union
+from typing import Any, Callable, List, Optional, Union
import binaryninja
from . import _binaryninjacore as core
@@ -545,6 +545,33 @@ class Project:
raise KeyError(key)
return Metadata(handle=md_handle).value
+ def get_metadata(self, key: str, default: Any = None) -> 'metadata.MetadataValueType | Any':
+ """
+ `get_metadata` retrieves a metadata value associated with the given key stored in the current Project.
+
+ This method behaves like `dict.get()`:
+ - If the key exists, its metadata value is returned.
+ - If the key does not exist and `default` is not provided, `None` is returned.
+ - If the key does not exist and `default` is provided, `default` is returned.
+
+ :param str key: key to query
+ :param default: value to return if the key does not exist (defaults to None)
+ :rtype: metadata associated with the key or the default value
+ :Example:
+
+ >>> current_project.store_metadata("integer", 1337)
+ >>> current_project.get_metadata("integer")
+ 1337L
+ >>> current_project.get_metadata("missing")
+ None
+ >>> current_project.get_metadata("missing", 42)
+ 42
+ """
+ md_handle = core.BNProjectQueryMetadata(self._handle, key)
+ if md_handle is None:
+ return default
+ return Metadata(handle=md_handle).value
+
def store_metadata(self, key: str, value: MetadataValueType) -> bool:
"""
Stores metadata within the project