diff options
Diffstat (limited to 'python/function.py')
| -rw-r--r-- | python/function.py | 70 |
1 files changed, 35 insertions, 35 deletions
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. |