scriptingprovider module

binaryninja.scriptingprovider.BlacklistedDict(...)

binaryninja.scriptingprovider.PythonScriptingInstance(...)

binaryninja.scriptingprovider.PythonScriptingProvider([...])

binaryninja.scriptingprovider.ScriptingInstance(...)

binaryninja.scriptingprovider.ScriptingOutputListener()

binaryninja.scriptingprovider.ScriptingProvider([...])

class BlacklistedDict(blacklist, *args)[source]

Bases: dict

enable_blacklist(enabled)[source]
property blacklist_enabled
class PythonScriptingInstance(provider)[source]

Bases: ScriptingInstance

class InterpreterThread(instance)[source]

Bases: Thread

add_input(data)[source]
apply_locals()[source]
end()[source]
execute(_code)[source]
get_selected_data()[source]
read(size)[source]
run()[source]

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

update_current_comment()[source]
update_current_raw_offset()[source]
update_current_selection()[source]
update_here()[source]
update_locals()[source]
write_at_cursor(data)[source]
abstract perform_cancel_script_input()[source]
abstract perform_complete_input(text, state)[source]
abstract perform_execute_script_input(text)[source]
abstract perform_execute_script_input_from_filename(filename)[source]
abstract perform_set_current_address(addr)[source]
abstract perform_set_current_basic_block(block)[source]
abstract perform_set_current_binary_view(view)[source]
abstract perform_set_current_function(func)[source]
abstract perform_set_current_selection(begin, end)[source]
abstract perform_stop()[source]
class PythonScriptingProvider(handle=None)[source]

Bases: ScriptingProvider

instance_class

alias of PythonScriptingInstance

apiName = 'python3'
name = 'Python'
class ScriptingInstance(provider, handle=None)[source]

Bases: object

cancel_script_input(text)[source]
complete_input(text, state)[source]
error(text)[source]
execute_script_input(text)[source]
execute_script_input_from_filename(filename)[source]
output(text)[source]
abstract perform_cancel_script_input()[source]
abstract perform_complete_input(text: str, state) → str[source]
Parameters:

text (str) –

Return type:

str

abstract perform_execute_script_input(text)[source]
abstract perform_execute_script_input_from_filename(text)[source]
abstract perform_set_current_address(addr)[source]
abstract perform_set_current_basic_block(block)[source]
abstract perform_set_current_binary_view(view)[source]
abstract perform_set_current_function(func)[source]
abstract perform_set_current_selection(begin, end)[source]
abstract perform_stop()[source]
register_output_listener(listener)[source]
set_current_address(addr)[source]
set_current_basic_block(block)[source]
set_current_binary_view(view)[source]
set_current_function(func)[source]
set_current_selection(begin, end)[source]
stop()[source]
unregister_output_listener(listener)[source]
warning(text)[source]
property delimiters
property input_ready_state
class ScriptingOutputListener[source]

Bases: object

notify_error(text)[source]
notify_input_ready_state_changed(state)[source]
notify_output(text)[source]
notify_warning(text)[source]
class ScriptingProvider(handle=None)[source]

Bases: object

create_instance() → ScriptingInstance | None[source]
Return type:

ScriptingInstance | None

register() → None[source]
Return type:

None

apiName = ''
instance_class: ScriptingInstance | None = None
name = ''
bninspect(code_, globals_, locals_)[source]

bninspect prints documentation about a command that is about to be run The interpreter will invoke this function if you input a line ending in ? e.g. bv?

Parameters:

  • code (str) – Python code to be evaluated

  • globals (dict) – globals() from callsite

  • locals (dict) – locals() from callsite

redirect_stdio()[source]