sphinx-quickstart on Wed Aug 11 23:04:59 2021. You can adapt this file completely to your liking, but it should at least contain the root toctree directive.

get-manaba のドキュメントへようこそ！¶

Library for get various information about manaba.

manabaのさまざまな情報を取得するためのライブラリです。

class manaba.Manaba(base_url: str)¶

manaba 基本ライブラリ

login(username: str, password: str) → bool¶

manaba にログインする

パラメータ

username -- manaba ユーザー名
password -- manaba パスワード

戻り値

ログインできたか

戻り値の型

bool

get_course(course_id: int) → manaba.models.ManabaCourse.ManabaCourse¶

指定したコース ID のコース情報(ManabaCourse)を取得します。

パラメータ: course_id -- 取得するコースのコース ID
戻り値: 取得するコースのコース ID
戻り値の型: ManabaCourse

get_courses() → list[manaba.models.ManabaCourse.ManabaCourse]¶

参加しているコース情報を取得する

戻り値: 参加しているコース情報
戻り値の型: list[ManabaCourse]

メモ

詳細情報は manaba.Manaba.get_course() で取得できます。

get_courses_all() → list[manaba.models.ManabaCourse.ManabaCourse]¶

参加しているすべてのコース情報を取得する

戻り値: 参加しているすべてのコース情報
戻り値の型: list[ManabaCourse]

メモ

詳細情報は manaba.Manaba.get_course() で取得できます。

get_querys(course_id: int) → list[manaba.models.ManabaQuery.ManabaQuery]¶

指定したコースの小テスト一覧を取得します。

パラメータ: course_id -- 取得するコースのコース ID
戻り値: コースの小テスト一覧
戻り値の型: list[ManabaQuery]

メモ

詳細情報は manaba.Manaba.get_query() で取得できます。

get_query(course_id: int, query_id: int) → manaba.models.ManabaQueryDetails.ManabaQueryDetails¶

指定したコース・小テスト ID の小テスト詳細情報を取得します。

パラメータ

course_id -- 取得する小テストのコース ID
query_id -- 取得する小テストの小テスト ID

戻り値

小テスト詳細情報

戻り値の型

ManabaQueryDetails

get_drill(course_id: int, drill_id: int) → manaba.models.ManabaDrillDetails.ManabaDrillDetails¶

指定したコース・小テスト ID の小テスト詳細情報を取得します。

パラメータ

course_id -- 取得する小テストドリルのコース ID
drill_id -- 取得する小テストドリルの小テスト ID

戻り値

小テストドリル詳細情報

戻り値の型

ManabaDrillDetails

get_surveys(course_id: int) → list[manaba.models.ManabaSurvey.ManabaSurvey]¶

指定したコースのアンケート一覧を取得します。

パラメータ: course_id -- 取得するコースのコース ID
戻り値: コースのアンケート一覧
戻り値の型: list[ManabaSurvey]

メモ

詳細情報は manaba.Manaba.get_survey() で取得できます。

get_survey(course_id: int, survey_id: int) → manaba.models.ManabaSurveyDetails.ManabaSurveyDetails¶

指定したコース・アンケート ID のアンケート詳細情報を取得します。

パラメータ

course_id -- 取得するアンケートのコース ID
survey_id -- 取得するアンケートのアンケート ID

戻り値

アンケート詳細情報

戻り値の型

ManabaSurveyDetails

get_reports(course_id: int) → list[manaba.models.ManabaReport.ManabaReport]¶

指定したコースのレポート一覧を取得します。

パラメータ: course_id -- 取得するコースのコース ID
戻り値: コースのレポート一覧
戻り値の型: list[ManabaReport]

メモ

詳細情報は manaba.Manaba.get_report() で取得できます。

get_report(course_id: int, report_id: int) → manaba.models.ManabaReportDetails.ManabaReportDetails¶

指定したコース・レポート ID のレポート詳細情報を取得します。

パラメータ

course_id -- 取得するレポートのコース ID
report_id -- 取得するレポートのレポート ID

戻り値

レポート詳細情報

戻り値の型

ManabaReportDetails

get_threads(course_id: int) → list[manaba.models.ManabaThread.ManabaThread]¶

指定したコースのスレッド一覧を取得します。

パラメータ: course_id -- 取得するコースのコース ID
戻り値: コースのスレッド一覧
戻り値の型: list[ManabaThread]

メモ

詳細情報は manaba.Manaba.get_thread() で取得できます。

get_thread(course_id: int, thread_id: int, start_id: Optional[int] = None, page_len: int = 10000) → manaba.models.ManabaThread.ManabaThread¶

指定したコース・スレッド ID のスレッド詳細情報を取得します。

パラメータ

course_id -- 取得するコースのコース ID
thread_id -- 取得するスレッドのスレッド ID
start_id -- 直近から何番目から取得するか (指定しない場合はすべて)
page_len -- 1 ページで最大何件コメント取得するか (指定しない場合は 10000 件)

戻り値

スレッド詳細情報

戻り値の型

ManabaThread

メモ

start_id の仕様は manaba 自体の仕様ですが、特殊です。スレッドのコメント数が 50 個ある場合、start_id に 5 を指定すると 45 件目以前を取得します。

get_news_list(course_id: int, start_id: Optional[int] = None, page_len: int = 10000) → list[manaba.models.ManabaCourseNews.ManabaCourseNews]¶

指定したコースのコースニュース一覧を取得します。

パラメータ

course_id -- 取得するコースのコース ID
start_id -- 直近から何番目から取得するか (指定しない場合はすべて)
page_len -- 1 ページで最大何件コメント取得するか (指定しない場合は 10000 件)

戻り値

コースのニュース一覧

戻り値の型

list[ManabaCourseNews]

メモ

一部の項目のプロパティは None になります。詳細情報は manaba.Manaba.get_news() で取得できます。

get_news(course_id: int, news_id: int) → manaba.models.ManabaCourseNews.ManabaCourseNews¶

指定したコース・ニュース ID のニュース詳細情報を取得します。

パラメータ

course_id -- 取得するコースのコース ID
news_id -- 取得するニュースのニュース ID

get_contents(course_id: int) → list[manaba.models.ManabaContent.ManabaContent]¶

指定したコースのコンテンツ一覧を取得します。

パラメータ: course_id -- 取得するコースのコース ID
戻り値: コースのコンテンツ一覧
戻り値の型: list[ManabaContent]

メモ

一部の項目のプロパティは None になります。詳細情報は manaba.Manaba.get_content_pages() で取得できます。

get_content_pages(content_id: str) → list[manaba.models.ManabaContentPage.ManabaContentPage]¶

指定したコンテンツ ID のコンテンツページ一覧を取得します。

パラメータ: content_id -- 取得するコンテンツのコンテンツ ID

メモ

一部の項目のプロパティは None になります。詳細情報は manaba.Manaba.get_content_page() で取得できます。

get_content_page(content_id: str, page_id: int) → manaba.models.ManabaContentPage.ManabaContentPage¶

指定したコンテンツ ID のコンテンツページ詳細を取得します。

パラメータ

content_id -- 取得するコンテンツページのコンテンツ ID
page_id -- 取得するコンテンツページのコンテンツページ ID

get_latest_response() → Optional[requests.models.Response]¶

最後のレスポンスを返します。デバッグのために利用することを想定しています。

戻り値: レスポンス (ない場合は None)
戻り値の型: Optional[Response]

static process_datetime(datetime_str: Optional[str]) → Optional[datetime.datetime]¶

manabaの日時テキスト(YYYY-MM-DD HH:MM:SS)から datetime.datetime に変換する

パラメータ: datetime_str -- manabaの日時テキスト
戻り値: 変換後の datetime.datetime
戻り値の型: Optional[datetime.datetime]

exception manaba.ManabaNotLoggedIn¶: manaba にログインしている必要があるがしていない

exception manaba.ManabaNotFound¶: manaba のコース等ページにアクセスしたが、そのページが見つからなかった

exception manaba.ManabaInternalError¶: 処理に失敗した

exception manaba.ManabaContentDisabled¶: コンテンツページが無効化（公開期間外などにより）されている

manaba コンテンツ

class manaba.models.ManabaContent.ManabaContent(course_id: int, content_id: str, title: str, description: str, updated_at: Optional[datetime.datetime], pages: Optional[list[manaba.models.ManabaContentPage.ManabaContentPage]])¶

manaba コンテンツ

property course_id: int¶

コース ID (URLの一部) ※コースコードではない

戻り値: コース ID
戻り値の型: int

property content_id: str¶

コンテンツ ID (URLの一部)

戻り値: コンテンツ ID
戻り値の型: str

property title: str¶

コンテンツタイトル

戻り値: コンテンツタイトル
戻り値の型: str

property description: str¶

説明文

戻り値: 説明文
戻り値の型: str

property updated_at: Optional[datetime.datetime]¶

更新日時

戻り値: 更新日時
戻り値の型: Optional[datetime.datetime]

property pages: Optional[list[manaba.models.ManabaContentPage.ManabaContentPage]]¶

コンテンツ内のページ

戻り値: コンテンツ内のページ
戻り値の型: Optional[list[ManabaContentPage]]

manaba コンテンツページ

class manaba.models.ManabaContentPage.ManabaContentPage(course_id: int, content_id: str, page_id: int, title: str, author: Optional[str], version: Optional[str], viewable: Optional[bool], last_edited_at: Optional[datetime.datetime], publish_start_at: Optional[datetime.datetime], publish_end_at: Optional[datetime.datetime], html: Optional[str])¶

manaba コンテンツページ

add_file(file: manaba.models.ManabaFile.ManabaFile) → None¶

添付ファイルを追加する

パラメータ: file -- ManabaFile オブジェクト

property course_id: int¶

コース ID (URLの一部) ※コースコードではない

戻り値: コース ID
戻り値の型: int

property content_id: str¶

コンテンツ ID (URLの一部)

戻り値: コンテンツ ID
戻り値の型: str

property page_id: int¶

ページ ID (URLの一部)

戻り値: ページ ID
戻り値の型: str

property title: str¶

コンテンツページタイトル

戻り値: コンテンツページタイトル
戻り値の型: str

property author: Optional[str]¶

ページの作成者

戻り値: ページ作成者
戻り値の型: str

メモ

Manaba.get_content_pages で取得した場合、この項目は None になります。Manaba.get_content_page でページ詳細情報を取得してください。

property version: Optional[str]¶

ページバージョン（版）

戻り値: ページバージョン（版）
戻り値の型: Optional[str]

メモ

Manaba.get_content_pages で取得した場合、この項目は None になります。Manaba.get_content_page でページ詳細情報を取得してください。

property viewable: Optional[bool]¶

閲覧可能か

戻り値: 閲覧可能か
戻り値の型: Optional[bool]

メモ

Manaba.get_content_pages で取得した場合、この項目は None になります。Manaba.get_content_page でページ詳細情報を取得してください。

property last_edited_at: Optional[datetime.datetime]¶

最終更新日時

戻り値: 最終更新日時
戻り値の型: Optional[datetime.datetime]

メモ

Manaba.get_content_pages で取得した場合、この項目は None になります。Manaba.get_content_page でページ詳細情報を取得してください。

property publish_start_at: Optional[datetime.datetime]¶

公開期間開始日時

戻り値: 公開期間開始日時
戻り値の型: Optional[datetime.datetime]

メモ

Manaba.get_content_pages で取得した場合、この項目は None になります。Manaba.get_content_page でページ詳細情報を取得してください。

property publish_end_at: Optional[datetime.datetime]¶

公開期間終了日時

戻り値: 公開期間終了日時
戻り値の型: Optional[datetime.datetime]

メモ

Manaba.get_content_pages で取得した場合、この項目は None になります。Manaba.get_content_page でページ詳細情報を取得してください。

property html: Optional[str]¶

ページの HTML

戻り値: ページの HTML
戻り値の型: Optional[str]

メモ

Manaba.get_content_pages で取得した場合、この項目は None になります。Manaba.get_content_page でページ詳細情報を取得してください。

viewable が false の場合、この項目は None になります。

property files: list[manaba.models.ManabaFile.ManabaFile]¶

ページに添付されているファイルの一覧

戻り値: ページに添付されているファイルの一覧
戻り値の型: list[ManabaFile]

メモ

この項目は、取得できないもしくは存在しなかったとしても空のリストになります。

manaba コース情報

class manaba.models.ManabaCourse.ManabaCourse(name: str, course_id: int, year: Optional[int], lecture_at: Optional[str], teacher: Optional[str], status_lamps: Optional[manaba.models.ManabaCourseLamps.ManabaCourseLamps])¶

manaba コース情報

property name: str¶

コース名

戻り値: コースの名称
戻り値の型: str

property course_id: int¶

コース ID (URLの一部) ※コースコードではない

戻り値: コース ID
戻り値の型: int

property year: Optional[int]¶

コースの年度

戻り値: コースの年度
戻り値の型: Optional[int]

メモ

コース一覧にて曜日表示を利用している場合、この項目は None になる可能性があります。

property lecture_at: Optional[str]¶

コース年度・時限

戻り値: コースの年度および時限 (取得できない場合 None)
戻り値の型: Optional[str]

property teacher: Optional[str]¶

コースの担当教員名

戻り値: コースの担当教員名 (取得できない場合 None)
戻り値の型: Optional[str]

property status_lamps: Optional[manaba.models.ManabaCourseLamps.ManabaCourseLamps]¶

コースのステータスランプ

戻り値: コースのステータスランプ
戻り値の型: Optional[ManabaCourseLamps]

メモ

コース一覧にて曜日表示を利用している場合、この項目は None になる可能性があります。

manaba コース一覧ページに表示されるランプ管理クラス

class manaba.models.ManabaCourseLamps.ManabaCourseLamps(news: bool, deadline: bool, grad: bool, thread: bool, individual: bool)¶

manaba コース一覧ページに表示されるランプ管理クラス

property news: bool¶

コースニュースランプ

戻り値: newsランプが点いているか
戻り値の型: bool

property deadline: bool¶

デッドラインランプ (課題ランプ)

戻り値: デッドラインランプが点いているか
戻り値の型: bool

property grad: bool¶

グラッドランプ (成績ランプ)

戻り値: 成績ランプが点いているか
戻り値の型: bool

property thread: bool¶

スレッドランプ

戻り値: スレッドランプが点いているか
戻り値の型: bool

property individual: bool¶

個人ランプ (コレクション)

戻り値: 個人ランプが点いているか
戻り値の型: bool

manaba コースニュース

class manaba.models.ManabaCourseNews.ManabaCourseNews(course_id: int, news_id: int, title: str, author: str, posted_at: Optional[datetime.datetime], last_edited_author: Optional[str], last_edited_at: Optional[datetime.datetime], html: Optional[str])¶

manaba コースニュース

add_file(file: manaba.models.ManabaFile.ManabaFile) → None¶

添付ファイルを追加する

パラメータ: file -- ManabaFile オブジェクト

property course_id: int¶

コース ID (URLの一部) ※コースコードではない

戻り値: コース ID
戻り値の型: int

property news_id: int¶

ニュース ID (URLの一部)

戻り値: ニュース ID
戻り値の型: int

property title: str¶

ニュースタイトル

戻り値: ニュースタイトル
戻り値の型: str

property author: str¶

投稿者名

戻り値: 投稿者名
戻り値の型: str

property posted_at: Optional[datetime.datetime]¶

投稿時刻

戻り値: 投稿時刻
戻り値の型: Optional[datetime.datetime]

property last_edited_author: Optional[str]¶

最終更新者

戻り値: 最終更新者
戻り値の型: Optional[str]

property last_edited_at: Optional[datetime.datetime]¶

最終更新日時

戻り値: 最終更新日時
戻り値の型: Optional[datetime.datetime]

property html: Optional[str]¶

ニュースの HTML

戻り値: コメントの HTML
戻り値の型: Optional[str]

property files: list[manaba.models.ManabaFile.ManabaFile]¶

ニュースに添付されているファイルの一覧

戻り値: コメントに添付されているファイルの一覧
戻り値の型: list[ManabaFile]

メモ

この項目は、取得できないもしくは存在しなかったとしても空のリストになります。

manaba ファイル

class manaba.models.ManabaFile.ManabaFile(parent: manaba.models.ManabaModel.ManabaModel, name: str, uploaded_at: Optional[datetime.datetime], download_url: str)¶

manaba ファイル

メモ

このモデルは manaba.models.ManabaContentPage・manaba.models.ManabaCourseNews・manaba.models.ManabaThreadComment で使用されます。

property parent: manaba.models.ManabaModel.ManabaModel¶

親モデル (例えば、ManabaContentPage・ManabaCourseNews・ManabaThreadComment)

戻り値: 親モデル
戻り値の型: ManabaModel

property name: str¶

ファイル名

戻り値: ファイル名
戻り値の型: str

property uploaded_at: Optional[datetime.datetime]¶

アップロード日時

戻り値: アップロード日時
戻り値の型: Optional[datetime.datetime]

property download_url: str¶

ファイルダウンロード URL

戻り値: ファイルダウンロード URL
戻り値の型: str

manaba 成績ポジション

class manaba.models.ManabaGradePosition.ManabaGradePosition(below_percent: Optional[int], _my_pos_percent: int, above_percent: Optional[int])¶

manaba 成績ポジション

property below_percent: Optional[int]¶

自分より下の成績割合

戻り値: 自分より下の成績割合
戻り値の型: int

property my_pos_percent: int¶

自分の成績と同じメンバーの割合

戻り値: 自分の成績と同じメンバーの割合
戻り値の型: int

property above_percent: Optional[int]¶

自分より上の成績割合

戻り値: 自分より上の成績割合
戻り値の型: int

manaba モデル群

class manaba.models.ManabaModel.ManabaModel¶: manaba モデル群

manaba ポートフォリオ種別 (小テスト・アンケート・レポート)

class manaba.models.ManabaPortfolioType.ManabaPortfolioType(value)¶: manaba ポートフォリオ種別 (小テスト)

manaba.models.ManabaPortfolioType.get_portfolio_type_from_name(name: Optional[str]) → Optional[manaba.models.ManabaPortfolioType.ManabaPortfolioType]¶

メンバー名称を指定して列挙メンバーを取得します

パラメータ: name -- メンバー名称
戻り値: 該当する列挙メンバー、ないか、入力値が None なら None
戻り値の型: Optional[ManabaPortfolioType]

manaba.models.ManabaPortfolioType.get_portfolio_type(showing_name: Optional[str]) → Optional[manaba.models.ManabaPortfolioType.ManabaPortfolioType]¶

表示名を指定して列挙メンバーを取得します (合致、もしくは包含)

パラメータ: showing_name -- 表示名
戻り値: 該当する列挙メンバー、なければ None
戻り値の型: Optional[ManabaPortfolioType]

manaba 小テスト

class manaba.models.ManabaQuery.ManabaQuery(course_id: int, query_id: int, title: str, status: manaba.models.ManabaTaskStatus.ManabaTaskStatus, status_lamp: bool, reception_start_time: Optional[datetime.datetime], reception_end_time: Optional[datetime.datetime], is_drill: bool)¶

manaba 小テスト

property course_id: int¶

コース ID (URLの一部) ※コースコードではない

戻り値: コース ID
戻り値の型: int

property query_id: int¶

小テスト ID (URLの一部)

戻り値: ID
戻り値の型: int

property title: str¶

小テストタイトル

戻り値: タイトル
戻り値の型: str

property status: manaba.models.ManabaTaskStatus.ManabaTaskStatus¶

ステータス

戻り値: ステータス
戻り値の型: ManabaTaskStatus

property status_lamp: bool¶

ステータスランプ

戻り値: ステータスランプが点いているか
戻り値の型: bool

property reception_start_time: Optional[datetime.datetime]¶

開始日時

戻り値: 受付開始日時
戻り値の型: Optional[datetime.datetime]

property reception_end_time: Optional[datetime.datetime]¶

終了日時

戻り値: 受付終了日時
戻り値の型: Optional[datetime.datetime]

property is_drill: Optional[bool]¶

ドリルかどうか

戻り値: ドリルかどうか
戻り値の型: Optional[bool]

manaba 小テスト詳細

class manaba.models.ManabaQueryDetails.ManabaQueryDetails(course_id: int, query_id: int, title: str, description: Optional[str], reception_start_time: Optional[datetime.datetime], reception_end_time: Optional[datetime.datetime], portfolio_type: Optional[manaba.models.ManabaPortfolioType.ManabaPortfolioType], result_view_type: Optional[manaba.models.ManabaResultViewType.ManabaResultViewType], status: Optional[manaba.models.ManabaTaskStatus.ManabaTaskStatus], grade: Union[None, int], position: Optional[manaba.models.ManabaGradePosition.ManabaGradePosition])¶

manaba 小テスト詳細

property course_id: int¶

コース ID (URLの一部) ※コースコードではない

戻り値: コース ID
戻り値の型: int

property query_id: int¶

小テスト ID

戻り値: ID
戻り値の型: int

property title: str¶

タイトル

戻り値: タイトル
戻り値の型: str

property description: Optional[str]¶

課題に関する説明

戻り値: 課題に関する説明
戻り値の型: str

property reception_start_time: Optional[datetime.datetime]¶

受付開始日時

戻り値: 受付開始日時
戻り値の型: Optional[datetime.datetime]

property reception_end_time: Optional[datetime.datetime]¶

受付終了日時

戻り値: 受付終了日時
戻り値の型: Optional[datetime.datetime]

property portfolio_type: Optional[manaba.models.ManabaPortfolioType.ManabaPortfolioType]¶

ポートフォリオ種別

戻り値: ポートフォリオ種別
戻り値の型: ManabaPortfolioType

property result_view_type: Optional[manaba.models.ManabaResultViewType.ManabaResultViewType]¶

採点結果と正解の公開

戻り値: 採点結果と正解の公開
戻り値の型: ManabaResultViewType

property status: Optional[manaba.models.ManabaTaskStatus.ManabaTaskStatus]¶

課題の状態

戻り値: 状態
戻り値の型: ManabaTaskStatus

property grade: Union[None, int]¶

成績

戻り値: 成績 (点数が付けられていない場合は None。例えば未提出、回答公開待ち)
戻り値の型: Union[None, int]

property position: Optional[manaba.models.ManabaGradePosition.ManabaGradePosition]¶

成績のポジション

戻り値: 成績のポジション
戻り値の型: ManabaGradePosition

manaba レポート

class manaba.models.ManabaReport.ManabaReport(course_id: int, report_id: int, title: str, status: manaba.models.ManabaTaskStatus.ManabaTaskStatus, status_lamp: bool, reception_start_time: Optional[datetime.datetime], reception_end_time: Optional[datetime.datetime])¶

manaba レポート

property course_id: int¶

コース ID (URLの一部) ※コースコードではない

戻り値: コース ID
戻り値の型: int

property report_id: int¶

アンケート ID (URLの一部)

戻り値: ID
戻り値の型: int

property title: str¶

アンケートタイトル

戻り値: タイトル
戻り値の型: str

property status: manaba.models.ManabaTaskStatus.ManabaTaskStatus¶

ステータス

戻り値: ステータス
戻り値の型: ManabaTaskStatus

property status_lamp: bool¶

ステータスランプ

戻り値: ステータスランプが点いているか
戻り値の型: bool

property reception_start_time: Optional[datetime.datetime]¶

開始日時

戻り値: 開始日時
戻り値の型: Optional[datetime.datetime]

property reception_end_time: Optional[datetime.datetime]¶

終了日時

戻り値: 終了日時
戻り値の型: Optional[datetime.datetime]

manaba レポート詳細

class manaba.models.ManabaReportDetails.ManabaReportDetails(course_id: int, report_id: int, title: str, description: Optional[str], reception_start_time: Optional[datetime.datetime], reception_end_time: Optional[datetime.datetime], portfolio_type: Optional[manaba.models.ManabaPortfolioType.ManabaPortfolioType], result_view_type: Optional[manaba.models.ManabaResultViewType.ManabaResultViewType], student_resubmit_type: Optional[manaba.models.ManabaStudentReSubmitType.ManabaStudentReSubmitType], status: Optional[manaba.models.ManabaTaskStatus.ManabaTaskStatus])¶

manaba レポート詳細

property course_id: int¶

コース ID (URLの一部) ※コースコードではない

戻り値: コース ID
戻り値の型: int

property report_id: int¶

レポート ID

戻り値: レポート ID
戻り値の型: int

property title: str¶

レポートタイトル

戻り値: レポートタイトル
戻り値の型: str

property description: Optional[str]¶

課題に関する説明

戻り値: 課題に関する説明
戻り値の型: Optional[str]

property reception_start_time: Optional[datetime.datetime]¶

受付開始日時

戻り値: 受付開始日時
戻り値の型: Optional[datetime.datetime]

property reception_end_time: Optional[datetime.datetime]¶

受付終了日時

戻り値: 受付終了日時
戻り値の型: Optional[datetime.datetime]

property portfolio_type: Optional[manaba.models.ManabaPortfolioType.ManabaPortfolioType]¶

ポートフォリオ種別

戻り値: ポートフォリオ
戻り値の型: Optional[ManabaPortfolioType]

property result_view_type: Optional[manaba.models.ManabaResultViewType.ManabaResultViewType]¶

閲覧設定

戻り値: 閲覧設定
戻り値の型: Optional[ManabaResultViewType]

property student_resubmit_type: Optional[manaba.models.ManabaStudentReSubmitType.ManabaStudentReSubmitType]¶

学生による再提出の許可

戻り値: 学生による再提出の許可
戻り値の型: Optional[ManabaStudentReSubmitType]

property status: Optional[manaba.models.ManabaTaskStatus.ManabaTaskStatus]¶

状態

戻り値: 状態
戻り値の型: Optional[ManabaTaskStatus]

manaba 採点結果と正解の公開種別 (小テスト) / 閲覧設定 (レポート)

class manaba.models.ManabaResultViewType.ManabaResultViewType(value)¶: manaba 採点結果と正解の公開種別 (小テスト)

manaba.models.ManabaResultViewType.get_result_view_type_from_name(name: Optional[str]) → Optional[manaba.models.ManabaResultViewType.ManabaResultViewType]¶

メンバー名称を指定して列挙メンバーを取得します

パラメータ: name -- メンバー名称
戻り値: 該当する列挙メンバー、ないか、入力値が None なら None
戻り値の型: Optional[ManabaResultViewType]

manaba.models.ManabaResultViewType.get_result_view_type(showing_name: Optional[str]) → Optional[manaba.models.ManabaResultViewType.ManabaResultViewType]¶

表示名を指定して列挙メンバーを取得します (合致、もしくは包含)

パラメータ: showing_name -- 表示名
戻り値: 該当する列挙メンバー、なければ None
戻り値の型: Optional[ManabaResultViewType]

manaba 学生による再提出の許可 (アンケート)

class manaba.models.ManabaStudentReSubmitType.ManabaStudentReSubmitType(value)¶: manaba 学生による再提出の許可 (アンケート)

manaba.models.ManabaStudentReSubmitType.get_student_resubmit_type_from_name(name: Optional[str]) → Optional[manaba.models.ManabaStudentReSubmitType.ManabaStudentReSubmitType]¶

メンバー名称を指定して列挙メンバーを取得します

パラメータ: name -- メンバー名称
戻り値: 該当する列挙メンバー、ないか、入力値が None なら None
戻り値の型: Optional[ManabaResultViewType]

manaba.models.ManabaStudentReSubmitType.get_student_resubmit_type(showing_name: Optional[str]) → Optional[manaba.models.ManabaStudentReSubmitType.ManabaStudentReSubmitType]¶

表示名を指定して列挙メンバーを取得します

パラメータ: showing_name -- 表示名
戻り値: 該当する列挙メンバー、なければ None
戻り値の型: Optional[ManabaStudentReSubmitType]

manaba アンケート

class manaba.models.ManabaSurvey.ManabaSurvey(course_id: int, survey_id: int, title: str, status: manaba.models.ManabaTaskStatus.ManabaTaskStatus, status_lamp: bool, reception_start_time: Optional[datetime.datetime], reception_end_time: Optional[datetime.datetime])¶

manaba アンケート

property course_id: int¶

コース ID (URLの一部) ※コースコードではない

戻り値: コース ID
戻り値の型: int

property survey_id: int¶

アンケート ID

戻り値: ID
戻り値の型: int

property title: str¶

アンケートタイトル

戻り値: タイトル
戻り値の型: str

property status: manaba.models.ManabaTaskStatus.ManabaTaskStatus¶

ステータス

戻り値: ステータス
戻り値の型: ManabaTaskStatus

property status_lamp: bool¶

ステータスランプ

戻り値: ステータスランプが点いているか
戻り値の型: bool

property reception_start_time: Optional[datetime.datetime]¶

開始日時

戻り値: 開始日時
戻り値の型: Optional[datetime.datetime]

property reception_end_time: Optional[datetime.datetime]¶

終了日時

戻り値: 終了日時
戻り値の型: Optional[datetime.datetime]

manaba アンケート詳細

class manaba.models.ManabaSurveyDetails.ManabaSurveyDetails(course_id: int, survey_id: int, title: str, reception_start_time: Optional[datetime.datetime], reception_end_time: Optional[datetime.datetime], portfolio_type: Optional[manaba.models.ManabaPortfolioType.ManabaPortfolioType], student_resubmit_type: Optional[manaba.models.ManabaStudentReSubmitType.ManabaStudentReSubmitType], status: Optional[manaba.models.ManabaTaskStatus.ManabaTaskStatus])¶

manaba アンケート詳細

property course_id: int¶

コース ID (URLの一部) ※コースコードではない

戻り値: コース ID
戻り値の型: int

property survey_id: int¶

アンケート ID

戻り値: アンケート ID
戻り値の型: int

property title: str¶

アンケートタイトル

戻り値: アンケートタイトル
戻り値の型: str

property reception_start_time: Optional[datetime.datetime]¶

受付開始日時

戻り値: 受付開始日時
戻り値の型: Optional[datetime.datetime]

property reception_end_time: Optional[datetime.datetime]¶

受付終了日時

戻り値: 受付終了日時
戻り値の型: Optional[datetime.datetime]

property portfolio_type: Optional[manaba.models.ManabaPortfolioType.ManabaPortfolioType]¶

ポートフォリオ種別

戻り値: ポートフォリオ
戻り値の型: Optional[ManabaPortfolioType]

property student_resubmit_type: Optional[manaba.models.ManabaStudentReSubmitType.ManabaStudentReSubmitType]¶

学生による再提出の許可

戻り値: 学生による再提出の許可
戻り値の型: Optional[ManabaStudentReSubmitType]

property status: Optional[manaba.models.ManabaTaskStatus.ManabaTaskStatus]¶

状態

戻り値: 状態
戻り値の型: Optional[ManabaTaskStatus]

manaba タスク(小テスト・アンケート・レポート)のステータス

class manaba.models.ManabaTaskStatus.ManabaTaskStatus(task_status: manaba.models.ManabaTaskStatusFlag.ManabaTaskStatusFlag, your_status: Optional[manaba.models.ManabaTaskYourStatusFlag.ManabaTaskYourStatusFlag])¶

manaba タスク(小テスト・アンケート・レポート)のステータス

property task_status: manaba.models.ManabaTaskStatusFlag.ManabaTaskStatusFlag¶

タスク自体のステータス

戻り値: タスク自体のステータス
戻り値の型: ManabaTaskStatusFlag

property your_status: Optional[manaba.models.ManabaTaskYourStatusFlag.ManabaTaskYourStatusFlag]¶

ユーザー自身のタスクステータス

戻り値: ユーザー自身のタスクステータス
戻り値の型: Optional[ManabaTaskYourStatusFlag]

manaba タスク(小テスト・アンケート・レポート)のステータスフラグ

class manaba.models.ManabaTaskStatusFlag.ManabaTaskStatusFlag(value)¶: manaba タスク(小テスト・アンケート・レポート)のステータスフラグ

manaba.models.ManabaTaskStatusFlag.get_task_status_from_name(name: Optional[str]) → Optional[manaba.models.ManabaTaskStatusFlag.ManabaTaskStatusFlag]¶

メンバー名称を指定して列挙メンバーを取得します

パラメータ: name -- メンバー名称
戻り値: 該当する列挙メンバー、ないか、入力値が None なら None
戻り値の型: Optional[ManabaTaskStatusFlag]

manaba.models.ManabaTaskStatusFlag.get_task_status(showing_name: str) → Optional[manaba.models.ManabaTaskStatusFlag.ManabaTaskStatusFlag]¶

表示名を指定して列挙メンバーを取得します

パラメータ: showing_name -- メンバー ID
戻り値: 該当する列挙メンバー、なければ None
戻り値の型: Optional[ManabaTaskStatusFlag]

manaba タスク(小テスト・アンケート・レポート)の提出ステータスフラグ

class manaba.models.ManabaTaskYourStatusFlag.ManabaTaskYourStatusFlag(value)¶: manaba タスク(小テスト・アンケート・レポート)の提出ステータスフラグ

manaba.models.ManabaTaskYourStatusFlag.get_your_status_from_name(name: Optional[str]) → Optional[manaba.models.ManabaTaskYourStatusFlag.ManabaTaskYourStatusFlag]¶

メンバー名称を指定して列挙メンバーを取得します

パラメータ: name -- メンバー名称
戻り値: 該当する列挙メンバー、ないか、入力値が None なら None
戻り値の型: Optional[ManabaTaskYourStatusFlag]

manaba.models.ManabaTaskYourStatusFlag.get_your_status(showing_name: str) → Optional[manaba.models.ManabaTaskYourStatusFlag.ManabaTaskYourStatusFlag]¶

表示名を指定して列挙メンバーを取得します (合致、もしくは前方一致)

パラメータ: showing_name -- 表示名
戻り値: 該当する列挙メンバー、なければ None
戻り値の型: Optional[ManabaTaskYourStatusFlag]

manaba スレッド

class manaba.models.ManabaThread.ManabaThread(course_id: int, thread_id: int, title: Optional[str], comments: Optional[list[manaba.models.ManabaThreadComment.ManabaThreadComment]])¶

manaba スレッド

property course_id: int¶

コース ID (URLの一部) ※コースコードではない

戻り値: コース ID
戻り値の型: int

property thread_id: int¶

スレッド ID (URLの一部)

戻り値: スレッド ID
戻り値の型: int

property title: Optional[str]¶

スレッドタイトル (1件目のコメントタイトルと同じ)

戻り値: スレッドタイトル
戻り値の型: str

property comments: Optional[list[manaba.models.ManabaThreadComment.ManabaThreadComment]]¶

コメント一覧

戻り値: コメント一覧
戻り値の型: Optional[list[ManabaThreadComment]]

メモ

この項目は、Manaba.get_threads で取得した場合必ず None になります。取得するには、 Manaba.get_thread メソッドを使用してください。

manaba スレッドコメント

class manaba.models.ManabaThreadComment.ManabaThreadComment(course_id: int, thread_id: int, comment_id: int, title: Optional[str], author: Optional[str], posted_at: Optional[datetime.datetime], reply_to_id: Optional[int], deleted: bool, html: Optional[str])¶

manaba スレッドコメント

add_file(file: manaba.models.ManabaFile.ManabaFile) → None¶

添付ファイルを追加する

パラメータ: file -- ManabaFile オブジェクト

property course_id: int¶

コース ID (URLの一部) ※コースコードではない

戻り値: コース ID
戻り値の型: int

property thread_id: int¶

スレッド ID (URLの一部)

戻り値: スレッド ID
戻り値の型: int

property comment_id: int¶

コメント ID (URLの一部)

戻り値: コメント ID
戻り値の型: int

property title: Optional[str]¶

コメントタイトル

戻り値: コメントタイトル
戻り値の型: Optional[str]

メモ

コメントが削除されている場合、この項目は None になります。

property author: Optional[str]¶

投稿者名

戻り値: 投稿者名
戻り値の型: Optional[str]

メモ

コメントが削除されている場合、この項目は None になります。

property posted_at: Optional[datetime.datetime]¶

投稿時刻

戻り値: 投稿時刻
戻り値の型: Optional[datetime.datetime]

メモ

コメントが削除されている場合、この項目は None になります。

property reply_to_id: Optional[int]¶

リプライ先コメント ID (リプライではない場合 None)

戻り値: リプライ先コメント ID

property deleted: bool¶

削除済みかどうか

戻り値: 削除されている場合は True、削除されていない場合は False
戻り値の型: bool

property html: Optional[str]¶

コメントの HTML

戻り値: コメントの HTML
戻り値の型: Optional[str]

property files: list[manaba.models.ManabaFile.ManabaFile]¶

コメントに添付されているファイルの一覧

戻り値: コメントに添付されているファイルの一覧
戻り値の型: list[ManabaFile]

メモ

この項目は、取得できないもしくは存在しなかったとしても空のリストになります。