kurusugawa-computer / kurusugawa-computer/annofab-api-python-client

`annofabapi.models`の定義はenumだけにして、`Dict[str,Any]`である型エイリアスは削除する

Open
#590 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
11
Forks
1
PR merge metrics
No merged PRs in 30d

Description

annofabapi.modelsには以下が定義されている。

  • enum
  • Dict[str, Any]である型エイリアス

型エイリアスにあるコメントを参照する価値があるかと思い公開したが、結局はDict[str,Any]なので使うメリットはあまりない。

したがって、最終的にはannofabapi.modelsにはenumだけを定義したい。

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the annofabapi.models module and reading its current definitions, focusing on the enum declarations and Dict[str, Any] type aliases. Confirm the intended final state by checking that the module retains the enums and no longer defines those type aliases.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.