interactive_controls.py

from dataclasses import dataclass
from copy import copy
import numpy as np
import pandas as pd

from syscore.interactive.input import (
    get_input_from_user_and_convert_to_type,
    true_if_answer_is_yes,
)
from syscore.interactive.menus import (
    interactiveMenu,
    print_menu_and_get_desired_option_index,
)
from syscore.interactive.display import (
    calculate_multiplication_factor_for_nice_repr_of_value,
    set_pd_print_options,
)
from syscore.dateutils import CALENDAR_DAYS_IN_YEAR, DAILY_PRICE_FREQ
from syscore.genutils import round_significant_figures

from sysinit.futures.safely_modify_roll_parameters import safely_modify_roll_parameters

from sysdata.data_blob import dataBlob
from sysobjects.contracts import futuresContract
from sysobjects.production.override import override_dict, Override
from sysobjects.production.process_control import processNotRunning
from sysobjects.production.tradeable_object import instrumentStrategy

from sysproduction.backup_db_to_csv import (
    backup_spread_cost_data,
    get_data_and_create_csv_directories,
)
from sysproduction.data.controls import (
    diagOverrides,
    updateOverrides,
    dataTradeLimits,
    dataPositionLimits,
    dataBrokerClientIDs,
)
from sysproduction.data.broker import dataBroker
from sysproduction.data.instruments import diagInstruments
from sysproduction.data.contracts import dataContracts
from sysproduction.data.control_process import dataControlProcess, diagControlProcess
from sysproduction.data.prices import (
    get_valid_instrument_code_from_user,
    get_list_of_instruments,
    diagPrices,
    updatePrices,
)
from sysproduction.data.strategies import get_valid_strategy_name_from_user
from sysproduction.data.instruments import updateSpreadCosts
from sysproduction.reporting.data.risk import get_risk_data_for_instrument
from sysproduction.reporting.data.volume import (
    get_best_average_daily_volume_for_instrument,
)

from sysproduction.reporting.api import reportingApi

# could get from config, but might be different by system
from sysproduction.reporting.data.constants import (
    MAX_VS_AVERAGE_FORECAST,
    RISK_TARGET_ASSUMED,
    MAX_PROPORTION_OF_VOLUME,
)


@dataclass()
class parametersForAutoPopulation:
    raw_max_leverage: float
    max_vs_average_forecast: float
    notional_risk_target: float
    approx_IDM: float
    notional_instrument_weight: float
    max_proportion_risk_one_contract: float
    max_proportion_of_volume: float


def interactive_controls():
    set_pd_print_options()
    with dataBlob(log_name="Interactive-Controls") as data:
        set_pd_print_options()
        menu = interactiveMenu(
            top_level_menu_of_options, nested_menu_of_options, dict_of_functions, data
        )
        menu.run_menu()


top_level_menu_of_options = {
    0: "Trade limits",
    1: "Position limits",
    2: "Trade control (override)",
    3: "Broker client IDS",
    4: "Process control and monitoring",
    5: "Update configuration",
    6: "Deletion",
}

nested_menu_of_options = {
    0: {
        0: "View trade limits",
        1: "Change/add global trade limit for instrument",
        2: "Reset global trade limit for instrument",
        3: "Change/add trade limit for instrument & strategy",
        4: "Reset trade limit for instrument & strategy",
        5: "Reset all trade limits",
        6: "Auto populate trade limits",
    },
    1: {
        10: "View position limits",
        11: "Change position limit for instrument",
        12: "Change position limit for instrument & strategy",
        13: "Auto populate position limits",
    },
    2: {
        20: "View overrides (configured, and database)",
        21: "Update / add / remove override for strategy in database",
        22: "Update / add / remove override for instrument in database",
        23: "Update / add / remove override for strategy & instrument in database",
        24: "Delete all overrides in database",
    },
    3: {30: "Clear all unused client IDS"},
    4: {
        40: "View process controls and status",
        41: "Change status of process control (STOP/GO/NO RUN)",
        42: "Global status change  (STOP/GO/NO RUN)",
        43: "Mark process as close",
        44: "Mark all dead processes as close",
        45: "View process configuration (set in YAML, cannot change here)",
    },
    5: {
        50: "Auto update spread cost configuration based on sampling and trades",
        51: "Safe modify of roll parameters configuration",
        52: "Check price multipliers are consistent",
    },
    6: {60: "Delete instrument from price tables"},
}


def view_trade_limits(data):
    trade_limits = dataTradeLimits(data)
    all_limits = trade_limits.get_all_limits_sorted()
    print("All limits\n")
    for limit in all_limits:
        print(limit)
    print("\n")


def change_limit_for_instrument(data):
    trade_limits = dataTradeLimits(data)
    instrument_code = get_valid_instrument_code_from_user(data)
    period_days = get_input_from_user_and_convert_to_type(
        "Period of days?", type_expected=int, allow_default=True, default_value=1
    )
    new_limit = get_input_from_user_and_convert_to_type(
        "Limit (in contracts?)", type_expected=int, allow_default=False
    )
    ans = input(
        "Update will change number of trades allowed in periods, but won't reset 'clock'. Are you sure? (y/other)"
    )
    if ans == "y":
        trade_limits.update_instrument_limit_with_new_limit(
            instrument_code, period_days, new_limit
        )


def reset_limit_for_instrument(data):
    trade_limits = dataTradeLimits(data)
    instrument_code = get_valid_instrument_code_from_user(data)
    period_days = get_input_from_user_and_convert_to_type(
        "Period of days?", type_expected=int, allow_default=True, default_value=1
    )
    ans = input("Reset means trade 'clock' will restart. Are you sure? (y/other)")
    if ans == "y":
        trade_limits.reset_instrument_limit(instrument_code, period_days)


def reset_all_limits(data):
    trade_limits = dataTradeLimits(data)
    ans = input("Reset means trade 'clock' will restart. Are you sure? (y/other)")
    if ans == "y":
        trade_limits.reset_all_limits()


def change_limit_for_instrument_strategy(data):
    trade_limits = dataTradeLimits(data)
    instrument_code = get_valid_instrument_code_from_user(data)
    strategy_name = get_valid_strategy_name_from_user(data)
    period_days = get_input_from_user_and_convert_to_type(
        "Period of days?", type_expected=int, allow_default=True, default_value=1
    )
    new_limit = get_input_from_user_and_convert_to_type(
        "Limit (in contracts?)", type_expected=int, allow_default=False
    )

    ans = input(
        "Update will change number of trades allowed in periods, but won't reset 'clock'. Are you sure? (y/other)"
    )
    if ans == "y":
        instrument_strategy = instrumentStrategy(
            instrument_code=instrument_code, strategy_name=strategy_name
        )
        trade_limits.update_instrument_strategy_limit_with_new_limit(
            instrument_strategy=instrument_strategy,
            period_days=period_days,
            new_limit=new_limit,
        )


def reset_limit_for_instrument_strategy(data):
    trade_limits = dataTradeLimits(data)
    instrument_code = get_valid_instrument_code_from_user(data)
    period_days = get_input_from_user_and_convert_to_type(
        "Period of days?", type_expected=int, allow_default=True, default_value=1
    )
    strategy_name = get_valid_strategy_name_from_user(data=data, source="positions")

    ans = input("Reset means trade 'clock' will restart. Are you sure? (y/other)")
    if ans == "y":
        instrument_strategy = instrumentStrategy(
            instrument_code=instrument_code, strategy_name=strategy_name
        )
        trade_limits.reset_instrument_strategy_limit(
            instrument_strategy=instrument_strategy, period_days=period_days
        )


from sysproduction.reporting.data.constants import MAX_POSITION_TRADED_DAILY


def auto_populate_limits(data: dataBlob):
    instrument_list = get_list_of_instruments(data)
    auto_parameters = get_auto_population_parameters()

    trade_multiplier = get_input_from_user_and_convert_to_type(
        "Higgest proportion of standard position expected to trade daily?",
        type_expected=float,
        default_value=MAX_POSITION_TRADED_DAILY,
    )
    period_days = get_input_from_user_and_convert_to_type(
        "What period in days to set limit for?", type_expected=int, default_value=1
    )
    _ = [
        set_trade_limit_for_instrument(
            data,
            instrument_code=instrument_code,
            auto_parameters=auto_parameters,
            trade_multiplier=trade_multiplier,
            period_days=period_days,
        )
        for instrument_code in instrument_list
    ]
    return None


def set_trade_limit_for_instrument(
    data,
    instrument_code: str,
    trade_multiplier: float,
    period_days: int,
    auto_parameters: parametersForAutoPopulation,
):
    trade_limits = dataTradeLimits(data)
    new_limit = calc_trade_limit_for_instrument(
        data,
        instrument_code=instrument_code,
        auto_parameters=auto_parameters,
        trade_multiplier=trade_multiplier,
        period_days=period_days,
    )
    if np.isnan(new_limit):
        print("Can't calculate trade limit for %s, not setting" % instrument_code)
    else:
        print(
            "Update limit for %s %d with %d" % (instrument_code, period_days, new_limit)
        )
        trade_limits.update_instrument_limit_with_new_limit(
            instrument_code, period_days, new_limit
        )


def calc_trade_limit_for_instrument(
    data: dataBlob,
    instrument_code: str,
    trade_multiplier: float,
    period_days: int,
    auto_parameters: parametersForAutoPopulation,
):
    standard_position = get_maximum_position_at_max_forecast(
        data, instrument_code=instrument_code, auto_parameters=auto_parameters
    )
    if np.isnan(standard_position):
        return np.nan

    adj_trade_multiplier = (float(period_days) ** 0.5) * trade_multiplier
    standard_trade = float(standard_position) * adj_trade_multiplier
    standard_trade_int = max(4, int(np.ceil(abs(standard_trade))))

    return standard_trade_int


from sysproduction.reporting.data.constants import (
    IDM_ASSUMED,
    INSTRUMENT_WEIGHT_ASSUMED,
    RAW_MAX_LEVERAGE,
    MAX_RISK_EXPOSURE_ONE_INSTRUMENT,
)


def get_auto_population_parameters() -> parametersForAutoPopulation:
    print("Enter parameters to estimate typical position sizes")
    notional_risk_target = get_input_from_user_and_convert_to_type(
        "Notional risk target (% per year, 0.25 = 25%%)",
        type_expected=float,
        default_value=RISK_TARGET_ASSUMED / 100.0,
    )
    approx_IDM = get_input_from_user_and_convert_to_type(
        "Approximate IDM", type_expected=float, default_value=IDM_ASSUMED
    )
    notional_instrument_weight = get_input_from_user_and_convert_to_type(
        "Notional instrument weight (go large for safety!)",
        type_expected=float,
        default_value=INSTRUMENT_WEIGHT_ASSUMED,
    )
    raw_max_leverage = get_input_from_user_and_convert_to_type(
        "Maximum Leverage per instrument (notional exposure*# contracts / capital)",
        type_expected=float,
        default_value=RAW_MAX_LEVERAGE,
    )

    max_proportion_risk_one_contract = get_input_from_user_and_convert_to_type(
        "Maximum proportion of risk in a single instrument (0.1 = 10%%)",
        type_expected=float,
        default_value=MAX_RISK_EXPOSURE_ONE_INSTRUMENT,
    )

    max_proportion_of_volume = get_input_from_user_and_convert_to_type(
        "Maximum proportion of volume for expiry with largest volume (0.1 = 10%)",
        type_expected=float,
        default_value=MAX_PROPORTION_OF_VOLUME,
    )

    auto_parameters = parametersForAutoPopulation(
        raw_max_leverage=raw_max_leverage,
        max_vs_average_forecast=MAX_VS_AVERAGE_FORECAST,
        notional_risk_target=notional_risk_target,
        approx_IDM=approx_IDM,
        max_proportion_risk_one_contract=max_proportion_risk_one_contract,
        notional_instrument_weight=notional_instrument_weight,
        max_proportion_of_volume=max_proportion_of_volume,
    )

    return auto_parameters


def get_maximum_position_at_max_forecast(
    data: dataBlob, instrument_code: str, auto_parameters: parametersForAutoPopulation
) -> float:
    risk_data = get_risk_data_for_instrument(data, instrument_code)
    position_for_risk = get_standardised_position_for_risk(
        risk_data, auto_parameters=auto_parameters
    )
    position_with_leverage = get_maximum_position_given_leverage_limit(
        risk_data, auto_parameters=auto_parameters
    )

    position_for_concentration = get_maximum_position_given_risk_concentration_limit(
        risk_data, auto_parameters=auto_parameters
    )

    position_for_volume = get_max_position_give_volume_limit(
        data, instrument_code=instrument_code, auto_parameters=auto_parameters
    )

    standard_position = min(
        position_for_risk,
        position_with_leverage,
        position_for_concentration,
        position_for_volume,
    )

    print(
        "Standardised maximum position for %s is %.1f, minimum of %.1f (risk), %.1f (leverage), %.1f (concentration), and %1.f (volume)"
        % (
            instrument_code,
            standard_position,
            position_for_risk,
            position_with_leverage,
            position_for_concentration,
            position_for_volume,
        )
    )

    return standard_position


def get_standardised_position_for_risk(
    risk_data: dict, auto_parameters: parametersForAutoPopulation
) -> float:
    capital = risk_data["capital"]
    annual_risk_per_contract = risk_data["annual_risk_per_contract"]
    if np.isnan(annual_risk_per_contract):
        print(
            "No estimated risk for contract, can't calculate standard position - returning zero"
        )
        return 0

    max_forecast_ratio = auto_parameters.max_vs_average_forecast
    idm = auto_parameters.approx_IDM
    instr_weight = auto_parameters.notional_instrument_weight
    risk_target = auto_parameters.notional_risk_target

    standard_position = abs(
        max_forecast_ratio
        * capital
        * idm
        * instr_weight
        * risk_target
        / (annual_risk_per_contract)
    )

    print(
        "Standard position = %.2f = (Max / Average forecast) * Capital * IDM * instrument weight * risk target / Annual cash risk per contract "
        % (standard_position)
    )
    print(
        "                  = (%.1f) * %.0f * %.2f * %.3f * %.3f / %.2f"
        % (
            max_forecast_ratio,
            capital,
            idm,
            instr_weight,
            risk_target,
            annual_risk_per_contract,
        )
    )

    return standard_position


def get_maximum_position_given_leverage_limit(
    risk_data: dict, auto_parameters: parametersForAutoPopulation
) -> float:
    notional_exposure_per_contract = risk_data["contract_exposure"]
    capital = risk_data["capital"]
    max_leverage = auto_parameters.raw_max_leverage
    max_exposure = capital * max_leverage

    max_position = abs(max_exposure / notional_exposure_per_contract)
    round_max_position = int(np.floor(max_position))

    print(
        "Max position with leverage = %.2f (%d) = Max exposure / Notional per contract = %0.f / %1.f"
        % (
            max_position,
            round_max_position,
            max_exposure,
            notional_exposure_per_contract,
        )
    )

    print(
        "(Max exposure = Capital * Maximum leverage = %.0f * %.2f"
        % (capital, max_leverage)
    )

    return round_max_position


def get_maximum_position_given_risk_concentration_limit(
    risk_data: dict, auto_parameters: parametersForAutoPopulation
) -> float:
    ccy_risk_per_contract = abs(risk_data["annual_risk_per_contract"])
    if np.isnan(ccy_risk_per_contract):
        print("Can't get risk per contract, Max position exposure limit will be zero")
        return 0

    capital = risk_data["capital"]
    risk_target = auto_parameters.notional_risk_target
    cash_risk_capital = capital * risk_target

    max_proportion_risk_one_contract = auto_parameters.max_proportion_risk_one_contract

    risk_budget_this_contract = cash_risk_capital * max_proportion_risk_one_contract

    position_limit = abs(risk_budget_this_contract / ccy_risk_per_contract)
    round_position_limit = int(np.floor(position_limit))

    print(
        "Max position exposure limit = %.2f (%d) = Risk budget / CCy risk per contract = %.1f / %.1f"
        % (
            position_limit,
            round_position_limit,
            risk_budget_this_contract,
            ccy_risk_per_contract,
        )
    )
    print(
        "(Risk budget = Cash risk capital * max proportion of risk = %.0f * %.3f)"
        % (cash_risk_capital, max_proportion_risk_one_contract)
    )
    print(
        "(Cash risk capital = Capital * Risk target = %0.f * %.3f"
        % (capital, risk_target)
    )

    return round_position_limit


def get_max_position_give_volume_limit(
    data: dataBlob, instrument_code: str, auto_parameters: parametersForAutoPopulation
) -> float:
    max_proportion_of_volume = auto_parameters.max_proportion_of_volume
    volume_for_instrument = get_best_average_daily_volume_for_instrument(
        data, instrument_code
    )
    if np.isnan(volume_for_instrument):
        print("No volume data available!! Assuming no constraint on liquidity")
        return 999999999

    volume_limit = max_proportion_of_volume * volume_for_instrument
    print(
        "Volume is %d and we are happy to do %.1f%% of that, i.e. %f"
        % (volume_for_instrument, max_proportion_of_volume * 100, volume_limit)
    )
    return volume_limit


def view_position_limit(data):
    data_position_limits = dataPositionLimits(data)
    instrument_limits = data_position_limits.get_all_instrument_limits_and_positions()
    strategy_instrument_limits = (
        data_position_limits.get_all_strategy_instrument_limits_and_positions()
    )

    print("\nInstrument limits across strategies\n")
    for limit_tuple in instrument_limits:
        print(limit_tuple)

    print("\nInstrument limits per strategy\n")
    for limit_tuple in strategy_instrument_limits:
        print(limit_tuple)


def change_position_limit_for_instrument(data):
    view_position_limit(data)
    data_position_limits = dataPositionLimits(data)
    instrument_code = get_valid_instrument_code_from_user(data, allow_all=False)
    new_position_limit = get_input_from_user_and_convert_to_type(
        "New position limit?",
        type_expected=int,
        allow_default=True,
        default_value=-1,
        default_str="No limit",
    )
    if new_position_limit == -1:
        data_position_limits.delete_position_limit_for_instrument(instrument_code)
    else:
        new_position_limit = abs(new_position_limit)
        data_position_limits.set_abs_position_limit_for_instrument(
            instrument_code, new_position_limit
        )


def change_position_limit_for_instrument_strategy(data):
    view_position_limit(data)
    data_position_limits = dataPositionLimits(data)
    strategy_name = get_valid_strategy_name_from_user(
        data, allow_all=False, source="positions"
    )
    instrument_code = get_valid_instrument_code_from_user(data, allow_all=False)
    new_position_limit = get_input_from_user_and_convert_to_type(
        "New position limit?",
        type_expected=int,
        allow_default=True,
        default_value=-1,
        default_str="No limit",
    )

    instrument_strategy = instrumentStrategy(
        instrument_code=instrument_code, strategy_name=strategy_name
    )

    if new_position_limit == -1:
        data_position_limits.delete_position_limit_for_instrument_strategy(
            instrument_strategy
        )
    else:
        new_position_limit = abs(new_position_limit)
        data_position_limits.set_position_limit_for_instrument_strategy(
            instrument_strategy, new_position_limit
        )


def auto_populate_position_limits(data: dataBlob):
    instrument_list = get_list_of_instruments(data)
    auto_parameters = get_auto_population_parameters()
    [
        set_position_limit_for_instrument(
            data, instrument_code=instrument_code, auto_parameters=auto_parameters
        )
        for instrument_code in instrument_list
    ]
    return None


def set_position_limit_for_instrument(
    data, instrument_code: str, auto_parameters: parametersForAutoPopulation
):
    data_position_limits = dataPositionLimits(data)
    existing_position_limit = (
        data_position_limits._get_position_limit_object_for_instrument(instrument_code)
    )
    max_position_int = get_max_rounded_position_for_instrument(
        data, instrument_code=instrument_code, auto_parameters=auto_parameters
    )

    if np.isnan(max_position_int):
        print(
            "Can't get standard position for %s, not setting max position"
            % instrument_code
        )
    else:
        print(
            "Update limit for %s from %s to %d"
            % (
                instrument_code,
                str(existing_position_limit.position_limit),
                max_position_int,
            )
        )
        data_position_limits.set_abs_position_limit_for_instrument(
            instrument_code, max_position_int
        )


def get_max_rounded_position_for_instrument(
    data, instrument_code: str, auto_parameters: parametersForAutoPopulation
):
    max_position = get_maximum_position_at_max_forecast(
        data, instrument_code=instrument_code, auto_parameters=auto_parameters
    )
    if np.isnan(max_position):
        return np.nan

    max_position_int = int(abs(max_position))

    return max_position_int


def view_overrides(data):
    diag_overrides = diagOverrides(data)
    all_overrides = diag_overrides.get_dict_of_all_overrides_with_reasons()
    print("All overrides:\n")
    list_of_keys = list(all_overrides.keys())
    list_of_keys.sort()
    for key in list_of_keys:
        print("%s %s" % (key, str(all_overrides[key])))
    print("\n")


def update_strategy_override(data):
    view_overrides(data)
    update_overrides = updateOverrides(data)
    strategy_name = get_valid_strategy_name_from_user(data=data, source="positions")
    new_override = get_overide_object_from_user()
    ans = input("Are you sure? (y/other)")
    if ans == "y":
        update_overrides.update_override_for_strategy(strategy_name, new_override)


def update_instrument_override(data):
    view_overrides(data)
    update_overrides = updateOverrides(data)
    instrument_code = get_valid_instrument_code_from_user(data)
    new_override = get_overide_object_from_user()
    ans = input("Are you sure? (y/other)")
    if ans == "y":
        update_overrides.update_override_for_instrument(instrument_code, new_override)


def update_strategy_instrument_override(data):
    view_overrides(data)
    update_overrides = updateOverrides(data)
    instrument_code = get_valid_instrument_code_from_user(data)
    strategy_name = get_valid_strategy_name_from_user(data=data, source="positions")
    instrument_strategy = instrumentStrategy(
        instrument_code=instrument_code, strategy_name=strategy_name
    )
    new_override = get_overide_object_from_user()
    ans = input("Are you sure? (y/other)")
    if ans == "y":
        update_overrides.update_override_for_instrument_strategy(
            instrument_strategy=instrument_strategy, new_override=new_override
        )


def get_overide_object_from_user():
    invalid_input = True
    while invalid_input:
        print(
            "Overide options are: A number between 0.0 and 1.0 that we multiply the natural position by,"
        )
        print("   or one of the following special values %s" % override_dict)

        value = input("Your value?")
        value = float(value)
        try:
            override_object = Override.from_numeric_value(value)
            return override_object
        except Exception as e:
            print(e)


def delete_all_overrides_in_db(data):
    update_overrides = updateOverrides(data)

    print("Delete all overrides in database (not config!)")
    ans = input("Are you sure? (y/other)")
    if ans == "y":
        update_overrides.delete_all_overrides_in_db(are_you_sure=True)


def clear_used_client_ids(data):
    print(
        "Clear all locks on broker client IDs. DO NOT DO IF ANY BROKER SESSIONS ARE ACTIVE!"
    )
    ans = input("Are you sure? (y/other)")
    if ans == "y":
        client_id_data = dataBrokerClientIDs(data)
        client_id_data.clear_all_clientids()


def view_process_controls(data):
    controls_df = get_dict_of_process_controls(data).as_pd_df()
    print("\nControlled processes:\n")
    print(f"{controls_df}\n")


def get_dict_of_process_controls(data):
    data_process = dataControlProcess(data)
    dict_of_controls = data_process.get_dict_of_control_processes()

    return dict_of_controls


def change_process_control_status(data):
    view_process_controls(data)

    process_name = get_process_name(data)
    status_int = get_valid_status_for_process()
    change_process_given_int(data, process_name, status_int)
    return None


def change_global_process_control_status(data):
    view_process_controls(data)
    print("Status for *all* processes")
    status_int = get_valid_status_for_process()
    if status_int == 0:
        return None
    process_dict = get_dict_of_process_controls(data)
    process_list = list(process_dict.keys())
    for process_name in process_list:
        change_process_given_int(data, process_name, status_int)


def get_valid_status_for_process():
    status_int = print_menu_and_get_desired_option_index(
        {
            1: "Go",
            2: "Do not run (don't stop if already running)",
            3: "Stop (and don't run if not started)",
            4: "Pause (carry on running process, but don't run methods)",
        },
        default_option_index=0,
        default_str="<CANCEL>",
    )
    return status_int


def change_process_given_int(data, process_name, status_int):
    data_process = dataControlProcess(data)

    if status_int == 1:
        data_process.change_status_to_go(process_name)
    if status_int == 2:
        data_process.change_status_to_no_run(process_name)
    if status_int == 3:
        data_process.change_status_to_stop(process_name)
    if status_int == 4:
        data_process.change_status_to_pause(process_name)


def get_process_name(data):
    process_names = get_dict_of_process_controls(data)
    menu_of_options = dict(list(enumerate(process_names)))
    print("Process name?")
    option = print_menu_and_get_desired_option_index(
        menu_of_options, default_option_index=1
    )
    ans = menu_of_options[option]
    return ans


def view_process_config(data):
    diag_config = diagControlProcess(data)
    process_name = get_process_name(data)
    result_dict = diag_config.get_config_dict(process_name)
    for key, value in result_dict.items():
        print("%s: %s" % (str(key), str(value)))
    print("\nAbove should be modified in private_config.yaml files")


def finish_process(data):
    view_process_controls(data)
    print("Will need to use if process aborted without properly closing")
    process_name = get_process_name(data)
    data_control = dataControlProcess(data)
    try:
        data_control.finish_process(process_name)
    except processNotRunning:
        pass


def finish_all_processes(data):
    data_control = dataControlProcess(data)
    data_control.check_if_pid_running_and_if_not_finish_all_processes()


def auto_update_spread_costs(data):
    slippage_comparison_pd = get_slippage_data(data)
    changes_to_make = get_list_of_changes_to_make_to_slippage(slippage_comparison_pd)

    make_changes_to_slippage_in_db(data, changes_to_make)
    backup_slippage_from_db_to_csv()


def get_slippage_data(data) -> pd.DataFrame:
    reporting_api = reportingApi(data, calendar_days_back=CALENDAR_DAYS_IN_YEAR)
    print("Getting data might take a while...")
    slippage_comparison_pd = reporting_api.combined_df_costs()

    return slippage_comparison_pd


def get_list_of_changes_to_make_to_slippage(
    slippage_comparison_pd: pd.DataFrame,
) -> dict:
    filter = get_filter_size_for_slippage()
    changes_to_make = dict()
    instrument_list = slippage_comparison_pd.index

    for instrument_code in instrument_list:
        pd_row = slippage_comparison_pd.loc[instrument_code]
        difference = pd_row["Difference"]
        configured = pd_row["Configured"]
        suggested_estimate = pd_row["estimate"]

        if np.isnan(suggested_estimate) or np.isnan(configured):
            print("No data for %s" % instrument_code)
            continue

        if abs(difference) < filter:
            ## do nothing
            continue

        mult_factor = calculate_mult_factor_from_cost_row(pd_row)

        if mult_factor > 1:
            print("ALL VALUES MULTIPLIED BY %f INCLUDING INPUTS!!!!" % mult_factor)

        print_data_with_multiplier(pd_row, mult_factor=mult_factor)

        suggested_estimate_multiplied = round_significant_figures(
            suggested_estimate * mult_factor, 2
        )

        configured_estimate_multiplied = configured * mult_factor

        estimate_to_use_with_mult = get_input_from_user_and_convert_to_type(
            "New configured slippage value (current %f, default is estimate %f)"
            % (configured_estimate_multiplied, suggested_estimate_multiplied),
            type_expected=float,
            allow_default=True,
            default_value=suggested_estimate_multiplied,
        )

        if estimate_to_use_with_mult == configured_estimate_multiplied:
            print("Same as configured, do nothing...")
            continue
        if estimate_to_use_with_mult != suggested_estimate_multiplied:
            difference = abs(
                (estimate_to_use_with_mult / suggested_estimate_multiplied) - 1.0
            )
            if difference > 0.5:
                ans = input(
                    "Quite a big difference from the suggested %f and yours %f, are you sure about this? (y/other)"
                    % (suggested_estimate_multiplied, estimate_to_use_with_mult)
                )
                if ans != "y":
                    continue

        estimate_to_use = estimate_to_use_with_mult / mult_factor
        changes_to_make[instrument_code] = estimate_to_use

    return changes_to_make


def get_filter_size_for_slippage() -> float:
    filter = get_input_from_user_and_convert_to_type(
        "% difference to filter on? (eg 30 means we ignore differences<30%",
        type_expected=float,
        allow_default=True,
        default_value=30.0,
    )

    return filter


def calculate_mult_factor_from_cost_row(pd_row) -> float:
    configured = pd_row["Configured"]
    suggested_estimate = pd_row["estimate"]

    smallest_value = min(configured, suggested_estimate)
    mult_factor = calculate_multiplication_factor_for_nice_repr_of_value(smallest_value)

    return mult_factor


def print_data_with_multiplier(pd_row, mult_factor: float = 1.0):
    multiplied_pd_row = copy(pd_row)
    to_multiply = [
        "bid_ask_trades",
        "total_trades",
        "bid_ask_sampled",
        "estimate",
        "Configured",
    ]
    for row_name in to_multiply:
        multiplied_pd_row[row_name] = multiplied_pd_row[row_name] * mult_factor

    print(multiplied_pd_row)


def make_changes_to_slippage_in_db(data: dataBlob, changes_to_make: dict):
    futures_data = updateSpreadCosts(data)
    for instrument_code, new_spread_cost in changes_to_make.items():
        futures_data.update_spread_costs(instrument_code, new_spread_cost)


def backup_slippage_from_db_to_csv():
    backup_data = get_data_and_create_csv_directories("")
    print(
        "Backing up slippage costs in database to .csv %s; you will need to copy to /pysystemtrade/data/futures/csvconfig/spreadcosts.csv for it to work in sim"
        % backup_data.csv_spread_cost.config_file
    )
    backup_spread_cost_data(backup_data)


def check_price_multipliers_consistent(data: dataBlob):
    list_of_instruments = get_list_of_instruments(data, "single")
    for instrument_code in list_of_instruments:
        check_price_multipliers_consistent_for_instrument(data, instrument_code)


def check_price_multipliers_consistent_for_instrument(
    data: dataBlob, instrument_code: str
):
    print("Checking %s" % instrument_code)
    data_broker = dataBroker(data)
    diag_instruments = diagInstruments(data)
    data_contracts = dataContracts(data)

    point_size_from_instrument_config = diag_instruments.get_point_size(instrument_code)

    ib_config_for_instrument = (
        data_broker.broker_futures_instrument_data.get_instrument_data(instrument_code)
    )

    contract_id_priced_contract = data_contracts.get_priced_contract_id(instrument_code)
    priced_contract = futuresContract(instrument_code, contract_id_priced_contract)
    contract_price_magnifier_from_ib = (
        data_broker.broker_futures_contract_data.get_price_magnifier_for_contract(
            priced_contract
        )
    )

    ib_configured_multiplier = ib_config_for_instrument.ib_data.ibMultiplier
    ib_configured_price_magnifier = ib_config_for_instrument.ib_data.priceMagnifier
    ib_configured_effective_multiplier = (
        ib_config_for_instrument.ib_data.effective_multiplier
    )

    if contract_price_magnifier_from_ib != ib_configured_price_magnifier:
        print(
            "Configured price magnifier of %s is different from value returned by IB of %s, for %s!"
            % (
                str(ib_configured_price_magnifier),
                str(contract_price_magnifier_from_ib),
                instrument_code,
            )
        )

    if ib_configured_effective_multiplier != point_size_from_instrument_config:
        print(
            "IB configured effective multiplier of %s (equal to multiplier %s x magnifier %s) is different from instrument configuration value of %s for %s"
            % (
                str(ib_configured_effective_multiplier),
                str(ib_configured_multiplier),
                str(ib_configured_price_magnifier),
                str(point_size_from_instrument_config),
                instrument_code,
            )
        )

    return None


def delete_instrument_from_prices(data: dataBlob):
    exit_code = ""
    instrument_code = get_valid_instrument_code_from_user(
        allow_all=False, source="single", allow_exit=True, exit_code=exit_code
    )

    if instrument_code == exit_code:
        return False

    sure = true_if_answer_is_yes(
        "Note that this will only delete price data and contract data. Won't delete configuration, position, or order data related to an instrument. Are you REALLY sure about this???"
    )
    if not sure:
        return False

    diag_prices = diagPrices(data)
    intraday_frequency = diag_prices.get_intraday_frequency_for_historical_download()
    daily_frequency = DAILY_PRICE_FREQ

    update_prices = updatePrices(data)
    update_prices.delete_contract_prices_at_frequency_for_instrument_code(
        instrument_code, frequency=intraday_frequency, are_you_sure=True
    )
    update_prices.delete_contract_prices_at_frequency_for_instrument_code(
        instrument_code, frequency=daily_frequency, are_you_sure=True
    )
    update_prices.delete_merged_contract_prices_for_instrument_code(
        instrument_code, are_you_sure=True
    )
    update_prices.delete_multiple_prices(instrument_code, are_you_sure=True)
    update_prices.delete_adjusted_prices(instrument_code, are_you_sure=True)

    update_prices.delete_spreads(instrument_code, are_you_sure=True)

    data_contracts = dataContracts(data)
    data_contracts.delete_all_contracts_for_instrument(
        instrument_code, are_you_sure=True
    )


def not_defined(data):
    print("\n\nFunction not yet defined\n\n")


dict_of_functions = {
    0: view_trade_limits,
    1: change_limit_for_instrument,
    2: reset_limit_for_instrument,
    3: change_limit_for_instrument_strategy,
    4: reset_limit_for_instrument_strategy,
    5: reset_all_limits,
    6: auto_populate_limits,
    10: view_position_limit,
    11: change_position_limit_for_instrument,
    12: change_position_limit_for_instrument_strategy,
    13: auto_populate_position_limits,
    20: view_overrides,
    21: update_strategy_override,
    22: update_instrument_override,
    23: update_strategy_instrument_override,
    24: delete_all_overrides_in_db,
    30: clear_used_client_ids,
    40: view_process_controls,
    41: change_process_control_status,
    42: change_global_process_control_status,
    43: finish_process,
    44: finish_all_processes,
    45: view_process_config,
    50: auto_update_spread_costs,
    51: safely_modify_roll_parameters,
    52: check_price_multipliers_consistent,
    60: delete_instrument_from_prices,
}

if __name__ == "__main__":
    interactive_controls()