Dev.ej/wizard navigation

joanise commented 2 months ago

PR Goal?

Add several navigation features to the EveryVoice new-project wizard:

The ability to go back to a previous step (use Ctrl-C, option 1)
The ability to view the question tree (Ctrl-C, option 3, with hidden option --trace to auto display it at each step)
Hidden option --debug-state displays the current state before each question
The ability to save progress (Ctrl-C, option 4), and the --resume-from option to resume from a saved state

Fixes?

Fixes #545 Fixes #468 Fixes #546

Feedback sought?

Code review, and playing around with the wizard to see how it feels, how it works, improvements you might like to see.

Priority?

beta

Tests added?

~~Not yet - I'm making this draft PR to seek feedback but I'll add unit testing before finalizing it.~~

In progress: navigation has unit testing now.

How to test?

Run the wizard with the new options, hit Ctrl-C are various points during the wizard and play with the options.

Confidence?

medium-high, since I have tested it interactively quite extensively, but will be higher once unit testing is in place.

Version change?

might have warranted a minor version bump since it's new features, but we're preparing the next alpha so that doesn't make sense. Nothing broken, in any case, so no major bump.

Related PRs?

nope, it's all in EV itself.

semanticdiff-com[bot] commented 2 months ago

Review changes with SemanticDiff.

Analyzed 17 of 18 files.

Overall, the semantic diff is 9% smaller than the GitHub diff.

	Filename	Status
:heavy_check_mark:	everyvoice/cli.py	15.61% smaller
:heavy_check_mark:	everyvoice/run_tests.py	Analyzed
:heavy_check_mark:	everyvoice/wizard/__init__.py	8.77% smaller
:heavy_check_mark:	everyvoice/wizard/basic.py	Analyzed
:heavy_check_mark:	everyvoice/wizard/dataset.py	9.9% smaller
:heavy_check_mark:	everyvoice/wizard/main_tour.py	2.27% smaller
:heavy_check_mark:	everyvoice/wizard/prompts.py	9.41% smaller
:heavy_check_mark:	everyvoice/wizard/simple_term_menu_win_stub.py	26.55% smaller
:heavy_check_mark:	everyvoice/wizard/utils.py	0.05% smaller
:heavy_check_mark:	everyvoice/wizard/validators.py	72.25% smaller
:heavy_check_mark:	everyvoice/tests/preprocessed_audio_fixture.py	37.34% smaller
:heavy_check_mark:	everyvoice/tests/stubs.py	27.31% smaller
:heavy_check_mark:	everyvoice/tests/test_cli.py	2.62% smaller
:heavy_check_mark:	everyvoice/tests/test_preprocessing.py	82.18% smaller
:heavy_check_mark:	everyvoice/tests/test_utils.py	Analyzed
:heavy_check_mark:	everyvoice/tests/test_wizard.py	1.61% smaller
:heavy_check_mark:	everyvoice/tests/test_wizard_helpers.py	Analyzed
:grey_question:	everyvoice/tests/data/metadata.psv	Unsupported file format

github-actions[bot] commented 2 months ago

CLI load time: 0:00.29
Pull Request HEAD: 19cfa3569016a389450e3aefea50a1493b5e2ace
Imports that take more than 0.1 s:
import time: self [us] | cumulative | imported package

codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 93.69369% with 21 lines in your changes missing coverage. Please review.

Project coverage is 76.14%. Comparing base (d7fbb81) to head (19cfa35). Report is 17 commits behind head on main.

Files with missing lines	Patch %	Lines
everyvoice/wizard/__init__.py	90.24%	10 Missing and 6 partials :warning:
everyvoice/wizard/dataset.py	96.42%	2 Missing and 1 partial :warning:
everyvoice/cli.py	50.00%	2 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #561 +/- ## ========================================== + Coverage 74.87% 76.14% +1.26% ========================================== Files 46 46 Lines 3144 3374 +230 Branches 510 550 +40 ========================================== + Hits 2354 2569 +215 - Misses 691 701 +10 - Partials 99 104 +5 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

EveryVoiceTTS / EveryVoice