line / line/centraldogma-python
Use `Query` type instead of `str`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 21
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
#14 introduced `Query` type. The existing APIs that use a string as a query expression need to be updated such as.
https://github.com/line/centraldogma-python/blob/6098f1afe6b181388ab32bd7f91161dd7bd2a70d/centraldogma/content_service.py#L44
https://github.com/line/centraldogma-python/blob/6098f1afe6b181388ab32bd7f91161dd7bd2a70d/centraldogma/query.py#L30-L45
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading centraldogma/content_service.py at the linked API and centraldogma/query.py around lines 30-45 to understand the Query type introduced by #14. Search the existing APIs for query expressions typed as str and update the relevant annotations and usage. Done means all applicable query-expression APIs use Query consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100