onesecondtrader 0.48.0__tar.gz → 0.50.0__tar.gz

{onesecondtrader-0.48.0 → onesecondtrader-0.50.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: onesecondtrader
-Version: 0.48.0
+Version: 0.50.0
 Summary: The Trading Infrastructure Toolkit for Python. Research, simulate, and deploy algorithmic trading strategies — all in one place.
 License-File: LICENSE
 Author: Nils P. Kujath

{onesecondtrader-0.48.0 → onesecondtrader-0.50.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "onesecondtrader"
-version = "0.48.0"
+version = "0.50.0"
 description = "The Trading Infrastructure Toolkit for Python. Research, simulate, and deploy algorithmic trading strategies — all in one place."
 authors = [
     {name = "Nils P. Kujath",email = "63961429+NilsKujath@users.noreply.github.com"}

onesecondtrader-0.50.0/src/onesecondtrader/indicators/__init__.py

@@ -0,0 +1,17 @@
+"""
+Provides a library of common technical indicators and a base class for creating custom ones.
+"""
+
+from .base import IndicatorBase
+from .moving_averages import SimpleMovingAverage
+from .market_fields import Open, High, Low, Close, Volume
+
+__all__ = [
+    "IndicatorBase",
+    "SimpleMovingAverage",
+    "Open",
+    "High",
+    "Low",
+    "Close",
+    "Volume",
+]

{onesecondtrader-0.48.0 → onesecondtrader-0.50.0}/src/onesecondtrader/indicators/base.py

@@ -9,7 +9,7 @@ import numpy as np
 from onesecondtrader import events
 
 
-class Indicator(abc.ABC):
+class IndicatorBase(abc.ABC):
     """
     Base class for scalar technical indicators with per-symbol history.
 

onesecondtrader-0.50.0/src/onesecondtrader/indicators/market_fields.py

@@ -0,0 +1,166 @@
+from __future__ import annotations
+
+import numpy as np
+
+from onesecondtrader import events, indicators
+
+
+class Open(indicators.IndicatorBase):
+    """
+    Open price indicator.
+
+    This indicator exposes the open price of each incoming market bar as a scalar time series.
+    Values are stored per symbol and can be accessed historically via the indicator interface.
+    """
+
+    @property
+    def name(self) -> str:
+        """
+        Canonical indicator name.
+
+        Returns:
+            Fixed identifier for the open price indicator.
+        """
+        return "OPEN"
+
+    def _compute_indicator(self, incoming_bar: events.market.BarReceived) -> float:
+        """
+        Extract the open price from an incoming market bar.
+
+        Parameters:
+            incoming_bar:
+                Market bar used as input.
+
+        Returns:
+            Open price of the bar.
+        """
+        return incoming_bar.open
+
+
+class High(indicators.IndicatorBase):
+    """
+    High price indicator.
+
+    This indicator exposes the high price of each incoming market bar as a scalar time series.
+    Values are stored per symbol and can be accessed historically via the indicator interface.
+    """
+
+    @property
+    def name(self) -> str:
+        """
+        Canonical indicator name.
+
+        Returns:
+            Fixed identifier for the high price indicator.
+        """
+        return "HIGH"
+
+    def _compute_indicator(self, incoming_bar: events.market.BarReceived) -> float:
+        """
+        Extract the high price from an incoming market bar.
+
+        Parameters:
+            incoming_bar:
+                Market bar used as input.
+
+        Returns:
+            High price of the bar.
+        """
+        return incoming_bar.high
+
+
+class Low(indicators.IndicatorBase):
+    """
+    Low price indicator.
+
+    This indicator exposes the low price of each incoming market bar as a scalar time series.
+    Values are stored per symbol and can be accessed historically via the indicator interface.
+    """
+
+    @property
+    def name(self) -> str:
+        """
+        Canonical indicator name.
+
+        Returns:
+            Fixed identifier for the low price indicator.
+        """
+        return "LOW"
+
+    def _compute_indicator(self, incoming_bar: events.market.BarReceived) -> float:
+        """
+        Extract the low price from an incoming market bar.
+
+        Parameters:
+            incoming_bar:
+                Market bar used as input.
+
+        Returns:
+            Low price of the bar.
+        """
+        return incoming_bar.low
+
+
+class Close(indicators.IndicatorBase):
+    """
+    Close price indicator.
+
+    This indicator exposes the close price of each incoming market bar as a scalar time series.
+    Values are stored per symbol and can be accessed historically via the indicator interface.
+    """
+
+    @property
+    def name(self) -> str:
+        """
+        Canonical indicator name.
+
+        Returns:
+            Fixed identifier for the close price indicator.
+        """
+        return "CLOSE"
+
+    def _compute_indicator(self, incoming_bar: events.market.BarReceived) -> float:
+        """
+        Extract the close price from an incoming market bar.
+
+        Parameters:
+            incoming_bar:
+                Market bar used as input.
+
+        Returns:
+            Close price of the bar.
+        """
+        return incoming_bar.close
+
+
+class Volume(indicators.IndicatorBase):
+    """
+    Volume indicator.
+
+    This indicator exposes the traded volume of each incoming market bar as a scalar time series.
+    Values are stored per symbol and can be accessed historically via the indicator interface.
+    Missing volume values yield `numpy.nan`.
+    """
+
+    @property
+    def name(self) -> str:
+        """
+        Canonical indicator name.
+
+        Returns:
+            Fixed identifier for the volume indicator.
+        """
+        return "VOLUME"
+
+    def _compute_indicator(self, incoming_bar: events.market.BarReceived) -> float:
+        """
+        Extract the volume from an incoming market bar.
+
+        Parameters:
+            incoming_bar:
+                Market bar used as input.
+
+        Returns:
+            Volume of the bar, or `numpy.nan` if unavailable.
+        """
+        return float(incoming_bar.volume) if incoming_bar.volume is not None else np.nan

onesecondtrader-0.50.0/src/onesecondtrader/indicators/moving_averages.py

@@ -0,0 +1,104 @@
+from __future__ import annotations
+
+import collections
+import numpy as np
+
+from onesecondtrader import events, indicators, models
+
+
+class SimpleMovingAverage(indicators.IndicatorBase):
+    """
+    Simple Moving Average (SMA) indicator.
+
+    This indicator computes the arithmetic mean of a selected bar field over a fixed rolling window.
+    One scalar value is produced per incoming bar and stored per symbol.
+
+    The rolling window is maintained independently for each symbol.
+    Until the window is fully populated, the indicator yields `numpy.nan`.
+    """
+
+    def __init__(
+        self,
+        period: int = 200,
+        max_history: int = 100,
+        bar_field: models.BarField = models.BarField.CLOSE,
+        plot_at: int = 0,
+    ) -> None:
+        """
+        Parameters:
+            period:
+                Window size used to compute the moving average.
+            max_history:
+                Maximum number of computed indicator values retained per symbol.
+            bar_field:
+                Bar field used as the input series.
+            plot_at:
+                Opaque plotting identifier forwarded to the charting backend.
+        """
+        super().__init__(max_history=max_history, plot_at=plot_at)
+
+        self.period: int = max(1, int(period))
+        self.bar_field: models.BarField = bar_field
+        self._window: dict[str, collections.deque[float]] = {}
+
+    @property
+    def name(self) -> str:
+        """
+        Canonical indicator name.
+
+        Returns:
+            Identifier encoding the indicator type, period, and bar field.
+        """
+        return f"SMA_{self.period}_{self.bar_field.name}"
+
+    def _compute_indicator(self, incoming_bar: events.market.BarReceived) -> float:
+        """
+        Compute the simple moving average for a single received bar.
+
+        Parameters:
+            incoming_bar:
+                Market bar used as input for the computation.
+
+        Returns:
+            Simple moving average value, or `numpy.nan` if the rolling window is not yet fully populated.
+        """
+        symbol = incoming_bar.symbol
+        if symbol not in self._window:
+            self._window[symbol] = collections.deque(maxlen=self.period)
+
+        window = self._window[symbol]
+        value = self._extract_field(incoming_bar)
+        window.append(value)
+
+        if len(window) < self.period:
+            return np.nan
+        return sum(window) / self.period
+
+    def _extract_field(self, incoming_bar: events.market.BarReceived) -> float:
+        """
+        Extract the configured bar field from an incoming bar.
+
+        Parameters:
+            incoming_bar:
+                Market bar providing the input data.
+
+        Returns:
+            Extracted field value, or `numpy.nan` if unavailable.
+        """
+        match self.bar_field:
+            case models.BarField.OPEN:
+                return incoming_bar.open
+            case models.BarField.HIGH:
+                return incoming_bar.high
+            case models.BarField.LOW:
+                return incoming_bar.low
+            case models.BarField.CLOSE:
+                return incoming_bar.close
+            case models.BarField.VOLUME:
+                return (
+                    float(incoming_bar.volume)
+                    if incoming_bar.volume is not None
+                    else np.nan
+                )
+            case _:
+                return incoming_bar.close

onesecondtrader-0.50.0/src/onesecondtrader/messaging/__init__.py

@@ -0,0 +1,11 @@
+"""
+Provides the infrastructure for event-based communication between system components.
+"""
+
+from .eventbus import EventBus
+from .subscriber import Subscriber
+
+__all__ = [
+    "EventBus",
+    "Subscriber",
+]

onesecondtrader-0.50.0/src/onesecondtrader/messaging/eventbus.py

@@ -0,0 +1,96 @@
+from __future__ import annotations
+
+import collections
+import threading
+import typing
+
+from onesecondtrader import events
+
+if typing.TYPE_CHECKING:
+    from .subscriber import Subscriber
+
+
+class EventBus:
+    """
+    Event dispatch mechanism for propagating event objects to subscribers.
+
+    The event bus maintains subscriptions between subscribers and concrete event types.
+    Events published to the bus are synchronously delivered to all subscribers registered for the exact event type.
+
+    Subscription management and event publication are thread-safe.
+    Event delivery itself occurs outside the internal lock.
+    """
+
+    def __init__(self) -> None:
+        """
+        Initialize an empty event bus.
+
+        The bus starts with no registered subscribers and no active subscriptions.
+        """
+        self._per_event_subscriptions: collections.defaultdict[
+            type[events.EventBase], set[Subscriber]
+        ] = collections.defaultdict(set)
+        self._subscribers: set[Subscriber] = set()
+        self._lock: threading.Lock = threading.Lock()
+
+    def subscribe(
+        self,
+        subscriber: Subscriber,
+        event_type: type[events.EventBase],
+    ) -> None:
+        """
+        Register a subscriber for a specific event type.
+
+        The subscriber will receive all future events whose concrete type matches `event_type`.
+
+        Parameters:
+            subscriber:
+                Object receiving published events.
+            event_type:
+                Concrete event class the subscriber is interested in.
+        """
+        with self._lock:
+            self._subscribers.add(subscriber)
+            self._per_event_subscriptions[event_type].add(subscriber)
+
+    def unsubscribe(self, subscriber: Subscriber) -> None:
+        """
+        Remove a subscriber from all event subscriptions.
+
+        After unsubscription, the subscriber will no longer receive any events published on this bus.
+
+        Parameters:
+            subscriber:
+                Subscriber to remove.
+        """
+        with self._lock:
+            for set_of_event_subscribers in self._per_event_subscriptions.values():
+                set_of_event_subscribers.discard(subscriber)
+            self._subscribers.discard(subscriber)
+
+    def publish(self, event: events.EventBase) -> None:
+        """
+        Publish an event to all subscribed listeners.
+
+        Subscribers are matched strictly by the concrete type of the event.
+        Parent classes and inheritance relationships are not considered.
+
+        Parameters:
+            event:
+                Event instance to dispatch.
+        """
+        with self._lock:
+            subscribers = self._per_event_subscriptions[type(event)].copy()
+        for subscriber in subscribers:
+            subscriber.receive(event)
+
+    def wait_until_system_idle(self) -> None:
+        """
+        Block until all subscribers report an idle state.
+
+        This method delegates to each subscriber's `wait_until_idle` method and returns only after all subscribers have completed any pending work.
+        """
+        with self._lock:
+            subscribers = self._subscribers.copy()
+        for subscriber in subscribers:
+            subscriber.wait_until_idle()

onesecondtrader-0.50.0/src/onesecondtrader/messaging/subscriber.py

@@ -0,0 +1,153 @@
+import abc
+import queue
+import threading
+
+from onesecondtrader import events, messaging
+
+
+class Subscriber(abc.ABC):
+    """
+    Abstract base class for event bus subscribers.
+
+    A subscriber receives events from an event bus and processes them asynchronously in a dedicated worker thread.
+    Incoming events are queued and handled sequentially.
+
+    Subclasses implement `_on_event` to define event-specific behavior.
+    """
+
+    def __init__(self, event_bus: messaging.EventBus) -> None:
+        """
+        Initialize the subscriber and start its event-processing thread.
+
+        Parameters:
+            event_bus:
+                Event bus used for subscribing to and publishing events.
+        """
+        self._event_bus = event_bus
+        self._queue: queue.Queue[events.EventBase | None] = queue.Queue()
+
+        self._running: threading.Event = threading.Event()
+        self._running.set()
+
+        self._thread = threading.Thread(
+            target=self._event_loop, name=self.__class__.__name__
+        )
+        self._thread.start()
+
+    def receive(self, event: events.EventBase) -> None:
+        """
+        Receive an event from the event bus.
+
+        The event is enqueued for asynchronous processing if the subscriber is running.
+
+        Parameters:
+            event:
+                Event instance delivered by the event bus.
+        """
+        if self._running.is_set():
+            self._queue.put(event)
+
+    def wait_until_idle(self) -> None:
+        """
+        Block until all queued events have been processed.
+
+        If the subscriber is not running, this method returns immediately.
+        """
+        if not self._running.is_set():
+            return
+
+        self._queue.join()
+
+    def shutdown(self) -> None:
+        """
+        Shut down the subscriber and stop event processing.
+
+        The subscriber is unsubscribed from the event bus, its worker thread is signaled to terminate, and all pending events are processed before shutdown completes.
+        """
+        if not self._running.is_set():
+            return
+
+        self._event_bus.unsubscribe(self)
+        self._running.clear()
+        self._queue.put(None)
+
+        if threading.current_thread() is not self._thread:
+            self._thread.join()
+
+    def _subscribe(self, *event_types: type[events.EventBase]) -> None:
+        """
+        Subscribe this subscriber to one or more event types.
+
+        Parameters:
+            *event_types:
+                Concrete event classes to subscribe to.
+        """
+        for event_type in event_types:
+            self._event_bus.subscribe(self, event_type)
+
+    def _publish(self, event: events.EventBase) -> None:
+        """
+        Publish an event to the event bus.
+
+        Parameters:
+            event:
+                Event instance to publish.
+        """
+        self._event_bus.publish(event)
+
+    def _event_loop(self) -> None:
+        """
+        Internal worker loop for processing queued events.
+
+        This method runs in a dedicated thread and should not be called directly.
+        """
+        while True:
+            event = self._queue.get()
+
+            if event is None:
+                self._queue.task_done()
+                break
+
+            try:
+                self._on_event(event)
+            except Exception as exc:
+                self._on_exception(exc)
+            finally:
+                self._queue.task_done()
+
+        self._cleanup()
+
+    def _on_exception(self, exc: Exception) -> None:
+        """
+        Handle an exception raised during event processing.
+
+        Subclasses may override this method to implement logging or recovery behavior.
+        The default implementation ignores the exception.
+
+        Parameters:
+            exc:
+                Exception raised while processing an event.
+        """
+        pass
+
+    def _cleanup(self) -> None:
+        """
+        Perform cleanup after the event loop terminates.
+
+        Subclasses may override this method to release resources or emit shutdown notifications.
+        """
+        pass
+
+    @abc.abstractmethod
+    def _on_event(self, event: events.EventBase) -> None:
+        """
+        Handle a single event.
+
+        This method is invoked sequentially for each event received by the subscriber.
+        Implementations must not block indefinitely, as `wait_until_idle` relies on timely completion.
+
+        Parameters:
+            event:
+                Event instance to handle.
+        """
+        ...

onesecondtrader-0.48.0/src/onesecondtrader/indicators/__init__.py

@@ -1,9 +0,0 @@
-"""
-Provides a library of common technical indicators and a base class for creating custom ones.
-"""
-
-from .base import Indicator
-
-__all__ = [
-    "Indicator",
-]