kabukit 0.5.4__tar.gz → 0.7.0__tar.gz

{kabukit-0.5.4 → kabukit-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: kabukit
-Version: 0.5.4
+Version: 0.7.0
 Summary: A Python toolkit for Japanese financial market data, supporting J-Quants and EDINET APIs.
 Author: daizutabi
 Author-email: daizutabi <daizutabi@gmail.com>
@@ -29,11 +29,13 @@ Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: async-typer>=0.1.10
-Requires-Dist: holidays>=0.81
+Requires-Dist: holidays>=0.82
 Requires-Dist: httpx>=0.28.1
 Requires-Dist: platformdirs>=4.4.0
 Requires-Dist: polars>=1.34.0
 Requires-Dist: python-dotenv>=1.1.1
+Requires-Dist: rich>=14.1.0
+Requires-Dist: tqdm>=4.67.1
 Requires-Dist: typer>=0.19.2
 Requires-Python: >=3.13
 Project-URL: Documentation, https://daizutabi.github.io/kabukit/

{kabukit-0.5.4 → kabukit-0.7.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "kabukit"
-version = "0.5.4"
+version = "0.7.0"
 description = "A Python toolkit for Japanese financial market data, supporting J-Quants and EDINET APIs."
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -17,11 +17,13 @@ classifiers = [
 requires-python = ">=3.13"
 dependencies = [
   "async-typer>=0.1.10",
-  "holidays>=0.81",
+  "holidays>=0.82",
   "httpx>=0.28.1",
   "platformdirs>=4.4.0",
   "polars>=1.34.0",
   "python-dotenv>=1.1.1",
+  "rich>=14.1.0",
+  "tqdm>=4.67.1",
   "typer>=0.19.2",
 ]
 
@@ -45,8 +47,7 @@ dev = [
   "pytest-mock>=3.15.1",
   "pytest-randomly>=4.0.1",
   "pytest-xdist>=3.8.0",
-  "rich>=14.1.0",
-  "tqdm>=4.67.1",
+  "scipy",
   "vegafusion-python-embed>=1.6.9",
   "vegafusion>=2.0.3",
   "vl-convert-python>=1.8.0",

kabukit-0.7.0/src/kabukit/analysis/visualization/__init__.py

@@ -0,0 +1,7 @@
+from .market import plot_topix_timeseries
+from .prices import plot_prices
+
+__all__ = [
+    "plot_prices",
+    "plot_topix_timeseries",
+]

kabukit-0.7.0/src/kabukit/analysis/visualization/market.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import altair as alt
+
+if TYPE_CHECKING:
+    from polars import DataFrame
+
+# pyright: reportUnknownMemberType=false
+
+
+def plot_topix_timeseries(df: DataFrame) -> alt.Chart:
+    """TOPIXの時系列データを折れ線グラフでプロットする。"""
+    return (
+        alt.Chart(df, title="TOPIX 時系列チャート")
+        .mark_line()
+        .encode(
+            x=alt.X("Date:T", title="日付"),
+            y=alt.Y("Close:Q", title="終値", scale=alt.Scale(zero=False)),
+            tooltip=[
+                alt.Tooltip("Date:T", title="日付"),
+                alt.Tooltip("Open:Q", title="始値"),
+                alt.Tooltip("High:Q", title="高値"),
+                alt.Tooltip("Low:Q", title="安値"),
+                alt.Tooltip("Close:Q", title="終値"),
+            ],
+        )
+    )

{kabukit-0.5.4 → kabukit-0.7.0}/src/kabukit/cli/app.py

@@ -5,7 +5,7 @@ from __future__ import annotations
 import typer
 from async_typer import AsyncTyper  # pyright: ignore[reportMissingTypeStubs]
 
-from . import auth, get
+from . import auth, cache, get
 
 app = AsyncTyper(
     add_completion=False,
@@ -13,6 +13,7 @@ app = AsyncTyper(
 )
 app.add_typer(auth.app, name="auth")
 app.add_typer(get.app, name="get")
+app.add_typer(cache.app, name="cache")
 
 
 @app.command()

kabukit-0.7.0/src/kabukit/cli/cache.py

@@ -0,0 +1,61 @@
+"""Cache management commands."""
+
+from __future__ import annotations
+
+import shutil
+from typing import TYPE_CHECKING
+
+import typer
+from rich.console import Console
+from rich.tree import Tree
+
+from kabukit.utils.config import get_cache_dir
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+app = typer.Typer(add_completion=False, help="キャッシュを管理します。")
+
+
+def add_to_tree(tree: Tree, path: Path) -> None:
+    for p in sorted(path.iterdir()):
+        if p.is_dir():
+            branch = tree.add(p.name)
+            add_to_tree(branch, p)
+        else:
+            tree.add(p.name)
+
+
+@app.command()
+def tree() -> None:
+    """キャッシュディレクトリのツリー構造を表示します。"""
+    cache_dir = get_cache_dir()
+
+    if not cache_dir.exists():
+        typer.echo(f"キャッシュディレクトリ '{cache_dir}' は存在しません。")
+        return
+
+    console = Console()
+    tree_view = Tree(str(cache_dir))
+    add_to_tree(tree_view, cache_dir)
+    console.print(tree_view)
+
+
+@app.command()
+def clean() -> None:
+    """キャッシュディレクトリを削除します。"""
+    cache_dir = get_cache_dir()
+
+    if not cache_dir.exists():
+        typer.echo(f"キャッシュディレクトリ '{cache_dir}' は存在しません。")
+        return
+
+    try:
+        shutil.rmtree(cache_dir)
+        msg = f"キャッシュディレクトリ '{cache_dir}' を正常にクリーンアップしました。"
+        typer.echo(msg)
+    except OSError:
+        msg = f"キャッシュディレクトリ '{cache_dir}' のクリーンアップ中に"
+        msg += "エラーが発生しました。"
+        typer.secho(msg, fg=typer.colors.RED, bold=True)
+        raise typer.Exit(1) from None

{kabukit-0.5.4 → kabukit-0.7.0}/src/kabukit/cli/get.py

@@ -57,7 +57,12 @@ async def _fetch(
 
     from kabukit.jquants.concurrent import fetch_all
 
-    df = await fetch_all(target, progress=tqdm.asyncio.tqdm, **kwargs)
+    try:
+        df = await fetch_all(target, progress=tqdm.asyncio.tqdm, **kwargs)
+    except KeyboardInterrupt:
+        typer.echo("中断しました。")
+        raise typer.Exit(1) from None
+
     typer.echo(df)
     path = cls(df).write()
     typer.echo(f"全銘柄の{message}を '{path}' に保存しました。")
@@ -100,7 +105,12 @@ async def list_() -> None:
     from kabukit.core.list import List
     from kabukit.edinet.concurrent import fetch_list
 
-    df = await fetch_list(years=10, progress=tqdm.asyncio.tqdm)
+    try:
+        df = await fetch_list(years=10, progress=tqdm.asyncio.tqdm)
+    except (KeyboardInterrupt, RuntimeError):
+        typer.echo("中断しました。")
+        raise typer.Exit(1) from None
+
     typer.echo(df)
     path = List(df).write()
     typer.echo(f"報告書一覧を '{path}' に保存しました。")
@@ -125,7 +135,12 @@ async def reports() -> None:
     lst = df.filter(pl.col("csvFlag"), pl.col("secCode").is_not_null())
     doc_ids = lst["docID"].unique()
 
-    df = await fetch_csv(doc_ids, limit=1000, progress=tqdm.asyncio.tqdm)
+    try:
+        df = await fetch_csv(doc_ids, limit=1000, progress=tqdm.asyncio.tqdm)
+    except (KeyboardInterrupt, RuntimeError):
+        typer.echo("中断しました。")
+        raise typer.Exit(1) from None
+
     typer.echo(df)
     path = Reports(df).write()
     typer.echo(f"報告書を '{path}' に保存しました。")

{kabukit-0.5.4 → kabukit-0.7.0}/src/kabukit/core/base.py

@@ -1,14 +1,15 @@
 from __future__ import annotations
 
 import datetime
-from pathlib import Path
 from typing import TYPE_CHECKING
 
 import polars as pl
-from platformdirs import user_cache_dir
+
+from kabukit.utils.config import get_cache_dir
 
 if TYPE_CHECKING:
     from collections.abc import Iterable
+    from pathlib import Path
     from typing import Any, Self
 
     from polars import DataFrame
@@ -24,7 +25,7 @@ class Base:
     @classmethod
     def data_dir(cls) -> Path:
         clsname = cls.__name__.lower()
-        return Path(user_cache_dir("kabukit")) / clsname
+        return get_cache_dir() / clsname
 
     def write(self) -> Path:
         data_dir = self.data_dir()

{kabukit-0.5.4 → kabukit-0.7.0}/src/kabukit/jquants/client.py

@@ -12,7 +12,7 @@ from kabukit.core.client import Client
 from kabukit.utils.config import load_dotenv, set_key
 from kabukit.utils.params import get_params
 
-from . import info, prices, statements
+from . import info, prices, statements, topix
 
 if TYPE_CHECKING:
     from collections.abc import AsyncIterator
@@ -342,3 +342,32 @@ class JQuantsClient(Client):
             return df
 
         return df.with_columns(pl.col("^.*Date$").str.to_date("%Y-%m-%d", strict=False))
+
+    async def get_topix(
+        self,
+        from_: str | datetime.date | None = None,
+        to: str | datetime.date | None = None,
+    ) -> DataFrame:
+        """日次のTOPIX指数データを取得する。
+
+        Args:
+            from_: 取得期間の開始日。
+            to: 取得期間の終了日。
+
+        Returns:
+            日次のTOPIX指数データを含むPolars DataFrame。
+
+        Raises:
+            HTTPStatusError: APIリクエストが失敗した場合。
+        """
+        params = get_params(from_=from_, to=to)
+
+        url = "/indices/topix"
+        name = "topix"
+
+        dfs = [df async for df in self.iter_pages(url, params, name)]
+        df = pl.concat(dfs)
+        if df.is_empty():
+            return df
+
+        return topix.clean(df)

{kabukit-0.5.4 → kabukit-0.7.0}/src/kabukit/jquants/concurrent.py

@@ -5,7 +5,7 @@ from typing import TYPE_CHECKING
 from kabukit.utils import concurrent
 
 from .client import JQuantsClient
-from .info import get_codes
+from .info import get_target_codes
 
 if TYPE_CHECKING:
     from collections.abc import Iterable
@@ -80,7 +80,7 @@ async def fetch_all(
             すべての銘柄の財務情報を含む単一のDataFrame。
     """
 
-    codes = await get_codes()
+    codes = await get_target_codes()
     codes = codes[:limit]
 
     return await fetch(

{kabukit-0.5.4 → kabukit-0.7.0}/src/kabukit/jquants/info.py

@@ -11,10 +11,13 @@ def clean(df: DataFrame) -> DataFrame:
     ).drop("^.+Code$", "CompanyNameEnglish")
 
 
-async def get_codes() -> list[str]:
-    """銘柄コードのリストを返す。
+async def get_target_codes() -> list[str]:
+    """分析対象となる銘柄コードのリストを返す。
 
-    市場「TOKYO PRO MARKET」と業種「その他」を除外した銘柄を対象とする。
+    以下の条件を満たす銘柄は対象外とする。
+    - 市場: TOKYO PRO MARKET
+    - 業種: その他 -- (投資信託など)
+    - 優先株式
     """
     from .client import JQuantsClient
 
@@ -25,6 +28,7 @@ async def get_codes() -> list[str]:
         info.filter(
             pl.col("MarketCodeName") != "TOKYO PRO MARKET",
             pl.col("Sector17CodeName") != "その他",
+            ~pl.col("CompanyName").str.contains("優先株式"),
         )
         .get_column("Code")
         .to_list()

kabukit-0.7.0/src/kabukit/jquants/topix.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import polars as pl
+
+if TYPE_CHECKING:
+    from polars import DataFrame
+
+
+def clean(df: DataFrame) -> DataFrame:
+    return df.select(
+        pl.col("Date").str.to_date("%Y-%m-%d"),
+        pl.lit("TOPIX").alias("Code"),
+        pl.exclude("Date"),
+    )

{kabukit-0.5.4 → kabukit-0.7.0}/src/kabukit/utils/concurrent.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import asyncio
-from dataclasses import dataclass
+import contextlib
 from typing import TYPE_CHECKING, Any, Protocol
 
 import polars as pl
@@ -48,10 +48,17 @@ async def collect[R](
         async with semaphore:
             return await awaitable
 
-    futures = (run(awaitable) for awaitable in awaitables)
+    tasks = {asyncio.create_task(run(awaitable)) for awaitable in awaitables}
 
-    async for future in asyncio.as_completed(futures):
-        yield await future
+    try:
+        async for future in asyncio.as_completed(tasks):
+            with contextlib.suppress(asyncio.CancelledError):
+                yield await future
+    finally:
+        for task in tasks:
+            task.cancel()
+        if tasks:
+            await asyncio.gather(*tasks, return_exceptions=True)
 
 
 async def collect_fn[T, R](
@@ -92,19 +99,16 @@ type Callback = Callable[[DataFrame], DataFrame | None]
 type Progress = type[progress_bar[Any] | tqdm[Any]] | _Progress
 
 
-@dataclass
-class Stream:
-    cls: type[Client]
-    resource: str
-    args: list[Any]
-    max_concurrency: int | None = None
-
-    async def __aiter__(self) -> AsyncIterator[DataFrame]:
-        async with self.cls() as client:
-            fn = getattr(client, f"get_{self.resource}")
+async def get_stream(
+    client: Client,
+    resource: str,
+    args: list[Any],
+    max_concurrency: int | None = None,
+) -> AsyncIterator[DataFrame]:
+    fn = getattr(client, f"get_{resource}")
 
-            async for df in collect_fn(fn, self.args, self.max_concurrency):
-                yield df
+    async for df in collect_fn(fn, args, max_concurrency):
+        yield df
 
 
 async def fetch(
@@ -137,13 +141,14 @@ async def fetch(
             すべての情報を含む単一のDataFrame。
     """
     args = list(args)
-    stream = Stream(cls, resource, args, max_concurrency)
+    async with cls() as client:
+        stream = get_stream(client, resource, args, max_concurrency)
 
-    if progress:
-        stream = progress(aiter(stream), total=len(args))
+        if progress:
+            stream = progress(stream, total=len(args))
 
-    if callback:
-        stream = (x if (r := callback(x)) is None else r async for x in stream)
+        if callback:
+            stream = (x if (r := callback(x)) is None else r async for x in stream)
 
-    dfs = [df async for df in stream if not df.is_empty()]
-    return pl.concat(dfs) if dfs else pl.DataFrame()
+        dfs = [df async for df in stream if not df.is_empty()]
+        return pl.concat(dfs) if dfs else pl.DataFrame()

{kabukit-0.5.4 → kabukit-0.7.0}/src/kabukit/utils/config.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 from pathlib import Path
 
 import dotenv
-from platformdirs import user_config_dir
+from platformdirs import user_cache_dir, user_config_dir
 
 
 def get_dotenv_path() -> Path:
@@ -21,3 +21,7 @@ def set_key(key: str, value: str) -> tuple[bool | None, str, str]:
 def load_dotenv() -> bool:
     dotenv_path = get_dotenv_path()
     return dotenv.load_dotenv(dotenv_path)
+
+
+def get_cache_dir() -> Path:
+    return Path(user_cache_dir("kabukit"))