Skip to content

Commit 0e2a604

Browse files
authored
pydantic_modelsのドキュメントを生成 (#700)
* add shell * 一時ファイルを削除 * add rst * update * add rule * 無視すべきルールを追加 * noqaコメント追加
1 parent bc6d2fa commit 0e2a604

17 files changed

+3254
-8676
lines changed

.vscode/cspell.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
"kurusugawa",
3131
"ndarray",
3232
"netrc",
33+
"pydantic",
3334
"pydata",
3435
"pylint",
3536
"relativedelta",

annofabapi/parser.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import abc
1+
import abc # noqa: A005
22
import json
33
import os
44
import zipfile

annofabapi/pydantic_models/annotation_detail_content_output_inner_unknown.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
class AnnotationDetailContentOutputInnerUnknown(BaseModel):
2424
"""
2525
アノテーションのデータ部をJSON内部に保持します。 AnnotationDetailV1の形式で保存されていたデータのAnnotationTypeが特定できない場合にこの値となります。 典型的な例では、アノテーションの保存後にアノテーション仕様が書き換わっていた場合が該当します。
26-
""" # noqa: E501
26+
"""
2727

2828
type: StrictStr = Field(alias="_type")
2929
data: StrictStr = Field(

annofabapi/pydantic_models/annotation_detail_content_output_outer_unresolved.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
class AnnotationDetailContentOutputOuterUnresolved(BaseModel):
2424
"""
2525
アノテーションのデータ部を外部ファイルの形式(画像など)で保持します。 Outerのurl / etagを解決しなかった場合(過去のアノテーションを取得した場合等)にこの値となります。
26-
""" # noqa: E501
26+
"""
2727

2828
type: StrictStr = Field(alias="_type")
2929
__properties: ClassVar[List[str]] = ["_type"]

annofabapi/pydantic_models/annotation_props_for_editor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
class AnnotationPropsForEditor(BaseModel):
2424
"""
2525
アノテーションエディタ用のアノテーション毎のプロパティです。<br /> ここに含まれているデータはアノテーション結果に反映されず、エディタが利用するために存在します。 エディタ用のデータであるため、たとえば`can_delete`や`can_edit_data`が`false`でも、APIによる編集は妨げません。<br /> ここで定義されているデータを利用して動作を変えるかどうかは、エディタによって異なります。
26-
""" # noqa: E501
26+
"""
2727

2828
can_delete: Optional[StrictBool] = Field(default=None, description="アノテーションがエディタ上で削除できるかどうか。 trueの場合削除可能。")
2929
can_edit_data: Optional[StrictBool] = Field(

annofabapi/pydantic_models/plugin_detail_extended_annotation_specs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
class PluginDetailExtendedAnnotationSpecs(BaseModel):
2929
"""
3030
カスタムのアノテーション種別を作成するプラグインを表します。 なお、このプラグインが設定されているプロジェクトでは、ここで指定したアノテーション種別以外は使用できなくなります。
31-
""" # noqa: E501
31+
"""
3232

3333
plugin_compatibility: Optional[OrganizationPluginCompatibility] = None
3434
annotation_types: List[AnnotationType] = Field(

annofabapi/pydantic_models/position_for_minimum_bounding_box_insertion.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
class PositionForMinimumBoundingBoxInsertion(BaseModel):
2424
"""
2525
`annotation_type` が `bounding_box` かつ `min_warn_rule` が `and` または `or` の場合のみ、挿入する最小矩形アノテーションの原点を指定できます。 画像左上の座標が「x=0, y=0」です。 未指定、もしくは「画像外に飛び出たアノテーション」を許可していないにも関わらず飛び出してしまう場合は、表示範囲の中央に挿入されます。 「スキャンした帳票の記入欄」や「定点カメラで撮影した製品ラベル」など、アノテーションしたい位置やサイズが多くの画像で共通している場合に便利です。 `annotation_type` が `bounding_box` 以外の場合は必ず未指定となります。
26-
""" # noqa: E501
26+
"""
2727

2828
x: StrictInt
2929
y: StrictInt

annofabapi/pydantic_models/task_generate_rule_by_input_data_csv.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
class TaskGenerateRuleByInputDataCsv(BaseModel):
2424
"""
2525
各タスクへの入力データへの割当を記入したCSVへのS3上のパスを指定してタスクを生成します。 1つのタスクに対する入力データの個数は最大200です。200を超えるタスクが1つでもある場合にはタスク生成に失敗します。
26-
""" # noqa: E501
26+
"""
2727

2828
csv_data_path: StrictStr = Field(description="各タスクへの入力データへの割り当てを記入したCSVへのS3上のパス。 ")
2929
type: Optional[StrictStr] = Field(

annofabapi/resource.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import logging
1+
import logging # noqa: A005
22
import netrc
33
import os
44
from typing import Optional, Union

docs/api_reference/credentials.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
annofabapi.credentials module
2+
============================
3+
4+
.. automodule:: annofabapi.credentials
5+
:members:
6+

0 commit comments

Comments
 (0)