implement autofix for 91x by jakkdl · Pull Request #158 · python-trio/flake8-async

jakkdl · 2023-03-15T15:04:08Z

does still not finish #70 😅 It "merely" inserts checkpoints wherever needed.

TODO:

insert checkpoints
add import if necessary
insert anyio checkpoint if anyio is the preferred library (and anyio import)
handle multiple yields on the same line (but they're not autofixed)
save state on new class members
add some more comments
add review comments

And added a couple more tasks to #124 before this is reasonably usable by an end user. That includes checks for whether autofix toggling actually is toggled, which I kinda know isn't done properly by this anyway (but atm it mostly doesn't matter cause the new file doesn't get written without the autofix flag). But I'll leave those for another PR.

Zac-HD · 2023-03-15T18:42:40Z

Exciting!

jakkdl · 2023-03-16T11:17:47Z

flake8_trio/visitors/visitor91x.py

-    @property
-    def artificial_errors(self) -> set[cst.Return | cst.FunctionDef | cst.Yield]:
-        return self.loop_state.artificial_errors
-
-    @artificial_errors.setter
-    def artificial_errors(self, value: set[cst.Return | cst.FunctionDef | cst.Yield]):
-        self.loop_state.artificial_errors = value  # pragma: no cover


randomly got irritated by this one as I had to modify the typing on it so I removed it, it was barely used anyway and you might not even noticed the diff access below.

jakkdl · 2023-03-16T11:59:25Z

flake8_trio/visitors/visitor91x.py

-        for statement in self.uncheckpointed_statements:
-            self.error_91x(node, statement)
+        self.restore_state(original_node)
+        return updated_node  # noqa: R504


R504 irritated me so much, but realized it wasn't just me writing esoteric code and opened an issue afonasev/flake8-return#133

jakkdl · 2023-03-16T12:01:31Z

flake8_trio/visitors/visitor91x.py

+    # TODO: generate an error in these two if transforming+visiting is done in a single
+    # pass and emit-error-on-transform can be enabled/disabled. The error can't be
+    # generated in the yield/return since it doesn't know if it will be autofixed.


unlikely I'll go with that design, transform+visit in single pass I'm pretty sure would guarantee that errors are output with incorrect line markers so I think you have to first transform, then revisit without transform. But would be substantial runtime reduction if you can do in single pass ofc, so will have to play around a bit with it.

jakkdl · 2023-03-16T12:24:04Z

flake8_trio/visitors/visitor_utility.py

                self.add_library(name)
+
+
+@utility_visitor_cst


pretty much just a copy of the ast version

jakkdl · 2023-03-16T12:26:00Z

tests/test_flake8_trio.py

remaining todo that [selectively] disabling autofix works, but now testing autofix for both trio and anyio.

jakkdl · 2023-03-16T12:27:06Z

flake8_trio/visitors/visitor91x.py


        # reset break & continue in case of nested loops
        self.outer[node]["uncheckpointed_statements"] = self.uncheckpointed_statements
-        self.restore_state(node)


needed to be moved to leave_While since it has to be done after inserting checkpoints in the loop body.

flake8_trio/visitors/visitor91x.py

jakkdl · 2023-03-16T13:02:33Z

flake8_trio/visitors/visitor91x.py

+    # returns a bool indicating if any real (i.e. not artificial) errors were raised
+    # so caller can insert checkpoint before statement (if yield/return) or at end
+    # of body (functiondef)
+    def check_function_exit(


moved all artificial statement logic from error_91x to check_function_exit

jakkdl · 2023-03-16T13:03:40Z

flake8_trio/visitors/visitor91x.py

        self.loop_state = LoopState()
        self.infinite_loop = self.body_guaranteed_once = False

+    visit_For = visit_While


ooooops, pretty nasty line to have forgotten about. Added a test that would've caught it.

flake8_trio/visitors/visitor91x.py

jakkdl · 2023-03-16T13:06:55Z

flake8_trio/visitors/visitor91x.py

+        This is *slightly* different enough from what the utility visitor does
+        that it's added here, but the functionality is maybe better placed in there.


it'd probably just need another bit saved in self.library on whether it's been explicitly imported, or just assumed/specified with --anyio. But I'll procrastinate on that with the on-the-spot-made-up-reasoning that there's ast visitors that use the current self.library functionality and I neither wanna update both nor have different library logic between them.

jakkdl · 2023-03-16T13:08:09Z

tests/eval_files/trio911.py

+async def foo_while_endless_3():
+    while True:
+        ...
+    yield  # type: ignore[unreachable]
+    await foo()
+
+
+async def foo_while_endless_4():
+    await foo()
+    while True:
+        yield
+        while True:
+            await foo()
+            yield


I don't remember why I added these 😇

tests/test_flake8_trio.py

jakkdl · 2023-03-16T13:12:25Z

Exciting indeed! Although not sure how you can be excited about reviewing modifications to a visitor that's up to 800 lines 😱 And that's before adding remove-unnecessary-checkpoint-logic!!!
Thankfully 1850 of the 2365 added lines are in generated autofix files, so you "only" have to review a diff of +501/-58 😅

Zac-HD · 2023-03-17T05:31:43Z

CONTRIBUTING.md

+### autofix files
+Checks that have autofixing can have a file in the `tests/autofix_files` directory matching the filename in `tests/eval_files`. The result of running the checker on the eval file with autofix enabled will then be compared to the content of the autofix file and will print a diff (if `-s` is on) and assert that the content is the same. `--generate-autofix` is added as a pytest flag to ease development, which will print a diff (with `-s`) and overwrite the content of the autofix file. Also see the magic line marker `pass # AUTOFIX_LINE ` below


Instead of spitting out the resulting .py files, can we save the diff between before and after as a .py.diff? It's much easier to get a sense of "what it's doing" in this format, and I'm concerned that without that code review is not going to be effective.

(although instead of constructing a three-way diff, I'd just let Pytest's assertion helper show the diff between the actual and expected diffs)

((diff diff diff, it hardly seems to ~~diff~~ mean anything anymore. diff)

I like the generated files for checking that they're valid and passes linters, and when developing they're easier to read and throw into cst.parse_module, but I'll generate diff files as well 👍

Oh, yep, both sounds good!

Wohoo, bigger commits! 😁
They're still not perfect, as they're not showing e.g. where checkpoints aren't inserted - but that will be covered by future tests that autofixed files don't generate any errors. (and will have to figure out a solution for errors that are expected not to get autofixed)

Zac-HD · 2023-03-17T05:33:32Z

flake8_trio/runner.py

        if not self.visitors:
            return
-        for v in self.visitors:
+        for v in chain(self.utility_visitors, self.visitors):


Suggested change

for v in chain(self.utility_visitors, self.visitors):

for v in (*self.utility_visitors, *self.visitors):

Could also use + because they're both tuples, but the "anything iterable" syntax is visibly safe.

Thought the chain was nice and explicit, but don't mind either variant. The plus solution might also be slower, no?

jakkdl · 2023-03-17T10:17:13Z

fixed comments

jakkdl · 2023-03-17T10:20:26Z

except I had untracked files ... updated my aliases so that won't happen again ^^
This is so handy it's crazy:

alias untracked="git ls-files -o --directory --exclude-standard | sed q1 > /dev/null"
alias gfpush='untracked && pytest --quiet -x && git commit -a --amend --no-edit && git push -f'

jakkdl · 2023-03-17T10:25:10Z

Oh and I realized that the pass # AUTOFIX_INSERT was a big brainfart yesterday, autofixing is all about inserting lines - I'm not explicitly marking each checkpoint that should be inserted, they're just added/generated to the autofix file. So completely removed that.
Still need the isort: skip_file though since autofix doesn't insert an empty line before the added import, and trying to worry about that isn't really viable.

jakkdl · 2023-03-17T10:45:18Z

ahahaha, trio.lowlevel.checkpoint() sure doesn't checkpoint - you kiiiinda need to do await trio.lowlevel.checkpoint()

jakkdl · 2023-03-17T11:02:52Z

I'm writing the extra tests now, and this implementation still does some dumb stuff (yield inside boolops and stuff), but I'll leave (not) handling those for the next PR.

Zac-HD · 2023-03-17T17:30:31Z

alias gfpush='untracked && pytest --quiet -x && git commit -a --amend --no-edit && git push -f'

--force-with-lease!

ahahaha, trio.lowlevel.checkpoint() sure doesn't checkpoint - you kiiiinda need to do await trio.lowlevel.checkpoint()

lint all the things 😜

jakkdl · 2023-03-20T11:15:05Z

Ooh, --force-with-lease is nice!

Well, there's no linter - other than flake8-trio itself, that catches unawaited trio.lowlevel.checkpoint()! Unless we change the pyright dependency from trio to trio-typing. That might definitely be good though, but I'm getting 59 errors when doing that - so needs a separate PR.

Zac-HD

Whew! Big diff to review, but this looks great. Thanks again @jakkdl!

jakkdl · 2023-03-21T07:27:21Z

I'll try to get the diffs to be smaller, but it's hard to avoid at this stage - and especially when working with the monster that is 91x 😅

Zac-HD · 2023-03-21T09:02:18Z

Oh yeah, that's not a criticism! Just an expression of relief that I made it through 😋

jakkdl · 2023-03-21T09:27:45Z

Haha, just meant it's worth trying for. If I don't keep it in the back of my mind the scope creep of PR's is very real 😇

jakkdl force-pushed the autofix_91x_forealthistime branch 3 times, most recently from 0bf4add to b700100 Compare March 15, 2023 15:16

jakkdl force-pushed the autofix_91x_forealthistime branch from b700100 to 49166b6 Compare March 16, 2023 11:14

jakkdl marked this pull request as ready for review March 16, 2023 11:14

jakkdl commented Mar 16, 2023

View reviewed changes

jakkdl force-pushed the autofix_91x_forealthistime branch from 49166b6 to 6f20d79 Compare March 16, 2023 13:00

jakkdl commented Mar 16, 2023

View reviewed changes

Zac-HD reviewed Mar 17, 2023

View reviewed changes

jakkdl force-pushed the autofix_91x_forealthistime branch from 6f20d79 to 249eb2b Compare March 17, 2023 10:14

jakkdl force-pushed the autofix_91x_forealthistime branch from 249eb2b to cc43270 Compare March 17, 2023 10:18

implement autofix for 91x

220c405

jakkdl force-pushed the autofix_91x_forealthistime branch from cc43270 to 220c405 Compare March 17, 2023 10:47

This was referenced Mar 17, 2023

test for autofix_files, fix some 91x autofixes, rejig eval_files #159

Merged

Switch backend to libCST #124

Open

Zac-HD approved these changes Mar 20, 2023

View reviewed changes

Zac-HD merged commit 033317a into python-trio:main Mar 20, 2023

jakkdl deleted the autofix_91x_forealthistime branch March 21, 2023 07:25

		This is slightly different enough from what the utility visitor does
		that it's added here, but the functionality is maybe better placed in there.

		### autofix files
		Checks that have autofixing can have a file in the `tests/autofix_files` directory matching the filename in `tests/eval_files`. The result of running the checker on the eval file with autofix enabled will then be compared to the content of the autofix file and will print a diff (if `-s` is on) and assert that the content is the same. `--generate-autofix` is added as a pytest flag to ease development, which will print a diff (with `-s`) and overwrite the content of the autofix file. Also see the magic line marker `pass # AUTOFIX_LINE ` below

	for v in chain(self.utility_visitors, self.visitors):
	for v in (self.utility_visitors, self.visitors):

		self.add_library(name)


		@utility_visitor_cst

Uh oh!

Conversation

jakkdl commented Mar 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Zac-HD commented Mar 15, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jakkdl commented Mar 16, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jakkdl commented Mar 17, 2023

Uh oh!

jakkdl commented Mar 17, 2023

Uh oh!

jakkdl commented Mar 17, 2023

Uh oh!

jakkdl commented Mar 17, 2023

Uh oh!

jakkdl commented Mar 17, 2023

Uh oh!

Zac-HD commented Mar 17, 2023

Uh oh!

jakkdl commented Mar 20, 2023

Uh oh!

Zac-HD left a comment

Choose a reason for hiding this comment

Uh oh!

jakkdl commented Mar 21, 2023

Uh oh!

Zac-HD commented Mar 21, 2023

Uh oh!

jakkdl commented Mar 21, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jakkdl commented Mar 15, 2023 •

edited

Loading