Fixes+silences type errors in models #155
Conversation
| @@ -17,4 +17,4 @@ class IssuedCurrencyAmount(IssuedCurrency): | |||
| See https://xrpl.org/currency-formats.html#issued-currency-amounts. | |||
| """ | |||
|
|
|||
| value: str = REQUIRED | |||
| value: str = REQUIRED # type: ignore | |||
There was a problem hiding this comment.
this causes a type error because the type of value is a str, but the default value is REQUIRED (an object). i tried a couple patterns but ran into the issue that the generated getter has a type of Union[<intended type>, object] which means that at call sites, you have to narrow the type...and we don't want to expose this to callers anyhow
this will likely require a deeper refactor - i could imagine this being implemented as a list of required attributes or a few other ways, although my understanding is that this is a tricky part of dataclass subclassing. as such, i opted for # type: ignore, as this preserves the type of the getter. not ideal, but don't think i'll have the time to go deeper so i did this everywhere in models
There was a problem hiding this comment.
actually i think this is the optimal solution. value = REQUIRED should be a type error in all cases because if a value = REQUIRED then an error will be thrown
| @@ -80,28 +80,28 @@ def _get_errors(self: PathStep) -> Dict[str, str]: | |||
|
|
|||
| def _get_account_error(self: PathStep) -> Optional[str]: | |||
| if self.account is None: | |||
| return | |||
| return None | |||
There was a problem hiding this comment.
for Optional return types, mypy by default requires you to return None instead of having an empty return. this seems like a stylistic choice to me, but opted to just make it pass the default settings to simplify configuration
if we want, we can enable a flag (warn_no_return) in the config to make this work
tedkalaw
requested review from
amiecorso,
ledhed2222 and
mvadari
as code owners
|
You will probs need to do more once #131 is merged in |
|
sure thing! |
High Level Overview of Change
Some were fixable, others were faster to silence. Comments inline
After this, there are 3 type errors left in all of
xrpl!Context of Change
Needed so we can use
mypyonxrplType of Change
Before / After
mypyreturns only 3 errors inxrplTest Plan
CI
poetry run mypy --strict xrpl3 errors should be returned: