Skip to content

Conversation

@drichardson
Copy link

@drichardsondrichardson commented Dec 14, 2024

Background

The documented steps to run tests say to

python setup.py test 

However, that results in

$ python setup.py test usage: setup.py [global_opts] cmd1 [cmd1_opts] [cmd2 [cmd2_opts] ...] or: setup.py --help [cmd1 cmd2 ...] or: setup.py --help-commands or: setup.py cmd --help error: invalid command 'test' 

However, the make test target works.

Changes

  1. Reference make test for running tests
  2. For consistency, also updated build and build debug commands in Building from source to use make and make debug.

Testing

Ran make htmldocs and verified output was correct. Only minor weirdness was the green syntax highlighting on test in make test (perhaps because it's a built in bash command).

Screenshot of rendered HTML:

Screenshot 2024-12-14 at 11 39 45

@drichardsondrichardson marked this pull request as ready for review December 14, 2024 19:41
@drichardsondrichardson changed the title Fix broken docsFix broken test running documentationDec 14, 2024
Copy link
Member

@elpranselprans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@drichardson
Copy link
Author

@elprans do you have permission to re-trigger a github Action run on this failed job (I'm guessing it's flaky since mine was only a documentation change).

====================================================================== FAIL: test_pool_max_inactive_time_04 (test_pool.TestPool) ---------------------------------------------------------------------- Traceback (most recent call last): File "D:\a\asyncpg\asyncpg\asyncpg\_testbase\__init__.py", line 453, in tearDown super().tearDown() File "D:\a\asyncpg\asyncpg\asyncpg\_testbase\__init__.py", line 369, in tearDown super().tearDown() File "D:\a\asyncpg\asyncpg\asyncpg\_testbase\__init__.py", line 138, in tearDown self.fail( AssertionError: unexpected exceptions in asynchronous code: 01. Exception in callback _ProactorBasePipeTransport._call_connection_lost(None): [handle]: <Handle _ProactorBasePipeTransport._call_connection_lost(None)> [exception]: Traceback (most recent call last): File "C:\hostedtoolcache\windows\Python\3.9.13\x64\lib\asyncio\events.py", line 80, in _run self._context.run(self._callback, *self._args) File "C:\hostedtoolcache\windows\Python\3.9.13\x64\lib\asyncio\proactor_events.py", line 162, in _call_connection_lost self._sock.shutdown(socket.SHUT_RDWR) ConnectionResetError: [WinError 10054] An existing connection was forcibly closed by the remote host 

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@drichardson@elprans