共通モジュール
例外クラス
- exception wikidot.common.exceptions.WikidotException(message)[ソース]
ベースクラス:
Exceptionwikidot.py独自の例外の基底クラス
ライブラリ内で発生する全ての例外の親クラスとなる。 具体的な例外は各サブクラスで定義される。
- パラメータ:
message (
str) -- 例外メッセージ
- exception wikidot.common.exceptions.UnexpectedException(message)[ソース]
ベースクラス:
WikidotException予期せぬ例外が発生したときに送出される例外
特定のエラー状態に分類できない、予期しない状況で発生する。 通常は内部エラーやバグを示す。
- パラメータ:
message (
str) -- 例外メッセージ
- exception wikidot.common.exceptions.SessionCreateException(message)[ソース]
ベースクラス:
WikidotExceptionセッションの作成に失敗したときに送出される例外
ログイン処理やセッション確立時に問題が発生した場合に使用される。 通常は認証情報の誤りやサーバー側の問題が原因となる。
- パラメータ:
message (
str) -- 例外メッセージ
- exception wikidot.common.exceptions.LoginRequiredException(message)[ソース]
ベースクラス:
WikidotExceptionログインが必要なメソッドを未ログイン状態で呼び出したときに送出される例外
認証が必要な操作を実行する前に、ログイン状態をチェックする際に使用される。
- パラメータ:
message (
str) -- 例外メッセージ
- exception wikidot.common.exceptions.AjaxModuleConnectorException(message)[ソース]
ベースクラス:
WikidotExceptionAjax Module Connectorへのリクエストに関連する例外の基底クラス
ajax-module-connector.phpへのAPIリクエスト処理中に発生する例外の親クラス。 具体的なエラー状態は各サブクラスで表現される。
- パラメータ:
message (
str) -- 例外メッセージ
- exception wikidot.common.exceptions.AMCHttpStatusCodeException(message, status_code)[ソース]
ベースクラス:
AjaxModuleConnectorExceptionAMCのHTTPステータスコードが200以外だった場合に送出される例外
Ajax Module ConnectorへのリクエストでHTTPレベルのエラーが発生した場合に使用される。
- exception wikidot.common.exceptions.WikidotStatusCodeException(message, status_code)[ソース]
ベースクラス:
AjaxModuleConnectorExceptionAMCからのレスポンスのステータスが「ok」でなかった場合に送出される例外
HTTP通信自体は成功したが、Wikidot側で処理エラーが発生した場合に使用される。 HTTPステータスが200以外の場合は代わりにAMCHttpStatusCodeExceptionが使用される。
- exception wikidot.common.exceptions.ResponseDataException(message)[ソース]
ベースクラス:
AjaxModuleConnectorExceptionAMCからのレスポンスデータが不正だった場合に送出される例外
レスポンスのパース失敗や、期待された形式と異なるデータが返された場合に使用される。
- パラメータ:
message (
str) -- 例外メッセージ
- exception wikidot.common.exceptions.NotFoundException(message)[ソース]
ベースクラス:
WikidotException要求されたリソースが見つからない場合に送出される例外
サイト、ページ、ユーザー、リビジョンなど、指定されたリソースが Wikidot上に存在しない場合に使用される。
- パラメータ:
message (
str) -- 例外メッセージ
- exception wikidot.common.exceptions.TargetExistsException(message)[ソース]
ベースクラス:
WikidotException既に存在するリソースを作成しようとした場合に送出される例外
新規作成操作が既存のリソースと衝突する場合に使用される。
- パラメータ:
message (
str) -- 例外メッセージ
- exception wikidot.common.exceptions.TargetErrorException(message)[ソース]
ベースクラス:
WikidotException対象オブジェクトに操作を適用できない場合に送出される例外
リソースは存在するが、現在の状態では要求された操作を 実行できない場合に使用される（例：ロック中のページを編集しようとする）。
- パラメータ:
message (
str) -- 例外メッセージ
- exception wikidot.common.exceptions.ForbiddenException(message)[ソース]
ベースクラス:
WikidotException権限不足により操作が拒否された場合に送出される例外
ユーザーが操作に必要な権限を持っていない場合や、 プライベートサイトへのアクセスが拒否された場合などに使用される。
- パラメータ:
message (
str) -- 例外メッセージ
- exception wikidot.common.exceptions.NoElementException(message)[ソース]
ベースクラス:
WikidotException必要な要素が見つからない場合に送出される例外
HTML解析時に期待された要素が見つからない場合など、 処理中に必要なデータが欠落している場合に使用される。
- パラメータ:
message (
str) -- 例外メッセージ
デコレータ
各種デコレータを提供するモジュール
このモジュールは、ライブラリ内で使用される共通のデコレータを提供する。 現在は認証関連のデコレータが実装されている。
- wikidot.common.decorators.login_required(func)[ソース]
ログインが必要なメソッドや関数に適用するデコレータ
このデコレータを適用したメソッドや関数は、実行前に自動的にログイン状態をチェックする。 ログインしていない場合はLoginRequiredExceptionが送出される。
クライアントインスタンスは以下の優先順位で検索される： 1. client という名前の引数 2. Client クラスのインスタンスである引数 3. self.client（呼び出し元オブジェクトの属性） 4. selfが持つ属性が持つclientクラス（例：self.site.client）
- パラメータ:
func (
callable) -- デコレートする関数またはメソッド- 戻り値:
ラップされた関数またはメソッド
- 戻り値の型:
callable- 例外:
ValueError -- クライアントインスタンスが見つからない場合
LoginRequiredException -- ログインしていない場合（client.login_check()による）
ロガー
ロギング機能を提供するモジュール
このモジュールは、ライブラリ全体で使用されるロガーを設定し、提供する。 ログレベルの設定やフォーマットの指定などが可能。