Add descriptions to restriction AST type schema

[yuji38kwmt]

概要

• RestrictionAstType の JSON Schema に各 AST type の説明を出力するように変更
• enum 定義に oneOf を追加し、const ごとの description を含めるようにした
• schema 出力のテストを追加

動作確認

• make format
• make lint
• pytest tests/util/test_attribute_restrictions.py

[kci-pr-agent]

Title

Add descriptions to restriction AST type schema

---

Description

• RestrictionAstTypeに説明追加

• JSON SchemaにoneOfとdescription追加

• __get_pydantic_json_schema__を実装

• テストでoneOfとdescription検証追加

---

Changes walkthrough 📝

	Relevant files
Enhancement	attribute_restrictions.py RestrictionAstTypeにスキーマ説明を追加                                                          annofabapi/util/attribute_restrictions.py Pydantic v2用スキーマ生成ハンドラをインポート Enumにdescriptionプロパティを追加 __get_pydantic_json_schema__でoneOfを生成 AST種別ごとの説明マッピングを定義 +41/-1
Tests	test_attribute_restrictions.py テストでoneOfとdescriptionを検証                                                                  tests/util/test_attribute_restrictions.py model_json_schemaテストを拡張 RestrictionAstTypeのoneOf項目を検証 スキーマdescriptionアサーションを追加 +12/-0

---

Need help?

Type /help how to ... in the comments thread for any questions about PR-Agent usage.

Check out the documentation for more information.

[kci-pr-agent]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 PR contains tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Unused Import 不使用のインポートが追加されています。BaseModel、ConfigDict、Field、field_serializer、model_validatorなどがこのファイル内で使用されていないため、不要なインポートを削除してください。 from pydantic import BaseModel, ConfigDict, Field, GetJsonSchemaHandler, field_serializer, model_validator from pydantic.json_schema import JsonSchemaValue from pydantic_core import CoreSchema JSON Schema 記述不足 RestrictionAstType の JSON Schema にトップレベルの description が設定されていません。テストが "属性制約ASTの種別です。" を期待しているため、__get_pydantic_json_schema__ メソッド内で適切な description を追加してください。 def __get_pydantic_json_schema__(cls, core_schema: CoreSchema, handler: GetJsonSchemaHandler) -> JsonSchemaValue: """AST種別ごとの説明を含むJSON Schemaを返します。""" json_schema = handler(core_schema) json_schema["oneOf"] = [ { "const": ast_type.value, "title": ast_type.name, "description": ast_type.description, } for ast_type in cls ] return json_schema

[kci-pr-agent]

Suggestion: JSON Schema のルートに enum 全体の説明が含まれていないため、json_schema["description"] を追加して明示的に説明文を設定してください。テストで期待される "属性制約ASTの種別です。" を指定するとマッチします。 [possible issue, importance: 9]

Suggested change

	"""AST種別ごとの説明を含むJSON Schemaを返します。"""
	json_schema = handler(core_schema)
	json_schema["oneOf"] = [
	{
	"const": ast_type.value,
	"title": ast_type.name,
	"description": ast_type.description,
	}
	for ast_type in cls
	]
	return json_schema
	def __get_pydantic_json_schema__(cls, core_schema: CoreSchema, handler: GetJsonSchemaHandler) -> JsonSchemaValue:
	"""AST種別ごとの説明を含むJSON Schemaを返します。"""
	json_schema = handler(core_schema)
	json_schema["description"] = "属性制約ASTの種別です。"
	json_schema["oneOf"] = [
	{
	"const": ast_type.value,
	"title": ast_type.name,
	"description": ast_type.description,
	}
	for ast_type in cls
	]
	return json_schema

[kci-pr-agent]

Suggestion: マッピングに漏れがあると KeyError になる可能性があるため、dict.get を使ってデフォルト値を返すようにガードしてください。 [general, importance: 3]

Suggested change

	def description(self) -> str:
	"""AST種別の説明文を返します。"""
	return _RESTRICTION_AST_TYPE_DESCRIPTIONS[self]
	@property
	def description(self) -> str:
	"""AST種別の説明文を返します。"""
	return _RESTRICTION_AST_TYPE_DESCRIPTIONS.get(self, "")

[Copilot]

Pull request overview

RestrictionAstType（属性制約ASTの種別）に対して、JSON Schema 出力時に各 AST type ごとの説明文が含まれるよう拡張し、スキーマ出力のテストも追加するPRです。

Changes:

• RestrictionAstType の JSON Schema に oneOf を追加し、const ごとに description を出力
• AST type の説明文を参照できるよう RestrictionAstType.description を追加
• RestrictionAst.model_json_schema() の $defs["RestrictionAstType"] を検証するテストを追加

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
annofabapi/util/attribute_restrictions.py	RestrictionAstType の JSON Schema をカスタマイズして、AST type ごとの説明を oneOf で出力
tests/util/test_attribute_restrictions.py	$defs["RestrictionAstType"] に description / oneOf が含まれることを検証するテストを追加