os-listdir (PTH208)

派生自 flake8-use-pathlib linter。

作用

检查 os.listdir 的使用。

为什么这不好？

与 os 提供的底层 API 相比，pathlib 为路径操作提供了更高级的 API。如果可能，使用 pathlib 的 Path.iterdir() 可以提高代码可读性，优于 os.listdir()。

示例

p = "."
for d in os.listdir(p):
    ...

if os.listdir(p):
    ...

if "file" in os.listdir(p):
    ...

建议改为

p = Path(".")
for d in p.iterdir():
    ...

if any(p.iterdir()):
    ...

if (p / "file").exists():
    ...

已知问题

虽然使用 pathlib 可以提高代码的可读性和类型安全性，但与直接使用字符串的较低级替代方案相比，它的性能可能会降低，尤其是在旧版本的 Python 上。

参考

• Python 文档: Path.iterdir
• Python 文档: os.listdir
• PEP 428 – pathlib 模块 – 面向对象的filesystem paths
• os 和 pathlib 之间的对应关系
• 为什么您应该使用 pathlib
• 真的，pathlib 很棒