settings module

binaryninja.settings.Settings([registry_id])
binaryninja.settings.pyNativeStr(arg)
binaryninja.settings.range(*args) A Python2 and Python3 Compatible Range Generator
class Settings(registry_id='default')[source]

Bases: object

copy_value(dest_registry_id, id)[source]
get_bool(id, view=None)[source]
get_bool_with_scope(id, view=None, scope=<SettingsScope.SettingsAutoScope: 1>)[source]
get_double(id, view=None)[source]
get_double_with_scope(id, view=None, scope=<SettingsScope.SettingsAutoScope: 1>)[source]
get_integer(id, view=None)[source]
get_integer_with_scope(id, view=None, scope=<SettingsScope.SettingsAutoScope: 1>)[source]
get_schema()[source]
get_string(id, view=None)[source]
get_string_list(id, view=None)[source]
get_string_list_with_scope(id, view=None, scope=<SettingsScope.SettingsAutoScope: 1>)[source]
get_string_with_scope(id, view=None, scope=<SettingsScope.SettingsAutoScope: 1>)[source]
register_group(group, title)[source]

register_group registers a group for use with this Settings registry. Groups provide a simple way to organize settings.

Parameters:
  • group (str) – a unique identifier
  • title (str) – a user friendly name appropriate for UI presentation
Returns:

True on success, False on failure.
Return type:

bool
Example:
>>> Settings().register_group("solver", "Solver")
True
>>>
register_setting(id, properties)[source]

register_setting registers a new setting with this Settings registry.

Parameters:
  • id (str) – a unique setting identifier in the form <group>.<id>
  • properties (str) – a JSON string describes the setting schema
Returns:

True on success, False on failure.
Return type:

bool
Example:
>>> Settings().register_group("solver", "Solver")
True
>>> Settings().register_setting("solver.basicBlockSlicing", '{"description" : "Enable the basic block slicing in the solver.", "title" : "Basic Block Slicing", "default" : true, "type" : "boolean", "id" : "basicBlockSlicing"}')
True
reset(id, view=None, scope=<SettingsScope.SettingsAutoScope: 1>)[source]
reset_all(view=None, scope=<SettingsScope.SettingsAutoScope: 1>)[source]
set_bool(id, value, view=None, scope=<SettingsScope.SettingsAutoScope: 1>)[source]
set_double(id, value, view=None, scope=<SettingsScope.SettingsAutoScope: 1>)[source]
set_integer(id, value, view=None, scope=<SettingsScope.SettingsAutoScope: 1>)[source]
set_string(id, value, view=None, scope=<SettingsScope.SettingsAutoScope: 1>)[source]
set_string_list(id, value, view=None, scope=<SettingsScope.SettingsAutoScope: 1>)[source]
update_property(id, setting_property)[source]