Documents

Contents

Response

モジュール概要

HTTP response classes.

チュートリアル

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

from nexom.app.response import HtmlResponse, JsonResponse, Redirect

ok_html = HtmlResponse('<h1>ok</h1>')
ok_json = JsonResponse({'ok': True})
move = Redirect('/documents')

運用チェックリスト

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

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

クラス

Response

分類: public class

Represents an HTTP response.

Response の全メソッド

__init__

分類: special method

シグネチャ
__init__(self, body: str | bytes = b'', status: int = 200, headers: Iterable[Header] | None = None, cookie: str | None = None, content_type: str = 'text/plain', charset: str = 'utf-8', include_charset: bool = False) -> None
使い方と仕様

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

引数
  • body / kind=positional-or-keyword / type=str | bytes / 任意 / default=b''
  • status / kind=positional-or-keyword / type=int / 任意 / default=200
  • headers / kind=positional-or-keyword / type=Iterable[Header] | None / 任意 / default=None
  • cookie / kind=positional-or-keyword / type=str | None / 任意 / default=None
  • content_type / kind=positional-or-keyword / type=str / 任意 / default='text/plain'
  • charset / kind=positional-or-keyword / type=str / 任意 / default='utf-8'
  • include_charset / kind=positional-or-keyword / type=bool / 任意 / default=False
戻り値

None

例外・注意点

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

利用例
from nexom.app.response import Response

obj = Response(body=b'', status=200, headers=None, cookie=None, content_type='text/plain', charset='utf-8', include_charset=False)
__iter__

分類: special method

シグネチャ
__iter__(self)
使い方と仕様

Allow Response to be returned directly from WSGI apps.

引数
  • 引数なし
戻り値

型指定なし

例外・注意点

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

利用例
from nexom.app.response import Response

obj = Response(...)
result = obj.__iter__()
print(result)
append_header

分類: public method

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

Append a response header (no dedupe).

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

None

例外・注意点

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

利用例
from nexom.app.response import Response

obj = Response(...)
result = obj.append_header(key="sample", value="sample")
print(result)

HtmlResponse

分類: public class

HTML response with text/html content type.

HtmlResponse の全メソッド

__init__

分類: special method

シグネチャ
__init__(self, body: str | bytes = b'', status: int = 200, headers: Iterable[Header] | None = None, cookie: str | None = None, *, charset: str = 'utf-8', include_charset: bool = True) -> None
使い方と仕様

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

引数
  • body / kind=positional-or-keyword / type=str | bytes / 任意 / default=b''
  • status / kind=positional-or-keyword / type=int / 任意 / default=200
  • headers / kind=positional-or-keyword / type=Iterable[Header] | None / 任意 / default=None
  • cookie / kind=positional-or-keyword / type=str | None / 任意 / default=None
  • charset / kind=keyword-only / type=str / 任意 / default='utf-8'
  • include_charset / kind=keyword-only / type=bool / 任意 / default=True
戻り値

None

例外・注意点

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

利用例
from nexom.app.response import HtmlResponse

obj = HtmlResponse(body=b'', status=200, headers=None, cookie=None, charset='utf-8', include_charset=True)

JsonResponse

分類: public class

JSON response with application/json content type.

JsonResponse の全メソッド

__init__

分類: special method

シグネチャ
__init__(self, body: Optional[dict] = None, status: int = 200, headers: Iterable[Header] | None = None, cookie: str | None = None, *, charset: str = 'utf-8', include_charset: bool = True) -> None
使い方と仕様

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

引数
  • body / kind=positional-or-keyword / type=Optional[dict] / 任意 / default=None
  • status / kind=positional-or-keyword / type=int / 任意 / default=200
  • headers / kind=positional-or-keyword / type=Iterable[Header] | None / 任意 / default=None
  • cookie / kind=positional-or-keyword / type=str | None / 任意 / default=None
  • charset / kind=keyword-only / type=str / 任意 / default='utf-8'
  • include_charset / kind=keyword-only / type=bool / 任意 / default=True
戻り値

None

例外・注意点

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

利用例
from nexom.app.response import JsonResponse

obj = JsonResponse(body=None, status=200, headers=None, cookie=None, charset='utf-8', include_charset=True)

Redirect

分類: public class

HTTP redirect response (302).

Redirect の全メソッド

__init__

分類: special method

シグネチャ
__init__(self, location: str, headers: Iterable[Header] | None = None, cookie: str | None = None) -> None
使い方と仕様

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

引数
  • location / kind=positional-or-keyword / type=str / 必須 / default=なし
  • headers / kind=positional-or-keyword / type=Iterable[Header] | None / 任意 / default=None
  • cookie / kind=positional-or-keyword / type=str | None / 任意 / default=None
戻り値

None

例外・注意点

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

利用例
from nexom.app.response import Redirect

obj = Redirect(location="sample", headers=None, cookie=None)

ErrorResponse

分類: public class

HTML error response rendered from template.

ErrorResponse の全メソッド

__init__

分類: special method

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

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

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

None

例外・注意点

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

利用例
from nexom.app.response import ErrorResponse

obj = ErrorResponse(status=1, message="sample")
_render

分類: internal method

シグネチャ
_render(status: int, message: str) -> str
使い方と仕様

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

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

str

例外・注意点

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

利用例
from nexom.app.response import ErrorResponse

obj = ErrorResponse(...)
result = obj._render(status=1, message="sample")
print(result)

ソース情報

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

©2026 Nexom MIT-License