ユーティリティモジュール

リクエストユーティリティ

class wikidot.util.requestutil.RequestUtil

ベースクラス: object

static request(client, method, urls, return_exceptions=False)

GETリクエストを送信する

パラメータ:

• client (Client) -- クライアント

• method (str) -- リクエストメソッド

• urls (list[str]) -- URLのリスト

• return_exceptions (bool) -- 例外を返すかどうか (True: 返す, False: 例外を送出) デフォルトでは例外を送出

戻り値:

レスポンスのリスト

戻り値の型:

list[httpx.Response | Exception]

文字列ユーティリティ

class wikidot.util.stringutil.StringUtil

ベースクラス: object

static to_unix(target_str)

Unix形式に文字列を変換する

パラメータ:

target_str (str) -- 変換対象の文字列

戻り値:

変換された文字列

戻り値の型:

str

クイックモジュール

class wikidot.util.quick_module.QMCUser(id, name)

ベースクラス: object

QuickModuleから返されるユーザー情報を格納するクラス

パラメータ:

• id (int)

• name (str)

id

ユーザーID

Type:

int

name

ユーザー名

Type:

str

id: int

name: str

class wikidot.util.quick_module.QMCPage(title, unix_name)

ベースクラス: object

QuickModuleから返されるページ情報を格納するクラス

パラメータ:

• title (str)

• unix_name (str)

title

ページタイトル

Type:

str

unix_name

ページのUNIX名

Type:

str

title: str

unix_name: str

class wikidot.util.quick_module.QuickModule

ベースクラス: object

static member_lookup(site_id, query)

メンバーを検索する

パラメータ:

• site_id (int) -- サイトID

• query (str) -- クエリ

戻り値:

ユーザーのリスト

戻り値の型:

list[QMCUser]

static user_lookup(site_id, query)

ユーザーを検索する

パラメータ:

• site_id (int) -- サイトID

• query (str) -- クエリ

戻り値:

ユーザーのリスト

戻り値の型:

list[QMCUser]

static page_lookup(site_id, query)

ページを検索する

パラメータ:

• site_id (int) -- サイトID

• query (str) -- クエリ

戻り値:

ページのリスト

戻り値の型:

list[QMCPage]

パーサー

wikidot.util.parser.odate.odate_parse(odate_element)

odate要素を解析し、datetimeオブジェクトを返す

パラメータ:

odate_element (bs4.Tag) -- odate要素

戻り値:

odate要素が表す日時

戻り値の型:

datetime

例外:

ValueError -- odate要素が有効なunix timeを含んでいない場合

wikidot.util.parser.user.user_parse(client, elem)

printuser要素をパースし、ユーザーオブジェクトを返す

パラメータ:

• elem (bs4.Tag) -- パース対象の要素（printuserクラスがついた要素）

• client (Client) -- クライアント

戻り値:

パースされて得られたユーザーオブジェクト User | DeletedUser | AnonymousUser | GuestUser | WikidotUser のいずれか

戻り値の型:

user.AbstractUser

文字テーブル

特殊記号・非英語アルファベットを英語アルファベットに変換するためのマッピングテーブル

このモジュールは、非ASCII文字を対応するASCII文字に変換するためのマッピングを提供する。 主にURL生成やページ名のunix形式への変換時に使用される。

wikidot.util.table.char_table.special_char_map

特殊文字からASCII文字への変換マッピング辞書

Type:

dict[str, str]