Support and prefer ``.jinja`` to ``_t`` for static templates (#11165)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

1 files changed, 20 insertions, 9 deletions

diff --git a/tests/test_util_fileutil.py b/tests/test_util_fileutil.py
index 7ea12508c..86f2c96b4 100644
--- a/tests/test_util_fileutil.py
+++ b/tests/test_util_fileutil.py
@@ -3,7 +3,7 @@
 from unittest import mock
 
 from sphinx.jinja2glue import BuiltinTemplateLoader
-from sphinx.util.fileutil import copy_asset, copy_asset_file
+from sphinx.util.fileutil import _template_basename, copy_asset, copy_asset_file
 
 
 class DummyTemplateLoader(BuiltinTemplateLoader):
@@ -28,9 +28,9 @@ def test_copy_asset_file(tempdir):
     assert src.read_text(encoding='utf8') == dest.read_text(encoding='utf8')
 
     # copy template file
-    src = (tempdir / 'asset.txt_t')
+    src = (tempdir / 'asset.txt.jinja')
     src.write_text('# {{var1}} data')
-    dest = (tempdir / 'output.txt_t')
+    dest = (tempdir / 'output.txt.jinja')
 
     copy_asset_file(src, dest, {'var1': 'template'}, renderer)
     assert not dest.exists()
@@ -38,7 +38,7 @@ def test_copy_asset_file(tempdir):
     assert (tempdir / 'output.txt').read_text(encoding='utf8') == '# template data'
 
     # copy template file to subdir
-    src = (tempdir / 'asset.txt_t')
+    src = (tempdir / 'asset.txt.jinja')
     src.write_text('# {{var1}} data')
     subdir1 = (tempdir / 'subdir')
     subdir1.makedirs()
@@ -48,14 +48,14 @@ def test_copy_asset_file(tempdir):
     assert (subdir1 / 'asset.txt').read_text(encoding='utf8') == '# template data'
 
     # copy template file without context
-    src = (tempdir / 'asset.txt_t')
+    src = (tempdir / 'asset.txt.jinja')
     subdir2 = (tempdir / 'subdir2')
     subdir2.makedirs()
 
     copy_asset_file(src, subdir2)
     assert not (subdir2 / 'asset.txt').exists()
-    assert (subdir2 / 'asset.txt_t').exists()
-    assert (subdir2 / 'asset.txt_t').read_text(encoding='utf8') == '# {{var1}} data'
+    assert (subdir2 / 'asset.txt.jinja').exists()
+    assert (subdir2 / 'asset.txt.jinja').read_text(encoding='utf8') == '# {{var1}} data'
 
 
 def test_copy_asset(tempdir):
@@ -65,12 +65,12 @@ def test_copy_asset(tempdir):
     source = (tempdir / 'source')
     source.makedirs()
     (source / 'index.rst').write_text('index.rst', encoding='utf8')
-    (source / 'foo.rst_t').write_text('{{var1}}.rst', encoding='utf8')
+    (source / 'foo.rst.jinja').write_text('{{var1}}.rst', encoding='utf8')
     (source / '_static').makedirs()
     (source / '_static' / 'basic.css').write_text('basic.css', encoding='utf8')
     (source / '_templates').makedirs()
     (source / '_templates' / 'layout.html').write_text('layout.html', encoding='utf8')
-    (source / '_templates' / 'sidebar.html_t').write_text('sidebar: {{var2}}', encoding='utf8')
+    (source / '_templates' / 'sidebar.html.jinja').write_text('sidebar: {{var2}}', encoding='utf8')
 
     # copy a single file
     assert not (tempdir / 'test1').exists()
@@ -101,3 +101,14 @@ def test_copy_asset(tempdir):
     assert not (destdir / '_static' / 'basic.css').exists()
     assert (destdir / '_templates' / 'layout.html').exists()
     assert not (destdir / '_templates' / 'sidebar.html').exists()
+
+
+def test_template_basename():
+    assert not _template_basename("asset.txt")
+    assert _template_basename("asset.txt.jinja") == "asset.txt"
+    assert _template_basename("sidebar.html.jinja") == "sidebar.html"
+
+
+def test_legacy_template_basename():
+    # TODO: deprecate '_t' template suffix support after 2024-12-31
+    assert _template_basename("asset.txt_t") == "asset.txt"