MITLibraries / transmogrifier / 5588821537

99%

push

github

Update type hints in helpers.write_timdex_records_to_json (#96)

* Update type hints in helpers.write_timdex_records_to_json

Why these changes are being introduced:
* After some refactoring in 07/2022 that added an iterator pattern to Transformer, it looks as though downstream type hints were not updated.
* While this did not affect runtime, it made reading the code somewhat confusing to someone new to the codebase.

How this addresses that need:
* Update the `records` input argument of `helpers.write_timdex_records_to_json()` from `Iterator[TimdexRecord]` to `Transformer`
* rename `records` to `transformer_instance`, matching variable names from calling `cli.py`
* Add explicit `TimdexRecord` type hint for result of `next(transformer_instance)`

Side effects of this change:
* None

Relevant ticket(s):
* None

Additional maintenance:
* Updated syntax for isort command in Makefile
  * Based on new results from isort, update import order in helpers.py
* update dependencies and revert click workaround
  * In PR https://github.com/MITLibraries/transmogrifier/pull/91, while updating dependencies, `click` and `mypy` had a conflict.
  * A temporary workaround was put into place that reordered the `click` decorators, but this deviated from other projects.
  * Now that `click` has updated again, that workaround is no longer needed.
  * Resolves #92

5 of 5 new or added lines in 2 files covered. (100.0%)

1023 of 1026 relevant lines covered (99.71%)

1.0 hits per line