REF/FIX: Fix Python 3.11 support and test suite-focused cleanup

klauer commented 1 year ago

Description

ophyd.Kind enum.Enum, being an IntFlag is a bit of a special beast. Its functionality in Python 3.11 differs in enumeration of items - resulting in typhos only picking up a couple of component kinds.
Secondarily, multiprocessing to run a caproto IOC ended up being problematic for Python 3.11, so I restructured the test suite a bit to run IOCs by name (simply regenerating the test cases in the parent process and in the IOC)
Profiling code is skipped on 3.11
"All QMenu escape hatch" remains for only one test (all screenshots test). Unclear why this is but we get a green checkmark.
Vendored pydm load_ui_file and modified it so we can always get our Display instance back and clean it up if desirable.
Ignore deleted qt objects on SignalConnection.remove_connection
Avoid hundreds of warnings during profiling
Avoid creating subdisplays during "hide_subdisplays"
Add a big pytest configuration helper to aid in finding dangling widgets
Avoid failing screenshot taking when widgets are garbage collected at the same time

Motivation and Context

Python 3.11 support would be nice eventually

This PR manifested itself like this:

Python 3.11 had some obvious incompatibilities with enums, so I fixed that
Once that was fixed, the benchmark/profiling test suite was causing major issues, so I refactored it to avoid multiprocessing and isolate the test IOC in its own script
That still wasn't enough to get the test suite to pass. I saw widgets leaking from one test to another, so I added a conftest pytest hook that aimed to remove all stragglers
Then I found that Python 3.11 benchmarking still wasn't working great, so I disabled it at moved on
... Then I found a bunch of stragglers and some weird things (listed above as 'avoid' or 'fix')
And finally, there was one failing test I couldn't resolve (test_take_top_level_widget_screenshots sees hundreds of QMenu instances at the top level)
And now, green checkmark

Overall, I think this is in a better spot than before. It's absolutely not perfect, though.

How Has This Been Tested?

Locally and test suite

Where Has This Been Documented?

Screenshots (if appropriate):

    def dump(obj, file, protocol=None):
        '''Replacement for pickle.dump() using ForkingPickler.'''
>       ForkingPickler(file, protocol).dump(obj)
E       _pickle.PicklingError: Can't pickle <class 'ophyd.device.FlatConnect'>: attribute lookup FlatConnect on ophyd.device failed

klauer commented 1 year ago

Well it failed spectacularly on GitHub Actions, whereas it passed locally so 🤷 Going to mark profiling code as xfail temporarily (PR is still draft)

klauer commented 1 year ago

OK, this is a bit of a mess and there are a ton of changes. I did this over a long period of time with (sometimes) limited attention being paid to what I was doing.

Each change should be really scrutinized!

ZLLentz commented 1 year ago

I notice that you left some of the cleanup for another day- I think that's completely appropriate. You've cleaned up almost all of it already and the last QMenus seem to be lurking from upstream code.

klauer commented 1 year ago

🤞

klauer commented 1 year ago

2 green checkmarks in a row indicate it's probably good enough as-is. Before this gets any larger, if you guys are good with it - I'd say let's merge @tangkong @ZLLentz

We may revisit and adjust how strict this is in the future based on how many intermittent failures we get (due to gc/teardown slowness). Increasing the wait time may also suffice...

ZLLentz commented 1 year ago

I'll click merge now to make sure it happens

pcdshub / typhos