更新文档

ricequant · Jul 7, 2023 · 8f9aaf1 · 8f9aaf1
1 parent 6b214db
commit 8f9aaf1
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 4 deletions.
diff --git a/docs/source/api/base_api.rst b/docs/source/api/base_api.rst
@@ -730,11 +730,19 @@ Account - 账户
     :inherited-members:
 
 
-Position - 持仓
+StockPosition - 股票持仓
 ------------------------------------------------------
-.. module:: rqalpha.portfolio.position
+.. module:: rqalpha.mod.rqalpha_mod_sys_accounts.position_model
 
-..  autoclass:: Position
+..  autoclass:: StockPosition
+    :members:
+    :inherited-members:
+
+
+FuturePosition - 期货持仓
+------------------------------------------------------
+
+..  autoclass:: FuturePosition
     :members:
     :inherited-members:
 

diff --git a/rqalpha/interface.py b/rqalpha/interface.py
@@ -132,6 +132,51 @@ def quantity(self):
         """
         raise NotImplementedError
 
+    @property
+    @abc.abstractmethod
+    def avg_price(self):
+        # type: () -> Union[int, float]
+        """
+        开仓均价
+        """
+        raise NotImplementedError
+
+    @property
+    @abc.abstractmethod
+    def pnl(self):
+        # type: () -> float
+        """
+        该持仓的累计盈亏
+        """
+        raise NotImplementedError
+
+    @property
+    @abc.abstractmethod
+    def equity(self):
+        # type: () -> float
+        """
+        当前持仓市值
+        """
+        raise NotImplementedError
+
+    @property
+    @abc.abstractmethod
+    def prev_close(self):
+        # type: () -> float
+        """
+        昨日收盘价
+        """
+        raise NotImplementedError
+
+    @property
+    @abc.abstractmethod
+    def last_price(self):
+        # type: () -> float
+        """
+        当前最新价
+        """
+        raise NotImplementedError
+
 
 class AbstractStrategyLoader(with_metaclass(abc.ABCMeta)):
     """

diff --git a/rqalpha/mod/rqalpha_mod_sys_accounts/position_model.py b/rqalpha/mod/rqalpha_mod_sys_accounts/position_model.py
@@ -236,7 +236,6 @@ def equity(self):
     @property
     def margin(self) -> float:
         """
-        保证金
         保证金 = 持仓量 * 最新价 * 合约乘数 * 保证金率
         """
         return self.margin_rate * self.market_value