# piker: trading gear for hackers # Copyright (C) Tyler Goodlet (in stewardship for pikers) # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Affero General Public License for more details. # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . ''' FSP UI and graphics components. Financial signal processing cluster and real-time graphics management. ''' from contextlib import asynccontextmanager as acm from functools import partial import inspect from itertools import cycle from typing import ( AsyncGenerator, Any, ) import numpy as np import msgspec import tractor import pyqtgraph as pg import trio from trio_typing import TaskStatus from piker.data.types import Struct from ._axes import PriceAxis from .._cacheables import maybe_open_context from ..calc import humanize from ..data._sharedmem import ( ShmArray, _Token, try_read, ) from ..data.feed import Flume from ..accounting._mktinfo import Symbol from ._chart import ( ChartPlotWidget, LinkedSplits, ) from ._forms import ( FieldsForm, mk_form, open_form_input_handling, ) from ..fsp._api import ( maybe_mk_fsp_shm, Fsp, ) from ..fsp import cascade from ..fsp._volume import ( # tina_vwap, dolla_vlm, flow_rates, ) from ..log import get_logger from .._profile import Profiler log = get_logger(__name__) def has_vlm(ohlcv: ShmArray) -> bool: # make sure that the instrument supports volume history # (sometimes this is not the case for some commodities and # derivatives) vlm = ohlcv.array['volume'] return not bool(np.all(np.isin(vlm, -1)) or np.all(np.isnan(vlm))) def update_fsp_chart( viz, graphics_name: str, array_key: str | None, **kwargs, ) -> None: shm = viz.shm if not shm: return array = shm.array last_row = try_read(array) # guard against unreadable case if not last_row: log.warning(f'Read-race on shm array: {graphics_name}@{shm.token}') return # update graphics # NOTE: this does a length check internally which allows it # staying above the last row check below.. viz.update_graphics() # XXX: re: ``array_key``: fsp func names must be unique meaning we # can't have duplicates of the underlying data even if multiple # sub-charts reference it under different 'named charts'. # read from last calculated value and update any label last_val_sticky = viz.plot.getAxis( 'right')._stickies.get(graphics_name) if last_val_sticky: last = last_row[array_key] last_val_sticky.update_from_data(-1, last) @acm async def open_fsp_sidepane( linked: LinkedSplits, conf: dict[str, dict[str, str]], ) -> FieldsForm: schema = {} assert len(conf) == 1 # for now # add (single) selection widget for name, config in conf.items(): schema[name] = { 'label': '**fsp**:', 'type': 'select', 'default_value': [name], } # add parameters for selection "options" params = config.get('params', {}) for name, config in params.items(): default = config['default_value'] kwargs = config.get('widget_kwargs', {}) # add to ORM schema schema.update({ name: { 'label': f'**{name}**:', 'type': 'edit', 'default_value': default, 'kwargs': kwargs, }, }) sidepane: FieldsForm = mk_form( parent=linked.godwidget, fields_schema=schema, ) # https://pydantic-docs.helpmanual.io/usage/models/#dynamic-model-creation FspConfig = msgspec.defstruct( "Point", [('name', name)] + list(params.items()), bases=(Struct,), ) model = FspConfig(name=name, **params) sidepane.model = model # just a logger for now until we get fsp configs up and running. async def settings_change( key: str, value: str ) -> bool: print(f'{key}: {value}') return True # TODO: async with ( open_form_input_handling( sidepane, focus_next=linked.godwidget, on_value_change=settings_change, ) ): yield sidepane @acm async def open_fsp_actor_cluster( names: list[str] = ['fsp_0', 'fsp_1'], ) -> AsyncGenerator[int, dict[str, tractor.Portal]]: from tractor._clustering import open_actor_cluster # profiler = Profiler( # delayed=False, # disabled=False # ) async with open_actor_cluster( count=2, names=names, modules=['piker.fsp._engine'], ) as cluster_map: # profiler('started fsp cluster') yield cluster_map async def run_fsp_ui( linkedsplits: LinkedSplits, flume: Flume, started: trio.Event, target: Fsp, conf: dict[str, dict], loglevel: str, # profiler: Profiler, # _quote_throttle_rate: int = 58, ) -> None: ''' Taskf for UI spawning around a ``LinkedSplits`` chart for fsp related graphics/UX management. This is normally spawned/called once for each entry in the fsp config. ''' name = target.name # profiler(f'started UI task for fsp: {name}') async with ( # side UI for parameters/controls open_fsp_sidepane( linkedsplits, {name: conf}, ) as sidepane, ): await started.wait() # profiler(f'fsp:{name} attached to fsp ctx-stream') overlay_with = conf.get('overlay', False) if overlay_with: if overlay_with == 'ohlc': chart = linkedsplits.chart else: chart = linkedsplits.subplots[overlay_with] shm = flume.rt_shm chart.draw_curve( name, shm, flume, overlay=True, color='default_light', array_key=name, **conf.get('chart_kwargs', {}) ) else: # create a new sub-chart widget for this fsp chart = linkedsplits.add_plot( name, shm, flume, array_key=name, sidepane=sidepane, # curve by default ohlc=False, # settings passed down to ``ChartPlotWidget`` **conf.get('chart_kwargs', {}) ) # should **not** be the same sub-chart widget assert chart.name != linkedsplits.chart.name array_key = name # profiler(f'fsp:{name} chart created') # first UI update, usually from shm pushed history viz = chart.get_viz(array_key) update_fsp_chart( chart, viz, name, array_key=array_key, ) chart.linked.focus() # TODO: figure out if we can roll our own `FillToThreshold` to # get brush filled polygons for OS/OB conditions. # ``pg.FillBetweenItems`` seems to be one technique using # generic fills between curve types while ``PlotCurveItem`` has # logic inside ``.paint()`` for ``self.opts['fillLevel']`` which # might be the best solution? # graphics = chart.update_from_array(chart.name, array[name]) # graphics.curve.setBrush(50, 50, 200, 100) # graphics.curve.setFillLevel(50) # if func_name == 'rsi': # from ._lines import level_line # # add moveable over-[sold/bought] lines # # and labels only for the 70/30 lines # level_line(chart, 20) # level_line(chart, 30, orient_v='top') # level_line(chart, 70, orient_v='bottom') # level_line(chart, 80, orient_v='top') chart.view._set_yrange(viz=viz) # done() # status updates # profiler(f'fsp:{func_name} starting update loop') # profiler.finish() # update chart graphics # last = time.time() # XXX: this currently doesn't loop since # the FSP engine does **not** push updates atm # since we do graphics update in the main loop # in ``._display. # async for value in stream: # print(value) # # chart isn't actively shown so just skip render cycle # if chart.linked.isHidden(): # continue # else: # now = time.time() # period = now - last # if period <= 1/_quote_throttle_rate: # # faster then display refresh rate # print(f'fsp too fast: {1/period}') # continue # # run synchronous update # update_fsp_chart( # chart, # shm, # display_name, # array_key=func_name, # ) # # set time of last graphics update # last = time.time() # TODO: maybe this should be our ``Viz`` type since it maps # one flume to the next? The machinery for task/actor mgmt should # be part of the instantiation API? class FspAdmin: ''' Client API for orchestrating FSP actors and displaying real-time graphics output. ''' def __init__( self, tn: trio.Nursery, cluster: dict[str, tractor.Portal], linked: LinkedSplits, flume: Flume, ) -> None: self.tn = tn self.cluster = cluster self.linked = linked self._rr_next_actor = cycle(cluster.items()) self._registry: dict[ tuple, tuple[tractor.MsgStream, ShmArray] ] = {} self._flow_registry: dict[_Token, str] = {} # TODO: make this a `.src_flume` and add # a `dst_flume`? # (=> but then wouldn't this be the most basic `Viz`?) self.flume = flume def rr_next_portal(self) -> tractor.Portal: name, portal = next(self._rr_next_actor) return portal async def open_chain( self, portal: tractor.Portal, complete: trio.Event, started: trio.Event, fqme: str, dst_fsp_flume: Flume, conf: dict, target: Fsp, loglevel: str, ) -> None: ''' Task which opens a remote FSP endpoint in the managed cluster and sleeps until signalled to exit. ''' ns_path = str(target.ns_path) async with ( portal.open_context( # chaining entrypoint cascade, # data feed key fqme=fqme, # TODO: pass `Flume.to_msg()`s here? # mems src_shm_token=self.flume.rt_shm.token, dst_shm_token=dst_fsp_flume.rt_shm.token, # target ns_path=ns_path, loglevel=loglevel, zero_on_step=conf.get('zero_on_step', False), shm_registry=[ (token.as_msg(), fsp_name, dst_token.as_msg()) for (token, fsp_name), dst_token in self._flow_registry.items() ], ) as (ctx, last_index), ctx.open_stream() as stream, ): dst_fsp_flume.stream: tractor.MsgStream = stream # register output data self._registry[ (fqme, ns_path) ] = ( stream, dst_fsp_flume.rt_shm, complete ) started.set() # wait for graceful shutdown signal async with stream.subscribe() as stream: async for msg in stream: info = msg.get('fsp_update') if info: # if the chart isn't hidden try to update # the data on screen. if not self.linked.isHidden(): log.debug( f'Re-syncing graphics for fsp: {ns_path}' ) self.linked.graphics_cycle( trigger_all=True, prepend_update_index=info['first'], ) else: log.info(f'recved unexpected fsp engine msg: {msg}') await complete.wait() async def start_engine_task( self, target: Fsp, conf: dict[str, dict[str, Any]], worker_name: str | None = None, loglevel: str = 'info', ) -> (Flume, trio.Event): fqme = self.flume.symbol.get_fqme(delim_char='') # allocate an output shm array key, dst_shm, opened = maybe_mk_fsp_shm( fqme, target=target, readonly=True, ) portal = self.cluster.get(worker_name) or self.rr_next_portal() provider_tag = portal.channel.uid symbol = Symbol( key=key, broker_info={ provider_tag: {'asset_type': 'fsp'}, }, ) dst_fsp_flume = Flume( mkt=symbol, _rt_shm_token=dst_shm.token, first_quote={}, # set to 0 presuming for now that we can't load # FSP history (though we should eventually). izero_hist=0, izero_rt=0, ) self._flow_registry[( self.flume.rt_shm._token, target.name )] = dst_shm._token # if not opened: # raise RuntimeError( # f'Already started FSP `{fqme}:{func_name}`' # ) complete = trio.Event() started = trio.Event() self.tn.start_soon( self.open_chain, portal, complete, started, fqme, dst_fsp_flume, conf, target, loglevel, ) return dst_fsp_flume, started async def open_fsp_chart( self, target: Fsp, conf: dict, # yeah probably dumb.. loglevel: str = 'error', ) -> (trio.Event, ChartPlotWidget): flume, started = await self.start_engine_task( target, conf, loglevel, ) # init async self.tn.start_soon( partial( run_fsp_ui, self.linked, flume, started, target, conf=conf, loglevel=loglevel, ) ) return started @acm async def open_fsp_admin( linked: LinkedSplits, flume: Flume, **kwargs, ) -> AsyncGenerator[dict, dict[str, tractor.Portal]]: async with ( maybe_open_context( # for now make a cluster per client? acm_func=open_fsp_actor_cluster, kwargs=kwargs, ) as (cache_hit, cluster_map), trio.open_nursery() as tn, ): if cache_hit: log.info('re-using existing fsp cluster') admin = FspAdmin( tn, cluster_map, linked, flume, ) try: yield admin finally: # terminate all tasks via signals for key, entry in admin._registry.items(): _, _, event = entry event.set() async def open_vlm_displays( linked: LinkedSplits, flume: Flume, dvlm: bool = True, loglevel: str = 'info', task_status: TaskStatus[ChartPlotWidget] = trio.TASK_STATUS_IGNORED, ) -> None: ''' Volume subchart displays. Since "volume" is often included directly alongside OHLCV price data, we don't really need a separate FSP-actor + shm array for it since it's likely already directly adjacent to OHLC samples from the data provider. Further only if volume data is detected (it sometimes isn't provided eg. forex, certain commodities markets) will volume dependent FSPs be spawned here. ''' sig = inspect.signature(flow_rates.func) params = sig.parameters ohlcv: ShmArray = flume.rt_shm async with ( open_fsp_sidepane( linked, { 'flows': { # TODO: add support for dynamically changing these 'params': { u'\u03BC' + '_type': { 'default_value': str(params['mean_type'].default), }, 'period': { 'default_value': str(params['period'].default), # make widget un-editable for now. 'widget_kwargs': {'readonly': True}, }, }, } }, ) as sidepane, open_fsp_admin(linked, flume) as admin, ): # TODO: support updates # period_field = sidepane.fields['period'] # period_field.setText( # str(period_param.default) # ) # use slightly less light (then bracket) gray # for volume from "main exchange" and a more "bluey" # gray for "dark" vlm. vlm_color = 'i3' dark_vlm_color = 'charcoal' # built-in vlm which we plot ASAP since it's # usually data provided directly with OHLC history. shm = ohlcv vlm_chart = linked.add_plot( name='volume', shm=shm, flume=flume, array_key='volume', sidepane=sidepane, # curve by default ohlc=False, # Draw vertical bars from zero. # we do this internally ourselves since # the curve item internals are pretty convoluted. style='step', ) vlm_viz = vlm_chart._vizs['volume'] # TODO: fix the x-axis label issue where if you put # the axis on the left it's totally not lined up... # show volume units value on LHS (for dinkus) # vlm_chart.hideAxis('right') vlm_chart.hideAxis('left') # TODO: is it worth being able to remove axes (from i guess # a perf perspective) enough that we can actually do this and # other axis related calls (for eg. label upddates in the # display loop) don't raise when a the axis can't be loaded and # thus would normally cause many label related calls to crash? # axis = vlm_chart.removeAxis('left') # send back new chart to caller task_status.started(vlm_chart) # should **not** be the same sub-chart widget assert vlm_chart.name != linked.chart.name # sticky only on sub-charts atm last_val_sticky = vlm_chart.plotItem.getAxis( 'right')._stickies.get(vlm_chart.name) # read from last calculated value value = shm.array['volume'][-1] last_val_sticky.update_from_data(-1, value) _, _, vlm_curve = vlm_viz.update_graphics() # add axis title axis = vlm_chart.getAxis('right') axis.set_title(' vlm') if dvlm: # spawn and overlay $ vlm on the same subchart dvlm_flume, started = await admin.start_engine_task( dolla_vlm, { # fsp engine conf 'func_name': 'dolla_vlm', 'zero_on_step': True, 'params': { 'price_func': { 'default_value': 'chl3', }, }, }, loglevel, ) # dolla vlm overlay # XXX: the main chart already contains a vlm "units" axis # so here we add an overlay wth a y-range in # $ liquidity-value units (normally a fiat like USD). dvlm_pi = vlm_chart.overlay_plotitem( 'dolla_vlm', index=0, # place axis on inside (nearest to chart) axis_title=' $vlm', axis_side='left', axis_kwargs={ 'typical_max_str': ' 100.0 M ', 'formatter': partial( humanize, digits=2, ), 'text_color': vlm_color, }, ) # all to be overlayed curve names dvlm_fields = [ 'dolla_vlm', 'dark_vlm', ] # dvlm_rate_fields = [ # 'dvlm_rate', # 'dark_dvlm_rate', # ] trade_rate_fields = [ 'trade_rate', 'dark_trade_rate', ] # add dvlm (step) curves to common view def chart_curves( names: list[str], pi: pg.PlotItem, shm: ShmArray, flume: Flume, step_mode: bool = False, style: str = 'solid', ) -> None: for name in names: if 'dark' in name: color = dark_vlm_color elif 'rate' in name: color = vlm_color else: color = 'bracket' assert isinstance(shm, ShmArray) assert isinstance(flume, Flume) viz = vlm_chart.draw_curve( name, shm, flume, array_key=name, overlay=pi, color=color, step_mode=step_mode, style=style, pi=pi, ) assert viz.plot is pi await started.wait() chart_curves( dvlm_fields, dvlm_pi, dvlm_flume.rt_shm, dvlm_flume, step_mode=True, ) # NOTE: spawn flow rates fsp **ONLY AFTER** the 'dolla_vlm' fsp is # up since calculating vlm "rates" obvs first requires the # underlying vlm event feed ;) fr_flume, started = await admin.start_engine_task( flow_rates, { # fsp engine conf 'func_name': 'flow_rates', 'zero_on_step': True, }, loglevel, ) # chart_curves( # dvlm_rate_fields, # dvlm_pi, # fr_flume.rt_shm, # ) # TODO: is there a way to "sync" the dual axes such that only # one curve is needed? # hide the original vlm curve since the $vlm one is now # displayed and the curves are effectively the same minus # liquidity events (well at least on low OHLC periods - 1s). # vlm_curve.hide() vlm_chart.removeItem(vlm_curve) vlm_viz = vlm_chart._vizs['volume'] vlm_chart.view.disable_auto_yrange() # NOTE: DON'T DO THIS. # WHY: we want range sorting on volume for the RHS label! # -> if you don't want that then use this but likely you # only will if we decide to drop unit vlm.. # vlm_viz.render = False # Trade rate overlay # XXX: requires an additional overlay for # a trades-per-period (time) y-range. tr_pi = vlm_chart.overlay_plotitem( 'trade_rates', # TODO: dynamically update period (and thus this axis?) # title from user input. axis_title='clears', axis_side='left', axis_kwargs={ 'typical_max_str': ' 10.0 M ', 'formatter': partial( humanize, digits=2, ), 'text_color': vlm_color, }, ) await started.wait() chart_curves( trade_rate_fields, tr_pi, fr_flume.rt_shm, fr_flume, # step_mode=True, # dashed line to represent "individual trades" being # more "granular" B) style='dash', ) for pi in ( dvlm_pi, tr_pi, ): for name, axis_info in pi.axes.items(): # lol this sux XD axis = axis_info['item'] if isinstance(axis, PriceAxis): axis.size_to_values() # built-in vlm fsps for target, conf in { # tina_vwap: { # 'overlay': 'ohlc', # overlays with OHLCV (main) chart # 'anchor': 'session', # }, }.items(): started = await admin.open_fsp_chart( target, conf, ) async def start_fsp_displays( linked: LinkedSplits, flume: Flume, group_status_key: str, loglevel: str, ) -> None: ''' Create fsp charts from a config input attached to a local actor compute cluster. Pass target entrypoint and historical data via ``ShmArray``. ''' linked.focus() # TODO: eventually we'll support some kind of n-compose syntax fsp_conf = { # 'rsi': { # 'func_name': 'rsi', # literal python func ref lookup name # # map of parameters to place on the fsp sidepane widget # # which should map to dynamic inputs available to the # # fsp function at runtime. # 'params': { # 'period': { # 'default_value': 14, # 'widget_kwargs': {'readonly': True}, # }, # }, # # ``ChartPlotWidget`` options passthrough # 'chart_kwargs': { # 'static_yrange': (0, 100), # }, # }, } profiler = Profiler( delayed=False, disabled=False ) async with ( # NOTE: this admin internally opens an actor cluster open_fsp_admin( linked, flume, ) as admin, ): statuses = [] for target, conf in fsp_conf.items(): started = await admin.open_fsp_chart( target, conf, ) done = linked.window().status_bar.open_status( f'loading fsp, {target}..', group_key=group_status_key, ) statuses.append((started, done)) for fsp_loaded, status_cb in statuses: await fsp_loaded.wait() profiler(f'attached to fsp portal: {target}') status_cb() # blocks on nursery until all fsp actors complete