Use meaningful domain type locations/imports
Open
Nobody has claimed this yet.
esssans
- Dominant language
- Python
- Stars
- 1
- Forks
- 3
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 17
Description
Currently many "types" are in esssans.types, and we use from esssans.types import *. Apart form wanting to avoid the import *, types is also meaningless to scientists. Therefore:
- Move important types to the package root (import in
__init__.py), avoidimport *. - More special or internal types should move to meaningful submodules.
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 examining the current types in esssans.types and the package imports in init.py. Identify which types are important to the public API and which are special or internal, then define meaningful locations that avoid import *. Done means the types have been relocated and imports updated consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100