#36697 closed Cleanup/optimization (fixed)
black need to be installed to launch the full test suite and it's not in the requirements
| Reported by: | Pierre Sassoulas | Owned by: | |
|---|---|---|---|
| Component: | Core (Management commands) | Version: | dev |
| Severity: | Normal | Keywords: | tests, black, contributing |
| Cc: | Pierre Sassoulas | Triage Stage: | Accepted |
| Has patch: | no | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description (last modified by )
When first starting to contribute to django, 205 test errors out (FAILED (errors=205, skipped=1827, expected failures=5)
) with the following stacktrace:
ERROR: test_makemessages_no_settings (i18n.test_extraction.NoSettingsExtractionTests.test_makemessages_no_settings)
----------------------------------------------------------------------
Traceback (most recent call last):
File "/home/pierre/.local/share/uv/python/cpython-3.13.1-linux-x86_64-gnu/lib/python3.13/unittest/case.py", line 58, in testPartExecutor
yield
File "/home/pierre/.local/share/uv/python/cpython-3.13.1-linux-x86_64-gnu/lib/python3.13/unittest/case.py", line 651, in run
self._callTestMethod(testMethod)
File "/home/pierre/.local/share/uv/python/cpython-3.13.1-linux-x86_64-gnu/lib/python3.13/unittest/case.py", line 606, in _callTestMethod
if method() is not None:
^^^^^^^^^^^^^^^
File "/home/pierre/git/django/tests/i18n/test_extraction.py", line 1131, in test_makemessages_no_settings
out, err = self.run_django_admin(["makemessages", "-l", "en", "-v", "0"])
^^^^^^^^^^^^^^^
File "/home/pierre/git/django/tests/admin_scripts/tests.py", line 167, in run_django_admin
return self.run_test(
^^^^^^^^^^^^^^^
File "/home/pierre/git/django/tests/admin_scripts/tests.py", line 152, in run_test
test_environ["PATH"] = self.path_without_formatters
^^^^^^^^^^^
File "/home/pierre/git/django/django/utils/functional.py", line 47, in __get__
res = instance.__dict__[self.name] = self.func(instance)
^^^^^^^^^^^^^^^
File "/home/pierre/git/django/tests/admin_scripts/tests.py", line 123, in path_without_formatters
if os.path.commonpath([path_component, formatter_path]) == os.sep
^^^^^^^
File "<frozen posixpath>", line 536, in commonpath
TypeError: expected str, bytes or os.PathLike object, not NoneType
When find_formatters return a black_path that is None (shutil.which("black") is None, meaning black is not installed).
I suggest raising a better error message by catching this in find_formatters directly and/or adding black to tests/requirements/py3.py.
Change History (7)
comment:1 by , 8 hours ago
| Description: | modified (diff) |
|---|
comment:2 by , 8 hours ago
comment:3 by , 8 hours ago
| Keywords: | contributing added |
|---|---|
| Triage Stage: | Unreviewed → Accepted |
| Version: | 5.2 → dev |
Thank you Pierre! This is in the context of Running Django’s test suite for the first time. I see the installation step has black listed in requirements.
I think it would be worth you troubleshoot why it’s not installed and worked as expected? But it also makes sense (to me at least) to have a better error message for this if this is a common issue for new contributors.
comment:4 by , 7 hours ago
I think a fix just landed in https://github.com/django/django/pull/20023. Please try again with latest upstream and confirm if the issue is fixed for you.
comment:5 by , 7 hours ago
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
| Triage Stage: | Accepted → Unreviewed |
Thank you everyone, Clifford is correct that a fix just landed. Sorry for the trouble! See #36680 for more details.
comment:6 by , 7 hours ago
| Component: | Uncategorized → Core (Management commands) |
|---|---|
| Triage Stage: | Unreviewed → Accepted |
(Adjusting triage a bit.)
Fixed in 3939cd279569fde44f557d79f20bb5b1a02440af.
I ran into the same problem and was able to resolve with
pip install black. Should we also skip tests if black is not installed?