Documents

Contents

AuthTemplate

モジュール概要

Auth HTML pages and handlers.

チュートリアル

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

from nexom.templates.auth import *

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

運用チェックリスト

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

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

クラス

AuthPages

分類: public class

クラスドキュメントは未定義です。

AuthPages の全メソッド

__init__

分類: special method

シグネチャ
__init__(self, path: str, auth_server: str, *, login_path: str = 'login/', signup_path: str = 'signup/', logout_path: str = 'logout/')
使い方と仕様

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

引数
  • path / kind=positional-or-keyword / type=str / 必須 / default=なし
  • auth_server / kind=positional-or-keyword / type=str / 必須 / default=なし
  • login_path / kind=keyword-only / type=str / 任意 / default='login/'
  • signup_path / kind=keyword-only / type=str / 任意 / default='signup/'
  • logout_path / kind=keyword-only / type=str / 任意 / default='logout/'
戻り値

型指定なし

例外・注意点

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

利用例
from nexom.templates.auth import AuthPages

obj = AuthPages(path="sample", auth_server="sample", login_path='login/', signup_path='signup/', logout_path='logout/')
_handler

分類: internal method

シグネチャ
_handler(self, req: Request, args: dict) -> JsonResponse
使い方と仕様

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

引数
  • req / kind=positional-or-keyword / type=Request / 必須 / default=なし
  • args / kind=positional-or-keyword / type=dict / 必須 / default=なし
戻り値

JsonResponse

例外・注意点

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

利用例
from nexom.templates.auth import AuthPages

obj = AuthPages(...)
result = obj._handler(req=..., args={})
print(result)

LoginPage

分類: public class

クラスドキュメントは未定義です。

LoginPage の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.templates.auth import LoginPage

obj = LoginPage(path="sample", auth_server="sample")
_handler

分類: internal method

シグネチャ
_handler(self, req: Request, args: dict) -> JsonResponse
使い方と仕様

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

引数
  • req / kind=positional-or-keyword / type=Request / 必須 / default=なし
  • args / kind=positional-or-keyword / type=dict / 必須 / default=なし
戻り値

JsonResponse

例外・注意点

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

利用例
from nexom.templates.auth import LoginPage

obj = LoginPage(...)
result = obj._handler(req=..., args={})
print(result)

SignupPage

分類: public class

クラスドキュメントは未定義です。

SignupPage の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.templates.auth import SignupPage

obj = SignupPage(path="sample", auth_server="sample")
_handler

分類: internal method

シグネチャ
_handler(self, req: Request, args: dict) -> JsonResponse
使い方と仕様

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

引数
  • req / kind=positional-or-keyword / type=Request / 必須 / default=なし
  • args / kind=positional-or-keyword / type=dict / 必須 / default=なし
戻り値

JsonResponse

例外・注意点

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

利用例
from nexom.templates.auth import SignupPage

obj = SignupPage(...)
result = obj._handler(req=..., args={})
print(result)

LogoutPage

分類: public class

クラスドキュメントは未定義です。

LogoutPage の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.templates.auth import LogoutPage

obj = LogoutPage(path="sample", auth_server="sample")
_handler

分類: internal method

シグネチャ
_handler(self, req: Request, args: dict) -> Redirect | ErrorResponse
使い方と仕様

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

引数
  • req / kind=positional-or-keyword / type=Request / 必須 / default=なし
  • args / kind=positional-or-keyword / type=dict / 必須 / default=なし
戻り値

Redirect | ErrorResponse

例外・注意点

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

利用例
from nexom.templates.auth import LogoutPage

obj = LogoutPage(...)
result = obj._handler(req=..., args={})
print(result)

ソース情報

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

©2026 Nexom MIT-License