Defaults#

class rateslib.default.Defaults#

Bases: object

The defaults object used by initialising objects. Values are printed below:

In [1]: from rateslib import defaults

In [2]: print(defaults.print())
Scheduling:

	stub: SHORTFRONT
	stub_length: SHORT
	modifier: MF
	eom: False
	eval_mode: swaps_align
	frequency_months: {'M': 1, 'B': 2, 'Q': 3, 'T': 4, 'S': 6, 'A': 12, 'Z': 100000000.0}

Instruments:

	convention: ACT360
	payment_lag: 2
	payment_lag_exchange: 0
	payment_lag_specific: {'IRS': 2, 'STIRFuture': 0, 'IIRS': 2, 'ZCS': 2, 'ZCIS': 0, 'FXSwap': 0, 'SBS': 2, 'Swap': 2, 'XCS': 2, 'FixedRateBond': 0, 'IndexFixedRateBond': 0, 'FloatRateNote': 0, 'Bill': 0, 'FRA': 0}
	notional: 1000000.0
	fixing_method: rfr_payment_delay
	fixing_method_param: {'rfr_payment_delay': 0, 'rfr_observation_shift': 2, 'rfr_lockout': 2, 'rfr_lookback': 2, 'rfr_payment_delay_avg': 0, 'rfr_observation_shift_avg': 2, 'rfr_lockout_avg': 2, 'rfr_lookback_avg': 2, 'ibor': 2}
	spread_compound_method: none_simple
	base_currency: usd

Curves:

	interpolation: {'Curve': 'log_linear', 'LineCurve': 'linear', 'IndexCurve': 'linear_index'}
	endpoints: natural
	multi_csa_steps: [2, 5, 10, 20, 30, 50, 77, 81, 86, 91, 96, 103, 110, 119, 128, 140, 153, 169, 188, 212, 242, 281, 332, 401, 498, 636, 835, 1104, 1407, 1646, 1766, 1808, 1821, 1824, 1825]

Solver:

	algorithm: levenberg_marquardt
	tag: v
	curve_not_in_solver: ignore

Miscellaneous:

	headers: {'type': 'Type', 'stub_type': 'Period', 'u_acc_start': 'Unadj Acc Start', 'u_acc_end': 'Unadj Acc End', 'a_acc_start': 'Acc Start', 'a_acc_end': 'Acc End', 'payment': 'Payment', 'convention': 'Convention', 'dcf': 'DCF', 'df': 'DF', 'notional': 'Notional', 'currency': 'Ccy', 'rate': 'Rate', 'spread': 'Spread', 'npv': 'NPV', 'cashflow': 'Cashflow', 'fx': 'FX Rate', 'npv_fx': 'NPV Ccy', 'real_cashflow': 'Real Cashflow', 'index_value': 'Index Val', 'index_ratio': 'Index Ratio', 'index_base': 'Index Base', 'collateral': 'Collateral'}
	no_fx_fixings_for_xcs: warn
	pool: 1

Attributes Summary

algorithm

base_currency

calc_mode

calc_mode_futures

convention

curve_not_in_solver

endpoints

eom

eval_mode

ex_div

fixing_method

fixing_method_param

fixings

frequency_months

fx_delivery_lag

fx_delta_type

fx_option_metric

headers

index_lag

index_method

ini_lambda

interpolation

modifier

multi_csa_steps

no_fx_fixings_for_xcs

notional

payment_lag

payment_lag_exchange

payment_lag_specific

pool

settle

spec

spread_compound_method

stub

stub_length

tag

Methods Summary

print()

Return a string representation of the current values in the defaults object.

reset_defaults()

Revert defaults back to their initialisation status.

Attributes Documentation

algorithm = 'levenberg_marquardt'#
base_currency = 'usd'#
calc_mode = 'ukg'#
calc_mode_futures = 'ytm'#
convention = 'ACT360'#
curve_not_in_solver = 'ignore'#
endpoints = 'natural'#
eom = False#
eval_mode = 'swaps_align'#
ex_div = 1#
fixing_method = 'rfr_payment_delay'#
fixing_method_param = {'ibor': 2, 'rfr_lockout': 2, 'rfr_lockout_avg': 2, 'rfr_lookback': 2, 'rfr_lookback_avg': 2, 'rfr_observation_shift': 2, 'rfr_observation_shift_avg': 2, 'rfr_payment_delay': 0, 'rfr_payment_delay_avg': 0}#
fixings = <rateslib.default.Fixings object>#
frequency_months = {'A': 12, 'B': 2, 'M': 1, 'Q': 3, 'S': 6, 'T': 4, 'Z': 100000000.0}#
fx_delivery_lag = 2#
fx_delta_type = 'spot'#
fx_option_metric = 'pips'#
headers = {'a_acc_end': 'Acc End', 'a_acc_start': 'Acc Start', 'cashflow': 'Cashflow', 'collateral': 'Collateral', 'convention': 'Convention', 'currency': 'Ccy', 'dcf': 'DCF', 'df': 'DF', 'fx': 'FX Rate', 'index_base': 'Index Base', 'index_ratio': 'Index Ratio', 'index_value': 'Index Val', 'notional': 'Notional', 'npv': 'NPV', 'npv_fx': 'NPV Ccy', 'payment': 'Payment', 'rate': 'Rate', 'real_cashflow': 'Real Cashflow', 'spread': 'Spread', 'stub_type': 'Period', 'type': 'Type', 'u_acc_end': 'Unadj Acc End', 'u_acc_start': 'Unadj Acc Start'}#
index_lag = 3#
index_method = 'daily'#
ini_lambda = (1000.0, 0.25, 2.0)#
interpolation = {'Curve': 'log_linear', 'IndexCurve': 'linear_index', 'LineCurve': 'linear'}#
modifier = 'MF'#
multi_csa_steps = [2, 5, 10, 20, 30, 50, 77, 81, 86, 91, 96, 103, 110, 119, 128, 140, 153, 169, 188, 212, 242, 281, 332, 401, 498, 636, 835, 1104, 1407, 1646, 1766, 1808, 1821, 1824, 1825]#
no_fx_fixings_for_xcs = 'warn'#
notional = 1000000.0#
payment_lag = 2#
payment_lag_exchange = 0#
payment_lag_specific = {'Bill': 0, 'FRA': 0, 'FXSwap': 0, 'FixedRateBond': 0, 'FloatRateNote': 0, 'IIRS': 2, 'IRS': 2, 'IndexFixedRateBond': 0, 'SBS': 2, 'STIRFuture': 0, 'Swap': 2, 'XCS': 2, 'ZCIS': 0, 'ZCS': 2}#
pool = 1#
settle = 1#
spec = {'cad_gb': {'calc_mode': 'cadgb', 'calendar': 'tro', 'convention': 'actacticma_stub365f', 'currency': 'cad', 'eom': False, 'ex_div': 1, 'final_exchange': True, 'frequency': 's', 'initial_exchange': False, 'modifier': 'none', 'payment_lag': 0, 'payment_lag_exchange': 0, 'settle': 1, 'stub': 'shortfront'}, 'cadgb': {'calc_mode': 'cadgb', 'calendar': 'tro', 'convention': 'actacticma_stub365f', 'currency': 'cad', 'eom': False, 'ex_div': 1, 'final_exchange': True, 'frequency': 's', 'initial_exchange': False, 'modifier': 'none', 'payment_lag': 0, 'payment_lag_exchange': 0, 'settle': 1, 'stub': 'shortfront'}, 'chf_irs': {'calendar': 'zur', 'convention': 'act360', 'currency': 'chf', 'eom': False, 'frequency': 'a', 'leg2_calendar': 'zur', 'leg2_convention': 'act360', 'leg2_currency': 'chf', 'leg2_eom': False, 'leg2_fixing_method': 'rfr_payment_delay', 'leg2_frequency': 'a', 'leg2_modifier': 'mf', 'leg2_payment_lag': 2, 'leg2_spread_compound_method': 'none_simple', 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 2, 'stub': 'shortfront'}, 'estr1mf': {'bp_value': 25.0, 'calendar': 'tgt', 'convention': 'act360', 'currency': 'eur', 'eom': False, 'frequency': 'm', 'leg2_calendar': 'tgt', 'leg2_convention': 'act360', 'leg2_currency': 'eur', 'leg2_eom': False, 'leg2_fixing_method': 'rfr_payment_delay_avg', 'leg2_frequency': 'm', 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_roll': 'imm', 'leg2_spread_compound_method': 'none_simple', 'modifier': 'mf', 'nominal': 3000000.0, 'payment_lag': 0, 'roll': 'imm'}, 'estr3mf': {'bp_value': 25.0, 'calendar': 'tgt', 'convention': 'act360', 'currency': 'eur', 'eom': False, 'frequency': 'q', 'leg2_calendar': 'tgt', 'leg2_convention': 'act360', 'leg2_currency': 'eur', 'leg2_eom': False, 'leg2_fixing_method': 'rfr_payment_delay', 'leg2_frequency': 'q', 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_roll': 'imm', 'leg2_spread_compound_method': 'none_simple', 'modifier': 'mf', 'nominal': 1000000.0, 'payment_lag': 0, 'roll': 'imm'}, 'eur_fra3': {'calendar': 'tgt', 'convention': 'act360', 'currency': 'eur', 'eom': False, 'frequency': 'q', 'leg2_fixing_method': 'ibor', 'leg2_method_param': 2, 'leg2_spread_compound_method': 'none_simple', 'modifier': 'mf', 'payment_lag': 0}, 'eur_fra6': {'calendar': 'tgt', 'convention': 'act360', 'currency': 'eur', 'eom': False, 'frequency': 's', 'leg2_fixing_method': 'ibor', 'leg2_method_param': 2, 'leg2_spread_compound_method': 'none_simple', 'modifier': 'mf', 'payment_lag': 0}, 'eur_irs': {'calendar': 'tgt', 'convention': 'act360', 'currency': 'eur', 'eom': False, 'frequency': 'a', 'leg2_calendar': 'tgt', 'leg2_convention': 'act360', 'leg2_currency': 'eur', 'leg2_eom': False, 'leg2_fixing_method': 'rfr_payment_delay', 'leg2_frequency': 'a', 'leg2_modifier': 'mf', 'leg2_payment_lag': 1, 'leg2_spread_compound_method': 'none_simple', 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 1, 'stub': 'shortfront'}, 'eur_irs1': {'calendar': 'tgt', 'convention': '30e360', 'currency': 'eur', 'eom': False, 'frequency': 'a', 'leg2_calendar': 'tgt', 'leg2_convention': 'act360', 'leg2_currency': 'eur', 'leg2_eom': False, 'leg2_fixing_method': 'ibor', 'leg2_frequency': 'm', 'leg2_method_param': 2, 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_spread_compound_method': 'none_simple', 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 0, 'stub': 'shortfront'}, 'eur_irs3': {'calendar': 'tgt', 'convention': '30e360', 'currency': 'eur', 'eom': False, 'frequency': 'a', 'leg2_calendar': 'tgt', 'leg2_convention': 'act360', 'leg2_currency': 'eur', 'leg2_eom': False, 'leg2_fixing_method': 'ibor', 'leg2_frequency': 'q', 'leg2_method_param': 2, 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_spread_compound_method': 'none_simple', 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 0, 'stub': 'shortfront'}, 'eur_irs6': {'calendar': 'tgt', 'convention': '30e360', 'currency': 'eur', 'eom': False, 'frequency': 'a', 'leg2_calendar': 'tgt', 'leg2_convention': 'act360', 'leg2_currency': 'eur', 'leg2_eom': False, 'leg2_fixing_method': 'ibor', 'leg2_frequency': 's', 'leg2_method_param': 2, 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_spread_compound_method': 'none_simple', 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 0, 'stub': 'shortfront'}, 'eur_sbs36': {'calendar': 'tgt', 'convention': 'act360', 'currency': 'eur', 'eom': False, 'fixing_method': 'ibor', 'frequency': 'q', 'leg2_calendar': 'tgt', 'leg2_convention': 'act360', 'leg2_currency': 'eur', 'leg2_eom': False, 'leg2_fixing_method': 'ibor', 'leg2_frequency': 's', 'leg2_method_param': 2, 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_spread_compound_method': 'none_simple', 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 0, 'spread_compound_method': 'none_simple', 'stub': 'shortfront'}, 'eur_stir': {'bp_value': 25.0, 'calendar': 'tgt', 'convention': 'act360', 'currency': 'eur', 'eom': False, 'frequency': 'q', 'leg2_calendar': 'tgt', 'leg2_convention': 'act360', 'leg2_currency': 'eur', 'leg2_eom': False, 'leg2_fixing_method': 'rfr_payment_delay', 'leg2_frequency': 'q', 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_roll': 'imm', 'leg2_spread_compound_method': 'none_simple', 'modifier': 'mf', 'nominal': 1000000.0, 'payment_lag': 0, 'roll': 'imm'}, 'eur_stir1': {'bp_value': 25.0, 'calendar': 'tgt', 'convention': 'act360', 'currency': 'eur', 'eom': False, 'frequency': 'm', 'leg2_calendar': 'tgt', 'leg2_convention': 'act360', 'leg2_currency': 'eur', 'leg2_eom': False, 'leg2_fixing_method': 'rfr_payment_delay_avg', 'leg2_frequency': 'm', 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_roll': 'imm', 'leg2_spread_compound_method': 'none_simple', 'modifier': 'mf', 'nominal': 3000000.0, 'payment_lag': 0, 'roll': 'imm'}, 'eur_stir3': {'bp_value': 25.0, 'calendar': 'tgt', 'convention': 'act360', 'currency': 'eur', 'eom': False, 'frequency': 'q', 'leg2_calendar': 'tgt', 'leg2_convention': 'act360', 'leg2_currency': 'eur', 'leg2_eom': False, 'leg2_fixing_method': 'rfr_payment_delay', 'leg2_frequency': 'q', 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_roll': 'imm', 'leg2_spread_compound_method': 'none_simple', 'modifier': 'mf', 'nominal': 1000000.0, 'payment_lag': 0, 'roll': 'imm'}, 'eur_zcis': {'calendar': 'tgt', 'convention': '1+', 'currency': 'eur', 'eom': False, 'frequency': 'a', 'leg2_calendar': 'tgt', 'leg2_convention': '1+', 'leg2_currency': 'eur', 'leg2_eom': False, 'leg2_frequency': 'a', 'leg2_index_lag': 3, 'leg2_index_method': 'monthly', 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 0, 'stub': 'shortfront'}, 'eurgbp_xcs': {'calendar': 'tgt,ldn', 'convention': 'act360', 'currency': 'eur', 'eom': False, 'final_exchange': True, 'fixed': False, 'fixing_method': 'rfr_payment_delay', 'frequency': 'q', 'initial_exchange': True, 'leg2_calendar': 'tgt,ldn', 'leg2_convention': 'act365f', 'leg2_currency': 'gbp', 'leg2_eom': False, 'leg2_final_exchange': True, 'leg2_fixed': False, 'leg2_fixing_method': 'rfr_payment_delay', 'leg2_frequency': 'q', 'leg2_initial_exchange': True, 'leg2_modifier': 'mf', 'leg2_mtm': True, 'leg2_payment_lag': 2, 'leg2_payment_lag_exchange': 0, 'leg2_spread_compound_method': 'none_simple', 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 2, 'payment_lag_exchange': 0, 'spread_compound_method': 'none_simple', 'stub': 'shortfront'}, 'euribor3mf': {'bp_value': 25.0, 'calendar': 'tgt', 'convention': 'act360', 'currency': 'eur', 'eom': False, 'frequency': 'q', 'leg2_calendar': 'tgt', 'leg2_convention': 'act360', 'leg2_currency': 'eur', 'leg2_eom': False, 'leg2_fixing_method': 'rfr_payment_delay', 'leg2_frequency': 'q', 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_roll': 'imm', 'leg2_spread_compound_method': 'none_simple', 'modifier': 'mf', 'nominal': 1000000.0, 'payment_lag': 0, 'roll': 'imm'}, 'eurusd_xcs': {'calendar': 'tgt,nyc', 'convention': 'act360', 'currency': 'eur', 'eom': False, 'final_exchange': True, 'fixed': False, 'fixing_method': 'rfr_payment_delay', 'frequency': 'q', 'initial_exchange': True, 'leg2_calendar': 'tgt,nyc', 'leg2_convention': 'act360', 'leg2_currency': 'usd', 'leg2_eom': False, 'leg2_final_exchange': True, 'leg2_fixed': False, 'leg2_fixing_method': 'rfr_payment_delay', 'leg2_frequency': 'q', 'leg2_initial_exchange': True, 'leg2_modifier': 'mf', 'leg2_mtm': True, 'leg2_payment_lag': 2, 'leg2_payment_lag_exchange': 0, 'leg2_spread_compound_method': 'none_simple', 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 2, 'payment_lag_exchange': 0, 'spread_compound_method': 'none_simple', 'stub': 'shortfront'}, 'gbp_gb': {'calc_mode': 'ukg', 'calendar': 'ldn', 'convention': 'actacticma', 'currency': 'gbp', 'eom': False, 'ex_div': 7, 'final_exchange': True, 'frequency': 's', 'initial_exchange': False, 'modifier': 'none', 'payment_lag': 0, 'payment_lag_exchange': 0, 'settle': 1, 'stub': 'shortfront'}, 'gbp_gbi': {'calc_mode': 'ukg', 'calendar': 'ldn', 'convention': 'actacticma', 'currency': 'gbp', 'eom': False, 'ex_div': 7, 'final_exchange': True, 'frequency': 's', 'index_lag': 3, 'index_method': 'daily', 'initial_exchange': False, 'modifier': 'none', 'payment_lag': 0, 'payment_lag_exchange': 0, 'settle': 1, 'stub': 'shortfront'}, 'gbp_irs': {'calendar': 'ldn', 'convention': 'act365f', 'currency': 'gbp', 'eom': True, 'frequency': 'a', 'leg2_calendar': 'ldn', 'leg2_convention': 'act365f', 'leg2_currency': 'gbp', 'leg2_eom': True, 'leg2_fixing_method': 'rfr_payment_delay', 'leg2_frequency': 'a', 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_spread_compound_method': 'none_simple', 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 0, 'stub': 'shortfront'}, 'gbp_stir': {'bp_value': 25.0, 'calendar': 'ldn', 'convention': 'act365f', 'currency': 'gbp', 'eom': False, 'frequency': 'q', 'leg2_calendar': 'ldn', 'leg2_convention': 'act365f', 'leg2_currency': 'gbp', 'leg2_eom': False, 'leg2_fixing_method': 'rfr_payment_delay', 'leg2_frequency': 'q', 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_roll': 'imm', 'leg2_spread_compound_method': 'none_simple', 'modifier': 'mf', 'nominal': 1000000.0, 'payment_lag': 0, 'roll': 'imm'}, 'gbp_zcis': {'calendar': 'ldn', 'convention': '1+', 'currency': 'gbp', 'eom': False, 'frequency': 'a', 'leg2_calendar': 'ldn', 'leg2_convention': '1+', 'leg2_currency': 'gbp', 'leg2_eom': False, 'leg2_frequency': 'a', 'leg2_index_lag': 2, 'leg2_index_method': 'monthly', 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 0, 'stub': 'shortfront'}, 'gbp_zcs': {'calendar': 'ldn', 'convention': 'act365f', 'currency': 'gbp', 'eom': True, 'frequency': 'a', 'leg2_calendar': 'ldn', 'leg2_convention': 'act365f', 'leg2_currency': 'gbp', 'leg2_eom': True, 'leg2_fixing_method': 'rfr_payment_delay', 'leg2_frequency': 'a', 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_spread_compound_method': 'none_simple', 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 0, 'stub': 'shortfront'}, 'gbpusd_xcs': {'calendar': 'ldn,nyc', 'convention': 'act365f', 'currency': 'gbp', 'eom': False, 'final_exchange': True, 'fixed': False, 'fixing_method': 'rfr_payment_delay', 'frequency': 'q', 'initial_exchange': True, 'leg2_calendar': 'ldn,nyc', 'leg2_convention': 'act360', 'leg2_currency': 'usd', 'leg2_eom': False, 'leg2_final_exchange': True, 'leg2_fixed': False, 'leg2_fixing_method': 'rfr_payment_delay', 'leg2_frequency': 'q', 'leg2_initial_exchange': True, 'leg2_modifier': 'mf', 'leg2_mtm': True, 'leg2_payment_lag': 2, 'leg2_payment_lag_exchange': 0, 'leg2_spread_compound_method': 'none_simple', 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 2, 'payment_lag_exchange': 0, 'spread_compound_method': 'none_simple', 'stub': 'shortfront'}, 'gilt': {'calc_mode': 'ukg', 'calendar': 'ldn', 'convention': 'actacticma', 'currency': 'gbp', 'eom': False, 'ex_div': 7, 'final_exchange': True, 'frequency': 's', 'initial_exchange': False, 'modifier': 'none', 'payment_lag': 0, 'payment_lag_exchange': 0, 'settle': 1, 'stub': 'shortfront'}, 'nok_irs': {'calendar': 'osl', 'convention': 'act365f', 'currency': 'nok', 'eom': False, 'frequency': 'a', 'leg2_calendar': 'osl', 'leg2_convention': 'act365f', 'leg2_currency': 'nok', 'leg2_eom': False, 'leg2_fixing_method': 'rfr_payment_delay', 'leg2_frequency': 'a', 'leg2_modifier': 'mf', 'leg2_payment_lag': 2, 'leg2_spread_compound_method': 'none_simple', 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 2, 'stub': 'shortfront'}, 'nok_irs3': {'calendar': 'stk', 'convention': '30e360', 'currency': 'sek', 'eom': False, 'frequency': 'a', 'leg2_calendar': 'stk', 'leg2_convention': 'act360', 'leg2_currency': 'nok', 'leg2_eom': False, 'leg2_fixing_method': 'ibor', 'leg2_frequency': 'q', 'leg2_method_param': 2, 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_spread_compound_method': 'none_simple', 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 0, 'stub': 'shortfront'}, 'nok_irs6': {'calendar': 'osl', 'convention': '30e360', 'currency': 'nok', 'eom': False, 'frequency': 'a', 'leg2_calendar': 'osl', 'leg2_convention': 'act360', 'leg2_currency': 'nok', 'leg2_eom': False, 'leg2_fixing_method': 'ibor', 'leg2_frequency': 's', 'leg2_method_param': 2, 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_spread_compound_method': 'none_simple', 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 0, 'stub': 'shortfront'}, 'sek_fra3': {'calendar': 'stk', 'convention': 'act360', 'currency': 'sek', 'eom': False, 'frequency': 'q', 'leg2_fixing_method': 'ibor', 'leg2_method_param': 2, 'leg2_spread_compound_method': 'none_simple', 'modifier': 'mf', 'payment_lag': 0}, 'sek_gb': {'calc_mode': 'sgb', 'calendar': 'stk', 'convention': 'actacticma', 'currency': 'sek', 'eom': False, 'ex_div': 5, 'final_exchange': True, 'frequency': 'a', 'initial_exchange': False, 'modifier': 'none', 'payment_lag': 0, 'payment_lag_exchange': 0, 'settle': 1, 'stub': 'shortfront'}, 'sek_gbb': {'calc_mode': 'sgbb', 'calendar': 'stk', 'convention': 'act360', 'currency': 'sek', 'ex_div': 0, 'final_exchange': True, 'initial_exchange': False, 'modifier': 'none', 'payment_lag': 0, 'payment_lag_exchange': 0, 'settle': 1}, 'sek_iirs': {'calendar': 'stk', 'convention': 'actacticma', 'currency': 'sek', 'eom': False, 'frequency': 'a', 'index_lag': 3, 'index_method': 'daily', 'leg2_calendar': 'stk', 'leg2_convention': 'act360', 'leg2_currency': 'sek', 'leg2_eom': False, 'leg2_fixing_method': 'ibor', 'leg2_frequency': 'q', 'leg2_method_param': 2, 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_spread_compound_method': 'none_simple', 'leg2_stub': 'shortfront', 'modifier': 'none', 'payment_lag': 0, 'stub': 'shortfront'}, 'sek_irs': {'calendar': 'stk', 'convention': 'act360', 'currency': 'sek', 'eom': False, 'frequency': 'a', 'leg2_calendar': 'stk', 'leg2_convention': 'act360', 'leg2_currency': 'sek', 'leg2_eom': False, 'leg2_fixing_method': 'rfr_payment_delay', 'leg2_frequency': 'a', 'leg2_modifier': 'mf', 'leg2_payment_lag': 1, 'leg2_spread_compound_method': 'none_simple', 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 1, 'stub': 'shortfront'}, 'sek_irs3': {'calendar': 'stk', 'convention': '30e360', 'currency': 'sek', 'eom': False, 'frequency': 'a', 'leg2_calendar': 'stk', 'leg2_convention': 'act360', 'leg2_currency': 'sek', 'leg2_eom': False, 'leg2_fixing_method': 'ibor', 'leg2_frequency': 'q', 'leg2_method_param': 2, 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_spread_compound_method': 'none_simple', 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 0, 'stub': 'shortfront'}, 'sgb': {'calc_mode': 'sgb', 'calendar': 'stk', 'convention': 'actacticma', 'currency': 'sek', 'eom': False, 'ex_div': 5, 'final_exchange': True, 'frequency': 'a', 'initial_exchange': False, 'modifier': 'none', 'payment_lag': 0, 'payment_lag_exchange': 0, 'settle': 1, 'stub': 'shortfront'}, 'sgbb': {'calc_mode': 'sgbb', 'calendar': 'stk', 'convention': 'act360', 'currency': 'sek', 'ex_div': 0, 'final_exchange': True, 'initial_exchange': False, 'modifier': 'none', 'payment_lag': 0, 'payment_lag_exchange': 0, 'settle': 1}, 'sofr': {'calendar': 'nyc', 'convention': 'act360', 'currency': 'usd', 'eom': False, 'frequency': 'a', 'leg2_calendar': 'nyc', 'leg2_convention': 'act360', 'leg2_currency': 'usd', 'leg2_eom': False, 'leg2_fixing_method': 'rfr_payment_delay', 'leg2_frequency': 'a', 'leg2_modifier': 'mf', 'leg2_payment_lag': 2, 'leg2_spread_compound_method': 'none_simple', 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 2, 'stub': 'shortfront'}, 'sofr1mf': {'bp_value': 41.67, 'calendar': 'nyc', 'convention': 'act360', 'currency': 'usd', 'eom': False, 'frequency': 'm', 'leg2_calendar': 'nyc', 'leg2_convention': 'act360', 'leg2_currency': 'usd', 'leg2_eom': False, 'leg2_fixing_method': 'rfr_payment_delay_avg', 'leg2_frequency': 'm', 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_roll': 'imm', 'leg2_spread_compound_method': 'none_simple', 'modifier': 'mf', 'nominal': 5000000.0, 'payment_lag': 0, 'roll': 'imm'}, 'sofr3mf': {'bp_value': 25.0, 'calendar': 'nyc', 'convention': 'act360', 'currency': 'usd', 'eom': False, 'frequency': 'q', 'leg2_calendar': 'nyc', 'leg2_convention': 'act360', 'leg2_currency': 'usd', 'leg2_eom': False, 'leg2_fixing_method': 'rfr_payment_delay', 'leg2_frequency': 'q', 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_roll': 'imm', 'leg2_spread_compound_method': 'none_simple', 'modifier': 'mf', 'nominal': 1000000.0, 'payment_lag': 0, 'roll': 'imm'}, 'sonia3mf': {'bp_value': 25.0, 'calendar': 'ldn', 'convention': 'act365f', 'currency': 'gbp', 'eom': False, 'frequency': 'q', 'leg2_calendar': 'ldn', 'leg2_convention': 'act365f', 'leg2_currency': 'gbp', 'leg2_eom': False, 'leg2_fixing_method': 'rfr_payment_delay', 'leg2_frequency': 'q', 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_roll': 'imm', 'leg2_spread_compound_method': 'none_simple', 'modifier': 'mf', 'nominal': 1000000.0, 'payment_lag': 0, 'roll': 'imm'}, 'test': {'calendar': 'nyc,tgt,ldn', 'convention': 'test', 'currency': 'tes', 'eom': False, 'frequency': 'm', 'leg2_calendar': 'nyc,tgt,ldn', 'leg2_convention': 'test2', 'leg2_eom': False, 'leg2_frequency': 'm', 'leg2_modifier': 'mp', 'leg2_payment_lag': 3, 'leg2_roll': 1, 'leg2_stub': 'longback', 'modifier': 'p', 'payment_lag': 4, 'stub': 'longfront'}, 'ukt': {'calc_mode': 'ukg', 'calendar': 'ldn', 'convention': 'actacticma', 'currency': 'gbp', 'eom': False, 'ex_div': 7, 'final_exchange': True, 'frequency': 's', 'initial_exchange': False, 'modifier': 'none', 'payment_lag': 0, 'payment_lag_exchange': 0, 'settle': 1, 'stub': 'shortfront'}, 'ukti': {'calc_mode': 'ukg', 'calendar': 'ldn', 'convention': 'actacticma', 'currency': 'gbp', 'eom': False, 'ex_div': 7, 'final_exchange': True, 'frequency': 's', 'index_lag': 3, 'index_method': 'daily', 'initial_exchange': False, 'modifier': 'none', 'payment_lag': 0, 'payment_lag_exchange': 0, 'settle': 1, 'stub': 'shortfront'}, 'usd_frn5': {'calendar': 'nyc', 'convention': 'act360', 'currency': 'usd', 'eom': False, 'ex_div': 1, 'fixing_method': 'rfr_observation_shift', 'frequency': 'q', 'method_param': 5, 'modifier': 'mf', 'payment_lag': 0, 'settle': 1, 'spread_compound_method': 'none_simple'}, 'usd_gb': {'calc_mode': 'ust', 'calendar': 'nyc', 'convention': 'actacticma', 'currency': 'usd', 'eom': False, 'ex_div': 1, 'final_exchange': True, 'frequency': 's', 'initial_exchange': False, 'modifier': 'none', 'payment_lag': 0, 'payment_lag_exchange': 0, 'settle': 1, 'stub': 'shortfront'}, 'usd_gbb': {'calc_mode': 'ustb', 'calendar': 'nyc', 'convention': 'act360', 'currency': 'usd', 'ex_div': 0, 'final_exchange': True, 'initial_exchange': False, 'modifier': 'none', 'payment_lag': 0, 'payment_lag_exchange': 0, 'settle': 1}, 'usd_irs': {'calendar': 'nyc', 'convention': 'act360', 'currency': 'usd', 'eom': False, 'frequency': 'a', 'leg2_calendar': 'nyc', 'leg2_convention': 'act360', 'leg2_currency': 'usd', 'leg2_eom': False, 'leg2_fixing_method': 'rfr_payment_delay', 'leg2_frequency': 'a', 'leg2_modifier': 'mf', 'leg2_payment_lag': 2, 'leg2_spread_compound_method': 'none_simple', 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 2, 'stub': 'shortfront'}, 'usd_stir': {'bp_value': 25.0, 'calendar': 'nyc', 'convention': 'act360', 'currency': 'usd', 'eom': False, 'frequency': 'q', 'leg2_calendar': 'nyc', 'leg2_convention': 'act360', 'leg2_currency': 'usd', 'leg2_eom': False, 'leg2_fixing_method': 'rfr_payment_delay', 'leg2_frequency': 'q', 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_roll': 'imm', 'leg2_spread_compound_method': 'none_simple', 'modifier': 'mf', 'nominal': 1000000.0, 'payment_lag': 0, 'roll': 'imm'}, 'usd_stir1': {'bp_value': 41.67, 'calendar': 'nyc', 'convention': 'act360', 'currency': 'usd', 'eom': False, 'frequency': 'm', 'leg2_calendar': 'nyc', 'leg2_convention': 'act360', 'leg2_currency': 'usd', 'leg2_eom': False, 'leg2_fixing_method': 'rfr_payment_delay_avg', 'leg2_frequency': 'm', 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_roll': 'imm', 'leg2_spread_compound_method': 'none_simple', 'modifier': 'mf', 'nominal': 5000000.0, 'payment_lag': 0, 'roll': 'imm'}, 'usd_zcis': {'calendar': 'nyc', 'convention': '1+', 'currency': 'usd', 'eom': False, 'frequency': 'a', 'leg2_calendar': 'nyc', 'leg2_convention': '1+', 'leg2_currency': 'usd', 'leg2_eom': False, 'leg2_frequency': 'a', 'leg2_index_lag': 3, 'leg2_index_method': 'daily', 'leg2_modifier': 'mf', 'leg2_payment_lag': 0, 'leg2_stub': 'shortfront', 'modifier': 'mf', 'payment_lag': 0, 'stub': 'shortfront'}, 'ust': {'calc_mode': 'ust', 'calendar': 'nyc', 'convention': 'actacticma', 'currency': 'usd', 'eom': False, 'ex_div': 1, 'final_exchange': True, 'frequency': 's', 'initial_exchange': False, 'modifier': 'none', 'payment_lag': 0, 'payment_lag_exchange': 0, 'settle': 1, 'stub': 'shortfront'}, 'ustb': {'calc_mode': 'ustb', 'calendar': 'nyc', 'convention': 'act360', 'currency': 'usd', 'ex_div': 0, 'final_exchange': True, 'initial_exchange': False, 'modifier': 'none', 'payment_lag': 0, 'payment_lag_exchange': 0, 'settle': 1}}#
spread_compound_method = 'none_simple'#
stub = 'SHORTFRONT'#
stub_length = 'SHORT'#
tag = 'v'#

Methods Documentation

print()#

Return a string representation of the current values in the defaults object.

reset_defaults()#

Revert defaults back to their initialisation status.

Examples

In [1]: from rateslib import defaults

In [2]: defaults.reset_defaults()