ユーザーモジュール

class wikidot.module.user.UserCollection(iterable=(), /)[ソース]

ベースクラス: list[AbstractUser]

ユーザーオブジェクトのコレクションを表すクラス

複数のユーザーオブジェクトを格納・操作するためのリスト拡張クラス。 イテレーション操作やユーザー名からの一括取得などの機能を提供する。

static from_names(client, names, raise_when_not_found=False)[ソース]

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

パラメータ:

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

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

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

戻り値:

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

戻り値の型:

UserCollection

例外:

  • NotFoundException -- raise_when_not_foundがTrueで、ユーザーが見つからない場合

  • NoElementException -- ユーザーページの解析中に必要な要素が見つからない場合

class wikidot.module.user.AbstractUser(client, id=None, name=None, unix_name=None, avatar_url=None, ip=None)[ソース]

ベースクラス: object

ユーザーオブジェクトの抽象基底クラス

すべてのユーザータイプの共通属性と機能を定義する。 このクラスを直接インスタンス化せず、派生クラスを使用する。

パラメータ:

  • client (Client)

  • id (int | None)

  • name (str | None)

  • unix_name (str | None)

  • avatar_url (str | None)

  • ip (str | None)

client

クライアントインスタンス

Type:

Client

id

ユーザーID

Type:

int | None

name

ユーザー名

Type:

str | None

unix_name

ユーザーのURLで使用されるUNIX形式の名前

Type:

str | None

avatar_url

ユーザーアバター画像のURL

Type:

str | None

ip

ユーザーのIPアドレス（匿名ユーザーの場合のみ設定される）

Type:

str | None

client: Client
id: int | None = None
name: str | None = None
unix_name: str | None = None
avatar_url: str | None = None
ip: str | None = None
class wikidot.module.user.User(client, id=None, name=None, unix_name=None, avatar_url=None, ip=None)[ソース]

ベースクラス: AbstractUser

一般のWikidotユーザーを表すクラス

登録済みの通常Wikidotユーザーを表現する。ユーザーIDやユーザー名などの基本情報を保持する。

パラメータ:

  • client (Client)

  • id (int | None)

  • name (str | None)

  • unix_name (str | None)

  • avatar_url (str | None)

  • ip (str | None)

client

クライアントインスタンス

Type:

Client

id

ユーザーID

Type:

int | None

name

ユーザー名

Type:

str | None

unix_name

ユーザーのURLで使用されるUNIX形式の名前

Type:

str | None

avatar_url

ユーザーアバター画像のURL

Type:

str | None

ip

ユーザーのIPアドレス（通常ユーザーでは取得できないためNone）

Type:

None

ip: str | None = None
static from_name(client, name, raise_when_not_found=False)[ソース]

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

パラメータ:

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

  • name (str) -- 検索対象のユーザー名

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

戻り値:

ユーザーオブジェクト

戻り値の型:

AbstractUser

例外:

  • NotFoundException -- raise_when_not_foundがTrueで、ユーザーが見つからない場合

  • NoElementException -- ユーザーページの解析中に必要な要素が見つからない場合

  • IndexError -- ユーザーが見つからない場合（raise_when_not_foundがFalseの場合）

class wikidot.module.user.DeletedUser(client, id=None, name='account deleted', unix_name='account_deleted', avatar_url=None, ip=None)[ソース]

ベースクラス: AbstractUser

削除されたWikidotユーザーを表すクラス

すでに削除されたユーザーアカウントを表現する。 削除されたユーザーには固定の「account deleted」という名前が割り当てられる。

パラメータ:

  • client (Client)

  • id (int | None)

  • name (str | None)

  • unix_name (str | None)

  • avatar_url (str | None)

  • ip (str | None)

client

クライアントインスタンス

Type:

Client

id

ユーザーID

Type:

int | None

name

ユーザー名（削除されたため"account deleted"固定）

Type:

str

unix_name

ユーザーのUNIX名（削除されたため"account_deleted"固定）

Type:

str

avatar_url

ユーザーアバターのURL（削除されたユーザーのためNone）

Type:

None

ip

ユーザーのIPアドレス（取得できないためNone）

Type:

None

id: int | None = None
name: str | None = 'account deleted'
unix_name: str | None = 'account_deleted'
avatar_url: str | None = None
ip: str | None = None
class wikidot.module.user.AnonymousUser(client, id=None, name='Anonymous', unix_name='anonymous', avatar_url=None, ip=None)[ソース]

ベースクラス: AbstractUser

匿名（非登録）のWikidotユーザーを表すクラス

登録せずに投稿した匿名ユーザーを表現する。 IPアドレスのみを識別情報として持つ。

パラメータ:

  • client (Client)

  • id (int | None)

  • name (str | None)

  • unix_name (str | None)

  • avatar_url (str | None)

  • ip (str | None)

client

クライアントインスタンス

Type:

Client

id

ユーザーID（匿名ユーザーのためNone）

Type:

None

name

ユーザー名（匿名ユーザーのため"Anonymous"固定）

Type:

str

unix_name

ユーザーのUNIX名（匿名ユーザーのため"anonymous"固定）

Type:

str

avatar_url

ユーザーアバターのURL（匿名ユーザーのためNone）

Type:

None

ip

ユーザーのIPアドレス

Type:

str

id: int | None = None
name: str | None = 'Anonymous'
unix_name: str | None = 'anonymous'
avatar_url: str | None = None
ip: str | None = None
class wikidot.module.user.GuestUser(client, id=None, name=None, unix_name=None, avatar_url=None, ip=None)[ソース]

ベースクラス: AbstractUser

ゲスト投稿したWikidotユーザーを表すクラス

名前とメールアドレスのみを入力して投稿したゲストユーザーを表現する。 ユーザー名は任意だが、IDやUNIX名は持たない。

パラメータ:

  • client (Client)

  • id (int | None)

  • name (str | None)

  • unix_name (str | None)

  • avatar_url (str | None)

  • ip (str | None)

client

クライアントインスタンス

Type:

Client

id

ユーザーID（ゲストユーザーのためNone）

Type:

None

name

ユーザー名（ゲスト投稿時に指定した名前）

Type:

str | None

unix_name

ユーザーのUNIX名（ゲストユーザーのためNone）

Type:

None

avatar_url

ユーザーアバターのURL（Gravatarの場合あり）

Type:

str | None

ip

ユーザーのIPアドレス（取得できないためNone）

Type:

None

id: int | None = None
name: str | None = None
unix_name: str | None = None
avatar_url: str | None = None
ip: str | None = None
class wikidot.module.user.WikidotUser(client, id=None, name='Wikidot', unix_name='wikidot', avatar_url=None, ip=None)[ソース]

ベースクラス: AbstractUser

Wikidotシステムユーザーを表すクラス

Wikidotシステムによる自動投稿や通知を表現するための特殊ユーザー。 "Wikidot"という固定の名前を持つ。

パラメータ:

  • client (Client)

  • id (int | None)

  • name (str | None)

  • unix_name (str | None)

  • avatar_url (str | None)

  • ip (str | None)

client

クライアントインスタンス

Type:

Client

id

ユーザーID（システムユーザーのためNone）

Type:

None

name

ユーザー名（システムユーザーのため"Wikidot"固定）

Type:

str

unix_name

ユーザーのUNIX名（システムユーザーのため"wikidot"固定）

Type:

str

avatar_url

ユーザーアバターのURL（システムユーザーのためNone）

Type:

None

ip

ユーザーのIPアドレス（取得できないためNone）

Type:

None

id: int | None = None
name: str | None = 'Wikidot'
unix_name: str | None = 'wikidot'
avatar_url: str | None = None
ip: str | None = None