Consistently use callback names 'handle_(un)subscribe_instruments'

rok-povsic · rok-povsic · commit dc7527256d05 · 2023-03-08T22:00:33.000+01:00
diff --git a/README.md b/README.md
@@ -55,23 +55,23 @@ The returned addon state object is used in many other functions below.
 #### start_addon
 ```python
 # Call this to start the communication between your addon and Bookmap.
-bm.start_addon(addon, add_instrument_handler, detach_instrument_handler)
+bm.start_addon(addon, handle_subscribe_instrument, handle_unsubscribe_instrument)
 ```
 It starts the communication between Bookmap and your Python script. Call it once you have added all
 your [Event handlers](#Event-handlers).
 
-`add_instrument_handler` is a function that you should define. It will be called each time you
+`handle_subscribe_instrument` is a function that you should define. It will be called each time you
 enable the addon in Bookmap for a certain instrument. All handlers, including this one, must have
 a proper signature (a list of parameters), as defined below.
 
-`detach_instrument_handler` is similar to above, except is called when the user disables the addon
+`handle_unsubscribe_instrument` is similar to above, except is called when the user disables the addon
 for a certain instrument.
 
 Example:
 ```python
 import pyl1api as bm
 
-def add_instrument_handler(
+def handle_subscribe_instrument(
     addon: Any,
     alias: str,
     full_name: str,
@@ -93,7 +93,7 @@ def add_instrument_handler(
     """
     print("Subscribing to the instrument " + alias, flush=True)
 
-def detach_instrument_handler(
+def handle_unsubscribe_instrument(
     addon: Any,
     alias: str
 ) -> None:
@@ -110,7 +110,7 @@ if __name__ == "__main__":
     addon = bm.create_addon()
     # start addon, requires 3 arguments - addon itself, handler for subscribe event
     # and handler for unsubscribe event
-    bm.start_addon(addon, add_instrument_handler, detach_instrument_handler)
+    bm.start_addon(addon, handle_subscribe_instrument, handle_unsubscribe_instrument)
     bm.wait_until_addon_is_turned_off(addon)
 ```
 
@@ -142,7 +142,7 @@ How to convert these levels to a real price or size? The rule are simple:
 > moment.
 
 How to know what the instrument's `pips` and `size_multiplier` values are? You receive them via the
-[add_instrument_handler](#start_addon) callback when the user subscribes to an instrument.
+[handle_subscribe_instrument](#start_addon) callback when the user subscribes to an instrument.
 
 ### Event handlers
 
diff --git a/examples/cvd_addon.py b/examples/cvd_addon.py
@@ -13,8 +13,8 @@
 
 
 # mandatory callback used to register instrument info inside the python
-def handle_instrument_info(addon, alias: str, full_name: str, is_crypto: bool, pips: float, size_granularity: float,
-                           instrument_multiplier: float):
+def handle_subscribe_instrument(addon, alias: str, full_name: str, is_crypto: bool, pips: float, size_granularity: float,
+                                instrument_multiplier: float):
     global cvd_accumulator
     global alias_to_size_granularity
     global req_id
@@ -80,7 +80,7 @@ def handle_trades(addon, alias: str, price: float, size: int, is_otc: bool, is_b
 
 
 # callback notifying that unsubscription appeared
-def handle_detach_instrument(addon, alias):
+def handle_unsubscribe_instrument(addon, alias):
     global cvd_accumulator
     del cvd_accumulator[alias]
     print("Detached " + alias, flush=True)
@@ -91,7 +91,7 @@ def handle_detach_instrument(addon, alias):
     bm.add_trades_handler(addon, handle_trades)  # register callback for trades
     # register indicator response callback
     bm.add_indicator_response_handler(addon, handle_indicator_response)
-    bm.start_addon(addon, handle_instrument_info,
-                   handle_detach_instrument)  # starting an addon
+    bm.start_addon(addon, handle_subscribe_instrument,
+                   handle_unsubscribe_instrument)  # starting an addon
     # give control over python scrip to Bookmap, so it won't be finished until it is turned off from Bookmap
     bm.wait_until_addon_is_turned_off(addon)
diff --git a/examples/liquidity_tracker.py b/examples/liquidity_tracker.py
@@ -10,7 +10,7 @@
 DEFAULT_LIQUIDITY_SIZE = 10
 
 
-def handle_instrument_info(addon, alias, full_name, is_crypto, pips, size_multiplier, instrument_multiplier):
+def handle_subscribe_instrument(addon, alias, full_name, is_crypto, pips, size_multiplier, instrument_multiplier):
     global req_id
 
     instrument = {
@@ -39,7 +39,7 @@ def handle_instrument_info(addon, alias, full_name, is_crypto, pips, size_multip
     print("Registered...", flush=True)
 
 
-def handle_instrument_detached(addon, alias):
+def handle_unsubscribe_instrument(addon, alias):
     del alias_to_order_book[alias]
     del alias_to_instrument[alias]
 
@@ -92,5 +92,5 @@ def on_settings_change_handler(addon, alias: str, setting_name: str, field_type:
     bm.add_indicator_response_handler(
         addon, handle_register_indicator_response)
     bm.add_on_setting_change_handler(addon, on_settings_change_handler)
-    bm.start_addon(addon, handle_instrument_info, handle_instrument_detached)
+    bm.start_addon(addon, handle_subscribe_instrument, handle_unsubscribe_instrument)
     bm.wait_until_addon_is_turned_off(addon)
diff --git a/examples/order_book_test.py b/examples/order_book_test.py
@@ -3,7 +3,7 @@
 alias_to_order_book = {}
 
 
-def handle_instrument_info(addon, alias, full_name, is_crypto, pips, size_multiplier, instrument_multiplier):
+def handle_subscribe_instrument(addon, alias, full_name, is_crypto, pips, size_multiplier, instrument_multiplier):
     print("Instrument received " + alias, flush=True)
     # create order book for each subscribed instrument
     alias_to_order_book[alias] = bm.create_order_book()
@@ -13,8 +13,8 @@ def handle_instrument_info(addon, alias, full_name, is_crypto, pips, size_multip
     print("Data subscribed", flush=True)
 
 
-def handle_detach(addon, alias):
-    print("Detached " + alias, flush=True)
+def handle_unsubscribe_instrument(addon, alias):
+    print("The instrument " + alias + " has been removed", flush=True)
 
 
 # handler for depth. it receives information about side, price and size.
@@ -33,5 +33,5 @@ def handle_depth_info(addon, alias, is_bid, price, size):
     addon = bm.create_addon()
     print("Addon created", flush=True)
     bm.add_depth_handler(addon, handle_depth_info)
-    bm.start_addon(addon, handle_instrument_info, handle_detach)
+    bm.start_addon(addon, handle_subscribe_instrument, handle_unsubscribe_instrument)
     bm.wait_until_addon_is_turned_off(addon)
