From 5f9c954f6fb1af293a8ca63814a44ba24767a713 Mon Sep 17 00:00:00 2001 From: actions-user Date: Sat, 31 Aug 2024 15:42:10 +0000 Subject: [PATCH] Generate docs --- docs/index.md | 26 +++++++ docs/nicovideo.md | 179 +++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 203 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 615c92b..56e7d55 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,7 +15,33 @@ documentation for details. * [`ContentNotFoundError`](nicovideo.md#nicovideo.errors.ContentNotFoundError) * [`FrozenInstanceError`](nicovideo.md#nicovideo.errors.FrozenInstanceError) * [nicovideo.user module](nicovideo.md#module-nicovideo.user) + * [`APIResponse`](nicovideo.md#nicovideo.user.APIResponse) + * [`APIResponse.user_id`](nicovideo.md#nicovideo.user.APIResponse.user_id) + * [`APIResponse.nickname`](nicovideo.md#nicovideo.user.APIResponse.nickname) + * [`APIResponse.description`](nicovideo.md#nicovideo.user.APIResponse.description) + * [`APIResponse.subscription`](nicovideo.md#nicovideo.user.APIResponse.subscription) + * [`APIResponse.version`](nicovideo.md#nicovideo.user.APIResponse.version) + * [`APIResponse.followee`](nicovideo.md#nicovideo.user.APIResponse.followee) + * [`APIResponse.follower`](nicovideo.md#nicovideo.user.APIResponse.follower) + * [`APIResponse.level`](nicovideo.md#nicovideo.user.APIResponse.level) + * [`APIResponse.exp`](nicovideo.md#nicovideo.user.APIResponse.exp) + * [`APIResponse.sns`](nicovideo.md#nicovideo.user.APIResponse.sns) + * [`APIResponse.cover`](nicovideo.md#nicovideo.user.APIResponse.cover) + * [`APIResponse.icon`](nicovideo.md#nicovideo.user.APIResponse.icon) + * [`APIResponse.videolist`](nicovideo.md#nicovideo.user.APIResponse.videolist) * [`get_metadata()`](nicovideo.md#nicovideo.user.get_metadata) * [nicovideo.video module](nicovideo.md#module-nicovideo.video) + * [`APIResponse`](nicovideo.md#nicovideo.video.APIResponse) + * [`APIResponse.nicovideo_id`](nicovideo.md#nicovideo.video.APIResponse.nicovideo_id) + * [`APIResponse.title`](nicovideo.md#nicovideo.video.APIResponse.title) + * [`APIResponse.update`](nicovideo.md#nicovideo.video.APIResponse.update) + * [`APIResponse.description`](nicovideo.md#nicovideo.video.APIResponse.description) + * [`APIResponse.duration`](nicovideo.md#nicovideo.video.APIResponse.duration) + * [`APIResponse.upload_date`](nicovideo.md#nicovideo.video.APIResponse.upload_date) + * [`APIResponse.thumbnail`](nicovideo.md#nicovideo.video.APIResponse.thumbnail) + * [`APIResponse.counters`](nicovideo.md#nicovideo.video.APIResponse.counters) + * [`APIResponse.genre`](nicovideo.md#nicovideo.video.APIResponse.genre) + * [`APIResponse.cached_uploader`](nicovideo.md#nicovideo.video.APIResponse.cached_uploader) + * [`APIResponse.uploader`](nicovideo.md#nicovideo.video.APIResponse.uploader) * [`get_metadata()`](nicovideo.md#nicovideo.video.get_metadata) * [Module contents](nicovideo.md#module-nicovideo) diff --git a/docs/nicovideo.md b/docs/nicovideo.md index 6c5123a..b9b3e53 100644 --- a/docs/nicovideo.md +++ b/docs/nicovideo.md @@ -33,6 +33,104 @@ Bases: `AttributeError` このモジュールは、ニコニコのユーザを扱います。 +### *class* nicovideo.user.APIResponse + +Bases: `object` + +ユーザの詳細 (e.g. ニックネーム, 投稿動画, etc.) を格納するクラスです。 + +#### user_id + +ニコニコ動画でのID (e.g. 9003560) + +* **Type:** + int + +#### nickname + +ニックネーム + +* **Type:** + str + +#### description + +ユーザ説明欄 + +* **Type:** + tuple[*Annoatated*[str, “HTML”], *Annotated*[str, “Plain”]] + +#### subscription + +会員種別 (プレミアム会員もしくは一般会員) + +* **Type:** + *Literal*[“premium”, “general”] + +#### version + +登録時のニコニコのバージョン (e.g. eR) + +* **Type:** + str + +#### followee + +フォロイー数 (フォロー数) + +* **Type:** + int + +#### follower + +フォロワー数 + +* **Type:** + int + +#### level + +ユーザレベル + +* **Type:** + int + +#### exp + +ユーザEXP + +* **Type:** + int + +#### sns + +連携されているSNS + +* **Type:** + frozenset[tuple[*Annotated*[str, “SNSの名前”], *Annotated*[str, “SNSのユーザ名”], *Annotated*[str, “SNSのアイコン (PNG)”]]] + +#### cover + +ユーザのカバー画像 + +* **Type:** + *Optional*[tuple[*Annotated*[str, “PC用画像のURL”], *Annotated*[str, “OGP用画像のURL”], *Annotated*[str, “SP用画像のURL”]]] + +#### icon + +ユーザアイコン + +* **Type:** + tuple[*Annotated*[str, “小アイコン画像のURL”], *Annotated*[str, “大アイコン画像のURL”]] + +#### *property* videolist *: Generator[APIResponseFromServer, None, None]* + +ユーザが投稿した動画を一つずつ、video.APIResponseにしてからyieldします。 +nextごとにニコニコ動画でのAPIリクエストが発生するため、注意してください。 + +* **Yields:** + *video.APIResponse* – ユーザの投稿動画 + ### nicovideo.user.get_metadata(user_id: int) ニコニコのAPIサーバからユーザ情報を取得します。 @@ -42,7 +140,7 @@ Bases: `AttributeError` * **Returns:** 取得結果 * **Return type:** - APIResponse + [APIResponse](#nicovideo.user.APIResponse) * **Raises:** * [**errors.ContentNotFoundError**](#nicovideo.errors.ContentNotFoundError) – 指定された動画が存在しなかった場合に送出。 * [**errors.APIRequestError**](#nicovideo.errors.APIRequestError) – ニコニコのAPIサーバへのリクエストに失敗した場合に送出。 @@ -57,6 +155,83 @@ Bases: `AttributeError` このモジュールは、ニコニコの動画を取り扱います。 +### *class* nicovideo.video.APIResponse + +Bases: `object` + +動画の詳細（e.g. タイトル, 概要, etc.）を格納するクラスです。 + +#### nicovideo_id + +ニコニコ動画での動画ID (e.g. sm9) + +* **Type:** + str + +#### title + +動画のタイトル + +* **Type:** + str + +#### update + +このオブジェクトに格納されている情報の取得時刻 + +* **Type:** + datetime.datetime + +#### description + +動画説明欄 + +* **Type:** + str + +#### duration + +動画の長さ + +* **Type:** + str + +#### upload_date + +動画の投稿時間 + +* **Type:** + datetime.datetime + +#### thumbnail + +サムネイル + +* **Type:** + dict[*Literal*[“large”, “middle”, “ogp”, “player”, “small”], str] + +#### counters + +各種カウンタ + +* **Type:** + dict[*Literal*[“comment”, “like”, “mylist”, “view”], str] + +#### genre + +動画ジャンル + +* **Type:** + *Optional*[dict[*Literal*[“label”, “key”], str]] + +#### *property* cached_uploader *: [APIResponse](#nicovideo.user.APIResponse)* + +動画の投稿者を取得する。（初回にキャッシュするので最新ではない可能性がある。） + +#### *property* uploader *: [APIResponse](#nicovideo.user.APIResponse)* + +動画の投稿者を取得する。 + ### nicovideo.video.get_metadata(video_id: str) ニコニコのAPIサーバから動画情報を取得します。 @@ -66,7 +241,7 @@ Bases: `AttributeError` * **Returns:** 取得結果 * **Return type:** - APIResponse + [APIResponse](#nicovideo.video.APIResponse) * **Raises:** * [**errors.ContentNotFoundError**](#nicovideo.errors.ContentNotFoundError) – 指定された動画が存在しなかった場合に送出。 * [**errors.APIRequestError**](#nicovideo.errors.APIRequestError) – ニコニコのAPIサーバへのリクエストに失敗した場合に送出。