bp / bp/ResSimpy

Move away from dictionaries to initialise DataObjectMixin classes

Open
#295 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
23
Forks
8
Avg merge
16d 4h
Merged PRs (30d)
1

Description

**Is your feature request related to a problem? Please describe.**
Entering a dict isn't intuitive and should be entered by named parameters instead. We should keep initialisation by dict as a "from_dict" classmethod.

**Describe the solution you'd like**
Remove the dict from the DataObjectMixin init. Update all derived classes to have a named parameter for all possible keywords in the keyword mapping dicts.

Contributor guide

Open the contributing guide

Research direction

Start by locating DataObjectMixin, its derived classes, and the keyword mapping dictionaries. Trace how those classes are currently initialized and identify the existing dictionary conversion path. Done means derived classes accept named parameters, dictionary initialization is provided through a from_dict classmethod, and all affected mappings are updated.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.