BackcastPro 0.3.4__py3-none-any.whl

BackcastPro/order.py

@@ -0,0 +1,161 @@
+"""
+注文管理モジュール。
+"""
+
+from typing import TYPE_CHECKING, Optional
+
+if TYPE_CHECKING:
+    from ._broker import _Broker
+    from .trade import Trade
+
+
+class Order:
+    """
+    `Strategy.buy()`と`Strategy.sell()`を通じて新しい注文を出します。
+    `Strategy.orders`を通じて既存の注文を照会します。
+
+    注文が実行または[約定]されると、`Trade`が発生します。
+
+    出されたがまだ約定されていない注文の側面を変更したい場合は、
+    キャンセルして新しい注文を出してください。
+
+    すべての出された注文は[取消注文まで有効]です。
+    """
+    
+    def __init__(self, broker: '_Broker',
+                 code: str,
+                 size: float,
+                 limit_price: Optional[float] = None,
+                 stop_price: Optional[float] = None,
+                 sl_price: Optional[float] = None,
+                 tp_price: Optional[float] = None,
+                 parent_trade: Optional['Trade'] = None,
+                 tag: object = None):
+        self.__code = code
+        self.__broker = broker
+        assert size != 0
+        self.__size = size
+        self.__limit_price = limit_price
+        self.__stop_price = stop_price
+        self.__sl_price = sl_price
+        self.__tp_price = tp_price
+        self.__parent_trade = parent_trade
+        self.__tag = tag
+
+    def _replace(self, **kwargs):
+        for k, v in kwargs.items():
+            setattr(self, f'_{self.__class__.__qualname__}__{k}', v)
+        return self
+
+
+    def cancel(self):
+        """注文をキャンセルします。"""
+        self.__broker.orders.remove(self)
+        trade = self.__parent_trade
+        if trade:
+            if self is trade._sl_order:
+                trade._replace(sl_order=None)
+            elif self is trade._tp_order:
+                trade._replace(tp_order=None)
+            else:
+                pass  # Order placed by Trade.close()
+
+    # Fields getters
+
+    @property
+    def code(self) -> str:
+        """
+        注文対象の銘柄コード。
+        """
+        return self.__code
+
+    @property
+    def size(self) -> float:
+        """
+        注文サイズ（ショート注文の場合は負の値）。
+
+        サイズが0と1の間の値の場合、現在利用可能な流動性（現金 + `Position.pl` - 使用済みマージン）の
+        割合として解釈されます。
+        1以上の値は絶対的なユニット数を示します。
+        """
+        return self.__size
+
+    @property
+    def limit(self) -> Optional[float]:
+        """
+        [指値注文]の注文指値価格、または[成行注文]の場合はNone（次に利用可能な価格で約定）。
+
+        [limit orders]: https://www.investopedia.com/terms/l/limitorder.asp
+        [market orders]: https://www.investopedia.com/terms/m/marketorder.asp
+        """
+        return self.__limit_price
+
+    @property
+    def stop(self) -> Optional[float]:
+        """
+        [ストップリミット/ストップ成行]注文の注文ストップ価格。
+        ストップが設定されていない場合、またはストップ価格が既にヒットした場合はNone。
+
+        [_]: https://www.investopedia.com/terms/s/stoporder.asp
+        """
+        return self.__stop_price
+
+    @property
+    def sl(self) -> Optional[float]:
+        """
+        ストップロス価格。設定されている場合、この注文の実行後に`Trade`に対して
+        新しい条件付きストップ成行注文が配置されます。
+        `Trade.sl`も参照してください。
+        """
+        return self.__sl_price
+
+    @property
+    def tp(self) -> Optional[float]:
+        """
+        テイクプロフィット価格。設定されている場合、この注文の実行後に`Trade`に対して
+        新しい条件付き指値注文が配置されます。
+        `Trade.tp`も参照してください。
+        """
+        return self.__tp_price
+
+    @property
+    def parent_trade(self):
+        return self.__parent_trade
+
+    @property
+    def tag(self):
+        """
+        任意の値（文字列など）。設定されている場合、この注文と関連する`Trade`の
+        追跡が可能になります（`Trade.tag`を参照）。
+        """
+        return self.__tag
+
+    __pdoc__ = {'Order.parent_trade': False}
+
+    # Extra properties
+
+    @property
+    def is_long(self):
+        """注文がロングの場合（注文サイズが正）にTrueを返します。"""
+        return self.__size > 0
+
+    @property
+    def is_short(self):
+        """注文がショートの場合（注文サイズが負）にTrueを返します。"""
+        return self.__size < 0
+
+    @property
+    def is_contingent(self):
+        """
+        [条件付き]注文、つまりアクティブな取引に配置された[OCO]ストップロスおよび
+        テイクプロフィットブラケット注文の場合にTrueを返します。
+        親`Trade`がクローズされると、残りの条件付き注文はキャンセルされます。
+
+        `Trade.sl`と`Trade.tp`を通じて条件付き注文を変更できます。
+
+        [contingent]: https://www.investopedia.com/terms/c/contingentorder.asp
+        [OCO]: https://www.investopedia.com/terms/o/oco.asp
+        """
+        return bool((parent := self.__parent_trade) and
+                    (self is parent._sl_order or
+                     self is parent._tp_order))

BackcastPro/position.py

@@ -0,0 +1,60 @@
+"""
+ポジション管理モジュール。
+"""
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ._broker import _Broker
+
+
+class Position:
+    """
+    現在保有している資産ポジション。
+    `backtesting.backtesting.Strategy.next`内で
+    `backtesting.backtesting.Strategy.position`として利用可能です。
+    ブール値コンテキストで使用できます。例：
+
+        if self.position:
+            ...  # ポジションがあります（ロングまたはショート）
+    """
+    
+    def __init__(self, broker: '_Broker'):
+        self.__broker = broker
+
+    def __bool__(self):
+        return self.size != 0
+
+    @property
+    def size(self) -> float:
+        """資産単位でのポジションサイズ。ショートポジションの場合は負の値。"""
+        return sum(trade.size for trade in self.__broker.trades)
+
+    @property
+    def pl(self) -> float:
+        """現在のポジションの利益（正）または損失（負）を現金単位で。"""
+        return sum(trade.pl for trade in self.__broker.trades)
+
+    @property
+    def pl_pct(self) -> float:
+        """現在のポジションの利益（正）または損失（負）をパーセントで。"""
+        total_invested = sum(trade.entry_price * abs(trade.size) for trade in self.__broker.trades)
+        return (self.pl / total_invested) * 100 if total_invested else 0
+
+    @property
+    def is_long(self) -> bool:
+        """ポジションがロング（ポジションサイズが正）の場合True。"""
+        return self.size > 0
+
+    @property
+    def is_short(self) -> bool:
+        """ポジションがショート（ポジションサイズが負）の場合True。"""
+        return self.size < 0
+
+    def close(self, portion: float = 1.):
+        """
+        各アクティブな取引の「一部」を決済することで、ポジションの一部を決済します。詳細は「Trade.close」を参照してください。
+        """
+        for trade in self.__broker.trades:
+            trade.close(portion)
+

BackcastPro/trade.py

@@ -0,0 +1,227 @@
+"""
+取引管理モジュール。
+"""
+
+import numpy as np
+import pandas as pd
+from copy import copy
+from math import copysign
+from typing import TYPE_CHECKING, Optional, Union
+
+if TYPE_CHECKING:
+    from ._broker import _Broker
+    from .order import Order
+
+
+class Trade:
+    """
+    `Order`が約定されると、アクティブな`Trade`が発生します。
+    アクティブな取引は`Strategy.trades`で、クローズされた決済済み取引は`Strategy.closed_trades`で見つけることができます。
+    """
+    def __init__(self, broker: '_Broker', code: str, size: int, entry_price: float, entry_time: Union[pd.Timestamp, int], tag):
+        self.__broker = broker
+        self.__code = code
+        self.__size = size
+        self.__entry_price = entry_price
+        self.__exit_price: Optional[float] = None
+        self.__entry_time: Union[pd.Timestamp, int] = entry_time
+        self.__exit_time: Optional[Union[pd.Timestamp, int]] = None
+        self.__sl_order: Optional[Order] = None
+        self.__tp_order: Optional[Order] = None
+        self.__tag = tag
+        self._commissions = 0
+
+    def _replace(self, **kwargs):
+        for k, v in kwargs.items():
+            setattr(self, f'_{self.__class__.__qualname__}__{k}', v)
+        return self
+
+    def _copy(self, **kwargs):
+        return copy(self)._replace(**kwargs)
+
+    def close(self, portion: float = 1.):
+        """次の市場価格で取引の`portion`をクローズする新しい`Order`を出します。"""
+        assert 0 < portion <= 1, "portion must be a fraction between 0 and 1"
+        # Ensure size is an int to avoid rounding errors on 32-bit OS
+        size = copysign(max(1, int(round(abs(self.__size) * portion))), -self.__size)
+        from .order import Order
+        order = Order(self.__broker, self.__code, size, parent_trade=self, tag=self.__tag)
+        self.__broker.orders.insert(0, order)
+
+    # Fields getters
+
+    @property
+    def code(self):
+        """取引対象銘柄"""
+        return self.__code
+
+    @property
+    def size(self):
+        """取引サイズ（ボリューム；ショート取引の場合は負の値）。"""
+        return self.__size
+
+    @property
+    def entry_price(self) -> float:
+        """取引エントリー価格。"""
+        return self.__entry_price
+
+    @property
+    def exit_price(self) -> Optional[float]:
+        """取引エグジット価格（取引がまだアクティブな場合はNone）。"""
+        return self.__exit_price
+
+    @property
+    def entry_bar(self) -> int:
+        """
+        取引がエントリーされた時のローソク足バーのインデックス。
+        
+        .. deprecated:: 0.1.0
+            `entry_time`プロパティを使用してください。
+        """
+        import warnings
+        warnings.warn(
+            "entry_barプロパティは非推奨です。entry_timeプロパティを使用してください。",
+            DeprecationWarning,
+            stacklevel=2
+        )
+        # データからインデックスを逆算
+        try:
+            data_index = self.__broker._data[self.__code].index
+            return data_index.get_loc(self.__entry_time)
+        except (KeyError, TypeError):
+            # インデックスが見つからない場合は0を返す
+            return 0
+
+    @property
+    def exit_bar(self) -> Optional[int]:
+        """
+        取引がエグジットされた時のローソク足バーのインデックス
+        （取引がまだアクティブな場合はNone）。
+        
+        .. deprecated:: 0.1.0
+            `exit_time`プロパティを使用してください。
+        """
+        import warnings
+        warnings.warn(
+            "exit_barプロパティは非推奨です。exit_timeプロパティを使用してください。",
+            DeprecationWarning,
+            stacklevel=2
+        )
+        if self.__exit_time is None:
+            return None
+        try:
+            data_index = self.__broker._data[self.__code].index
+            return data_index.get_loc(self.__exit_time)
+        except (KeyError, TypeError):
+            # インデックスが見つからない場合はNoneを返す
+            return None
+
+    @property
+    def entry_time(self) -> Union[pd.Timestamp, int]:
+        """取引がエントリーされた日時。"""
+        return self.__entry_time
+
+    @property
+    def exit_time(self) -> Optional[Union[pd.Timestamp, int]]:
+        """取引がエグジットされた日時。"""
+        return self.__exit_time
+
+    @property
+    def tag(self):
+        """
+        この取引を開始した`Order`から継承されたタグ値。
+
+        取引の追跡や条件付きロジック/サブグループ分析に使用できます。
+
+        `Order.tag`も参照してください。
+        """
+        return self.__tag
+
+    @property
+    def _sl_order(self):
+        return self.__sl_order
+
+    @property
+    def _tp_order(self):
+        return self.__tp_order
+
+    # Extra properties
+
+    @property
+    def is_long(self):
+        """取引がロングの場合True（取引サイズが正の値）。"""
+        return self.__size > 0
+
+    @property
+    def is_short(self):
+        """取引がショートの場合True（取引サイズが負の値）。"""
+        return not self.is_long
+
+    @property
+    def pl(self):
+        """
+        取引の利益（正の値）または損失（負の値）を現金単位で表示。
+        手数料は取引がクローズされた後にのみ反映されます。
+        """
+        price = self.__exit_price or self.__broker.last_price(self.__code)
+        return (self.__size * (price - self.__entry_price)) - self._commissions
+
+    @property
+    def pl_pct(self):
+        """取引の利益（正の値）または損失（負の値）をパーセントで表示。"""
+        price = self.__exit_price or self.__broker.last_price(self.__code)
+        gross_pl_pct = copysign(1, self.__size) * (price / self.__entry_price - 1)
+
+        # 取引全体のサイズに対する手数料を個別単位に換算
+        commission_pct = self._commissions / (abs(self.__size) * self.__entry_price)
+        return gross_pl_pct - commission_pct
+
+    @property
+    def value(self):
+        """取引の総価値を現金単位で表示（ボリューム × 価格）。"""
+        price = self.__exit_price or self.__broker.last_price(self.__code)
+        return abs(self.__size) * price
+
+    # SL/TP management API
+
+    @property
+    def sl(self):
+        """
+        取引をクローズするストップロス価格。
+
+        この変数は書き込み可能です。新しい価格値を割り当てることで、
+        既存のSLオーダーを作成または修正します。
+        `None`を割り当てることでキャンセルできます。
+        """
+        return self.__sl_order and self.__sl_order.stop
+
+    @sl.setter
+    def sl(self, price: float):
+        self.__set_contingent('sl', price)
+
+    @property
+    def tp(self):
+        """
+        取引をクローズするテイクプロフィット価格。
+
+        このプロパティは書き込み可能です。新しい価格値を割り当てることで、
+        既存のTPオーダーを作成または修正します。
+        `None`を割り当てることでキャンセルできます。
+        """
+        return self.__tp_order and self.__tp_order.limit
+
+    @tp.setter
+    def tp(self, price: float):
+        self.__set_contingent('tp', price)
+
+    def __set_contingent(self, type, price):
+        assert type in ('sl', 'tp')
+        assert price is None or 0 < price < np.inf, f'Make sure 0 < price < inf! price: {price}'
+        attr = f'_{self.__class__.__qualname__}__{type}_order'
+        order: Order = getattr(self, attr)
+        if order:
+            order.cancel()
+        if price:
+            kwargs = {'stop': price} if type == 'sl' else {'limit': price}
+            order = self.__broker.new_order(self.code, -self.size, trade=self, tag=self.tag, **kwargs)
+            setattr(self, attr, order)

backcastpro-0.3.4.dist-info/METADATA

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: BackcastPro
+Version: 0.3.4
+Summary: トレーディング戦略のためのPythonバックテストライブラリ
+Project-URL: Homepage, https://github.com/botterYosuke/BackcastPro/
+Project-URL: Issues, https://github.com/botterYosuke/BackcastPro/issues
+Project-URL: Logo, https://raw.githubusercontent.com/botterYosuke/BackcastPro/main/docs/img/logo.drawio.svg
+Author: botterYosuke
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Requires-Dist: anywidget>=0.9.21
+Requires-Dist: duckdb>=0.9.0
+Requires-Dist: matplotlib>=3.0.0
+Requires-Dist: numpy>=1.20.0
+Requires-Dist: pandas>=1.3.0
+Requires-Dist: plotly>=5.0.0
+Requires-Dist: python-dotenv>=0.19.0
+Requires-Dist: requests>=2.25.0
+Requires-Dist: scipy>=1.7.0
+Provides-Extra: all
+Requires-Dist: yfinance>=0.2.0; extra == 'all'
+Provides-Extra: yfinance
+Requires-Dist: yfinance>=0.2.0; extra == 'yfinance'
+Description-Content-Type: text/markdown
+
+# <img src="https://raw.githubusercontent.com/botterYosuke/BackcastPro/main/docs/img/logo.drawio.svg" alt="BackcastPro Logo" width="40" height="24"> BackcastPro
+
+トレーディング戦略のためのPythonバックテストライブラリ。
+**リプレイ型シミュレーター**で、1バーずつ時間を進めながらチャートと売買を可視化できます。
+
+## インストール（Windows）
+
+### PyPIから（エンドユーザー向け）
+
+```powershell
+python -m pip install BackcastPro
+```
+
+### 開発用インストール
+
+```powershell
+git clone <repository-url>
+cd BackcastPro
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+python -m pip install -e .
+python -m pip install -r requirements.txt
+```
+
+## 使用方法
+
+### 基本的な使い方
+
+```python
+from BackcastPro import Backtest
+import pandas as pd
+
+# データ準備
+df = pd.read_csv("AAPL.csv", index_col=0, parse_dates=True)
+bt = Backtest(data={"AAPL": df}, cash=100000)
+
+# 戦略関数
+def my_strategy(bt):
+    if bt.position == 0:
+        bt.buy(tag="entry")
+    elif bt.position > 0:
+        bt.sell(tag="exit")
+
+# ステップ実行
+while not bt.is_finished:
+    my_strategy(bt)
+    bt.step()
+
+# 結果を取得
+results = bt.finalize()
+print(results)
+```
+
+### 一括実行
+
+```python
+bt = Backtest(data={"AAPL": df}, cash=100000)
+results = bt.run_with_strategy(my_strategy)
+```
+
+### marimo連携（リプレイ型シミュレーター）
+
+```python
+import marimo as mo
+
+slider = mo.ui.slider(start=1, stop=len(bt.index), value=1, label="時間")
+bt.goto(slider.value, strategy=my_strategy)
+chart = bt.chart()  # plotlyローソク足 + 売買マーカー
+
+mo.vstack([slider, chart])
+```
+
+## ドキュメント
+
+- [ドキュメント一覧](https://github.com/botterYosuke/BackcastPro/blob/main/docs/index.md)
+
+## バグ報告 / サポート
+
+- バグ報告や要望は GitHub Issues へ
+- 質問は Discord コミュニティへ（[招待リンク](https://discord.gg/fzJTbpzE)）
+- 使い方はドキュメントをご参照ください

backcastpro-0.3.4.dist-info/RECORD

@@ -0,0 +1,26 @@
+BackcastPro/__init__.py,sha256=vY2nk7aULUyIbW6ftJEgshANUZLSdY1l1PS0zJVfza4,1148
+BackcastPro/_broker.py,sha256=VAHJ9A8JRxEue7bBr6RnwMOjDQy-4zPWRGFogoot6ck,20729
+BackcastPro/_stats.py,sha256=378fs_XUyJo0etwZYnamB_69GjJFvzAmURv4fki4F9w,8260
+BackcastPro/backtest.py,sha256=hUTJJRDkuf5R-Z0iYkdsuxXN-WxJ16osZh3IdIKCVh0,23199
+BackcastPro/order.py,sha256=ir8FbZkWSHD1VdfWs1HlWm-xM_7zmwV4OumIK74xjIU,5545
+BackcastPro/position.py,sha256=5yfeTJFWZdptxDkz14-IRvco13098WAWeB3A6zTQcDE,2077
+BackcastPro/trade.py,sha256=QWISxpBNfdjNRX9K1yq-w6uLH2-E9_E0anqdWpo-2As,8113
+BackcastPro/api/__init__.py,sha256=0sbuGUTeTsxJI9ZIJ5bL665kSh4cxO77ooojxnj0m8g,59
+BackcastPro/api/board.py,sha256=DnzStITA2XfV6ZLW6vfPSKUxE09c0LLiWvVqCQ8oOrE,4861
+BackcastPro/api/chart.py,sha256=-5hlOKF14xKfuouS6Ct1Hy7SG3bm1uZT7Bg48cldr54,15678
+BackcastPro/api/db_manager.py,sha256=aKMoI6mJ0rv4NE5Zri9yh9aCIpL3oZcf5FtHTLGAHKQ,13051
+BackcastPro/api/db_stocks_board.py,sha256=2vEn6BpDKu1mRS7eGxWMEnqa-APfea6wzfMNtm6Pa_g,18219
+BackcastPro/api/db_stocks_daily.py,sha256=NTLrNA9-akqCU9rxRPZxHGv6SitKj2RlYvYhInP4ypo,21872
+BackcastPro/api/db_stocks_info.py,sha256=anEI-DuA1_h1tMJItmqdkvIiCvlxVz2yQqmACKKRdrs,11029
+BackcastPro/api/stocks_board.py,sha256=rUEno0Isy9d-AoMiPGMBF6G5FtU55VHprOs5sal4oWc,2829
+BackcastPro/api/stocks_info.py,sha256=jU108M3MCm0bT1t1YtMJppPWaCHYgpD7A2O9YSle6Kk,3232
+BackcastPro/api/stocks_price.py,sha256=PezgWJtVstfAFZ615S5WXHxEw8QrAxzzAQ1w_WXlPWc,5174
+BackcastPro/api/lib/__init__.py,sha256=XbMfpIz8vom84qygXaCEUVJHhlIh9AxSa0oCkGOvgkI,50
+BackcastPro/api/lib/e_api.py,sha256=BjYbk9beGtd1smLCpTo_ZFiM7-OZuufCz3cQjb_mG9A,23563
+BackcastPro/api/lib/jquants.py,sha256=PCo8KlD4_Tl6HExQxpnTW-tN2XkAT6pHjRJuv20RhwQ,12826
+BackcastPro/api/lib/kabusap.py,sha256=CoZ9FEYDcfoAbGdWhSW9V7D_EMjSJVQ8xHOARQN9kIc,9441
+BackcastPro/api/lib/stooq.py,sha256=goPssHTORTmvkQz6Og_A-WDatZ-Bh3EikL0_9kG6dZQ,16334
+BackcastPro/api/lib/util.py,sha256=Jwdlo9cvVVUQ9RP42VhI7C9BDXbm6N2y9539gMmwI80,950
+backcastpro-0.3.4.dist-info/METADATA,sha256=p0zpeB4ioB85bmnUMQo1WmTw3cN_ZcO87KcS3FyCPNg,3279
+backcastpro-0.3.4.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+backcastpro-0.3.4.dist-info/RECORD,,

backcastpro-0.3.4.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any