openzim / openzim/python-scraperlib
Calls to third party code not respecting type hints
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 31
- Forks
- 27
- Avg merge
- 3d 7h
- Merged PRs (30d)
- 2
Description
Following #227, scraperlib users are not allowed to send values of unexpected types to our API.
We should apply the same strict treatment to our usage of other's APIs.
beartype allows setting this in our code and raising or warning on incorrect calls. Once we fix the codebase, we would keep it and it would serve as automated test for this.
Contributor guide
No contributing guide indexed for this repository
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 reviewing the scraperlib codebase for calls into third-party APIs and the type-hint enforcement described in #227. Use beartype to identify incorrect calls; done means the codebase passes this checking without unexpected argument types, while retaining the checks as automated tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100