ImperialCollegeLondon / ImperialCollegeLondon/virtual_ecosystem
Fix circular import problem with typing ModuleInfo
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20
- Forks
- 5
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 34
Description
**Describe the bug**
Typing the `core.registry.ModuleInfo` with `BaseModel` is what we _should_ be doing but it causes circular imports. We need to restructure something to get properly accurate typing on the MODULE_REGISTRY components.
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 tracing imports around core.registry.ModuleInfo, BaseModel, and the MODULE_REGISTRY components. Identify the circular dependency that prevents accurate typing, then determine a restructuring that preserves the registry behavior while allowing ModuleInfo to be typed with BaseModel; done means imports succeed and the registry has accurate typing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100