Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Allow dotted test filenames (`*.test.py`) via one-line change to `compute_module_name`

未关闭 适合新手
#14,514 6 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

@siddy-stack 已经在做这个了。

开始于 2026年8月18日。

  • #14515 来自 @NIK-TIGER-BILL —— 已关闭,未合并
  • #14562 来自 @marko1olo —— 已关闭,未合并
  • #14750 来自 @Abhi-DevHub —— 已关闭,未合并

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
86/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
python
领域
testing-qa

调研方向

从 _pytest/pathlib.py 中的 compute_module_name 开始,将其对路径部分的处理与第 796 行附近的 module_name_from_path 进行比较。在相关的导入模式下验证带点文件名的情况,然后添加转义行为,使 pkg/foo.test.py 解析为 pkg.foo_test,同时不改变不带点的文件名。

由索引模型根据 Issue 内容生成。

描述

Proposal

Escape dots inside path parts in _pytest.pathlib.compute_module_name, the same way module_name_from_path already does:

  def compute_module_name(root: Path, module_path: Path) -> str | None:
      ...
      names = list(relative.parts)
      if not names:
          return None
      if names[-1] == "__init__":
          names.pop()
+     names = [p.replace(".", "_") for p in names]
      return ".".join(names)

This makes pkg/foo.test.py collect as module pkg.foo_test instead of the invalid pkg.foo.test.

Motivation

The *.test.py filename convention has a property that test_*.py and *_test.py do not: a test file colocated next to its target module cannot be imported by production code. A dot in the filename makes it an invalid Python module name, so the import system cannot reach it through any import statement. With this change, pytest becomes the only thing that can load it.

In practice this:

  • Allows colocating tests next to source (pkg/foo.py + pkg/foo.test.py) without any risk of production code importing test helpers, fixtures, or mock data
  • Eliminates a class of "we accidentally shipped/imported test code" bugs that naming conventions alone cannot prevent
  • Mirrors the widely-used foo.test.ts convention from the JS/TS ecosystem
Current behavior

compute_module_name joins path parts with . without escaping, so pkg/foo.test.py produces the module name pkg.foo.test. Under --import-mode=importlib, _import_module_using_spec then walks up looking for the parent package, concludes it needs pkg.foo, finds pkg/__init__.py adjacent, and loads pkg/__init__.py under the wrong name pkg.foo — silently aliasing the package onto a name that should belong to the sibling source module pkg/foo.py. Subsequent import pkg.foo from inside the test gets the package's __init__.py, not foo.py.

Under --import-mode=prepend|append, the failure is loud: ModuleNotFoundError: No module named 'pkg.foo.test'; 'pkg.foo' is not a package.

The fallback module_name_from_path already applies this exact dot-escape (line 796 of _pytest/pathlib.py):

path_parts = tuple(x.replace(".", "_") for x in path_parts)

But that fallback only runs when resolve_pkg_root_and_module_name fails (no __init__.py chain) — exactly the case where colocation is least useful.

Why this is safe

The proposed line is verbatim what pytest already does in its sibling code path. Applying it consistently in compute_module_name:

  • Has no effect on any filename without a dot (the vast majority of test files)
  • Doesn't change behavior for files where compute_module_name already produces a valid module name
  • Maps dotted filenames to a deterministic name (foo.test.py → foo_test)
Related
  • #1426 (closed, "warn about invalid test module names")
  • #6422 (closed as invalid, "filename contains more than one dot")
主要语言
Python
星标
14.6k
派生
3.5k
平均合并
1 天 17 小时
30 天内合并 PR
25

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

pytest-dev/pytest 的其他 Issue

查看 pytest-dev/pytest 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。