Documents

Contents

ObjectHTML

モジュール概要

Object HTML template renderer.

チュートリアル

最初に以下の最小例でモジュール利用方法を確認し、その後 API リファレンスを参照してください。

from nexom.core.object_html_render import *

# このモジュールの関数・クラスを用途に合わせて呼び出します。
# 下の API リファレンスで各関数の引数と使い方を確認してください。

運用チェックリスト

  • 本番では例外処理を必ず実装し、戻り値の型を固定してください。
  • 引数のデフォルト値と必須/任意を仕様書としてチーム内で固定してください。
  • ログと監視を追加し、エラー時の復旧手順を運用Runbookに記載してください。

API リファレンス（全関数・全メソッド）

クラス

HTMLDoc

分類: public class

Raw HTML document container (no rendering).

HTMLDoc の全メソッド

__init__

分類: special method

シグネチャ
__init__(self, name: str, html: str) -> None
使い方と仕様

メソッドドキュメントは未定義です。

引数
  • name / kind=positional-or-keyword / type=str / 必須 / default=なし
  • html / kind=positional-or-keyword / type=str / 必須 / default=なし
戻り値

None

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.core.object_html_render import HTMLDoc

obj = HTMLDoc(name="sample", html="sample")
__repr__

分類: special method

シグネチャ
__repr__(self) -> str
使い方と仕様

メソッドドキュメントは未定義です。

引数
  • 引数なし
戻り値

str

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.core.object_html_render import HTMLDoc

obj = HTMLDoc(...)
result = obj.__repr__()
print(result)

HTMLDocLib

分類: public class

A list of HTML documents with name lookup.

HTMLDocLib の全メソッド

__init__

分類: special method

シグネチャ
__init__(self, docs: list[HTMLDoc] | None = None) -> None
使い方と仕様

メソッドドキュメントは未定義です。

引数
  • docs / kind=positional-or-keyword / type=list[HTMLDoc] | None / 任意 / default=None
戻り値

None

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.core.object_html_render import HTMLDocLib

obj = HTMLDocLib(docs=None)
get

分類: public method

シグネチャ
get(self, name: str, raise_error: bool = False) -> HTMLDoc | None
使い方と仕様

メソッドドキュメントは未定義です。

引数
  • name / kind=positional-or-keyword / type=str / 必須 / default=なし
  • raise_error / kind=positional-or-keyword / type=bool / 任意 / default=False
戻り値

HTMLDoc | None

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.core.object_html_render import HTMLDocLib

obj = HTMLDocLib(...)
result = obj.get(name="sample", raise_error=False)
print(result)

ObjectHTML

分類: public class

Object HTML renderer. Provides dynamic callable access: engine.default(title="x") engine.layout.base(title="x") Internals: - Extends/Insert are applied first (non-strict slots for inserts) - Imports are expanded with indentation preserved - Final {{slot}} replacement is applied (strict)

ObjectHTML の全メソッド

__init__

分類: special method

シグネチャ
__init__(self, *docs: HTMLDoc, lib: HTMLDocLib | None = None) -> None
使い方と仕様

メソッドドキュメントは未定義です。

引数
  • docs / kind=variadic-positional(*args) / type=HTMLDoc / 必須 / default=なし
  • lib / kind=keyword-only / type=HTMLDocLib | None / 任意 / default=None
戻り値

None

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.core.object_html_render import ObjectHTML

obj = ObjectHTML(lib=None)
_set_doc

分類: internal method

シグネチャ
_set_doc(self, doc: HTMLDoc) -> None
使い方と仕様

メソッドドキュメントは未定義です。

引数
  • doc / kind=positional-or-keyword / type=HTMLDoc / 必須 / default=なし
戻り値

None

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.core.object_html_render import ObjectHTML

obj = ObjectHTML(...)
result = obj._set_doc(doc=...)
print(result)
render

分類: public method

シグネチャ
render(self, name: str, **kwargs: str) -> str
使い方と仕様

Render a template by name.

引数
  • name / kind=positional-or-keyword / type=str / 必須 / default=なし
  • kwargs / kind=variadic-keyword(**kwargs) / type=str / 必須 / default=なし
戻り値

str

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.core.object_html_render import ObjectHTML

obj = ObjectHTML(...)
result = obj.render(name="sample")
print(result)
_render_structure

分類: internal method

シグネチャ
_render_structure(self, name: str) -> str
使い方と仕様

Resolve Extends/Insert and Import. Leaves {{slots}} unresolved.

引数
  • name / kind=positional-or-keyword / type=str / 必須 / default=なし
戻り値

str

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.core.object_html_render import ObjectHTML

obj = ObjectHTML(...)
result = obj._render_structure(name="sample")
print(result)
_apply_extends

分類: internal method

シグネチャ
_apply_extends(self, html: str) -> str
使い方と仕様

メソッドドキュメントは未定義です。

引数
  • html / kind=positional-or-keyword / type=str / 必須 / default=なし
戻り値

str

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.core.object_html_render import ObjectHTML

obj = ObjectHTML(...)
result = obj._apply_extends(html="sample")
print(result)
_apply_imports

分類: internal method

シグネチャ
_apply_imports(self, html: str) -> str
使い方と仕様

メソッドドキュメントは未定義です。

引数
  • html / kind=positional-or-keyword / type=str / 必須 / default=なし
戻り値

str

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.core.object_html_render import ObjectHTML

obj = ObjectHTML(...)
result = obj._apply_imports(html="sample")
print(result)
_line_indent_before

分類: internal method

シグネチャ
_line_indent_before(self, html: str, pos: int) -> str
使い方と仕様

Return whitespace indent from the start of the line up to pos. If the substring from line start to pos contains only whitespace, that whitespace is returned. Otherwise returns empty string.

引数
  • html / kind=positional-or-keyword / type=str / 必須 / default=なし
  • pos / kind=positional-or-keyword / type=int / 必須 / default=なし
戻り値

str

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.core.object_html_render import ObjectHTML

obj = ObjectHTML(...)
result = obj._line_indent_before(html="sample", pos=1)
print(result)
_indent_multiline_slot_value

分類: internal method

シグネチャ
_indent_multiline_slot_value(self, value: str, indent: str) -> str
使い方と仕様

Indent multi-line slot values for {{slot}} replacement. IMPORTANT: The indent before {{slot}} already remains in the output, so we indent ONLY lines after the first line.

引数
  • value / kind=positional-or-keyword / type=str / 必須 / default=なし
  • indent / kind=positional-or-keyword / type=str / 必須 / default=なし
戻り値

str

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.core.object_html_render import ObjectHTML

obj = ObjectHTML(...)
result = obj._indent_multiline_slot_value(value="sample", indent="sample")
print(result)
_apply_slots_non_strict

分類: internal method

シグネチャ
_apply_slots_non_strict(self, html: str, values: dict[str, str]) -> str
使い方と仕様

メソッドドキュメントは未定義です。

引数
  • html / kind=positional-or-keyword / type=str / 必須 / default=なし
  • values / kind=positional-or-keyword / type=dict[str, str] / 必須 / default=なし
戻り値

str

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.core.object_html_render import ObjectHTML

obj = ObjectHTML(...)
result = obj._apply_slots_non_strict(html="sample", values="sample")
print(result)
_apply_slots_strict

分類: internal method

シグネチャ
_apply_slots_strict(self, html: str, values: dict[str, str]) -> str
使い方と仕様

メソッドドキュメントは未定義です。

引数
  • html / kind=positional-or-keyword / type=str / 必須 / default=なし
  • values / kind=positional-or-keyword / type=dict[str, str] / 必須 / default=なし
戻り値

str

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.core.object_html_render import ObjectHTML

obj = ObjectHTML(...)
result = obj._apply_slots_strict(html="sample", values="sample")
print(result)

ソース情報

  • module: nexom.core.object_html_render
  • source file: services/venv/lib/python3.10/site-packages/nexom/core/object_html_render.py
  • generated date: 2026-03-14

©2026 Nexom MIT-License