summaryrefslogtreecommitdiff
path: root/python
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2023-09-20 17:57:40 -0700
committerJordan Wiens <jordan@psifertex.com>2023-09-20 17:57:40 -0700
commit77d6ab57c9beb60a2ffb450a8603bad9c53902d6 (patch)
tree0f3400fc13c460a779086f6a913ade7762ab8a4c /python
parent1299153666110369829676107128448985693716 (diff)
standardize deprecation format and linkify suggestions
Diffstat (limited to 'python')
-rw-r--r--python/__init__.py2
-rw-r--r--python/binaryview.py58
-rw-r--r--python/function.py70
3 files changed, 65 insertions, 65 deletions
diff --git a/python/__init__.py b/python/__init__.py
index d1de2d91..4a9d1d1c 100644
--- a/python/__init__.py
+++ b/python/__init__.py
@@ -337,7 +337,7 @@ def load(*args, **kwargs) -> BinaryView:
return bv
-@deprecation.deprecated(deprecated_in="3.5.4378", details='Use `load` instead')
+@deprecation.deprecated(deprecated_in="3.5.4378", details='Use :py:func:`BinaryView.load` instead')
def open_view(*args, **kwargs) -> BinaryView:
return load(*args, **kwargs)
diff --git a/python/binaryview.py b/python/binaryview.py
index 531da297..8a439ce2 100644
--- a/python/binaryview.py
+++ b/python/binaryview.py
@@ -1168,14 +1168,14 @@ class BinaryViewType(metaclass=_BinaryViewTypeMetaclass):
# TODO : Check if we need binary_view_type's at all after these deprecations? (move add_binaryview_finalized_event and add_binaryview_initial_analysis_completion_event to BinaryView?)
@classmethod
- @deprecation.deprecated(deprecated_in="3.5.4378", details="Use `binaryninja.load` instead")
+ @deprecation.deprecated(deprecated_in="3.5.4378", details="Use :py:func:`binaryninja.load` instead.")
def get_view_of_file(
cls, filename: PathType, update_analysis: bool = True, progress_func: Optional[ProgressFuncType] = None
) -> Optional['BinaryView']:
return BinaryViewType.load(filename, update_analysis, progress_func)
@classmethod
- @deprecation.deprecated(deprecated_in="3.5.4378", details="Use `binaryninja.load` instead")
+ @deprecation.deprecated(deprecated_in="3.5.4378", details="Use :py:func:`binaryninja.load` instead.")
def get_view_of_file_with_options(
cls, filename: Union[str, 'os.PathLike'], update_analysis: Optional[bool] = True, progress_func: Optional[ProgressFuncType] = None,
options: Mapping[str, Any] = {}
@@ -1183,7 +1183,7 @@ class BinaryViewType(metaclass=_BinaryViewTypeMetaclass):
return BinaryViewType.load(filename, update_analysis, progress_func, options)
@classmethod
- @deprecation.deprecated(deprecated_in="3.5.4378", details="Use `binaryninja.load` instead")
+ @deprecation.deprecated(deprecated_in="3.5.4378", details="Use :py:func:`binaryninja.load` instead.")
def load_raw_view_with_options(
cls, raw_view: Optional['BinaryView'], update_analysis: Optional[bool] = True, progress_func: Optional[ProgressFuncType] = None,
options: Mapping[str, Any] = {}
@@ -1193,7 +1193,7 @@ class BinaryViewType(metaclass=_BinaryViewTypeMetaclass):
return BinaryViewType.load(raw_view, update_analysis, progress_func, options)
@classmethod
- @deprecation.deprecated(deprecated_in="3.5.4378", details="Use `binaryninja.load` instead")
+ @deprecation.deprecated(deprecated_in="3.5.4378", details="Use :py:func:`binaryninja.load` instead.")
def load(
cls, source: Union[str, bytes, bytearray, 'databuffer.DataBuffer', 'os.PathLike', 'BinaryView'], update_analysis: Optional[bool] = True,
progress_func: Optional[ProgressFuncType] = None, options: Mapping[str, Any] = {}) -> Optional['BinaryView']:
@@ -1315,7 +1315,7 @@ class Segment:
x = "x" if self.executable else "-"
return f"<segment: {self.start:#x}-{self.end:#x}, {r}{w}{x}>"
- @deprecation.deprecated(deprecated_in="3.4.3997", details="Use .length instead. Python disallows the length of an object to "
+ @deprecation.deprecated(deprecated_in="3.4.3997", details="Use :py:attr:`length` instead. Python disallows the length of an object to "
">= 0x8000000000000000. See https://bugs.python.org/issue21444.")
def __len__(self):
return self.length
@@ -1421,7 +1421,7 @@ class Section:
def __repr__(self):
return f"<section {self.name}: {self.start:#x}-{self.end:#x}>"
- @deprecation.deprecated(deprecated_in="3.4.3997", details="Use .length instead. Python disallows the length of an object to "
+ @deprecation.deprecated(deprecated_in="3.4.3997", details="Use :py:attr:`length` instead. Python disallows the length of an object to "
">= 0x8000000000000000. See https://bugs.python.org/issue21444.")
def __len__(self):
return self.length
@@ -2083,7 +2083,7 @@ class BinaryView:
return f"<BinaryView: '{filename}', {size}>"
return f"<BinaryView: {size}>"
- @deprecation.deprecated(deprecated_in="3.4.3997", details="Use .length instead. Python disallows the length of an object to "
+ @deprecation.deprecated(deprecated_in="3.4.3997", details="Use :py:attr:`length` instead. Python disallows the length of an object to "
">= 0x8000000000000000. See https://bugs.python.org/issue21444.")
def __len__(self):
return int(core.BNGetViewLength(self.handle))
@@ -5533,29 +5533,29 @@ class BinaryView:
core.BNAddTag(self.handle, tag.handle, user)
core.BNAddUserDataTag(self.handle, addr, tag.handle)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tag_type instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tag_type` instead.')
def get_tag_type_by_name(self, name: str) -> Optional['TagType']:
tag_type = core.BNGetTagType(self.handle, name)
if tag_type is None:
return None
return TagType(tag_type)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tag_type instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tag_type` instead.')
def get_tag_type_by_id(self, id: str) -> Optional['TagType']:
tag_type = core.BNGetTagTypeById(self.handle, id)
if tag_type is None:
return None
return TagType(tag_type)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use add_tag instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`add_tag` instead.')
def create_user_tag(self, type: 'TagType', data: str) -> 'Tag':
return self.create_tag(type, data, True)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use add_tag instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`add_tag` instead.')
def create_auto_tag(self, type: 'TagType', data: str) -> 'Tag':
return self.create_tag(type, data, False)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use add_tag instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`add_tag` instead.')
def create_tag(self, tag_type: 'TagType', data: str, user: bool = True) -> 'Tag':
if not isinstance(tag_type, TagType):
raise ValueError(f"type is not a TagType instead got {type(tag_type)} : {repr(tag_type)}")
@@ -5613,12 +5613,12 @@ class BinaryView:
core.BNFreeTagReferences(tags, count.value)
@property
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use tags instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:attr:`tags` instead.')
def data_tags(self) -> List[Tuple[int, 'Tag']]:
return self.tags
@property
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags` instead.')
def auto_data_tags(self) -> List[Tuple[int, 'Tag']]:
count = ctypes.c_ulonglong()
tags = core.BNGetAutoDataTagReferences(self.handle, count)
@@ -5637,7 +5637,7 @@ class BinaryView:
core.BNFreeTagReferences(tags, count.value)
@property
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags` instead.')
def user_data_tags(self) -> List[Tuple[int, 'Tag']]:
count = ctypes.c_ulonglong()
refs = core.BNGetUserDataTagReferences(self.handle, count)
@@ -5685,19 +5685,19 @@ class BinaryView:
finally:
core.BNFreeTagList(tags, count.value)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags_at instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags_at` instead.')
def get_data_tags_at(self, addr: int, auto: Optional[bool] = None) -> List['Tag']:
return self.get_tags_at(addr, auto)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags_at instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags_at` instead.')
def get_auto_data_tags_at(self, addr: int) -> List['Tag']:
return self.get_tags_at(addr, True)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags_at instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags_at` instead.')
def get_user_data_tags_at(self, addr: int) -> List['Tag']:
return self.get_tags_at(addr, False)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags_at instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags_at` instead.')
def get_data_tags_of_type(self, addr: int, tag_type: str, auto: Optional[bool] = None) -> List['Tag']:
count = ctypes.c_ulonglong()
@@ -5725,7 +5725,7 @@ class BinaryView:
finally:
core.BNFreeTagList(tags, count.value)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags_at instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags_at` instead.')
def get_auto_data_tags_of_type(self, addr: int, tag_type: 'TagType') -> List['Tag']:
count = ctypes.c_ulonglong()
tags = core.BNGetAutoDataTagsOfType(self.handle, addr, tag_type.handle, count)
@@ -5740,7 +5740,7 @@ class BinaryView:
finally:
core.BNFreeTagList(tags, count.value)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags_at instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags_at` instead.')
def get_user_data_tags_of_type(self, addr: int, tag_type: 'TagType') -> List['Tag']:
count = ctypes.c_ulonglong()
tags = core.BNGetUserDataTagsOfType(self.handle, addr, tag_type.handle, count)
@@ -5787,23 +5787,23 @@ class BinaryView:
finally:
core.BNFreeTagReferences(refs, count.value)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags_in_range instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags_in_range` instead.')
def get_data_tags_in_range(self, address_range: 'variable.AddressRange', user: Optional[bool] = None) -> List[Tuple[int, 'Tag']]:
return self.get_tags_in_range(address_range, user)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags_in_range instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags_in_range` instead.')
def get_auto_data_tags_in_range(self, address_range: 'variable.AddressRange') -> List[Tuple[int, 'Tag']]:
return self.get_tags_in_range(address_range, True)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags_in_range instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags_in_range` instead.')
def get_user_data_tags_in_range(self, address_range: 'variable.AddressRange') -> List[Tuple[int, 'Tag']]:
return self.get_tags_in_range(address_range, False)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use add_tag instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`add_tag` instead')
def add_user_data_tag(self, addr: int, tag: 'Tag'):
core.BNAddUserDataTag(self.handle, addr, tag.handle)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use add_tag instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`add_tag` instead')
def create_user_data_tag(self, addr: int, type: 'TagType', data: str, unique: bool = False) -> 'Tag':
if unique:
tags = self.get_data_tags_at(addr)
@@ -5839,11 +5839,11 @@ class BinaryView:
if tag_type is not None:
core.BNRemoveUserDataTagsOfType(self.handle, addr, tag_type.handle)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='use add_tag instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`add_tag` instead')
def add_auto_data_tag(self, addr: int, tag: 'Tag'):
core.BNAddAutoDataTag(self.handle, addr, tag.handle)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='use add_tag instead')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`add_tag` instead')
def create_auto_data_tag(self, addr: int, type: 'TagType', data: str, unique: bool = False) -> 'Tag':
if unique:
tags = self.get_data_tags_at(addr)
@@ -9207,7 +9207,7 @@ class StructuredDataView(object):
>>>
"""
- @deprecation.deprecated(deprecated_in="3.4.3997", details='Use TypedDataAccessor or DataVariable.value instead.')
+ @deprecation.deprecated(deprecated_in="3.4.3997", details='Use :py:class:`TypedDataAccessor` or :py:attr:`DataVariable.value` instead.')
def __init__(self, bv: 'BinaryView', structure_name: '_types.QualifiedNameType', address: int):
self._bv = bv
self._structure_name = structure_name
diff --git a/python/function.py b/python/function.py
index 4bd48d54..f558a8e8 100644
--- a/python/function.py
+++ b/python/function.py
@@ -562,7 +562,7 @@ class Function:
core.BNSetUserFunctionPure(self.handle, bc)
@property
- @deprecation.deprecated(deprecated_in="3.4.4049", details="Use Function.has_explicitly_defined_type instead.")
+ @deprecation.deprecated(deprecated_in="3.4.4049", details="Use :py:attr:`Function.has_explicitly_defined_type` instead.")
def explicitly_defined_type(self) -> bool:
"""Whether function has explicitly defined types (read-only)"""
return self.has_explicitly_defined_type
@@ -790,24 +790,24 @@ class Function:
else:
core.BNAddUserAddressTag(self.handle, arch.handle, addr, tag.handle)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use add_tag instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`add_tag` instead.')
def create_user_tag(self, type: 'binaryview.TagType', data: str = "") -> 'binaryview.Tag':
return self.create_tag(type, data, True)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use add_tag instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`add_tag` instead.')
def create_auto_tag(self, type: 'binaryview.TagType', data: str = "") -> 'binaryview.Tag':
return self.create_tag(type, data, False)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use add_tag instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`add_tag` instead.')
def create_tag(self, type: 'binaryview.TagType', data: str = "", auto: bool = False) -> 'binaryview.Tag':
return self.view.create_tag(type, data, auto)
@property
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use tags instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:attr:`Function.tags` instead.')
def address_tags(self) -> TagList:
return TagList(self)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags_at instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags_at` instead.')
def get_address_tags_at(self, addr: int,
arch: Optional['architecture.Architecture'] = None) -> List['binaryview.Tag']:
if arch is None:
@@ -825,7 +825,7 @@ class Function:
finally:
core.BNFreeTagList(tags, count.value)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use add_tag instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`add_tag` instead.')
def add_user_address_tag(
self, addr: int, tag: 'binaryview.Tag', arch: Optional['architecture.Architecture'] = None
) -> None:
@@ -833,7 +833,7 @@ class Function:
arch = self.arch
core.BNAddUserAddressTag(self.handle, arch.handle, addr, tag.handle)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use add_tag instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`add_tag` instead.')
def create_user_address_tag(
self, addr: int, tag_type: 'binaryview.TagType', data: str, unique: bool = False,
arch: Optional['architecture.Architecture'] = None
@@ -868,7 +868,7 @@ class Function:
arch = self.arch
core.BNRemoveUserAddressTag(self.handle, arch.handle, addr, tag.handle)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use add_tag instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`add_tag` instead.')
def add_auto_address_tag(
self, addr: int, tag: 'binaryview.Tag', arch: Optional['architecture.Architecture'] = None
) -> None:
@@ -876,7 +876,7 @@ class Function:
arch = self.arch
core.BNAddAutoAddressTag(self.handle, arch.handle, addr, tag.handle)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use add_tag instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`add_tag` instead.')
def create_auto_address_tag(
self, addr: int, type: 'binaryview.TagType', data: str, unique: bool = False,
arch: Optional['architecture.Architecture'] = None
@@ -894,7 +894,7 @@ class Function:
return tag
@property
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_function_tags instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py;func:`get_function_tags` instead.')
def function_tags(self) -> List['binaryview.Tag']:
count = ctypes.c_ulonglong()
tags = core.BNGetFunctionTags(self.handle, count)
@@ -909,11 +909,11 @@ class Function:
finally:
core.BNFreeTagList(tags, count.value)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use add_tag instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`add_tag` instead.')
def add_user_function_tag(self, tag: 'binaryview.Tag') -> None:
core.BNAddUserFunctionTag(self.handle, tag.handle)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use add_tag instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`add_tag` instead.')
def create_user_function_tag(self, type: 'binaryview.TagType', data: str, unique: bool = False) -> 'binaryview.Tag':
if unique:
for tag in self.function_tags:
@@ -934,11 +934,11 @@ class Function:
"""
core.BNRemoveUserFunctionTag(self.handle, tag.handle)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use add_tag instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`add_tag` instead.')
def add_auto_function_tag(self, tag: 'binaryview.Tag') -> None:
core.BNAddAutoFunctionTag(self.handle, tag.handle)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use add_tag instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`add_tag` instead.')
def create_auto_function_tag(self, type: 'binaryview.TagType', data: str, unique: bool = False) -> 'binaryview.Tag':
if unique:
for tag in self.function_tags:
@@ -950,7 +950,7 @@ class Function:
return tag
@property
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use tags instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:attr:`tags` instead.')
def auto_address_tags(self) -> List[Tuple['architecture.Architecture', int, 'binaryview.Tag']]:
count = ctypes.c_ulonglong()
tags = core.BNGetAutoAddressTagReferences(self.handle, count)
@@ -968,7 +968,7 @@ class Function:
core.BNFreeTagReferences(tags, count.value)
@property
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use tags instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:attr:`tags` instead.')
def user_address_tags(self):
count = ctypes.c_ulonglong()
tags = core.BNGetUserAddressTagReferences(self.handle, count)
@@ -985,7 +985,7 @@ class Function:
finally:
core.BNFreeTagReferences(tags, count.value)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags_at instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags_at` instead.')
def get_auto_address_tags_at(self, addr, arch=None):
if arch is None:
assert self.arch is not None, "Can't call get_auto_address_tags_at for function with no architecture specified"
@@ -1003,7 +1003,7 @@ class Function:
finally:
core.BNFreeTagList(tags, count.value)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags_at instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags_at` instead.')
def get_user_address_tags_at(self, addr, arch=None):
if arch is None:
assert self.arch is not None, "Can't call get_user_address_tags_at for function with no architecture specified"
@@ -1021,7 +1021,7 @@ class Function:
finally:
core.BNFreeTagList(tags, count.value)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags_at instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags_at` instead.')
def get_address_tags_of_type(self, addr: int, tag_type: 'binaryview.TagType', arch=None):
if arch is None:
assert self.arch is not None, "Can't call get_address_tags_of_type for function with no architecture specified"
@@ -1039,7 +1039,7 @@ class Function:
finally:
core.BNFreeTagList(tags, count.value)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags_at instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags_at` instead.')
def get_auto_address_tags_of_type(
self, addr: int, tag_type: 'binaryview.TagType', arch: Optional['architecture.Architecture'] = None
):
@@ -1059,7 +1059,7 @@ class Function:
finally:
core.BNFreeTagList(tags, count.value)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags_at instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags_at` instead.')
def get_user_address_tags_of_type(
self, addr: int, tag_type: 'binaryview.TagType', arch: Optional['architecture.Architecture'] = None
):
@@ -1079,7 +1079,7 @@ class Function:
finally:
core.BNFreeTagList(tags, count.value)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags_in_range instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags_in_range` instead.')
def get_address_tags_in_range(
self, address_range: 'variable.AddressRange', arch: Optional['architecture.Architecture'] = None
) -> List[Tuple['architecture.Architecture', int, 'binaryview.Tag']]:
@@ -1100,7 +1100,7 @@ class Function:
finally:
core.BNFreeTagReferences(refs, count.value)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags_in_range instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags_in_range` instead.')
def get_auto_address_tags_in_range(
self, address_range: 'variable.AddressRange', arch: Optional['architecture.Architecture'] = None
) -> List[Tuple['architecture.Architecture', int, 'binaryview.Tag']]:
@@ -1121,7 +1121,7 @@ class Function:
finally:
core.BNFreeTagReferences(refs, count.value)
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_tags_in_range instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_tags_in_range` instead.')
def get_user_address_tags_in_range(
self, address_range: 'variable.AddressRange', arch: Optional['architecture.Architecture'] = None
) -> List[Tuple['architecture.Architecture', int, 'binaryview.Tag']]:
@@ -1189,7 +1189,7 @@ class Function:
core.BNRemoveAutoAddressTagsOfType(self.handle, arch.handle, addr, tag_type.handle)
@property
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_function_tags instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_function_tags` instead.')
def auto_function_tags(self):
count = ctypes.c_ulonglong()
tags = core.BNGetAutoFunctionTags(self.handle, count)
@@ -1203,7 +1203,7 @@ class Function:
return result
@property
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_function_tags instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_function_tags` instead.')
def user_function_tags(self):
count = ctypes.c_ulonglong()
tags = core.BNGetUserFunctionTags(self.handle, count)
@@ -1216,7 +1216,7 @@ class Function:
core.BNFreeTagList(tags, count.value)
return result
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_function_tags instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_function_tags` instead.')
def get_function_tags_of_type(self, tag_type):
count = ctypes.c_ulonglong()
tags = core.BNGetFunctionTagsOfType(self.handle, tag_type.handle, count)
@@ -1229,7 +1229,7 @@ class Function:
core.BNFreeTagList(tags, count.value)
return result
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_function_tags instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_function_tags` instead.')
def get_auto_function_tags_of_type(self, tag_type):
count = ctypes.c_ulonglong()
tags = core.BNGetAutoFunctionTagsOfType(self.handle, tag_type.handle, count)
@@ -1242,7 +1242,7 @@ class Function:
core.BNFreeTagList(tags, count.value)
return result
- @deprecation.deprecated(deprecated_in="3.4.4146", details='Use get_function_tags instead.')
+ @deprecation.deprecated(deprecated_in="3.4.4146", details='Use :py:func:`get_function_tags` instead.')
def get_user_function_tags_of_type(self, tag_type):
count = ctypes.c_ulonglong()
tags = core.BNGetUserFunctionTagsOfType(self.handle, tag_type.handle, count)
@@ -1388,7 +1388,7 @@ class Function:
return highlevelil.HighLevelILFunction(self.arch, result, self)
@property
- @deprecation.deprecated(deprecated_in="3.4.3997", details="Use .type instead", current_version=__version__)
+ @deprecation.deprecated(deprecated_in="3.4.3997", details="Use :py:attr:`type` instead", current_version=__version__)
def function_type(self) -> 'types.FunctionType':
"""
Function type object, can be set with either a string representing the function prototype
@@ -1397,7 +1397,7 @@ class Function:
return self.type
@function_type.setter
- @deprecation.deprecated(deprecated_in="3.4.3997", details="Use .type instead", current_version=__version__)
+ @deprecation.deprecated(deprecated_in="3.4.3997", details="Use :py:attr:`type` instead", current_version=__version__)
def function_type(self, value: Union['types.FunctionType', str]) -> None:
self.type = value
@@ -1773,7 +1773,7 @@ class Function:
start += i[1]
@property
- @deprecation.deprecated(deprecated_in="3.4.3997", details="Use LowLevelIlFunction.instructions instead.")
+ @deprecation.deprecated(deprecated_in="3.4.3997", details="Use :py:attr:`LowLevelIlFunction.instructions` instead.")
def llil_instructions(self) -> Generator['lowlevelil.LowLevelILInstruction', None, None]:
"""
.. note:: Use :py:meth:`LowLevelIlFunction.instructions` instead.
@@ -1781,7 +1781,7 @@ class Function:
return self.llil.instructions
@property
- @deprecation.deprecated(deprecated_in="3.4.3997", details="Use MediumLevelIlFunction.instructions instead.")
+ @deprecation.deprecated(deprecated_in="3.4.3997", details="Use :py:attr:`MediumLevelIlFunction.instructions` instead.")
def mlil_instructions(self) -> Generator['mediumlevelil.MediumLevelILInstruction', None, None]:
"""
.. note:: Use :py:meth:`MediumLevelIlFunction.instructions` instead.
@@ -1882,7 +1882,7 @@ class Function:
def get_comment_at(self, addr: int) -> str:
return core.BNGetCommentForAddress(self.handle, addr)
- @deprecation.deprecated(deprecated_in="3.4.3997", details="Use Function.set_comment_at instead.")
+ @deprecation.deprecated(deprecated_in="3.4.3997", details="Use :py:func:`Function.set_comment_at` instead.")
def set_comment(self, addr: int, comment: str) -> None:
"""
.. note:: Use :py:meth:`set_comment_at` instead.