Documents

Contents

Log

モジュール概要

Logging utilities.

チュートリアル

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

from nexom.core.log import *

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

運用チェックリスト

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

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

クラス

AppLogger

分類: public class

Application-level logger. Used for: - info - warn - error - access

AppLogger の全メソッド

__init__

分類: special method

シグネチャ
__init__(self, *, info: str | Path | None = None, warn: str | Path | None = None, error: str | Path | None = None, access: str | Path | None = None) -> None
使い方と仕様

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

引数
  • info / kind=keyword-only / type=str | Path | None / 任意 / default=None
  • warn / kind=keyword-only / type=str | Path | None / 任意 / default=None
  • error / kind=keyword-only / type=str | Path | None / 任意 / default=None
  • access / kind=keyword-only / type=str | Path | None / 任意 / default=None
戻り値

None

例外・注意点

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

利用例
from nexom.core.log import AppLogger

obj = AppLogger(info=None, warn=None, error=None, access=None)
info

分類: public method

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

Write an INFO log line.

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

None

例外・注意点

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

利用例
from nexom.core.log import AppLogger

obj = AppLogger(...)
result = obj.info(msg="sample")
print(result)
warn

分類: public method

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

Write a WARN log line.

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

None

例外・注意点

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

利用例
from nexom.core.log import AppLogger

obj = AppLogger(...)
result = obj.warn(msg="sample")
print(result)
error

分類: public method

シグネチャ
error(self, err: Exception | str) -> None
使い方と仕様

Write an ERROR log line (with traceback if Exception).

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

None

例外・注意点

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

利用例
from nexom.core.log import AppLogger

obj = AppLogger(...)
result = obj.error(err="sample")
print(result)
access

分類: public method

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

Write an ACCESS log line.

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

None

例外・注意点

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

利用例
from nexom.core.log import AppLogger

obj = AppLogger(...)
result = obj.access(msg="sample")
print(result)
_norm

分類: internal method

シグネチャ
_norm(self, path: str | Path | None) -> Path | None
使い方と仕様

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

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

Path | None

例外・注意点

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

利用例
from nexom.core.log import AppLogger

obj = AppLogger(...)
result = obj._norm(path="sample")
print(result)
_write

分類: internal method

シグネチャ
_write(self, path: Path | None, level: str, msg: str) -> None
使い方と仕様

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

引数
  • path / kind=positional-or-keyword / type=Path | None / 必須 / default=なし
  • level / kind=positional-or-keyword / type=str / 必須 / default=なし
  • msg / kind=positional-or-keyword / type=str / 必須 / default=なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.log import AppLogger

obj = AppLogger(...)
result = obj._write(path="/path/to/value", level="sample", msg="sample")
print(result)

AuthLogger

分類: public class

Authentication / Security logger. Used for: - login success / failure - signup - token verification failure

AuthLogger の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.core.log import AuthLogger

obj = AuthLogger(path="sample")
login_success

分類: public method

シグネチャ
login_success(self, *, user_id: str, ip: str | None = None) -> None
使い方と仕様

Log a successful login.

引数
  • user_id / kind=keyword-only / type=str / 必須 / default=なし
  • ip / kind=keyword-only / type=str | None / 任意 / default=None
戻り値

None

例外・注意点

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

利用例
from nexom.core.log import AuthLogger

obj = AuthLogger(...)
result = obj.login_success(user_id="sample", ip=None)
print(result)
login_failed

分類: public method

シグネチャ
login_failed(self, *, user_id: str, ip: str | None = None) -> None
使い方と仕様

Log a failed login.

引数
  • user_id / kind=keyword-only / type=str / 必須 / default=なし
  • ip / kind=keyword-only / type=str | None / 任意 / default=None
戻り値

None

例外・注意点

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

利用例
from nexom.core.log import AuthLogger

obj = AuthLogger(...)
result = obj.login_failed(user_id="sample", ip=None)
print(result)
signup

分類: public method

シグネチャ
signup(self, *, user_id: str, ip: str | None = None) -> None
使い方と仕様

Log a signup event.

引数
  • user_id / kind=keyword-only / type=str / 必須 / default=なし
  • ip / kind=keyword-only / type=str | None / 任意 / default=None
戻り値

None

例外・注意点

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

利用例
from nexom.core.log import AuthLogger

obj = AuthLogger(...)
result = obj.signup(user_id="sample", ip=None)
print(result)
token_invalid

分類: public method

シグネチャ
token_invalid(self, *, token: str | None, ip: str | None = None) -> None
使い方と仕様

Log an invalid token attempt.

引数
  • token / kind=keyword-only / type=str | None / 必須 / default=なし
  • ip / kind=keyword-only / type=str | None / 任意 / default=None
戻り値

None

例外・注意点

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

利用例
from nexom.core.log import AuthLogger

obj = AuthLogger(...)
result = obj.token_invalid(token="sample", ip=None)
print(result)
_write

分類: internal method

シグネチャ
_write(self, action: str, subject: str, ip: str | None) -> None
使い方と仕様

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

引数
  • action / kind=positional-or-keyword / type=str / 必須 / default=なし
  • subject / kind=positional-or-keyword / type=str / 必須 / default=なし
  • ip / kind=positional-or-keyword / type=str | None / 必須 / default=なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.log import AuthLogger

obj = AuthLogger(...)
result = obj._write(action="sample", subject="sample", ip="sample")
print(result)

ソース情報

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

©2026 Nexom MIT-License