Error

モジュール概要

Framework error definitions.

チュートリアル

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

from nexom.core.error import *

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

運用チェックリスト

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

API リファレンス(全関数・全メソッド)

モジュール関数

_status_for_auth_error

分類: internal function

シグネチャ

_status_for_auth_error(code: str) -> int

使い方と仕様

実装コード由来のAPIです。

引数

  • code / kind=positional-or-keyword / type=str / 必須 / default=なし

戻り値

int

例外・注意点

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

利用例

from nexom.core.error import _status_for_auth_error

result = _status_for_auth_error(code="sample")
print(result)

クラス

NexomError

分類: public class

Base exception class for all Nexom errors. Attributes: code: Stable error code for programmatic handling. message: Human-readable error message.

NexomError の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.core.error import NexomError

obj = NexomError(code="sample", message="sample")
__str__

分類: special method

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

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

引数
  • 引数なし
戻り値

str

例外・注意点

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

利用例
from nexom.core.error import NexomError

obj = NexomError(...)
result = obj.__str__()
print(result)

CommandArgumentsError

分類: public class

Raised when required CLI arguments are missing.

CommandArgumentsError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import CommandArgumentsError

obj = CommandArgumentsError()

PathNotFoundError

分類: public class

Raised when no matching route is found.

PathNotFoundError の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.core.error import PathNotFoundError

obj = PathNotFoundError(path="sample")

PathInvalidHandlerTypeError

分類: public class

Raised when a handler returns an invalid response type.

PathInvalidHandlerTypeError の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.core.error import PathInvalidHandlerTypeError

obj = PathInvalidHandlerTypeError(handler=...)

PathlibTypeError

分類: public class

Raised when a non-Path object is added to Pathlib.

PathlibTypeError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import PathlibTypeError

obj = PathlibTypeError()

PathHandlerMissingArgError

分類: public class

Raised when a handler signature is invalid.

PathHandlerMissingArgError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import PathHandlerMissingArgError

obj = PathHandlerMissingArgError()

CookieInvalidValueError

分類: public class

Raised when a cookie value is invalid.

CookieInvalidValueError の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.core.error import CookieInvalidValueError

obj = CookieInvalidValueError(value="sample")

TemplateNotFoundError

分類: public class

Raised when a template file cannot be found.

TemplateNotFoundError の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.core.error import TemplateNotFoundError

obj = TemplateNotFoundError(name="sample")

TemplateInvalidNameError

分類: public class

Raised when a template file/dir name violates Nexom template naming rules.

TemplateInvalidNameError の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.core.error import TemplateInvalidNameError

obj = TemplateInvalidNameError(key="sample")

TemplatesNotDirError

分類: public class

Raised when the base templates directory is not a directory.

TemplatesNotDirError の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.core.error import TemplatesNotDirError

obj = TemplatesNotDirError(path="sample")

HTMLDocLibNotFoundError

分類: public class

Raised when an HTML document is not found in the library.

HTMLDocLibNotFoundError の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.core.error import HTMLDocLibNotFoundError

obj = HTMLDocLibNotFoundError(name="sample")

ObjectHTMLInsertValueError

分類: public class

Raised when an insert value for ObjectHTML is invalid.

ObjectHTMLInsertValueError の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.core.error import ObjectHTMLInsertValueError

obj = ObjectHTMLInsertValueError(name="sample")

ObjectHTMLExtendsError

分類: public class

Raised when an extends for ObjectHTML is invalid.

ObjectHTMLExtendsError の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.core.error import ObjectHTMLExtendsError

obj = ObjectHTMLExtendsError(name="sample")

ObjectHTMLImportError

分類: public class

Raised when an import for ObjectHTML is invalid.

ObjectHTMLImportError の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.core.error import ObjectHTMLImportError

obj = ObjectHTMLImportError(name="sample")

ObjectHTMLTypeError

分類: public class

Raised when an set HTMLDoc for type is valid.

ObjectHTMLTypeError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import ObjectHTMLTypeError

obj = ObjectHTMLTypeError()

DBError

分類: public class

Base class for database-related errors. This error represents a generic database failure that does not fall into a more specific category such as connection, integrity, operational, or programming errors. It is typically used as a catch-all or wrapper error when the underlying database exception cannot be safely or clearly classified.

このクラスにメソッド定義はありません。

DBMConnectionInvalidError

分類: public class

Raised when the database manager connection is invalid or not initialized. This error indicates that the database manager (DBM) is in an unusable state, such as: - the database connection has not been established yet - the connection was already closed - the DBM was accessed before proper initialization This is typically a lifecycle or configuration error.

DBMConnectionInvalidError の全メソッド

__init__

分類: special method

シグネチャ
__init__(self, message: str = 'Not started') -> None
使い方と仕様

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

引数
  • message / kind=positional-or-keyword / type=str / 任意 / default='Not started'
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import DBMConnectionInvalidError

obj = DBMConnectionInvalidError(message='Not started')

DBOperationalError

分類: public class

Raised when a database operational error occurs. This error represents failures related to the database runtime environment, such as: - inability to open or connect to the database file - database being locked - I/O errors during a query - transaction failures caused by the database state Typically maps to sqlite3.OperationalError.

DBOperationalError の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.core.error import DBOperationalError

obj = DBOperationalError(message="sample")

DBIntegrityError

分類: public class

Raised when a database integrity constraint is violated. This error indicates that a database constraint has been broken, such as: - UNIQUE constraint violations - FOREIGN KEY constraint failures - NOT NULL constraint violations - CHECK constraint failures Typically maps to sqlite3.IntegrityError.

DBIntegrityError の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.core.error import DBIntegrityError

obj = DBIntegrityError(message="sample")

DBProgrammingError

分類: public class

Raised when a database programming or SQL syntax error occurs. This error indicates a bug in application code or query construction, such as: - malformed SQL statements - referencing non-existent tables or columns - incorrect parameter binding - misuse of the database API Typically maps to sqlite3.ProgrammingError.

DBProgrammingError の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.core.error import DBProgrammingError

obj = DBProgrammingError(message="sample")

AuthMissingFieldError

分類: public class

Required auth fields are missing.

AuthMissingFieldError の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.core.error import AuthMissingFieldError

obj = AuthMissingFieldError(key="sample")

AuthUserIdAlreadyExistsError

分類: public class

user_id already exists (signup conflict).

AuthUserIdAlreadyExistsError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import AuthUserIdAlreadyExistsError

obj = AuthUserIdAlreadyExistsError()

AuthInvalidCredentialsError

分類: public class

user_id or password is invalid (login).

AuthInvalidCredentialsError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import AuthInvalidCredentialsError

obj = AuthInvalidCredentialsError()

AuthUserDisabledError

分類: public class

User is inactive/disabled.

AuthUserDisabledError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import AuthUserDisabledError

obj = AuthUserDisabledError()

AuthTokenMissingError

分類: public class

Token is missing.

AuthTokenMissingError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import AuthTokenMissingError

obj = AuthTokenMissingError()

AuthTokenInvalidError

分類: public class

Token is invalid (malformed / not found).

AuthTokenInvalidError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import AuthTokenInvalidError

obj = AuthTokenInvalidError()

AuthTokenExpiredError

分類: public class

Token is expired.

AuthTokenExpiredError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import AuthTokenExpiredError

obj = AuthTokenExpiredError()

AuthTokenRevokedError

分類: public class

Token is revoked (logout etc).

AuthTokenRevokedError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import AuthTokenRevokedError

obj = AuthTokenRevokedError()

AuthServiceUnavailableError

分類: public class

AuthService is unreachable / timed out / invalid response.

AuthServiceUnavailableError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import AuthServiceUnavailableError

obj = AuthServiceUnavailableError()

AuthPermissionGroupAlreadyExistsError

分類: public class

Permission group_id already exists.

AuthPermissionGroupAlreadyExistsError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import AuthPermissionGroupAlreadyExistsError

obj = AuthPermissionGroupAlreadyExistsError()

PsStatusTypesError

分類: public class

This error occurs when the FileStatus value is invalid.

PsStatusTypesError の全メソッド

__init__

分類: special method

シグネチャ
__init__(self, status) -> None
使い方と仕様

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

引数
  • status / kind=positional-or-keyword / type=型指定なし / 必須 / default=なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import PsStatusTypesError

obj = PsStatusTypesError(status=...)

PsFileStatusInvalidError

分類: public class

This contents_id is not available.

PsFileStatusInvalidError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import PsFileStatusInvalidError

obj = PsFileStatusInvalidError()

PsFileStatusInvalidError

分類: public class

This contents_id is not available.

PsFileStatusInvalidError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import PsFileStatusInvalidError

obj = PsFileStatusInvalidError()

PsArgmentsError

分類: public class

Raised when an argument value is invalid

PsArgmentsError の全メソッド

__init__

分類: special method

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

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

引数
  • name / kind=positional-or-keyword / type=str | None / 任意 / default=None
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import PsArgmentsError

obj = PsArgmentsError(name=None)

PsPublicIDInvalidError

分類: public class

Occurs when public_id is invalid

PsPublicIDInvalidError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import PsPublicIDInvalidError

obj = PsPublicIDInvalidError()

PsContentsIDInvalidError

分類: public class

Occurs when contents_id is invalid

PsContentsIDInvalidError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import PsContentsIDInvalidError

obj = PsContentsIDInvalidError()

PsDataCorruotedError

分類: public class

This occurs when data is corrupted.

PsDataCorruotedError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import PsDataCorruotedError

obj = PsDataCorruotedError()

PsChunkEntityTooLargeError

分類: public class

This occurs when data is corrupted.

PsChunkEntityTooLargeError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import PsChunkEntityTooLargeError

obj = PsChunkEntityTooLargeError()

PsPermissionError

分類: public class

This occurs when data is corrupted.

PsPermissionError の全メソッド

__init__

分類: special method

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

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

引数
  • 引数なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import PsPermissionError

obj = PsPermissionError()

PsFileTypesError

分類: public class

This error occurs when the FileType is invalid.

PsFileTypesError の全メソッド

__init__

分類: special method

シグネチャ
__init__(self, status) -> None
使い方と仕様

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

引数
  • status / kind=positional-or-keyword / type=型指定なし / 必須 / default=なし
戻り値

None

例外・注意点

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

利用例
from nexom.core.error import PsFileTypesError

obj = PsFileTypesError(status=...)

ソース情報

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