flupy CLI does not work on Windows

[abraha2d]

Ran into this issue while in the process of adding flupy (and alembic-utils) to conda-forge here: conda-forge/staged-recipes#26023.

Seems to be due to this bit here:

flupy/src/flupy/cli/cli.py

Line 4 in 5fc989c

from signal import SIG_DFL, SIGPIPE, signal

signal.SIGPIPE is not available on Windows.

Traceback:

>flu --help 
Traceback (most recent call last):
  File "C:\bld\flupy_1712887240528\_test_env\Scripts\flu-script.py", line 5, in <module>
    from flupy.cli.cli import main
  File "C:\bld\flupy_1712887240528\_test_env\Lib\site-packages\flupy\cli\cli.py", line 4, in <module>
    from signal import SIG_DFL, SIGPIPE, signal
ImportError: cannot import name 'SIGPIPE' from 'signal' (C:\bld\flupy_1712887240528\_test_env\Lib\signal.py). Did you mean: 'SIGFPE'?

[olirice]

Unfortunately I don't have access to a windows machine. Any chance you'd be interested in a creating a PR?

[abraha2d]

Let me see if I can put up a PR. I also don't run Windows regularly, but do occasionally use a VM.

[abraha2d]

Looked into this a little more... I think the solution might be to just remove that line entirely?
SIGPIPE is already ignored in Python by default: https://docs.python.org/3/library/signal.html#signal.SIGPIPE

[olirice]

did you get a chance to test if that functioned on a windows machine, or is that a best guess?

[abraha2d]

Not tested on Windows (still trying to recover my VM), but I did test on Linux, and removing that line did not change any behavior.

Tested it with this invocation:
journalctl -ef | flu '_.filter(lambda x: x.startswith("Apr 27 04:15"))'
(and then finding the PID of the journalctl process and killing it)

No broken pipe exception was thrown. This was with Python 3.10 on Ubuntu 22.04

[abraha2d]

Ok, verified that it fixes functionality on Windows as well:

(.venv) C:\git\flupy>type logs.txt
ERROR 1
ERROR 2
ERROR 3
NOT AN ERROR 4
ERROR 5
NOT AN ERROR 6
NOT AN ERROR 7
ERROR 8
NOT AN ERROR 9
NOT AN ERROR 10

(.venv) C:\git\flupy>type logs.txt | flu "_.filter(lambda x: x.startswith('ERROR'))"
Traceback (most recent call last):
  File "<frozen runpy>", line 198, in _run_module_as_main
  File "<frozen runpy>", line 88, in _run_code
  File "C:\git\flupy\.venv\Scripts\flu.exe\__main__.py", line 4, in <module>
  File "C:\git\flupy\src\flupy\cli\cli.py", line 4, in <module>
    from signal import SIG_DFL, SIGPIPE, signal
ImportError: cannot import name 'SIGPIPE' from 'signal' (C:\Program Files\WindowsApps\PythonSoftwareFoundation.Python.3.12_3.12.1008.0_x64__qbz5n2kfra8p0\Lib\signal.py). Did you mean: 'SIGFPE'?

(.venv) C:\git\flupy>git checkout fix-windows-compat
branch 'fix-windows-compat' set up to track 'origin/fix-windows-compat'.
Switched to a new branch 'fix-windows-compat'

(.venv) C:\git\flupy>type logs.txt | flu "_.filter(lambda x: x.startswith('ERROR'))"
ERROR 1
ERROR 2
ERROR 3
ERROR 5
ERROR 8

#34 is now ready for review.