os-path-islink (PTH114)

Derived from the flake8-use-pathlib linter.

What it does

Checks for uses of os.path.islink.

Why is this bad?

pathlib offers a high-level API for path manipulation, as compared to the lower-level API offered by os.path. When possible, using Path object methods such as Path.is_symlink() can improve readability over the os.path module's counterparts (e.g., os.path.islink()).

Examples

import os

os.path.islink("docs")

Use instead:

from pathlib import Path

Path("docs").is_symlink()

Known issues

While using pathlib can improve the readability and type safety of your code, it can be less performant than the lower-level alternatives that work directly with strings, especially on older versions of Python.

References

• Python documentation: Path.is_symlink
• Python documentation: os.path.islink
• PEP 428 – The pathlib module – object-oriented filesystem paths
• Correspondence between os and pathlib
• Why you should be using pathlib
• No really, pathlib is great