クライアントモジュール

クライアントクラス

class wikidot.module.client.ClientUserMethods(client)

ベースクラス: object

ユーザー関連の操作を提供するクラス

クライアントインスタンスに関連付けられ、Wikidotユーザーの取得や操作を行うメソッドを提供する。 Client.userプロパティを通じてアクセスする。

パラメータ:

client (Client)

get(name, raise_when_not_found=False)

ユーザー名からユーザーオブジェクトを取得する

パラメータ:

• name (str) -- ユーザー名

• raise_when_not_found (bool, default False) -- ユーザーが見つからない場合に例外を送出するかどうか (True: 送出する, False: 送出しない) デフォルトでは送出せずにNoneを返す

戻り値:

ユーザーオブジェクト

戻り値の型:

AbstractUser

get_bulk(names, raise_when_not_found=False)

複数のユーザー名からユーザーオブジェクトのコレクションを取得する

パラメータ:

• names (list[str]) -- ユーザー名のリスト

• raise_when_not_found (bool, default False) -- ユーザーが見つからない場合に例外を送出するかどうか (True: 送出する, False: 送出しない) デフォルトでは送出せずにNoneを返す

戻り値:

ユーザーオブジェクトのコレクション

戻り値の型:

UserCollection

class wikidot.module.client.ClientPrivateMessageMethods(client)

ベースクラス: object

プライベートメッセージ関連の操作を提供するクラス

クライアントインスタンスに関連付けられ、Wikidotプライベートメッセージの送信や取得を行うメソッドを提供する。 Client.private_messageプロパティを通じてアクセスする。

パラメータ:

client (Client)

send(recipient, subject, body)

プライベートメッセージを送信する

パラメータ:

• recipient (User) -- 受信者

• subject (str) -- 件名

• body (str) -- 本文

戻り値の型:

None

property inbox: PrivateMessageInbox

受信箱を取得する

戻り値:

受信箱オブジェクト

戻り値の型:

PrivateMessageInbox

property sentbox: PrivateMessageSentBox

送信箱を取得する

戻り値:

送信箱オブジェクト

戻り値の型:

PrivateMessageSentBox

get_messages(message_ids)

複数のメッセージIDからメッセージのコレクションを取得する

パラメータ:

message_ids (list[int]) -- メッセージIDのリスト

戻り値:

メッセージのコレクション

戻り値の型:

PrivateMessageCollection

get_message(message_id)

メッセージIDからメッセージを取得する

パラメータ:

message_id (int) -- メッセージID

戻り値:

メッセージオブジェクト

戻り値の型:

PrivateMessage

class wikidot.module.client.ClientSiteMethods(client)

ベースクラス: object

サイト関連の操作を提供するクラス

クライアントインスタンスに関連付けられ、Wikidotサイトの取得や操作を行うメソッドを提供する。 Client.siteプロパティを通じてアクセスする。

パラメータ:

client (Client)

get(unix_name)

UNIX名からサイトオブジェクトを取得する

パラメータ:

unix_name (str) -- サイトのUNIX名（例: 'fondation'）

戻り値:

サイトオブジェクト

戻り値の型:

Site

class wikidot.module.client.Client(username=None, password=None, amc_config=None, logging_level='WARNING')

ベースクラス: object

Wikidot APIへの接続とインタラクションを管理する基幹クライアント

このクラスは、Wikidot APIとの全てのインタラクションの基盤となる。 ユーザー認証、サイト操作、ページ管理などすべての機能はこのクライアントを通じて提供される。

パラメータ:

• username (str | None)

• password (str | None)

• amc_config (AjaxModuleConnectorConfig | None)

• logging_level (str)

login_check()

ログイン状態の確認

ログインが必要な操作を実行する前に呼び出される。 ログインしていない場合は例外を送出する。

例外:

LoginRequiredException -- ログインしていない場合

戻り値の型:

None

認証モジュール

class wikidot.module.auth.HTTPAuthentication

ベースクラス: object

WikidotへのHTTP認証を提供するクラス

ログインおよびログアウト処理を管理するための静的メソッドを提供する。

static login(client, username, password)

ユーザー名とパスワードでWikidotにログインする

パラメータ:

• client (Client) -- 接続するクライアントインスタンス

• username (str) -- ログインするユーザー名

• password (str) -- ユーザーのパスワード

例外:

SessionCreateException -- ログイン試行が失敗した場合（HTTP応答コードエラー、認証情報不一致、Cookieの問題等）

static logout(client)

Wikidotからログアウトする

パラメータ:

client (Client) -- ログアウトするクライアントインスタンス

メモ

ログアウト処理でエラーが発生しても無視され、Cookieの削除は常に行われる。