summaryrefslogtreecommitdiff
path: root/python/__init__.py
diff options
context:
space:
mode:
authorKyleMiles <krm504@nyu.edu>2023-06-29 20:49:26 -0400
committerKyleMiles <krm504@nyu.edu>2023-07-10 12:58:24 -0400
commit04bc6f11ae0289aae57d63d4cd32f4ef305d1a7a (patch)
tree46f06280b13fb80f2aebf0eea9b52f884e698d0c /python/__init__.py
parent7598688466960427890036590239565364310171 (diff)
Move binary view loading in to the core; deprecate open_view in favor of load; update examples
Diffstat (limited to 'python/__init__.py')
-rw-r--r--python/__init__.py33
1 files changed, 5 insertions, 28 deletions
diff --git a/python/__init__.py b/python/__init__.py
index 40415e87..d1de2d91 100644
--- a/python/__init__.py
+++ b/python/__init__.py
@@ -287,7 +287,7 @@ def core_set_license(licenseData: str) -> None:
>>> import os
>>> core_set_license(os.environ['BNLICENSE']) #Do this before creating any BinaryViews
- >>> with open_view("/bin/ls") as bv:
+ >>> with load("/bin/ls") as bv:
... print(len(list(bv.functions)))
128
'''
@@ -307,7 +307,7 @@ def get_memory_usage_info() -> Mapping[str, int]:
def load(*args, **kwargs) -> BinaryView:
"""
- `load` is a convenience wrapper for :py:class:`BinaryViewType.load` that opens a BinaryView object.
+ Opens a BinaryView object.
:param Union[str, bytes, bytearray, 'databuffer.DataBuffer', 'os.PathLike'] source: a file or byte stream to load into a virtual memory space
:param bool update_analysis: whether or not to run :func:`update_analysis_and_wait` after opening a :py:class:`BinaryView`, defaults to ``True``
@@ -331,38 +331,15 @@ def load(*args, **kwargs) -> BinaryView:
...
1
"""
- bv = BinaryViewType.load(*args, **kwargs)
+ bv = BinaryView.load(*args, **kwargs)
if bv is None:
raise Exception("Unable to create new BinaryView")
return bv
+@deprecation.deprecated(deprecated_in="3.5.4378", details='Use `load` instead')
def open_view(*args, **kwargs) -> BinaryView:
- """
- `open_view` is a convenience wrapper for :py:class:`get_view_of_file_with_options` that opens a BinaryView object.
-
- .. note:: If attempting to open a BNDB, the file MUST have the suffix .bndb, or else the file will not be loaded as a database.
-
- :param Union[str, 'os.PathLike'] filename: path to filename or bndb to open
- :param bool update_analysis: whether or not to run :func:`update_analysis_and_wait` after opening a :py:class:`BinaryView`, defaults to ``True``
- :param callback progress_func: optional function to be called with the current progress and total count
- :param dict options: a dictionary in the form {setting identifier string : object value}
- :return: returns a :py:class:`BinaryView` object for the given filename
- :rtype: :py:class:`BinaryView`
- :raises Exception: When a BinaryView could not be created
-
- :Example:
- >>> from binaryninja import *
- >>> with open_view("/bin/ls") as bv:
- ... print(len(list(bv.functions)))
- ...
- 128
-
- """
- bv = BinaryViewType.get_view_of_file_with_options(*args, **kwargs)
- if bv is None:
- raise Exception("Unable to create new BinaryView")
- return bv
+ return load(*args, **kwargs)
def connect_pycharm_debugger(port=5678):