Use mypy

[chanhosuh]

Description

Closes #253. Makes progress toward #162.

As part of fixing mypy errors, ended up sneaking a new interface in (see changelog entry).

TODO:

• add command to `makefile
• use make command in CI (create separate flow)
• fix current mypy errors so CI passes

Hygiene checklist

• Changelog entry
• Everything public has a Numpy-style docstring
  (modules, public functions, classes, and public methods)
• Commit history is cleaned-up with minor changes squashed together
  and descriptive commit messages following Tim Pope's style

Cute Animal Picture

[github-actions]

Coverage report

The coverage rate went from 75.9% to 76.19% ⬆️
The branch rate is 63%.

100% of new lines are covered.

Diff Coverage details (click to unfold)

curvesim/logging.py

100% of new lines are covered (92.98% of the complete file).

curvesim/pool/base.py

100% of new lines are covered (49.41% of the complete file).

curvesim/pool/cryptoswap/pool.py

100% of new lines are covered (90.21% of the complete file).

curvesim/pool/stableswap/metapool.py

100% of new lines are covered (94.22% of the complete file).

curvesim/pipelines/simple/strategy.py

100% of new lines are covered (100% of the complete file).

curvesim/pool/snapshot.py

100% of new lines are covered (95.95% of the complete file).

curvesim/iterators/price_samplers/price_volume.py

100% of new lines are covered (93.54% of the complete file).

curvesim/pool/stableswap/pool.py

100% of new lines are covered (97.01% of the complete file).

curvesim/pool/cryptoswap/calcs/init.py

100% of new lines are covered (87.5% of the complete file).

curvesim/templates/init.py

100% of new lines are covered (100% of the complete file).

curvesim/templates/log.py

100% of new lines are covered (100% of the complete file).

curvesim/pipelines/vol_limited_arb/strategy.py

100% of new lines are covered (48% of the complete file).

curvesim/pool/cryptoswap/calcs/factory_2_coin.py

100% of new lines are covered (85.46% of the complete file).

curvesim/pool/cryptoswap/calcs/tricrypto_ng.py

100% of new lines are covered (91.16% of the complete file).

curvesim/templates/strategy.py

100% of new lines are covered (100% of the complete file).

curvesim/metrics/state_log/log.py

100% of new lines are covered (95.65% of the complete file).