kabukit 0.4.0__tar.gz → 0.5.0__tar.gz

{kabukit-0.4.0 → kabukit-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: kabukit
-Version: 0.4.0
+Version: 0.5.0
 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.4.0 → kabukit-0.5.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "kabukit"
-version = "0.4.0"
+version = "0.5.0"
 description = "A Python toolkit for Japanese financial market data, supporting J-Quants and EDINET APIs."
 readme = "README.md"
 license = { file = "LICENSE" }

{kabukit-0.4.0 → kabukit-0.5.0}/src/kabukit/core/prices.py

@@ -41,10 +41,10 @@ class Prices(Base):
         (`AdjustmentFactor`) を用いて補正し、日次ベースの時系列データとして
         提供します。これにより、日々の時価総額計算などが正確に行えるようになります。
 
-        具体的には、`statements`から`TotalShares`（発行済株式総数）と
+        具体的には、`statements`から`IssuedShares`（発行済株式総数）と
         `TreasuryShares`（自己株式数）を取得し、それぞれを調整します。
         計算結果は、元の列名との混同を避けるため、接頭辞`Adjusted`を付与した
-        新しい列（`AdjustedTotalShares`, `AdjustedTreasuryShares`）として
+        新しい列（`AdjustedIssuedShares`, `AdjustedTreasuryShares`）として
         追加されます。
 
         .. note::
@@ -54,11 +54,10 @@ class Prices(Base):
             反映されないイベントによる株式数の変動は考慮されません。
 
         Args:
-            statements (Statements): `number_of_shares()`メソッドを通じて
-                株式数データを提供できる`Statements`オブジェクト。
+            statements (Statements): 財務データを提供する`Statements`オブジェクト。
 
         Returns:
-            Self: `AdjustedTotalShares`および`AdjustedTreasuryShares`列が
+            Self: `AdjustedIssuedShares`および`AdjustedTreasuryShares`列が
             追加された、新しいPricesオブジェクト。
         """
         shares = statements.number_of_shares().rename({"Date": "ReportDate"})
@@ -80,7 +79,7 @@ class Prices(Base):
             .select(
                 "Date",
                 "Code",
-                (pl.col("TotalShares", "TreasuryShares") * pl.col("CumulativeRatio"))
+                (pl.col("IssuedShares", "TreasuryShares") * pl.col("CumulativeRatio"))
                 .round(0)
                 .cast(pl.Int64)
                 .name.prefix("Adjusted"),
@@ -90,3 +89,16 @@ class Prices(Base):
         data = self.data.join(adjusted, on=["Date", "Code"], how="left")
 
         return self.__class__(data)
+
+    # def with_yields(self, statements: Statements) -> Self:
+    #     """各種利回り指標（収益利回り、純資産利回り、配当利回り）を計算し、列として追加する。
+
+    #     Args:
+    #         statements (Statements): 財務データを提供する`Statements`オブジェクト。
+
+    #     Returns:
+    #         Self: 各種利回り指標が追加された、新しいPricesオブジェクト。
+    #     """
+    #     prices_with_adjusted_shares = self.with_adjusted_shares(statements)
+    #     data_with_yields = calculate_all_yields(prices_with_adjusted_shares, statements)
+    #     return self.__class__(data_with_yields)

{kabukit-0.4.0 → kabukit-0.5.0}/src/kabukit/core/statements.py

@@ -14,11 +14,11 @@ class Statements(Base):
     def number_of_shares(self) -> DataFrame:
         """発行済株式数を取得する。"""
         return self.data.filter(
-            pl.col("TotalShares").is_not_null(),
+            pl.col("IssuedShares").is_not_null(),
         ).select(
             "Date",
             "Code",
-            "TotalShares",
+            "IssuedShares",
             "TreasuryShares",
             "AverageOutstandingShares",
         )

{kabukit-0.4.0 → kabukit-0.5.0}/src/kabukit/jquants/schema.py

@@ -130,7 +130,7 @@ class StatementColumns(BaseColumns):
     ChangesInAccountingEstimates = "会計上の見積りの変更"
     RetrospectiveRestatement = "修正再表示"
 
-    TotalShares = "期末発行済株式数" # 自己株式を含む (NumberOfIssuedAndOutstandingSharesAtTheEndOfFiscalYearIncludingTreasuryStock)
+    IssuedShares = "期末発行済株式数" # 自己株式を含む (NumberOfIssuedAndOutstandingSharesAtTheEndOfFiscalYearIncludingTreasuryStock)
     TreasuryShares = "期末自己株式数" # (NumberOfTreasuryStockAtTheEndOfFiscalYear)
     AverageOutstandingShares = "期中平均株式数" # 自己株式を除く。EPSなどの計算に使用される (AverageNumberOfShares)
 

{kabukit-0.4.0 → kabukit-0.5.0}/src/kabukit/jquants/statements.py

@@ -17,7 +17,7 @@ def clean(df: DataFrame) -> DataFrame:
         .rename(
             {
                 "LocalCode": "Code",
-                "NumberOfIssuedAndOutstandingSharesAtTheEndOfFiscalYearIncludingTreasuryStock": "TotalShares",  # noqa: E501
+                "NumberOfIssuedAndOutstandingSharesAtTheEndOfFiscalYearIncludingTreasuryStock": "IssuedShares",  # noqa: E501
                 "NumberOfTreasuryStockAtTheEndOfFiscalYear": "TreasuryShares",
                 "AverageNumberOfShares": "AverageOutstandingShares",
             },
@@ -49,7 +49,7 @@ def _cast_float(df: DataFrame) -> DataFrame:
         ]
     ).with_columns(
         pl.col(
-            "TotalShares",
+            "IssuedShares",
             "TreasuryShares",
         ).cast(pl.Int64, strict=False),
         pl.col(