Possible cleanup of "Options" boilerplate #402

ErikDies · 2023-05-21T20:24:29Z

ErikDies commented

2023-05-21 20:24:29 +00:00

Maybe this is a little cleaner using dataclasses?

The dataclass decorator is doing the same thing you are here with __init__, but also adds __repr__ and __eq__ by default. The args can be passed positionally or as kwargs by default, with a kwargs only option. The dataclass also allows for some nice things like setting defaults that would be challenging with regular classes.
re: https://docs.python.org/3/library/dataclasses.html

You can also get some features that might be desirable (not used in this PR), like fake immutability using the kwarg "frozen"

@dataclass(frozen=True)
class DataExample:
    foo: int
    bar: bool
    
>> ex = DataExample(4, True)
>> print(ex)
 DataExample(foo=4, bar=True)
 
>> ex.foo = 5
---------------------------------------------------------------------------
FrozenInstanceError                       Traceback (most recent call last)
Cell In[19], line 1
----> 1 ex.foo = 5

File <string>:4, in __setattr__(self, name, value)

FrozenInstanceError: cannot assign to field 'foo'

Maybe this is a little cleaner using dataclasses? The dataclass decorator is doing the same thing you are here with `__init__`, but also adds `__repr__` and `__eq__` by default. The args can be passed positionally or as kwargs by default, with a kwargs only option. The dataclass also allows for some nice things like setting defaults that would be challenging with regular classes. re: https://docs.python.org/3/library/dataclasses.html You can also get some features that might be desirable (_not used in this PR_), like fake immutability using the kwarg "frozen" ``` @dataclass(frozen=True) class DataExample: foo: int bar: bool >> ex = DataExample(4, True) >> print(ex) DataExample(foo=4, bar=True) >> ex.foo = 5 --------------------------------------------------------------------------- FrozenInstanceError Traceback (most recent call last) Cell In[19], line 1 ----> 1 ex.foo = 5 File <string>:4, in __setattr__(self, name, value) FrozenInstanceError: cannot assign to field 'foo' ```

ErikDies reviewed 2023-05-21 20:25:43 +00:00

cli.py

ErikDies commented

2023-05-21 20:25:42 +00:00

Setting defaults here is not needed, just done to match the defaults in the CLI tooling to replicate defaults for repl use.

dboreham reviewed 2023-05-21 21:50:10 +00:00

dboreham left a comment

Thanks!

Sign in to join this conversation.

No reviewers

No Milestone

No project

No Assignees

2 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: cerc-io/stack-orchestrator#402