(機械翻訳) pyramid.interfaces

その他のインターフェイス

interface IAuthenticationPolicy[ソース]

Pyramid認証ポリシーを表すオブジェクト。

authenticated_userid(request)

認証されたユーザIDが見つからない場合は、authenticated：term： userid`または None``を返します。このポリシーの方法では、ユーザーに関連して永続ストアが使用されている（ユーザーは削除されてはいけない）レコードが存在することを確認する必要があります。現在のidに関連付けられたレコードが永続ストアに存在しない場合は、 ` None``を返す必要があります。

unauthenticated_userid(request)

Return the unauthenticated userid. This method performs the same duty as authenticated_userid but is permitted to return the userid based only on data present in the request; it needn't (and shouldn't) check any persistent store to ensure that the user record related to the request userid exists.

このメソッドは主に、リクエストを認証するために使用される特定のヘッダー、クエリ文字列などを抽象化して、要求データからクレデンシャルを引き出す際に `` authenticated_userid``メソッドを支援するヘルパーを意図しています。

effective_principals(request)

：term： userid`を含む有効なプリンシパルと、 pyramid.security.Everyone``や `pyramid.security 'などの' system 'グループを常に含む現在のユーザが所属するグループを表すシーケンスを返します。認証済み。

remember(request, userid, **kw)

レスポンスに設定されたときに `` userid``という名前の：term： `userid`を '覚えている'に適したヘッダーのセットを返します。個人認証ポリシーとその消費者は、「** kw」の構成と意味を決定できます。

forget(request)

後続のリクエストで現在のユーザーを「忘れる」のに適した一連のヘッダーを返します。

interface IAuthorizationPolicy[ソース]

ピラミッド認可ポリシーを表すオブジェクト。

permits(context, principals, permission)

`` principal``の中に `` context``の `` permission``が許されていれば、class： pyramid.security.Allowed`のインスタンスを返します。そうでなければ：class： pyramid .security.Denied`。

principals_allowed_by_permission(context, permission)

`` context``の `` permission``で許される主体識別子のセットを返します。この動作はオプションです。実装しない場合は、このメソッドを「NotImplementedError」を発生させるものとして定義する必要があります。このメソッドは、 `` pyramid.security.principals_allowed_by_permission`` APIが使用されている場合にのみ呼び出されます。

interface IExceptionResponse[ソース]

拡張：：class： pyramid.interfaces.IException、：class：` pyramid.interfaces.IResponse`

例外オブジェクトでもあるWSGI応答を表すインタフェース。このインタフェースを「コンテキスト」として使用して例外ビューを登録すると、内部的に：app： Pyramid`（すべての例外例外：class： pyramid.response.Response`から継承した例外）によって生成されたすべての例外タイプに対して登録されたビューを適用します。 ：class： pyramid.httpexceptions.HTTPNotFound`と：class： pyramid.httpexceptions.HTTPForbidden`）。

prepare(environ)

WSGIアプリケーションとして呼び出されるための応答を準備する

interface IRoute[ソース]

`` IRoutesMapper.get_route``から返されたオブジェクトの型を表すインタフェース

name

ルート名

pattern

ルートパターン

factory

このルートが一致したときには：app： Pyramid`ルータで使用される：term：`ルートファクトリ `（または None`）

predicates

基本パターンマッチングが完了した後、リクエストがこのルートと一致するかどうかを判断するために使用されるterm： `ルート述語 'オブジェクトのシーケンス。

pregenerator

この属性は `` None``か `` IRoutePregenerator``インタフェースを実装した呼び出し可能なオブジェクトのいずれかでなければなりません

match(path)

この関数に渡された `` path``をこのルートの `` pattern``でマッチさせることができるならば、値にマッピングされたパターン内の動的セグメントマーカを表すキーを含む辞書（ 'matchdict'）を返します提供された「パス」から抽出される。

この関数に渡された `` path``がこのルートの `` pattern``でマッチできない場合は、 `` None``を返します。

generate(kw)

提供された `` kw``ディクショナリを使用して、パターン内の動的セグメントマーカーを埋めることに基づいてURLを生成します。

interface IRoutePregenerator[ソース]
__call__(request, elements, kw)

事前生成子は、開発者によって：term： ルート`と関連付けられた関数です。ルートの事前生成者は、Pylonsのサブドメインのような特別な目的のためにユーザが渡す引数のセットを調整するために：meth： `pyramid.request.Request.route_url`と呼ばれます。 ` route_url``が返すURLに影響します。

事前生成者は、この関数に渡されたオリジナルを調べた後、 ``（要素、kw） ``の2タプルを返すべきです。これは引数 ``（request、elements、kw） ``です。最も簡単な事前生成者は:

def pregenerator(request, elements, kw):
    return elements, kw

`` pregenerator``引数を：meth： `pyramid.config.Configurator.add_route`関数に渡すことで、事前生成子を使用することができます。

interface ICSRFStoragePolicy[ソース]

CSRFトークンを検証し、新しいトークンを生成する機能を提供するオブジェクト。

new_csrf_token(request)

新しいランダムなクロスサイトリクエスト偽造保護トークンを作成して返します。トークンは、ASCII互換のUnicode文字列になります。

get_csrf_token(request)

クロスサイトリクエスト偽造保護トークンを返します。これは、ASCII互換のUnicode文字列になります。 `` new_csrf_token``を介してトークンがこのユーザに対して以前に設定されていた場合、そのトークンが返されます。以前にCSRFトークンが設定されていない場合は、 `` new_csrf_token``が呼び出され、トークンを作成して設定し、このトークンが返されます。

check_csrf_token(request, token)

指定された `` token``が有効かどうかを判定します。ほとんどの実装では、 `` token``を `` get_csrf_token``の現在の値と単純に比較するだけですが、このメソッドを使って必要なメカニズムを使ってトークンを検証することは可能です。

`` token``が有効であれば `` True``を、そうでなければ `` False``を返します。

interface ISession[ソース]

拡張：：class： pyramid.interfaces.IDict

セッションを表すインタフェース（通常は `` request.session``でアクセスされるWebセッションオブジェクト）。

セッションのキーと値はpickleableでなければなりません。

バージョン 1.9 で変更: セッションはもはや `` get_csrf_token``と `` new_csrf_token``を実装する必要はありません。 CSRFトークンのサポートは、pluggable：class： `pyramid.interfaces.ICSRFStoragePolicy`設定フックに移動しました。

created

作成時のエポック時間を表す整数。

new

ブール属性。 `` True``の場合、セッションは新規です。

invalidate()

セッションを無効にします。 `` invalidate``によって引き起こされるアクションはインプリメンテーション依存ですが、セッションに格納されているすべてのデータを現在のリクエストと完全に分離するという効果があります。応答値（クッキーを消去する値など）を設定することもあれば、そうでないこともあります。

データを格納するために新しいセッションが作成されるという効果を持つ `` invalidate``の呼び出しの後で、無効化されたセッションを使用することができます。これにより、権限レベルの変更や固定攻撃の防止など、まったく新しいセッションを必要とするワークフローが可能になります。

changed()

セッションを変更済みとしてマークします。セッションのユーザーは、*セッションの値*である可変オブジェクトを変更した後にこのメソッドを呼び出す必要があります（セッション自体を変更した後には必要ありません）。例えば、ユーザがキーを `` foo``でセッションに保存していて、 `` session ['foo'] = {} ``、 `` changed（） `` needn '呼び出される。しかし、後で `` session ['foo'] ['a'] = 1``を実行すると、セッション機械が内部辞書の突然変異に気づくために `` changed（） ``を呼び出さなければなりません。

flash(msg, queue='', allow_duplicate=True)

`` queue``で表されるフラッシュキューの最後にフラッシュメッセージを押します。代わりのフラッシュメッセージキューはオプションの `` queue``を渡すことによって使用できます。これは文字列でなければなりません。 `` allow_duplicate``がfalseの場合、 `` msg``がすでにキューに存在する場合、それは再追加されません。

pop_flash(queue='')

フラッシュストレージからキューをポップします。このメッセージが呼び出された後、キューはフラッシュストレージから削除されます。キューが返されます。それは：meth： `pyramid.interfaces.ISession.flash`によって追加されたフラッシュメッセージのリストです

peek_flash(queue='')

フラッシュストレージ内の待ち行列を覗いてみてください。このメッセージが呼び出されると、キューはフラッシュストレージに残ります。キューが返されます。それは：meth： `pyramid.interfaces.ISession.flash`によって追加されたフラッシュメッセージのリストです

interface ISessionFactory[ソース]

要求オブジェクトを受け取り、ISessionオブジェクトを返すファクトリを表すインターフェイス

__call__(request)

ISessionオブジェクトを返す

interface IRendererInfo[ソース]

このインタフェースを実装するオブジェクトは、すべての：term： renderer factory`コンストラクタに唯一の引数として渡されます（通常は `info``という名前です）

name

ユーザーがレンダラー名として渡す値

package

レンダラー構成ステートメントが見つかったときの"現在のパッケージ"

type

レンダラーの型名

registry

レンダラーが作成されたときの"現在の"アプリケーションレジストリ

settings

現在のアプリケーションに関連する展開設定辞書

clone()

可変状態を共有しない浅いコピーを返します。

interface IRendererFactory[ソース]
__call__(info)

クラス： pyramid.interfaces.IRenderer`を実装しているオブジェクトを返します。 ` info``は：class： `pyramid.interfaces.IRendererInfo`を実装するオブジェクトです。

interface IRenderer[ソース]
__call__(value, system)

ビューの結果（ `` value``）が渡されたレンダラーを呼び出し、結果（レスポンス本文として有用な文字列またはユニコードオブジェクト）を返します。システムによって計算された値は、辞書である `` system``パラメータでシステムによって渡されます。辞書のキーには、 `` view``（値を返す呼び出し可能ビュー）、 `` renderer_name``（テンプレート名またはレンダラーの単純な名前）、 `` context``（ビュー）、 `` request``（ビューに渡されたリクエストオブジェクト）の3つです。

interface IRequestFactory[ソース]

リクエストを生成するユーティリティ

__call__(environ)

`` pyramid.request.Request``のインスタンスを返します。

blank(path)

空のリクエストオブジェクトを返します（：meth： `pyramid.request.Request.blank`を参照）。

interface IResponseFactory[ソース]

応答を生成するユーティリティ

__call__(request)

IResponseを実装するレスポンスオブジェクトを返します（例：class： pyramid.response.Response）。 `` request``が `` None``の場合に対応してください。

interface IRouter[ソース]

ビューレジストリに基づいて要求を「ビュー」コードにルーティングするWSGIアプリケーション。

registry

このアプリケーションのローカルのコンポーネントアーキテクチャレジストリ。

request_context(environ)

WSGI環境から新しい要求コンテキストを作成します。

要求コンテキストは、要求を処理するときに必要なスレッド・ロックをプッシュ/ポップするために使用されます。また、登録された：class： pyramid.interfaces.IRequestFactory`を使用して初期化された：class： pyramid.interfaces.IRequest`インスタンスも含まれています。コンテキストは、スレッドローカルライフサイクルを制御するコンテキストマネージャとして使用できます。

with router.request_context(environ) as request:
    ...

あるいは、 `` begin（） ``メソッドと `` end（） ``メソッドを手動で呼び出すことで、コンテキストを `` with``ステートメントなしで使用することもできます。

ctx = router.request_context(environ)
request = ctx.begin()
try:
    ...
finally:
    ctx.end()
invoke_request(request)

：app： `Pyramid`リクエストパイプラインを呼び出します。

要求パイプラインに関する情報は：ref： `router_chapter`を参照してください。

出力は：class： `pyramid.interfaces.IResponse`オブジェクトか、発生した例外でなければなりません。

interface IViewMapperFactory[ソース]
__call__(self, **kw)

クラス： pyramid.interfaces.IViewMapper`を実装しているオブジェクトを返します。 ` kw``は、 許可 ``、 ``述語 ``、 `` attr、 ``レンダラー ``などのビュー固有の引数を含む辞書になります。 IViewMapperFactoryは：meth： `pyramid.config.Configurator.add_view`によって潜在的なビュー呼び出し可能な呼び出しシグネチャと応答値を変更したい拡張機能開発者に提供するために使用されます。

interface IViewMapper[ソース]
__call__(self, object)

任意のオブジェクト（関数、クラス、またはインスタンス）があれば、コールシグネチャ ``（context、request） ``でコール可能オブジェクトを返します。返される呼び出し可能オブジェクトは、それ自身がResponseオブジェクトを返す必要があります。 IViewMapperは：class： `pyramid.interfaces.IViewMapperFactory`によって返されます。

interface IDict[ソース]
__contains__(k)

キー `` k``が辞書に存在すれば `` True``を返します。

__setitem__(k, value)

キー/値のペアを辞書に設定する

__delitem__(k)

ディクショナリからレンダラーに渡されるアイテムをレンダラーのグローバルディクショナリとして削除します。

__getitem__(k)

辞書からキー `` k``の値を返し、キーが存在しなければKeyErrorを送出します

__iter__()

この辞書のキーのイテレータを返します。

get(k, default=None)

キー "k"の値をレンダラー辞書から返します。値が存在しない場合はデフォルトを返します。

items()

辞書から[（k、v）]対のリストを返す

keys()

辞書からキーのリストを返す

values()

辞書から値のリストを返す

pop(k, default=None)

キーkを辞書からポップし、その値を返します。 kが存在せず、デフォルトが提供されている場合は、デフォルトを返します。 kが存在せず、デフォルトが提供されていない場合、KeyErrorを送出します。

popitem()

辞書からキーkで項目をポップし、2タプル（k、v）として返します。 kが存在しない場合は、KeyErrorを発生させます。

setdefault(k, default=None)

辞書にあるキー "k"の既存の値を返します。辞書に `` k``の値がない場合は、渡されたkの名前の辞書に `` default``の値を設定します。値がすでに辞書に存在する場合は、それを返します。値が辞書に存在しない場合は、デフォルト値

update(d)

レンダラー辞書を別の辞書 `` d``で更新してください。

clear()

辞書からすべての値をクリアする

interface IMultiDict[ソース]

拡張：：class： pyramid.interfaces.IDict

各キーに複数の値を持つことができる順序付き辞書。 multidictは、通常の辞書インタフェースに `` getall``、 `` getone``、 `` mixed``、 `` extend``、 `` add``、 `` dict_of_lists``メソッドを追加します。マルチダイレクトデータ構造は、：app： Pyramid`アプリケーション内で request.POST`、` request.GET`、` `request.params``として使用されます。

add(key, value)

以前の値を上書きしないで、キーと値を追加します。

dict_of_lists()

各キーが値のリストに関連付けられている辞書を返します。

extend(other=None, **kwargs)

以前の値を上書きしないで、キーと値のセットを追加します。 「他の」構造体は、2つのタプルまたは辞書のリストであってもよい。 `` ** kwargs``が渡された場合、その値*は既存の値を上書きします。

getall(key)

キーに一致するすべての値のリストを返します（空のリストかもしれません）

getone(key)

キーに一致する値を1つ取得し、複数の値が見つかった場合はKeyErrorを発生させます。

mixed()

値が単一値である辞書、またはキー/値がこの辞書に複数回現れるときの値のリストを返します。これは、Webリクエストで変数を表すためによく使われる辞書の種類と似ています。

interface IResponse[ソース]

WebOb応答インタフェースを使用したWSGI応答を表します。このインタフェースの属性とメソッドのドキュメントの中には、rfc： `2616`を参照しているものがあります。

このインタフェースは、class： pyramid.response.Response`と：mod： pyramid.httpexceptions`のHTTP例外クラスによって最も有名に実装されています。

RequestClass

エイリアス：class： pyramid.request.Request

__call__(environ, start_response)

：term： `WSGI`コールインタフェース。start_responseコールバックを呼び出す必要があり、iterableを返す必要があります

accept_ranges

Accept-Rangesヘッダーを取得、設定、削除します。 Accept-Rangeの詳細については、RFC 2616のセクション14.5を参照してください。

age

Ageヘッダーを取得、設定、削除します。 intを使用して変換します。 Ageの詳細については、RFC 2616のセクション14.6を参照してください。

allow

Allowヘッダーを取得、設定、削除します。リストを使用して変換します。許可の詳細については、RFC 2616、第14.7項を参照してください。

app_iter

応答のapp_iterを返します。

bodyが設定されている場合、その本体からapp_iterが作成されます（単一項目のリスト）

app_iter_range(start, stop)

応答app_iterから構築された新しいapp_iterを返します。このapp_iterは、指定されたstart：stop範囲のみを処理します。

body

レスポンスの本文は、strとして返されます。これは、必要に応じてapp_iter全体で読み取られます。

body_file

本文に書き込むのに使用できるファイルのようなオブジェクト。 app_iterというリストを渡した場合、そのapp_iterは書き込みによって変更されます。

cache_control

Cache-Controlヘッダを取得/設定/変更する（RFC 2616のセクション14.9）

cache_expires

Cache-ControlヘッダーとExpiresヘッダーを取得/設定します。これは、設定されたときに経過した秒数で応答が期限切れになるように設定します。

charset

文字セットの取得/設定（Content-Type内）

conditional_response_app(environ, start_response)

通常の__call__インタフェースと同様ですが、条件付きヘッダをチェックします：

  • If-Modified-Since（304は変更されず、GET、HEADのみ）
  • 一致しない場合（304は変更されず、GET、HEADの場合のみ）
  • 範囲（406の部分コンテンツ、GET、HEADのみ）
content_disposition

Content-Dispositionヘッダーを取得、設定、削除します。 Content-Dispositionの詳細については、RFC 2616のセクション19.5.1を参照してください。

content_encoding

Content-Encodingヘッダーを取得、設定、および削除します。 Content-Encodingの詳細については、RFC 2616のセクション14.11を参照してください。

content_language

Content-Languageヘッダーを取得、設定、および削除します。リストを使用して変換します。 Content-Languageの詳細については、RFC 2616のセクション14.12を参照してください。

content_length

Content-Lengthヘッダーを取得、設定、削除します。 Content-Lengthの詳細については、RFC 2616のセクション14.17を参照してください。 intを使用して変換します。

content_location

Content-Locationヘッダーを取得、設定、および削除します。 Content-Locationの詳細については、RFC 2616の14.14節を参照してください。

content_md5

Content-MD5ヘッダーを取得、設定、および削除します。 Content-MD5の詳細については、RFC 2616の14.14節を参照してください。

content_range

Content-Rangeヘッダーを取得、設定、削除します。 Content-Rangeの詳細については、14.16節を参照してください。 ContentRangeオブジェクトを使用して変換します。

content_type

文字セットまたは任意のパラメータを使用せずに、Content-Typeヘッダ（またはNone）を取得または設定します。 content_typeの設定時にパラメータを含めると、既存のパラメータはすべて削除されます。さもなければそれらは保存されます。

content_type_params

コンテンツタイプのすべてのパラメータの辞書。これは変更されるビューではなく、ディクテーションの変更は適用されません。

copy()

応答のコピーを作成し、そのコピーを返します。

date

Dateヘッダーを取得、設定、削除します。 Dateの詳細については、RFC 2616のセクション14.18を参照してください。 HTTPの日付を使用して変換します。

クライアントからクッキーを削除します。パスとドメインは、Cookieの元の設定と一致する必要があります。これにより、クッキーが空の文字列に設定され、max_age = 0に設定され、すぐに期限切れになります。

encode_content(encoding='gzip', lazy=False)

指定されたエンコーディングでコンテンツをエンコードします（gzipとIDのみサポートされます）。

environ

この応答に関連付けられたリクエスト環境を取得/設定します（存在する場合）。

etag

ETagヘッダーを取得および設定し、削除します。 ETagの詳細については、RFC 2616のセクション14.19を参照してください。エンティティタグを使用して変換します。

expires

Expiresヘッダーを取得、設定、削除します。 Expiresの詳細については、RFC 2616のセクション14.21を参照してください。 HTTPの日付を使用して変換します。

headerlist

応答ヘッダーのリスト。

headers

辞書のようなオブジェクトのヘッダー

last_modified

Last-Modifiedヘッダーを取得、設定、削除します。 Last-Modifiedの詳細については、RFC 2616のセクション14.29を参照してください。 HTTPの日付を使用して変換します。

location

Locationヘッダーを取得、設定、削除します。場所の詳細については、RFC 2616セクション14.30を参照してください。

md5_etag(body=None, set_content_md5=False)

本文のMD5ハッシュ（bodyパラメータ、または与えられていない場合はself.body）を使用してレスポンスオブジェクトのetagを生成します。 self.etagを設定します。 set_content_md5がTrueの場合、self.content_md5も同様に設定されます。

merge_cookies(resp)

このレスポンスに設定されたCookieを、指定されたrespオブジェクト（任意のWSGIアプリケーション）にマージします。 respがwebob.Responseオブジェクトの場合、もう一方のオブジェクトはインプレースで変更されます。

pragma

プラグマヘッダーを取得、設定、削除します。プラグマの詳細については、RFC 2616のセクション14.32を参照してください。

request

この応答に関連付けられた要求があれば返します。

retry_after

Retry-Afterヘッダーを取得、設定、および削除します。 Retry-Afterの詳細については、RFC 2616の14.37節を参照してください。 HTTPの日付またはデルタ秒を使用して変換します。

server

サーバーヘッダーを取得および設定し、削除します。サーバーの詳細については、RFC216の14.38節を参照してください。

レスポンスにクッキーを設定（追加）する

status

ステータス文字列。

status_int

整数としての状態

unicode_body

本文のユニコード値を取得/設定する（Content-Typeの文字セットを使用）

指定された名前のクッキーの設定を解除します（応答から削除します）。

vary

Varyヘッダーを取得、設定、削除します。 Varyの詳細については、14.44節を参照してください。リストを使用して変換します。

www_authenticate

WWW-Authenticateヘッダーを取得、設定、削除します。 WWW-Authenticateの詳細については、RFC 2616の14.47節を参照してください。 'parse_auth'と 'serialize_auth'を使って変換します。

interface IIntrospectable[ソース]

構成イントロスペクションに使用されるイントロスペクティブなオブジェクト。以下のメソッドに加えて、このインタフェースを実装するオブジェクトは、Pythonの `` collections.MutableMapping``（"辞書インタフェース"）のすべてのメソッドも実装しなければならず、ハッシュ可能でなければなりません。

title

このイントロスペクタブルを説明するテキストタイトル

type_name

このイントロスペクティブを記述するテキストタイプ名

order

introspectorに登録された整数の順序（通常、イントロスペクサーによって管理されます）

category_name

イントロスペクションカテゴリ名

discriminator

（カテゴリ内の）イントロスペクティブな識別子（ハッシュ可能でなければならない）

discriminator_hash

ディスクリミネータの整数ハッシュ

action_info

このイントロビュー可能オブジェクトの作成を呼び出した呼び出し元を表すIActionInfoオブジェクト（通常、self.register中に更新されるまでは、センチネル）

relate(category_name, discriminator)

アクションの実行中に、このIIntrospectableと別のIIntrospectable（ `` category_name``と `` discriminator``に関連するもの）を関連付ける意図を示します。

unrelate(category_name, discriminator)

アクションの実行中に、このIIntrospectableと他のIIntrospectable（ `` category_name``と `` discriminator``に関連するもの）との関係を壊す意図を示します。

register(introspector, action_info)

このIIntrospectableをイントロスペクサーに登録します。このメソッドは、アクションの実行中に呼び出されます。 introspectorとその関係をintrospectorに追加します。 `` introspector``はIIntrospectorを実装するオブジェクトでなければなりません。 `` action_info``は、このイントロスペクタブルを登録した呼び出しを表すインタフェース：class： `pyramid.interfaces.IActionInfo`を実装するオブジェクトでなければなりません。このメソッドを実装するための擬似コード：

def register(self, introspector, action_info):
    self.action_info = action_info
    introspector.add(self)
    for methodname, category_name, discriminator in self._relations:
        method = getattr(introspector, methodname)
        method((i.category_name, i.discriminator),
               (category_name, discriminator))
__hash__()

見込み客はハッシュ可能でなければならない。 introspectableの__hash__の典型的な実装は:

return hash((self.category_name,) + (self.discriminator,))
interface IIntrospector[ソース]
get(category_name, discriminator, default=None)

category_nameとdiscriminator（またはdiscriminator hash）の `` discriminator``に関連するIIntrospectableを取得します。 introspectorに存在しない場合は、 `` default``の値を返します

get_category(category_name, default=None, sort_key=None)

`` {{'introspectable'：IIntrospectable、 'related'：[関連するIIntrospectablesのシーケンス}}、...] ``形式で辞書のシーケンスを取得します。各イントロスペクタブルは `` category_name``に関連するカテゴリの一部です。 `。

introspectorに `` category_name``というカテゴリが存在しない場合、 `` default``として渡された値が返されます。

`` sort_key``が `` None``の場合、イントロスペクターがイントロスペクターに追加された順序でシーケンスが返されます。それ以外の場合、sort_keyはIIntrospectableを受け取り、その値を返します（alaはPythonの `` sorted``呼び出し可能関数の `` key``関数です）。

categories()

このIntrospectorが認識しているカテゴリ名のソートされたシーケンスを返します。

categorized(sort_key=None)

``（category_name、[{'introspectable'：IIntrospectable、 'related'：[関連するIIntrospectablesのシーケンス]}、...]） `` 形式のタプルのシーケンスを取得します。 ` sort_key``が `` None``の場合、各イントロスペクターブルシーケンスは、イントロスペクターがイントロスペクターに追加された順に返されます。それ以外の場合、sort_keyはIIntrospectableを受け取り、その値を返します（alaはPythonの `` sorted``呼び出し可能関数の `` key``関数です）。

remove(category_name, discriminator)

イントロスペクサから `` category_name``と `` discriminator``に関連するIIntrospectableを削除し、イントロスペクサブルが関与する関係を修正します。カテゴリ名とディスクリミネータに関連するイントロスペクタブルが存在する。

related(intr)

IIntrospectableの `` intr``に関連するIIntrospectablesのシーケンスを返します。関係が存在しない場合は、空のシーケンスを返します。

add(intr)

IIntrospectable `` intr``を追加します（カスタムIIntrospectableを持っているときは、：meth： `pyramid.interfaces.IIntrospector.add`の代わりに使用します）。同じカテゴリ/弁別子を使用して登録された既存のイントロスペクトなものを置き換えます。

このメソッドは通常、直接呼び出されるのではなく、meth： `pyramid.interfaces.IIntrospector.register`によって間接的に呼び出されます。

relate(*pairs)

任意の数の ``（category_name、discriminator）対が位置引数として渡された場合、関連するイントロスペクティブを互いに関連付ける。各ペアに関連するイントロスペクタブルは、 `` .add``または `.add_intr``を介して既に追加されていなければなりません。これが真でない場合、a：exc： `KeyError`が返されます。ペアがすでに別のペアに関連付けられている場合、エラーは発生しません。

このメソッドは通常、直接呼び出されるのではなく、meth： `pyramid.interfaces.IIntrospector.register`によって間接的に呼び出されます。

unrelate(*pairs)

任意の数の ``（category_name、discriminator）対が位置引数として渡された場合、関連するイントロスペクタブルを互いに関連付けることはありません。各ペアに関連するイントロスペクタブルは、 `` .add``または `.add_intr``を介して既に追加されていなければなりません。これが真でない場合、a：exc： `KeyError`が返されます。ペアがまだ別のペアと関連していない場合、エラーは発生しません。

このメソッドは通常、直接呼び出されるのではなく、meth： `pyramid.interfaces.IIntrospector.register`によって間接的に呼び出されます。

interface IActionInfo[ソース]

アクションに関連付けられたコードイントロスペクション機能を提供するクラス。 ZCMLによって使用されるParserInfoクラスは、同じインタフェースを実装します。

file

アクションを呼び出すコードのファイル名

line

行番号をアクション呼び出しコードのファイルとして（整数で）開始します。値が決定できなかった場合、これは `` None``になります。

__str__()

アクション情報の表現を返します（可能であれば、ファイルからのソースコードを含む）

interface IAssetDescriptor[ソース]

：term： `asset`について説明します。

absspec()

このアセットの絶対アセット仕様を返します（例えば、 `` mypackage：templates / foo.pt``など）。

abspath()

ファイルシステム内のアセットへの絶対パスを返します。

stream()

アセットコンテンツを読み込むための入力ストリームを返します。アセットがディレクトリであるか存在しない場合に例外を発生させます。

isdir()

アセットがディレクトリの場合はTrueを返し、そうでない場合はFalseを返します。

listdir()

ディレクトリの内容のファイル名の繰り返しを返します。 assetがディレクトリでない場合は例外を発生させます。

exists()

アセットが存在する場合はTrueを返し、それ以外の場合はFalseを返します。

interface IResourceURL[ソース]
virtual_path

文字列としてのリソースの仮想URLパス。

physical_path

文字列としてのリソースの物理URLパス。

virtual_path_tuple

タプルとしてのリソースの仮想URLパス。 （1.5の新機能）

physical_path_tuple

タプルとしてのリソースの物理URLパス。 （1.5の新機能）

interface ICacheBuster[ソース]

キャッシュバスターは：meth： `〜pyramid.request.Request.static_url`のURL生成機構を変更します。参照：ref： `cache_busting`を参照してください。

バージョン 1.6 で追加.

__call__(request, subpath, kw)

URL生成中に静的アセットURLが計算されるサブパスまたはキーワード引数を変更します。

`` subpath``引数は、アセットを見つけるのに使われるアセットURLの部分を表す `` / ``で区切られたセグメントのパスです。 `` kw``引数は、URL生成のために最終的に：meth： 〜pyramid.request.Request.static_url`に渡されるキーワードの辞書です。戻り値は、 ``（subpath、kw） ``の2タプルでなければなりません。 ` subpath``は、ファイルが提供される相対URLであり、 `` kw``は同じ入力引数です。戻り値は、生成されたURLにキャッシュバストトークンを含めるように変更する必要があります。

`` kw``辞書には：meth： `〜pyramid.request.Request.static_url`に渡される余分な引数が含まれています。

  • `` pathspec``は、キャッシュを破棄するリソースのパス指定です。
  • `` rawspec``はファイルの元の場所です：meth： `pyramid.config.Configurator.override_asset`への呼び出しは無視されます。

`` pathspec``と `` rawspec``の値は、アセットが：meth： pyramid.config.Configurator.override_asset`を使って仮想位置にマウントされている場合にのみ異なります。たとえば、 ` request.static_url（ 'myapp：static / foo.png'）を呼び出すと、 `` pathspec``は `` myapp：static / foo.png``ですが、 `` rawspec``はconfig.override_asset（ 'myapp：static / foo.png'、 'themepkg：bar.png'） ``を呼んでいると仮定して、 `` themepkg：bar.png``になります。

interface IViewDeriver[ソース]
options

渡されるサポートされるオプションのリスト：meth： pyramid.config.Configurator.add_view。この属性はオプションです。

__call__(view, info)

提供されたビューから新しいビューを派生させます。

ビューオプション、パッケージ情報、レジストリは `` info``：class： `pyramid.interfaces.IViewDeriverInfo`のインスタンスで利用できます。

`` view``は ``（context、request） `'を受け入れる呼び出し可能です。

interface IViewDeriverInfo[ソース]

このインタフェースを実装するオブジェクトは、コンフィグレーション時にterm： `view deriver 'に渡されます。

registry

ビューが作成された"現在の"アプリケーションレジストリ

package

ビュー構成ステートメントが見つかった"現在のパッケージ"

settings

現在のアプリケーションに関連する展開設定辞書

options

オーバーライドされなかったデフォルト値を含め、ビューに渡されるビューオプション

predicates

ビューでアクティブな述語のリスト

original_view

ラップされている元のビューオブジェクト

exception_only

ビューは例外に対してのみ呼び出されます