pyskey package

Client

class pyskey.client.Event(func)[ソース]

ベースクラス: object

wrapper(instance)[ソース]

class pyskey.client.Client(*, address: str, token: str, connect_websocket: bool = False)[ソース]

ベースクラス: object

Pyskeyのクライアントクラス。以下の方法で呼び出すことを推奨します。

client = pyskey.Client(address="misskey.example.com", token="xxxxxxxxxx")

クラスを継承する方法でも呼び出せるかもしれません。(未検証)

イベントを追加するには、デコレータを使用するか、add_event関数を使用します。

client = pyskey.Client(address="misskey.example.com", token="xxxxxxxxxx")

# デコレータを使う方法
@client.event
async def on_ready():
        print(f"{client.me.name} ( {client.me.username} ) にログインしました - デコレータ")

# add_event関数を使う方法
async def ready_event():
        print(f"{client.me.name} ( {client.me.username} ) にログインしました - add_event関数")
add_event("on_ready", ready_event)

client.run()

address

token

http

me

connect_websocket

is_closed

event(func)[ソース]

async on_ready()[ソース]: run()関数を実行後、ログインできたときに発火されます。

add_event(event_name: str, func: LambdaType)[ソース]

イベントを登録します。この関数を使う方法のほかに、デコレータを利用してイベントを登録する方法もあります。

パラメータ:

event_name (str) -- 登録するイベントの名前。間違っていてもエラーは出ません。
func (FunctionType) -- イベントが実行される関数。

async close()[ソース]: 初期化したPyskeyをクローズします。プログラムの途中でこの関数を呼ぶのはお勧めしません。

run()[ソース]: ログインを試みます。

async start()[ソース]

async create_note(text: str, *, visibility: NoteVisibility = 'public', visibleUserIds: list | None = None, cw: str | None = None, localOnly: bool = False, reactionAcceptance: ReactionAcceptance | None = None, noExtractMentions: bool = False, noExtractHashtags: bool = False, noExtractEmojis: bool = False, replyId: str | None = None, renoteId: str | None = None, fileIds: list | None = None, mediaIds: list | None = None, poll: Poll | None = None) → Note[ソース]

ノートを作成します。

パラメータ:

text (str) -- ノートの本文。
visibility (NoteVisibility = NoteVisibility.public) -- ノートの公開範囲。
visibleUserIds (list = None) -- ノートを公開するユーザーのリスト。 visibilityをNoteVisibility.specifiedにしたときに指定します。
cw (str = None) -- ノートの注訳。これをNone以外に指定した場合、ノートが閲覧注意になります。
localOnly (str = False) -- ノートを連合しないかどうか。
reactionAcceptance (ReactionAcceptance = ReactionAcceptance.all) -- リアクションの許可範囲。
noExtractMentions (bool = False) -- メンションを展開するかどうか。
noExtractHashtags (bool = False) -- ハッシュタグを展開するかどうか。
noExtractEmojis (bool = False) -- 絵文字を展開するかどうか。
replyId (str = None) -- 返信先ノートのID。 Note.reply_note関数で代用できます。
renoteId (str = None) -- リノート先ノートのID。 Note.renote_note関数で代用できます。また、これを指定した場合、textを""(空欄)にするとただのリノートになります。それ以外の場合は引用リノートになります。
fileIds (list = None) -- 添付ファイルのIDのリスト。
mediaIds (list = None) -- 添付メディアファイルのIDのリスト。

poll (Poll = None) --

アンケート。以下のようにして作成します。

poll = pyskey.Poll(
        choices=["選択肢1", "選択肢2", "選択肢3"]
)
await misskey.create_note(
        "アンケートのテスト",
        poll=poll,
)

戻り値:

作成したNoteのインスタンス。

戻り値の型:

Note

HTTP

class pyskey.http.HTTP(address: str, token: str, loop: AbstractEventLoop | None = None)[ソース]

ベースクラス: object

async post(address: str, data: dict = {})[ソース]: POSTリクエストを送信します。

async close()[ソース]: HTTPセッションをクローズします。プログラム終了時に自動で呼び出されるため、手動で呼び出すのはお勧めしません。

Utils

class pyskey.utils.utils[ソース]

ベースクラス: object

classmethod to_datetime(date: str | int | datetime)[ソース]: dateにstrを渡した場合はdatetime.strptime関数で、intを渡した場合はdatetime.fromtimestampを返すユーティリティ関数です。

Errors

Enums

Object

Pyskeyでのオブジェクトの基底クラス。

MeDetailed

自分の情報。内部的には /api/i から取得します。

User

misskeyのユーザー。

Note

misskeyのノート。

Role

misskeyのロール。

Poll

misskeyの投票。

Channel

Achievement

misskeyの実績。

AvatarDecoration

AvatarDecoration(id: str = '', angle: float = 0.0, flipH: bool = False, url: str = '', offsetX: float = 0.0, offsetY: float = 0.0)

BadgeRole

BadgeRole(name: str = '', iconUrl: str = '', displayOrder: int = 0, behavior: str = '')

Folder

misskeyのフォルダ。

File

misskeyのファイル。