subprocess.TimeoutExpired exception in get_version

[apteronal]

Hello,

I'm using a development version of websockets for a program. Sometimes when starting the program, this exception occurs and the program fails:
subprocess.TimeoutExpired: Command '['git', 'describe', '--dirty', '--tags', '--long']' timed out after 1 seconds

Not sure why. The system is using a slow, spinning disk so I wonder if the Git command just takes longer than 1 second. Whatever the case, it seems like the exception should be handled.

Traceback:

Traceback (most recent call last):
  File "/home/apteronal/foo.py", line 6, in <module>
    import websockets
  File "/home/apteronal/development/websockets/src/websockets/__init__.py", line 4, in <module>
    from .version import version as __version__  # noqa
  File "/home/apteronal/development/websockets/src/websockets/version.py", line 68, in <module>
    version = get_version(tag)
  File "/home/apteronal/development/websockets/src/websockets/version.py", line 38, in get_version
    description = subprocess.run(
  File "/usr/lib/python3.9/subprocess.py", line 507, in run
    stdout, stderr = process.communicate(input, timeout=timeout)
  File "/usr/lib/python3.9/subprocess.py", line 1134, in communicate
    stdout, stderr = self._communicate(input, endtime, timeout)
  File "/usr/lib/python3.9/subprocess.py", line 1982, in _communicate
    self._check_timeout(endtime, orig_timeout, stdout, stderr)
  File "/usr/lib/python3.9/subprocess.py", line 1178, in _check_timeout
    raise TimeoutExpired(
subprocess.TimeoutExpired: Command '['git', 'describe', '--dirty', '--tags', '--long']' timed out after 1 seconds

I'd be glad to try to provide further information if needed. Thank you for developing this library.

[aaugustin]

Yes, it would make sense to catch this exception here: https://github.com/python-websockets/websockets/blob/main/src/websockets/version.py#L49

[apteronal]

Added the exception to that tuple. I assume it'll fix the intermittent problem. Will submit a PR once I verify.

[aaugustin]

I was thinking of adding a separate except TimeoutError: that logs a warning. This slows down the import of the library. If you have the problem, probably you want to know about it.

[aaugustin]

I decided to keep things simple and just catch subprocess.TimeoutError.