A bunch of small improvements while working on the wizard back and resume #556

joanise · 2024-09-20T19:08:59Z

PR Goal?

I made these changes while working on the wizard's back and resume functions, but I want to PR them separately because they will be confusing to review as part of that PR.

Fixes?

remove irrelevant unit-testing code from the Step class
make more test suites compatible with Windows
don't let the wizard leave directories around just to test that we're able to create them
turn the warning about not running the sox effects on Windows into a fatal error, unless an explicit environment variable is set: we never want this warning to be ignorable!

Feedback sought?

sanity check

Priority?

medium: these changes will be required for the wizard improvement PR

Tests added?

yes

How to test?

Should you really care to do so (but don't!), run the test suites on Windows, and see fewer failures.
Tell the wizard to save files in a deep directory that doesn't exist yet, then quit before you're done. Before this PR, most of the deep directory is left behind, with this PR you can see it is not.

Confidence?

high

Version change?

no

Related PRs?

n/a

semanticdiff-com · 2024-09-20T19:09:02Z

Review changes with SemanticDiff.

Analyzed 6 of 6 files.

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

	Filename	Status
✔️	everyvoice/wizard/__init__.py	6.98% smaller
✔️	everyvoice/wizard/basic.py	15.54% smaller
✔️	everyvoice/tests/test_configs.py	61.04% smaller
✔️	everyvoice/tests/test_utils.py	Analyzed
✔️	everyvoice/tests/test_wizard.py	Analyzed
✔️	everyvoice/preprocessor/preprocessor.py	22.57% smaller

github-actions · 2024-09-20T19:16:56Z

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

codecov · 2024-09-20T19:17:24Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.85%. Comparing base (bbc883d) to head (6d7a98f).
Report is 4 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #556      +/-   ##
==========================================
+ Coverage   74.64%   74.85%   +0.20%     
==========================================
  Files          46       46              
  Lines        3132     3142      +10     
  Branches      510      510              
==========================================
+ Hits         2338     2352      +14     
+ Misses        693      691       -2     
+ Partials      101       99       -2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

SamuelLarkin

I would prefer not to import readalongs.
I have a question about can_make_dir().

SamuelLarkin · 2024-09-23T15:25:02Z

everyvoice/tests/test_configs.py

+try:
+    from readalongs.portable_tempfile import (
+        PortableNamedTemporaryFile as NamedTemporaryFile,
+    )
+except ImportError:
+    from tempfile import NamedTemporaryFile
+


Is there a way not to require readalongs? Is EV already dependent on readalongs? Wouldn't it be wiser to have that readalongs.protable_temfile be a new library that both EV and readalongs could import?

We don't depend on readalongs yet, and with the try/except we still don't really, which is why I did not add it to requirements.

Also, when we do #439, we will then really add the readalongs dependency to support that export feature, which is in part why I thought I could slide this weird thing in.

SamuelLarkin · 2024-09-23T15:26:41Z

everyvoice/wizard/__init__.py

+    def add_step(self, step: Step, parent: Step):
+        """Insert a step in the specified position in the tour.
+
+        Args:
+            step: The step to add
+            parent: The parent to add the step to
+        """


👍🏼 Thank you for adding documentation for the methods.

SamuelLarkin · 2024-09-23T15:34:51Z

everyvoice/wizard/basic.py

+        while not d.exists() and d not in (Path("/"), Path(""), Path(".")):
+            dirs_to_make.append(d)
+            d = d.parent


Will this survive path=="/somewhere_exist/doesntexist/doesnexists/../../a/b/c?
I guess it depends on d.parent.

Yes, this is exactly the use case I was working to support, and the reason I did this patch. Previously, validation would have left /somewhere_exist/doesntexist/doesnexists/../../a/b on the filesystem, now this while loop will add all the components to dirs_to_make and stop at /somewhere_exist, since it exists.

And the finally block at the end of this function will remove them all so we leave no traces behind just for trying to validate that we can create this deep directory.

For dev't purposes, we want to be able to skip it, but let's force the dev to set an env variable to do so, instead of using a warning that might be missed if someone does not look at the logs.

- refactor: test_configs use readalongs PortableNamedTmpFile allows more unit tests to pass on Windows. - make test_utils.py compatible with Windows by expecting either windows or posix paths

also: - document the methods in the wizard's Tour class - remove the unused child_index arg to add_step

joanise requested review from SamuelLarkin and roedoejet September 20, 2024 19:08

joanise force-pushed the dev.ej/misc-improvements branch from 832a2ba to 9f19ff5 Compare September 20, 2024 19:13

SamuelLarkin approved these changes Sep 23, 2024

View reviewed changes

joanise added 4 commits September 23, 2024 12:32

fix: make the Windows warning about no sox a fatal error

5f246e8

For dev't purposes, we want to be able to skip it, but let's force the dev to set an env variable to do so, instead of using a warning that might be missed if someone does not look at the logs.

fix: make sure validate does not leave partial directories behind

2d2dbee

fix: make more test suites compatible with Windows

ac9b295

- refactor: test_configs use readalongs PortableNamedTmpFile allows more unit tests to pass on Windows. - make test_utils.py compatible with Windows by expecting either windows or posix paths

refactor: move test harness code out of Step into TestStep

6d7a98f

also: - document the methods in the wizard's Tour class - remove the unused child_index arg to add_step

joanise force-pushed the dev.ej/misc-improvements branch from 9f19ff5 to 6d7a98f Compare September 23, 2024 16:35

joanise merged commit 6d7a98f into main Sep 23, 2024
6 checks passed

joanise deleted the dev.ej/misc-improvements branch September 23, 2024 16:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

A bunch of small improvements while working on the wizard back and resume #556

A bunch of small improvements while working on the wizard back and resume #556

joanise commented Sep 20, 2024

semanticdiff-com bot commented Sep 20, 2024 •

edited

Loading

github-actions bot commented Sep 20, 2024 •

edited

Loading

codecov bot commented Sep 20, 2024 •

edited

Loading

SamuelLarkin left a comment

SamuelLarkin Sep 23, 2024

joanise Sep 23, 2024

SamuelLarkin Sep 23, 2024

SamuelLarkin Sep 23, 2024

joanise Sep 23, 2024

joanise Sep 23, 2024

A bunch of small improvements while working on the wizard back and resume #556

A bunch of small improvements while working on the wizard back and resume #556

Conversation

joanise commented Sep 20, 2024

PR Goal?

Fixes?

Feedback sought?

Priority?

Tests added?

How to test?

Confidence?

Version change?

Related PRs?

semanticdiff-com bot commented Sep 20, 2024 • edited Loading

github-actions bot commented Sep 20, 2024 • edited Loading

codecov bot commented Sep 20, 2024 • edited Loading

Codecov Report

SamuelLarkin left a comment

Choose a reason for hiding this comment

SamuelLarkin Sep 23, 2024

Choose a reason for hiding this comment

joanise Sep 23, 2024

Choose a reason for hiding this comment

SamuelLarkin Sep 23, 2024

Choose a reason for hiding this comment

SamuelLarkin Sep 23, 2024

Choose a reason for hiding this comment

joanise Sep 23, 2024

Choose a reason for hiding this comment

joanise Sep 23, 2024

Choose a reason for hiding this comment

semanticdiff-com bot commented Sep 20, 2024 •

edited

Loading

github-actions bot commented Sep 20, 2024 •

edited

Loading

codecov bot commented Sep 20, 2024 •

edited

Loading