stbkit 0.1.0a9.dev1__py3-none-any.whl

stbkit/__main__.py

@@ -0,0 +1,10 @@
+# Copyright 2025-2026 TAISEI CORPORATION
+# SPDX-License-Identifier: MPL-2.0
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+from .cli import main
+
+if __name__ == "__main__":
+    main()

stbkit/api/__init__.py

@@ -0,0 +1,48 @@
+# Copyright 2026 TAISEI CORPORATION
+# SPDX-License-Identifier: MPL-2.0
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+"""stbkitの基本機能をまとめたAPI
+
+ST-Bridgeファイルの読み書き、バージョンアップ、他形式への変換を提供します。
+バージョンごとのデータモデルはstb_latest、stb_v2_0、stb_v2_1から利用してください。
+
+読み込みは、ファイルのバージョンをそのまま扱うload・loadsと、
+読み込んでから最新版へ変換するload_latest・loads_latestがあります。
+
+IFCへの変換を利用する場合はifcopenshellのインストールが必要です。
+"""
+
+from stbkit.core.data_model.common import StBridgeElement as StBridgeElement
+from stbkit.core.data_model.common import StBridgeRoot as StBridgeRoot
+from stbkit.core.stb_exceptions import NoneAccessError as NoneAccessError
+from stbkit.core.stb_io import dump as dump
+from stbkit.core.stb_io import dumps as dumps
+from stbkit.core.stb_io import load as load
+from stbkit.core.stb_io import loads as loads
+from stbkit.core.validation import validate_schema as validate_schema
+
+from stbkit.tools._internal.stb_io import load_latest as load_latest
+from stbkit.tools._internal.stb_io import loads_latest as loads_latest
+from stbkit.tools.converters import to_ifc as to_ifc
+from stbkit.tools.upgrade import upgrade_to_latest as upgrade_to_latest
+
+__all__ = [
+    "NoneAccessError",
+    "StBridgeElement",
+    "StBridgeRoot",
+    "dump",
+    "dumps",
+    "load",
+    "load_latest",
+    "loads",
+    "loads_latest",
+    "stb_latest",
+    "stb_v2_0",
+    "stb_v2_1",
+    "to_ifc",
+    "upgrade_to_latest",
+    "validate_schema",
+]

stbkit/api/experimental/__init__.py

@@ -0,0 +1,19 @@
+# Copyright 2026 TAISEI CORPORATION
+# SPDX-License-Identifier: MPL-2.0
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+"""将来の公開を意図した、暫定公開API
+
+※このモジュール内のAPIは暫定的なものであり、今後変更される可能性があります。
+  仕様が固まったものはstbkit.apiへ移し、このモジュールからは段階的に外します。
+  継続的に利用するコードから使う場合は、この点を了解したうえで、バージョンを固定して使用してください。
+  互換性に関する方針は、GitHubリポジトリのCOMPATIBILITY.mdを参照してください。
+"""
+
+from stbkit.core.repository import get_repository as get_repository
+from stbkit.core.serialization import from_dict as from_dict
+from stbkit.core.serialization import to_dict as to_dict
+
+__all__ = ["from_dict", "get_repository", "to_dict"]

stbkit/api/experimental/repository/__init__.py

@@ -0,0 +1,30 @@
+# Copyright 2026 TAISEI CORPORATION
+# SPDX-License-Identifier: MPL-2.0
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+"""バージョンごとのリポジトリ
+
+リポジトリは、読み込んだST-Bridgeの参照解決や検索を行うクラスです。
+型注釈を利用したい場合に利用します。
+インスタンスはstbkit.api.experimental.get_repositoryを使って取得できます。
+モデルのバージョンに対応する型を選ぶため、バージョンごとの分岐が不要になります。
+
+※このモジュール内のAPIは暫定的なものであり、今後変更される可能性があります。
+  仕様が固まったものはstbkit.apiへ移し、このモジュールからは段階的に外します。
+  継続的に利用するコードから使う場合は、この点を了解したうえで、バージョンを固定して使用してください。
+  互換性に関する方針は、GitHubリポジトリのCOMPATIBILITY.mdを参照してください。
+"""
+
+from stbkit.core.repository import RepositoryV2_0_2 as RepositoryV2_0_2
+from stbkit.core.repository import RepositoryV2_1_0 as RepositoryV2_1_0
+from stbkit.core.repository import RepositoryV2_1_1 as RepositoryLatest
+from stbkit.core.repository import RepositoryV2_1_1 as RepositoryV2_1_1
+
+__all__ = [
+    "RepositoryLatest",
+    "RepositoryV2_0_2",
+    "RepositoryV2_1_0",
+    "RepositoryV2_1_1",
+]

stbkit/api/stb_latest.py

@@ -0,0 +1,7 @@
+# Copyright 2026 TAISEI CORPORATION
+# SPDX-License-Identifier: MPL-2.0
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+from stbkit.core.data_model.stb_v2_1_1 import *

stbkit/api/stb_v2_0_2.py

@@ -0,0 +1,11 @@
+# Copyright 2026 TAISEI CORPORATION
+# SPDX-License-Identifier: MPL-2.0
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+"""ST-Bridge v2.0.2のデータモデル
+
+WARNING: ST-Bridge 2.0.xは、2027年末でサポート終了となります。v2.1.xへの移行を推奨します。"""
+
+from stbkit.core.data_model.stb_v2_0_2 import *

stbkit/api/stb_v2_1_1.py

@@ -0,0 +1,9 @@
+# Copyright 2026 TAISEI CORPORATION
+# SPDX-License-Identifier: MPL-2.0
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+"""ST-Bridge v2.1.1のデータモデル"""
+
+from stbkit.core.data_model.stb_v2_1_1 import *

stbkit/cli/__init__.py

@@ -0,0 +1,17 @@
+# Copyright 2025-2026 TAISEI CORPORATION
+# SPDX-License-Identifier: MPL-2.0
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+"""cliのエントリポイント
+
+※このモジュール内のAPIは暫定的なものであり、今後変更される可能性があります。
+  継続的に利用するコードから使う場合は、この点を了解したうえで、バージョンを固定して使用してください。
+  互換性に関する方針は、GitHubリポジトリのCOMPATIBILITY.mdを参照してください。
+"""
+
+from ._internal.cli_main import main as main
+
+if __name__ == "__main__":
+    main()

stbkit/cli/_internal/cli_main.py

@@ -0,0 +1,114 @@
+# Copyright 2025-2026 TAISEI CORPORATION
+# SPDX-License-Identifier: MPL-2.0
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+from __future__ import annotations
+
+import sys
+import traceback
+from argparse import ArgumentParser, Namespace, _SubParsersAction
+from importlib import metadata
+from typing import Any, Never
+
+from .constants_exit_code import (
+    EXIT_EXECUTION_ERROR,
+    EXIT_INTERRUPTED,
+    EXIT_INVALID_ARGUMENT,
+)
+from .entry_points import load_command_entry_points
+from .global_parent import make_global_parent
+
+
+class SubcommandHelpArgumentParser(ArgumentParser):
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        self.subparsers_action: _SubParsersAction[ArgumentParser] | None = None
+
+    def add_subparsers(self, *args: Any, **kwargs: Any) -> _SubParsersAction[Any]:
+        self.subparsers_action = super().add_subparsers(*args, **kwargs)
+        return self.subparsers_action
+
+    def error(self, message: str) -> Never:
+        self._print_message(f"error: {message}\n", sys.stderr)
+        if self.subparsers_action:
+            for subcmd in self.subparsers_action.choices:
+                if subcmd in sys.argv:
+                    self.subparsers_action.choices[subcmd].print_help()
+                    self.exit(EXIT_INVALID_ARGUMENT)
+        self.print_help()
+        self.exit(EXIT_INVALID_ARGUMENT)
+
+
+def main() -> None:
+    """stbkitのcliを実行する"""
+    try:
+        _main()
+    # 想定外例外がそのまま投げられると、終了コードが1になるが、
+    # 1はバリデーションや比較の結果に利用したいため終了コードを変更する。
+    except KeyboardInterrupt:
+        # Ctrl+Cによる中断。
+        raise SystemExit(EXIT_INTERRUPTED) from None
+    except Exception:  # noqa: BLE001
+        # 終了コードを変更するための最後の受け皿なので種類を問わずキャッチする。
+        traceback.print_exc()
+        raise SystemExit(EXIT_EXECUTION_ERROR) from None
+
+
+def _main() -> None:
+    parser: ArgumentParser = SubcommandHelpArgumentParser(
+        prog="stbkit", parents=[make_global_parent()]
+    )
+    subparsers: _SubParsersAction[Any] = parser.add_subparsers(dest="command")
+    entry_points: metadata.EntryPoints = load_command_entry_points()
+
+    for entry_point in entry_points:
+        register: Any = entry_point.load()
+        try:
+            register(subparsers)
+        except Exception as e:  # noqa: BLE001
+            print(
+                f"不明なサブコマンドを登録しようとして失敗しました[{entry_point.name}]: {e}",
+                file=sys.stderr,
+            )
+
+    if ("--interactive" in sys.argv) and (
+        len([a for a in sys.argv[1:] if not a.startswith("-")]) == 0
+    ):
+        subcommands = list(subparsers.choices.keys())
+        print("利用可能なサブコマンド:")
+        for idx, cmd in enumerate(subcommands, 1):
+            print(f"  {idx}: {cmd}")
+        while True:
+            print("実行するサブコマンドの番号またはコマンド名を入力してください: ")
+            choice = input().strip()
+            if choice.isdigit():
+                idx = int(choice)
+                if 1 <= idx <= len(subcommands):
+                    selected = subcommands[idx - 1]
+                    break
+                else:
+                    print("無効な番号です。")
+            elif choice in subcommands:
+                selected = choice
+                break
+            else:
+                print("無効な入力です。番号またはコマンド名を入力してください。")
+        insert_pos = 1
+        sys.argv.insert(insert_pos, selected)
+        args: Namespace = parser.parse_args()
+        # エラーメッセージを拾いやすいように改行を挟む
+        print()
+    else:
+        args = parser.parse_args()
+
+    if getattr(args, "version", False):
+        from .show_versions import show_versions
+
+        show_versions(entry_points)
+        return
+    if getattr(args, "command", None):
+        args.func(args)
+        return
+    parser.print_help()

stbkit/cli/_internal/common.py

@@ -0,0 +1,126 @@
+# Copyright 2026 TAISEI CORPORATION
+# SPDX-License-Identifier: MPL-2.0
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+import sys
+from argparse import ArgumentParser, Namespace
+from collections.abc import Sequence
+from pathlib import Path
+from typing import IO
+
+from stbkit.core.stb_exceptions import XmlLimitExceededError, XmlLimitKind
+from stbkit.core.stb_io._internal.loader import _detect_encoding
+
+from stbkit.tools._internal.utils.atomic_writer import (
+    write_text_with_temp_file as _write_text_via_temporary_file,
+)
+
+from .global_parent import get_interactive
+
+
+def use_input(parser: ArgumentParser) -> None:
+    parser.add_argument(
+        "input", nargs="?", help="入力ファイルのパス。-で標準入力を使用します。"
+    )
+
+
+def read_stdin_xml(*, max_size: int, encoding: str | None = None) -> str:
+    # 端末のエンコーディング設定だとST-Bridgeに記載のencodingを読めないため、bytesとして受け取り、XML宣言から判定する。
+    # encodingを明示した場合は判定より優先する。
+    buffer: IO[bytes] | None = getattr(sys.stdin, "buffer", None)
+    if buffer is None:
+        text: str = sys.stdin.read(max_size + 1)
+        if len(text) > max_size:
+            raise XmlLimitExceededError(kind=XmlLimitKind.SIZE, limit=max_size)
+        return text
+
+    raw: bytes = buffer.read(max_size + 1)
+    if len(raw) > max_size:
+        raise XmlLimitExceededError(kind=XmlLimitKind.SIZE, limit=max_size)
+    return raw.decode(encoding or _detect_encoding(raw))
+
+
+def get_input(args: Namespace) -> str:
+    interactive: bool = get_interactive(args)
+    input_path: str = args.input
+    if not input_path and interactive:
+        print("入力ファイルパスを入力してください: ")
+        input_path = input().strip()
+    if not input_path:
+        input_path = "-"
+    return input_path
+
+
+def use_output(parser: ArgumentParser) -> None:
+    parser.add_argument(
+        "-o",
+        "--output",
+        default="-",
+        help="出力ファイルのパス。-で標準出力を使用します。",
+    )
+
+
+def get_output(args: Namespace) -> str:
+    interactive: bool = get_interactive(args)
+    output_path: str = args.output
+    if not output_path and interactive:
+        print("出力ファイルパスを入力してください: ")
+        output_path = input().strip()
+    if not output_path:
+        output_path = "-"
+    return output_path
+
+
+def use_yes(parser: ArgumentParser) -> None:
+    parser.add_argument(
+        "-y", "--yes", action="store_true", help="確認なしで上書きします。"
+    )
+
+
+def get_yes(args: Namespace) -> bool:
+    yes: bool = args.yes
+    return yes
+
+
+def use_quiet(parser: ArgumentParser) -> None:
+    parser.add_argument("--quiet", action="store_true", help="エラーのみを表示します。")
+
+
+def get_quiet(args: Namespace) -> bool:
+    quiet: bool = args.quiet
+    return quiet
+
+
+def ensure_output_not_input(output: str, input_paths: Sequence[Path]) -> None:
+    if output == "-":
+        return
+
+    output_path = Path(output).resolve()
+    for input_path in input_paths:
+        resolved_input = input_path.resolve()
+        is_same_resolved_path = output_path == resolved_input
+        is_same_file = output_path.exists() and output_path.samefile(resolved_input)
+        if is_same_resolved_path or is_same_file:
+            raise ValueError("出力先に入力ファイルは指定できません。")
+
+
+def confirm_overwrite(*, output: str, yes: bool, interactive: bool) -> bool:
+    if output == "-":
+        return True
+
+    output_path = Path(output)
+    if not output_path.exists() or yes:
+        return True
+    if not interactive:
+        return False
+
+    response = input(f"{output_path}は既に存在します。上書きしますか？(y/N):")
+    return response.strip().casefold() in {"y", "yes"}
+
+
+def write_text_via_temporary_file(
+    *, output: str, text: str, encoding: str = "utf-8"
+) -> None:
+    _write_text_via_temporary_file(Path(output), text, encoding=encoding)

stbkit/cli/_internal/constants_exit_code.py

@@ -0,0 +1,59 @@
+# Copyright 2026 TAISEI CORPORATION
+# SPDX-License-Identifier: MPL-2.0
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+"""CLIの終了コード
+
+同系統の結果は、サブコマンドが違っても同じ値を返すようにする。
+0と1は「処理を正常に実行できた」場合、2以降は「処理が実行できなかった」場合。
+"""
+
+from typing import Final
+
+EXIT_OK: Final[int] = 0
+"""処理が正常に終了した。バリデーション比較、diff差分なし等"""
+
+EXIT_ISSUE_FOUND: Final[int] = 1
+"""処理は正常に実行できたが、対象に問題または差分あり。
+
+バリデーションNG、diffで差分有り、変換の実行はできたがエラーが出た場合が該当。
+
+1は正常に実行した結果でエラーではないが、検査や比較を行うツールの慣習に合わせている。
+grepの一致なし、diffの差分あり、`git diff --exit-code`の差分有り等は`1を返す。
+
+想定外例外がそのまま投げられると、終了コードが1になってしまうが、
+1はバリデーションや比較の結果に利用したいため、混ざらないように終了コードを変更する処理を行う。
+"""
+
+EXIT_INVALID_ARGUMENT: Final[int] = 2
+"""引数や指定の間違いで、処理が開始できなかった。
+
+未知のオプション、非対応の変換の指定、存在しないパスの指定等。
+
+argparseが引数エラーに2を使うため、それに合わせている。
+stbkitで把握しきれなかった引数エラーが素通りしても同じ値になる。
+grepやdiffも異常に2を使い、シェルの慣習でもビルトインの誤用が2。
+"""
+
+EXIT_EXECUTION_ERROR: Final[int] = 3
+"""処理の実行中に失敗した。
+
+入出力の失敗など、引数の誤りでも実行結果の問題でもない場合。
+想定外の例外もこれで終了する。
+"""
+
+EXIT_OPTIONAL_DEPENDENCY_MISSING: Final[int] = 4
+"""オプション依存パッケージがなく、処理を実行できなかった。
+
+ifcopenshellやxmlschemaを必要とする処理を指定したのにインストールされていない場合。
+利用者の環境によって結果が変わるため、EXIT_EXECUTION_ERRORとは分ける。
+"""
+
+EXIT_INTERRUPTED: Final[int] = 130
+"""中断(Ctrl+C)で終了した。
+
+シグナルnによる終了を128+nで表す慣習に合わせている(128+2=130)。
+Pythonの既定ではKeyboardInterruptが1になるため、キャッチして変更する。
+"""