ignore files for quartdoc build -- watch

[hamelsmu]

This attempts to addresses #223 by adding files we might want to ignore

I wasn't able to repro #223 but I made a best effort based on the comments around ignoring __pycache__ which seems reasonable. I also added similar directories we wanted to ignore.

@machow @wch do you want to test this branch to see if it solves the issue?

[machow]

Thanks for this! Do you mind tweaking here (or in another PR) the try/except to do something like...

                except KeyboardInterrupt:
                    pass
                finally:
                    observer.stop()
                    observer.join()

It looks like when non- KeyboardInterrupt errors occur right now, they leave they end up not joining the handler

[hamelsmu]

Thanks for this! Do you mind tweaking here (or in another PR) the try/except to do something like...

done 85634c6

[machow]

It looks like it is still rebuilding multiple times.

I tested by:

• running quartodoc build --watch from quartodoc's docs folder
• changing quartodoc/renderers/md_renderer.py (just added a newline)

Do you mind taking another look? Thanks!

edit: I wonder if we need to ignore the __pycache__ directory itself (so the trailing slash throws it off), but have no idea based off of the very sparse watchdog docs 😭

[hamelsmu]

Wasn't able to repro

Steps I took

gh pr checkout 228
pip install -e .
cd docs
quartodoc build --watch

Then I add the following function to md_renderer.py

def foo(): pass

The following is emitted to the logs (no infinite loop)

Watching /Users/hamel/github/quartodoc/quartodoc for changes...
Rebuilding docs.  Detected: modified path : /Users/hamel/github/quartodoc/quartodoc/renderers/md_renderer.py

[hamelsmu]

Stuff about my environment:

Python 3.9.12
Quarto v1.4.224

watchdog                      3.0.0
click                         8.1.3
click-default-group-wheel     1.2.2
plum-dispatch                 1.7.4

[hamelsmu]

@machow this is ready for review. I limited the Queue size to 1 and also added a delay into the callback such that when there is a flood of events at the same time it will ignore ones that occur in near succession (to mitigate what happens when you change branches in git)

[machow]

This looks great! Thanks for working out all the watcher quirks. All this stuff has made docs workflow way smoother!

I left a small question about the order of printing (I noticed "Rebuilding ..." came after the build). Sorry for missing it when reviewing earlier 😓

[machow]

I was thrown for a second seeing the Rebuilding message, after the build output. I wonder if putting it before might help people connect the triggering event with the build? WDYT?

For long builds, a message after might look like nothing's happening (could also sandwich the build with a pre "going to build" message, and post "just built" message)

Here is what my output looked like...

Watching /Users/machow/repos/quartodoc/quartodoc for changes...
2023-08-03 10:05:56,694 - quartodoc.autosummary - INFO - Generating blueprint.
2023-08-03 10:05:56,701 - quartodoc.builder.blueprint - INFO - Getting object for quartodoc:Auto
...
2023-08-03 10:05:56,798 - quartodoc.autosummary - INFO - Creating inventory file
2023-08-03 10:05:56,798 - quartodoc.autosummary - INFO - Creating inventory
2023-08-03 10:05:56,800 - quartodoc.autosummary - INFO - Writing sidebar yaml to api/_sidebar.yml
Rebuilding docs.  Detected: created path : /Users/machow/repos/quartodoc/quartodoc/a.py

[hamelsmu]

@machow I fixed this in 7593571

Thanks

[machow]

LGTM! Thanks for slogging through this!