BackcastPro 0.0.1__py3-none-any.whl → 0.0.3__py3-none-any.whl

BackcastPro/strategy.py

@@ -0,0 +1,174 @@
+"""
+トレーディング戦略の基底クラス。
+"""
+
+from __future__ import annotations
+
+import sys
+from abc import ABCMeta, abstractmethod
+from typing import Optional, Tuple
+
+import pandas as pd
+
+# Import classes from their new modules
+from .order import Order
+from .position import Position
+from .trade import Trade
+from ._broker import _Broker
+
+# pdoc（Pythonドキュメント生成ツール）の設定
+# Falseを設定することで、該当するメソッドをドキュメントから除外
+# 通常、__init__メソッドは内部実装の詳細であり、ユーザー向けドキュメントには不要
+__pdoc__ = {
+    'Strategy.__init__': False,
+    'Order.__init__': False,
+    'Position.__init__': False,
+    'Trade.__init__': False,
+}
+
+
+class Strategy(metaclass=ABCMeta):
+    """
+    トレーディング戦略の基底クラス。このクラスを拡張し、
+    `backtesting.backtesting.Strategy.init` と
+    `backtesting.backtesting.Strategy.next` メソッドを
+    オーバーライドして独自の戦略を定義してください。
+    """
+    
+    def __init__(self, broker: _Broker, data: pd.DataFrame):
+        """
+        これは Backtestクラスで初期化するためユーザーは不要
+        """
+        self._broker: _Broker = broker
+        self._data: pd.DataFrame = data
+
+
+    @abstractmethod
+    def init(self):
+        """
+        戦略を初期化します。
+        このメソッドをオーバーライドしてください。
+        戦略開始前に、事前計算が必要なものやベクトル化された方法で
+        事前計算できるものを事前計算します。
+
+        `backtesting.lib`からコンポーザブル戦略を拡張する場合は、
+        必ず以下を呼び出してください：
+
+            super().init()
+        """
+
+    @abstractmethod
+    def next(self):
+        """
+        メインのストラテジー実行メソッド。新しい
+        `backtesting.backtesting.Strategy.data`
+        インスタンス（行；完全なローソク足バー）が利用可能になるたびに呼び出されます。
+        これは、`backtesting.backtesting.Strategy.init`で
+        事前計算されたデータに基づくストラテジーの意思決定が
+        行われるメインメソッドです。
+
+        `backtesting.lib`からコンポーザブルストラテジーを拡張する場合は、
+        必ず以下を呼び出してください：
+
+            super().next()
+        """
+        
+
+    class __FULL_EQUITY(float):  # noqa: N801
+        """
+        利用可能資金のほぼ100%を表す特別な浮動小数点数クラス。
+        floatを継承し、表示時に'.9999'として表示される。
+        浮動小数点の精度問題を回避し、安全な取引を可能にする。
+        """
+        def __repr__(self): return '.9999'  # noqa: E704
+
+    # 利用可能資金のほぼ100%を使用するための特別な値
+    # 1 - sys.float_info.epsilonにより、浮動小数点の精度問題を回避し、
+    # 手数料やスプレッドを考慮した安全な取引を可能にする
+    _FULL_EQUITY = __FULL_EQUITY(1 - sys.float_info.epsilon)
+
+    def buy(self, *,
+            size: float = _FULL_EQUITY,
+            limit: Optional[float] = None,
+            stop: Optional[float] = None,
+            sl: Optional[float] = None,
+            tp: Optional[float] = None,
+            tag: object = None) -> 'Order':
+        """
+        新しいロングオーダーを発注し、それを返します。パラメータの説明については、
+        `Order` とそのプロパティを参照してください。
+        `Backtest(..., trade_on_close=True)` で実行していない限り、
+        成行注文は次のバーの始値で約定され、
+        その他の注文タイプ（指値、ストップ指値、ストップ成行）は
+        それぞれの条件が満たされたときに約定されます。
+
+        既存のポジションをクローズするには、`Position.close()` と `Trade.close()` を参照してください。
+
+        `Strategy.sell()` も参照してください。
+        """
+        assert 0 < size < 1 or round(size) == size >= 1, \
+            "sizeは正の資産割合または正の整数単位である必要があります"
+        return self._broker.new_order(size, limit, stop, sl, tp, tag)
+
+    def sell(self, *,
+             size: float = _FULL_EQUITY,
+             limit: Optional[float] = None,
+             stop: Optional[float] = None,
+             sl: Optional[float] = None,
+             tp: Optional[float] = None,
+             tag: object = None) -> 'Order':
+        """
+        新しいショートオーダーを発注し、それを返します。パラメータの説明については、
+        `Order` とそのプロパティを参照してください。
+
+        .. caution::
+            `self.sell(size=.1)` は、以下の場合を除いて、
+            既存の `self.buy(size=.1)` トレードをクローズしないことに注意してください：
+
+            * バックテストが `exclusive_orders=True` で実行された場合、
+            * 両方のケースで原資産価格が等しく、
+              バックテストが `spread = commission = 0` で実行された場合。
+
+            トレードを明示的に終了するには、`Trade.close()` または `Position.close()` を使用してください。
+
+        `Strategy.buy()` も参照してください。
+
+        .. note::
+            既存のロングポジションをクローズしたいだけの場合は、
+            `Position.close()` または `Trade.close()` を使用してください。
+        """
+        assert 0 < size < 1 or round(size) == size >= 1, \
+            "sizeは正の資産割合または正の整数単位である必要があります"
+        return self._broker.new_order(-size, limit, stop, sl, tp, tag)
+
+    @property
+    def equity(self) -> float:
+        """現在のアカウント資産（現金プラス資産）。"""
+        return self._broker.equity
+
+    @property
+    def data(self) -> pd.DataFrame:
+        """
+        価格データは、`Backtest.__init__`に渡されるものと同じ
+        """
+        return self._data
+
+    @property
+    def position(self) -> 'Position':
+        """`Position` のインスタンス。"""
+        return self._broker.position
+
+    @property
+    def orders(self) -> 'Tuple[Order, ...]':
+        """実行待ちのオーダーリスト（`Order` を参照）。"""
+        return tuple(self._broker.orders)
+
+    @property
+    def trades(self) -> 'Tuple[Trade, ...]':
+        """アクティブなトレードリスト（`Trade` を参照）。"""
+        return tuple(self._broker.trades)
+
+    @property
+    def closed_trades(self) -> 'Tuple[Trade, ...]':
+        """決済済みトレードリスト（`Trade` を参照）。"""
+        return tuple(self._broker.closed_trades)

BackcastPro/trade.py

@@ -0,0 +1,195 @@
+"""
+取引管理モジュール。
+"""
+
+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', size: int, entry_price: float, entry_bar, tag):
+        self.__broker = broker
+        self.__size = size
+        self.__entry_price = entry_price
+        self.__exit_price: Optional[float] = None
+        self.__entry_bar: int = entry_bar
+        self.__exit_bar: Optional[int] = None
+        self.__sl_order: Optional[Order] = None
+        self.__tp_order: Optional[Order] = None
+        self.__tag = tag
+        self._commissions = 0
+
+    def __repr__(self):
+        return f'<Trade size={self.__size} time={self.__entry_bar}-{self.__exit_bar or ""} ' \
+               f'price={self.__entry_price}-{self.__exit_price or ""} pl={self.pl:.0f}' \
+               f'{" tag=" + str(self.__tag) if self.__tag is not None else ""}>'
+
+    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, size, parent_trade=self, tag=self.__tag)
+        self.__broker.orders.insert(0, order)
+
+    # Fields getters
+
+    @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:
+        """取引がエントリーされた時のローソク足バーのインデックス。"""
+        return self.__entry_bar
+
+    @property
+    def exit_bar(self) -> Optional[int]:
+        """
+        取引がエグジットされた時のローソク足バーのインデックス
+        （取引がまだアクティブな場合はNone）。
+        """
+        return self.__exit_bar
+
+    @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 entry_time(self) -> Union[pd.Timestamp, int]:
+        """取引がエントリーされた日時。"""
+        return self.__broker._data.index[self.__entry_bar]
+
+    @property
+    def exit_time(self) -> Optional[Union[pd.Timestamp, int]]:
+        """取引がエグジットされた日時。"""
+        if self.__exit_bar is None:
+            return None
+        return self.__broker._data.index[self.__exit_bar]
+
+    @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
+        return (self.__size * (price - self.__entry_price)) - self._commissions
+
+    @property
+    def pl_pct(self):
+        """取引の利益（正の値）または損失（負の値）をパーセントで表示。"""
+        price = self.__exit_price or self.__broker.last_price
+        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
+        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.size, trade=self, tag=self.tag, **kwargs)
+            setattr(self, attr, order)

backcastpro-0.0.3.dist-info/METADATA

@@ -0,0 +1,59 @@
+Metadata-Version: 2.4
+Name: BackcastPro
+Version: 0.0.3
+Summary: トレーディング戦略のためのPythonバックテストライブラリ
+Author-email: botterYosuke <yosuke.sasazawa@gmail.com>
+Project-URL: Homepage, https://BackcastPro.github.io/BackcastPro/
+Project-URL: Issues, https://github.com/BackcastPro/BackcastPro/issues
+Project-URL: Logo, https://raw.githubusercontent.com/BackcastPro/BackcastPro/main/docs/img/logo.png
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# BackcastPro
+
+トレーディング戦略のためのPythonバックテストライブラリ。
+
+## インストール
+
+### PyPIから（エンドユーザー向け）
+
+```bash
+pip install BackcastPro
+```
+
+### 開発用インストール
+
+開発用に、リポジトリをクローンして開発モードでインストールしてください：
+
+```bash
+git clone <repository-url>
+cd BackcastPro
+pip install -e .
+```
+
+**開発モードインストール（pip install -e .）**
+- 上記で実行したpip install -e .コマンドは、プロジェクトを開発モードでインストールしました
+- これにより、srcディレクトリが自動的にPythonパスに追加されます
+
+## 使用方法
+
+```python
+from BackcastPro import Strategy, Backtest
+from BackcastPro.lib import resample_apply
+
+# ここにトレーディング戦略の実装を記述
+```
+
+## ドキュメント
+
+- [PyPIへのデプロイ方法](./docs/How%20to%20deploy%20to%20PyPI.md)
+- [サンプル](./docs/examples/)
+
+## バグ報告
+
+バグを報告したり、[ディスカッションボード](https://discord.gg/fzJTbpzE)に投稿する前に、
+
+

backcastpro-0.0.3.dist-info/RECORD

@@ -0,0 +1,14 @@
+BackcastPro/__init__.py,sha256=1PPRDL8uh_fE35shzswg3f1XrqVMNBJ1N6H7ZTqSzPg,191
+BackcastPro/_broker.py,sha256=5n6SR9wqEZz2s68iIrp7x3v7vhh6zL8ichfoYZPsquA,18191
+BackcastPro/_stats.py,sha256=Omcx4BgfddBvnmkYHn4b49TXqCgHYr9McKk46qMKNuM,7843
+BackcastPro/backtest.py,sha256=jcLzq9kOFYpm0u3FdXen92kPfKxdMkM4COVS9pbc_kA,13947
+BackcastPro/order.py,sha256=JuPJah6Mcm4Qr0wzOCex4hTmqXU96HGGRDiIl7_rsiQ,5636
+BackcastPro/position.py,sha256=7G1fKrCLuW8QACN4mWNvR-6yrk_X9ERFLbqo97LKuX0,2236
+BackcastPro/strategy.py,sha256=KhVXH62QxivI_6C3-7CxjXPXMQ--VMOL3as2iHBGegw,7207
+BackcastPro/trade.py,sha256=8pDyIh96NmzPgEDkYB9h2lekHl3wdK6JeZ5Ix3y8wWQ,7162
+BackcastPro/data/__init__.py,sha256=qSf674-OW7fQj48y6VqJW3Y_fSqwj9pAGhFS2u_s5ik,126
+BackcastPro/data/datareader.py,sha256=dhJ6BBmj713rD_Ks8mKm2o1MiLf4uG3YwS3xnEb1_cw,6154
+backcastpro-0.0.3.dist-info/METADATA,sha256=P-fyxj4jZWfnpIAYbQUmI1T0Eq-ZwsdEd3lWFmY9_wQ,1848
+backcastpro-0.0.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+backcastpro-0.0.3.dist-info/top_level.txt,sha256=GiP-TX_Bc2jjwHS9cx0VCrW27e9JPbhWWnqGxa5B4Fs,12
+backcastpro-0.0.3.dist-info/RECORD,,

BackcastPro/example.py

@@ -1,2 +0,0 @@
-def add_one(number):
-    return number + 1

backcastpro-0.0.1.dist-info/METADATA

@@ -1,18 +0,0 @@
-Metadata-Version: 2.4
-Name: BackcastPro
-Version: 0.0.1
-Summary: A small example package
-Author-email: 笹澤ようすけ <yosuke.sasazawa@gmail.com>
-Project-URL: Homepage, https://BackcastPro.github.io/BackcastPro/
-Project-URL: Issues, https://github.com/BackcastPro/BackcastPro/issues
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Classifier: License :: OSI Approved :: MIT License
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-
-# Example Package
-
-This is a simple example package. You can use
-[GitHub-flavored Markdown](https://guides.github.com/features/mastering-markdown/)
-to write your content.

backcastpro-0.0.1.dist-info/RECORD

@@ -1,6 +0,0 @@
-BackcastPro/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-BackcastPro/example.py,sha256=X4bE2aofVJAbmacOI_Ny0Oc7m2Ru4ShxUscmJqVps1Q,43
-backcastpro-0.0.1.dist-info/METADATA,sha256=XC8ETHW_-JRmAG_frw-tkAfHkrNEqXyReg_JwK-EGyw,685
-backcastpro-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-backcastpro-0.0.1.dist-info/top_level.txt,sha256=GiP-TX_Bc2jjwHS9cx0VCrW27e9JPbhWWnqGxa5B4Fs,12
-backcastpro-0.0.1.dist-info/RECORD,,