kabukit 0.5.1__tar.gz → 0.5.2__tar.gz

{kabukit-0.5.1 → kabukit-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: kabukit
-Version: 0.5.1
+Version: 0.5.2
 Summary: A Python toolkit for Japanese financial market data, supporting J-Quants and EDINET APIs.
 Author: daizutabi
 Author-email: daizutabi <daizutabi@gmail.com>

{kabukit-0.5.1 → kabukit-0.5.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "kabukit"
-version = "0.5.1"
+version = "0.5.2"
 description = "A Python toolkit for Japanese financial market data, supporting J-Quants and EDINET APIs."
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -104,5 +104,6 @@ reportExplicitAny = false
 reportImplicitOverride = false
 reportImportCycles = false
 reportIncompatibleVariableOverride = false
+reportPrivateUsage = false
 reportUnusedCallResult = false
 reportUnusedImport = false

{kabukit-0.5.1 → kabukit-0.5.2}/src/kabukit/core/prices.py

@@ -60,7 +60,7 @@ class Prices(Base):
             Self: `AdjustedIssuedShares`および`AdjustedTreasuryShares`列が
             追加された、新しいPricesオブジェクト。
         """
-        shares = statements.number_of_shares().rename({"Date": "ReportDate"})
+        shares = statements.shares().rename({"Date": "ReportDate"})
 
         adjusted = (
             self.data.join_asof(
@@ -89,6 +89,46 @@ class Prices(Base):
 
         return self.__class__(data)
 
+    def with_market_cap(self) -> Self:
+        """時価総額を計算し、列として追加する。
+
+        このメソッドは、日々の調整前終値 (`RawClose`) と、調整済みの発行済株式数
+        (`AdjustedIssuedShares`) および自己株式数 (`AdjustedTreasuryShares`)
+        を基に、日次ベースの時価総額を計算します。
+
+        計算式:
+            時価総額 = 調整前終値 * (調整済み発行済株式数 - 調整済み自己株式数)
+
+        Note:
+            このメソッドを呼び出す前に、`with_adjusted_shares()` を
+            実行して、調整済みの株式数列を事前に計算しておく必要があります。
+
+        Returns:
+            Self: `MarketCap` 列が追加された、新しいPricesオブジェクト。
+        """
+        shares = pl.col("AdjustedIssuedShares") - pl.col("AdjustedTreasuryShares")
+        data = self.data.with_columns(
+            (pl.col("RawClose") * shares).round(0).alias("MarketCap"),
+        )
+        return self.__class__(data)
+
+    def with_equity(self, statements: Statements) -> Self:
+        """時系列の純資産を列として追加する。
+
+        Args:
+            statements (Statements): 財務データを提供する`Statements`オブジェクト。
+
+        Returns:
+            Self: `Equity` 列が追加された、新しいPricesオブジェクト。
+        """
+        data = self.data.join_asof(
+            statements.equity(),
+            on="Date",
+            by="Code",
+            check_sortedness=False,
+        )
+        return self.__class__(data)
+
     def with_forecast_profit(self, statements: Statements) -> Self:
         """時系列の予想純利益を列として追加する。
 
@@ -105,3 +145,20 @@ class Prices(Base):
             check_sortedness=False,
         )
         return self.__class__(data)
+
+    def with_forecast_dividend(self, statements: Statements) -> Self:
+        """時系列の予想年間配当総額を列として追加する。
+
+        Args:
+            statements (Statements): 財務データを提供する`Statements`オブジェクト。
+
+        Returns:
+            Self: `ForecastDividend` 列が追加された、新しいPricesオブジェクト。
+        """
+        data = self.data.join_asof(
+            statements.forecast_dividend(),
+            on="Date",
+            by="Code",
+            check_sortedness=False,
+        )
+        return self.__class__(data)

kabukit-0.5.2/src/kabukit/core/statements.py

@@ -0,0 +1,89 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import polars as pl
+
+from .base import Base
+
+if TYPE_CHECKING:
+    from polars import DataFrame
+
+
+class Statements(Base):
+    def shares(self) -> DataFrame:
+        """発行済株式数を取得する。"""
+        return self.data.filter(
+            pl.col("IssuedShares").is_not_null(),
+        ).select(
+            "Date",
+            "Code",
+            "IssuedShares",
+            "TreasuryShares",
+            "AverageOutstandingShares",
+        )
+
+    def equity(self) -> DataFrame:
+        """Statementsデータから純資産を抽出する。
+
+        Returns:
+            DataFrame: Date, Code, Equity を含むDataFrame
+        """
+        return self.data.filter(
+            pl.col("Equity").is_not_null(),
+        ).select("Date", "Code", "Equity")
+
+    def forecast_profit(self) -> DataFrame:
+        """Statementsデータから予想純利益を抽出する。
+
+        Returns:
+            DataFrame: Date, Code, ForecastProfit を含むDataFrame
+        """
+        return (
+            self.data.with_columns(
+                pl.when(pl.col("TypeOfDocument").str.starts_with("FY"))
+                .then(pl.col("NextYearForecastProfit"))
+                .otherwise(pl.col("ForecastProfit"))
+                .alias("ForecastProfit"),
+            )
+            .filter(pl.col("ForecastProfit").is_not_null())
+            .select("Date", "Code", "ForecastProfit")
+        )
+
+    def forecast_dividend(self) -> DataFrame:
+        """予想年間配当総額を抽出する。
+
+        Returns:
+            DataFrame: Date, Code, ForecastDividend を含むDataFrame
+        """
+        # 予想株式数を計算
+        forecast_shares = (
+            pl.when(pl.col("TypeOfDocument").str.starts_with("FY"))
+            .then(
+                pl.col("NextYearForecastProfit")
+                / pl.col("NextYearForecastEarningsPerShare"),
+            )
+            .otherwise(pl.col("ForecastProfit") / pl.col("ForecastEarningsPerShare"))
+            .alias("ForecastShares")
+        )
+
+        # 年間配当総額を計算
+        annual_forecast_dividend = (
+            pl.when(pl.col("TypeOfDocument").str.starts_with("FY"))
+            .then(
+                pl.col("NextYearForecastDividendPerShareAnnual")
+                * pl.col("ForecastShares"),
+            )
+            .otherwise(
+                pl.col("ForecastDividendPerShareAnnual") * pl.col("ForecastShares"),
+            )
+            .round(0)
+            .alias("ForecastDividend")
+        )
+
+        return (
+            self.data.with_columns(forecast_shares)
+            .with_columns(annual_forecast_dividend)
+            .filter(pl.col("ForecastDividend").is_not_null())
+            .select("Date", "Code", "ForecastDividend")
+        )

{kabukit-0.5.1 → kabukit-0.5.2}/src/kabukit/jquants/statements.py

@@ -12,17 +12,24 @@ if TYPE_CHECKING:
 
 
 def clean(df: DataFrame) -> DataFrame:
+    df = df.select(pl.exclude(r"^.*\(REIT\)$"))
+    return df.pipe(_rename).pipe(_cast)
+
+
+def _rename(df: DataFrame) -> DataFrame:
+    return df.rename(
+        {
+            "LocalCode": "Code",
+            "NumberOfIssuedAndOutstandingSharesAtTheEndOfFiscalYearIncludingTreasuryStock": "IssuedShares",  # noqa: E501
+            "NumberOfTreasuryStockAtTheEndOfFiscalYear": "TreasuryShares",
+            "AverageNumberOfShares": "AverageOutstandingShares",
+        },
+    )
+
+
+def _cast(df: DataFrame) -> DataFrame:
     return (
-        df.select(pl.exclude(r"^.*\(REIT\)$"))
-        .rename(
-            {
-                "LocalCode": "Code",
-                "NumberOfIssuedAndOutstandingSharesAtTheEndOfFiscalYearIncludingTreasuryStock": "IssuedShares",  # noqa: E501
-                "NumberOfTreasuryStockAtTheEndOfFiscalYear": "TreasuryShares",
-                "AverageNumberOfShares": "AverageOutstandingShares",
-            },
-        )
-        .with_columns(
+        df.with_columns(
             pl.col("^.*Date$").str.to_date("%Y-%m-%d", strict=False),
             pl.col("DisclosedTime").str.to_time("%H:%M:%S", strict=False),
             pl.col("TypeOfCurrentPeriod").cast(pl.Categorical),

kabukit-0.5.1/src/kabukit/core/statements.py

@@ -1,41 +0,0 @@
-from __future__ import annotations
-
-from typing import TYPE_CHECKING
-
-import polars as pl
-
-from .base import Base
-
-if TYPE_CHECKING:
-    from polars import DataFrame
-
-
-class Statements(Base):
-    def number_of_shares(self) -> DataFrame:
-        """発行済株式数を取得する。"""
-        return self.data.filter(
-            pl.col("IssuedShares").is_not_null(),
-        ).select(
-            "Date",
-            "Code",
-            "IssuedShares",
-            "TreasuryShares",
-            "AverageOutstandingShares",
-        )
-
-    def forecast_profit(self) -> DataFrame:
-        """予想純利益を抽出する。
-
-        Returns:
-            DataFrame: Date, Code, ForecastProfit を含むDataFrame
-        """
-        return (
-            self.data.with_columns(
-                pl.when(pl.col("TypeOfDocument").str.starts_with("FY"))
-                .then(pl.col("NextYearForecastProfit"))
-                .otherwise(pl.col("ForecastProfit"))
-                .alias("ForecastProfit"),
-            )
-            .filter(pl.col("ForecastProfit").is_not_null())
-            .select("Date", "Code", "ForecastProfit")
-        )