Fixed #35571 -- Store template_names as string #18331
Conversation
When passing pathlib.Path or pathlib.PosixPath as template names (because templates are in subdirectories, so pathlib seems reasonable to use) the assertTemplateUsed breaks as it performs a str.join on all template names without sanitizing them.
```
File "<stuff>/.local/lib/python3.12/site-packages/django/test/testcases.py", line 681, in _assert_template_used
% (template_name, ", ".join(template_names)),
^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: sequence item 0: expected str instance, PosixPath found
```
This causes a lot of confusion as it is quite hard to track down the Template that introduced the PosixPath.
This is one proposed solution for fixing this. I.e. trying to sanitize all template names when they are passed into the template engine, as this seems easier then trying to find all cases where the stringiness of the template name is assumed. Another approach would be to have an assert that the template name is a string, but this could possible break code that doesn't utilize the test framework.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello! Thank you for your contribution 💪
As it's your first contribution be sure to check out the patch review checklist.
If you're fixing a ticket from Trac make sure to set the "Has patch" flag and include a link to this PR in the ticket!
If you have any design or process questions then you can ask in the Django forum.
Welcome aboard ⛵️!
|
Hello @guserav, thank you for your first contribution! 🌟 As I mentioned in the ticket, we would need to first fully understand the report by having a minimal reproducer or a Django test case, for then to be able to accept the ticket and thus properly reviewing this PR. |
Trac ticket number
ticket-35571
Branch description
When passing pathlib.Path or pathlib.PosixPath as template names (because templates are in subdirectories, so pathlib seems reasonable to use) the assertTemplateUsed breaks as it performs a str.join on all template names without sanitizing them.
This causes a lot of confusion as it is quite hard to track down the Template that introduced the PosixPath.
This is one proposed solution for fixing this. I.e. trying to sanitize all template names when they are passed into the template engine, as this seems easier then trying to find all cases where the stringiness of the template name is assumed. Another approach would be to have an assert that the template name is a string, but this could possible break code that doesn't utilize the test framework.
Checklist
mainbranch.