Gather symbols in a better way
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 11
- Forks
- 77
- PR merge metrics
- No merged PRs in 30d
Description
In #816 all IC symbols were gathered in the same file and collected into a dictionary. This dictionary is useful to make all the symbols available to the code that reads config files. However, the method used to collect them into the dictionary is not the best. As suggested here The main alternatives are:
- A class decorator that adds every variant of the decorated enum to the dictionary
- Metaclasses
1 is the most straightforward, but both options should be explored and compared to see which one fits best.
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 issue #816 and the linked pull request discussion, then trace how IC symbols are currently gathered into the dictionary. Compare the class-decorator and metaclass alternatives, and document or implement the approach that best fits. Done means the symbols remain available to code reading config files through a clearer collection mechanism.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100