Add utils for core - Githubissues

Transport-for-the-North / caf.toolkit

Toolkit of transport planning and appraisal functionalities.

https://caftoolkit.readthedocs.io/en/stable/

Other

0 stars 2 forks source link

Add utils for core #70

Closed isaac-tfn closed 1 year ago

isaac-tfn commented 1 year ago

Describe Changes

Task Checklist

[ ] Have unittests been added (testing individual functions and their edge cases)
[ ] Have integration tests been added (if applicable, to test modules of functionality)
[ ] Updated RELEASE.md to reflect changes in PR
[ ] Have new dependencies been added?
- [ ] Have they been added to either requirements.txt or requirements_dev.txt.
- [ ] Have they been added to pyproject.toml

codecov[bot] commented 1 year ago

Codecov Report

Attention: 18 lines in your changes are missing coverage. Please review.

Files	Coverage Δ
src/caf/toolkit/log_helpers.py	`98.36% <100.00%> (+<0.01%)`	:arrow_up:
src/caf/toolkit/pandas_utils/__init__.py	`100.00% <ø> (ø)`
src/caf/toolkit/config_base.py	`96.20% <87.50%> (-3.80%)`	:arrow_down:
src/caf/toolkit/toolbox.py	`90.38% <37.50%> (-9.62%)`	:arrow_down:
src/caf/toolkit/translation.py	`92.59% <83.33%> (-4.15%)`	:arrow_down:

:loudspeaker: Thoughts on this report? Let us know!

isaac-tfn commented 1 year ago

@wsp-mbuckley @BenTaylor-TfN I don't think I'll need to add any more to this for core, and until the next version if published all of the tests fail for core. Could one of you take a quick look if you get a chance? I'll fix linting if/when the functionality has been approved.

wsp-mbuckley commented 1 year ago

@wsp-mbuckley @BenTaylor-TfN I don't think I'll need to add any more to this for core, and until the next version if published all of the tests fail for core. Could one of you take a quick look if you get a chance?

Is it urgent or can it wait until Wednesday / Thursday?

isaac-tfn commented 1 year ago

Is it urgent or can it wait until Wednesday / Thursday?

Wednesday or Thursday is fine I just think it should be this week so that core is as ready as possible to hand over next week.

BenTaylor-TfN commented 1 year ago

@wsp-mbuckley, can you cover the config_base files and I'll get the rest?

wsp-mbuckley commented 1 year ago

Ben's comments cover everything in the config_base module, I would just add it would be worth adding a test to make sure the converting None values inside dicts or collections works

BenTaylor-TfN commented 1 year ago

I've refactored this code a little bit to make it more flexible with multiple frontends. I've got a few more comments to add. @isaac-tfn, please can you address the requested changes when you're back.

Please can you also aim to add some rough tests that check the basic cases for the added functionality? Feel free to mark edge cases that need checking as TODOs. I know they take the longest to write

BenTaylor-TfN commented 1 year ago

Rebased on main.

Will update code now to reflect discussion in #79.

BenTaylor-TfN commented 1 year ago

Continuing these changes in #87