diff --git a/CHANGES.rst b/CHANGES.rst index afc86e5e7..4cc30f11f 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -5,6 +5,9 @@ Version 3.1.1 Unreleased +- The template filename on Windows uses the primary path separator. + :issue:`1637` + Version 3.1.0 ------------- diff --git a/src/jinja2/loaders.py b/src/jinja2/loaders.py index e255cd41f..d2f98093c 100644 --- a/src/jinja2/loaders.py +++ b/src/jinja2/loaders.py @@ -213,7 +213,8 @@ def uptodate() -> bool: except OSError: return False - return contents, filename, uptodate + # Use normpath to convert Windows altsep to sep. + return contents, os.path.normpath(filename), uptodate raise TemplateNotFound(template) def list_templates(self) -> t.List[str]: @@ -330,8 +331,11 @@ def get_source( self, environment: "Environment", template: str ) -> t.Tuple[str, str, t.Optional[t.Callable[[], bool]]]: # Use posixpath even on Windows to avoid "drive:" or UNC - # segments breaking out of the search directory. - p = posixpath.join(self._template_root, *split_template_path(template)) + # segments breaking out of the search directory. Use normpath to + # convert Windows altsep to sep. + p = os.path.normpath( + posixpath.join(self._template_root, *split_template_path(template)) + ) up_to_date: t.Optional[t.Callable[[], bool]] if self._archive is None: diff --git a/tests/test_loader.py b/tests/test_loader.py index 812358316..04c921d24 100644 --- a/tests/test_loader.py +++ b/tests/test_loader.py @@ -3,7 +3,6 @@ import importlib.util import os import platform -import posixpath import shutil import sys import tempfile @@ -172,6 +171,15 @@ def test_uses_specified_encoding(self, encoding, expect): t = e.get_template("mojibake.txt") assert t.render() == expect + def test_filename_normpath(self): + """Nested template names should only contain ``os.sep`` in the + loaded filename. + """ + loader = loaders.FileSystemLoader(self.searchpath) + e = Environment(loader=loader) + t = e.get_template("foo/test.html") + assert t.filename == str(self.searchpath / "foo" / "test.html") + class TestModuleLoader: archive = None @@ -304,7 +312,7 @@ def package_dir_loader(monkeypatch): def test_package_dir_source(package_dir_loader, template, expect): source, name, up_to_date = package_dir_loader.get_source(None, template) assert source.rstrip() == expect - assert name.endswith(posixpath.join(*split_template_path(template))) + assert name.endswith(os.path.join(*split_template_path(template))) assert up_to_date() @@ -326,7 +334,7 @@ def package_file_loader(monkeypatch): def test_package_file_source(package_file_loader, template, expect): source, name, up_to_date = package_file_loader.get_source(None, template) assert source.rstrip() == expect - assert name.endswith(posixpath.join(*split_template_path(template))) + assert name.endswith(os.path.join(*split_template_path(template))) assert up_to_date() @@ -349,7 +357,7 @@ def package_zip_loader(monkeypatch): def test_package_zip_source(package_zip_loader, template, expect): source, name, up_to_date = package_zip_loader.get_source(None, template) assert source.rstrip() == expect - assert name.endswith(posixpath.join(*split_template_path(template))) + assert name.endswith(os.path.join(*split_template_path(template))) assert up_to_date is None