feat: flake8-use-pathlib PTH100-124 (#2090)

README.md

@@ -141,6 +141,7 @@ developer of [Zulip](https://github.com/zulip/zulip):
    1. [flake8-executable (EXE)](#flake8-executable-exe)
    1. [flake8-type-checking (TYP)](#flake8-type-checking-typ)
    1. [tryceratops (TRY)](#tryceratops-try)
+   1. [flake8-use-pathlib (PTH)](#flake8-use-pathlib-pth)
    1. [Ruff-specific rules (RUF)](#ruff-specific-rules-ruf)<!-- End auto-generated table of contents. -->
 1. [Editor Integrations](#editor-integrations)
 1. [FAQ](#faq)
@@ -1197,6 +1198,38 @@ For more, see [tryceratops](https://pypi.org/project/tryceratops/1.1.0/) on PyPI
 | TRY004 | prefer-type-error | Prefer `TypeError` exception for invalid type | 🛠 |
 | TRY300 | try-consider-else | Consider `else` block |  |
 
+### flake8-use-pathlib (PTH)
+
+For more, see [flake8-use-pathlib](https://pypi.org/project/flake8-use-pathlib/) on PyPI.
+
+| Code | Name | Message | Fix |
+| ---- | ---- | ------- | --- |
+| PTH100 | pathlib-abspath | `os.path.abspath` should be replaced by `.resolve()` |  |
+| PTH101 | pathlib-chmod | `os.chmod` should be replaced by `.chmod()` |  |
+| PTH102 | pathlib-mkdir | `os.mkdir` should be replaced by `.mkdir()` |  |
+| PTH103 | pathlib-makedirs | `os.makedirs` should be replaced by `.mkdir(parents=True)` |  |
+| PTH104 | pathlib-rename | `os.rename` should be replaced by `.rename()` |  |
+| PTH105 | pathlib-replace | `os.replace`should be replaced by `.replace()` |  |
+| PTH106 | pathlib-rmdir | `os.rmdir` should be replaced by `.rmdir()` |  |
+| PTH107 | pathlib-remove | `os.remove` should be replaced by `.unlink()` |  |
+| PTH108 | pathlib-unlink | `os.unlink` should be replaced by `.unlink()` |  |
+| PTH109 | pathlib-getcwd | `os.getcwd()` should be replaced by `Path.cwd()` |  |
+| PTH110 | pathlib-exists | `os.path.exists` should be replaced by `.exists()` |  |
+| PTH111 | pathlib-expanduser | `os.path.expanduser` should be replaced by `.expanduser()` |  |
+| PTH112 | pathlib-is-dir | `os.path.isdir` should be replaced by `.is_dir()` |  |
+| PTH113 | pathlib-is-file | `os.path.isfile` should be replaced by `.is_file()` |  |
+| PTH114 | pathlib-is-link | `os.path.islink` should be replaced by `.is_symlink()` |  |
+| PTH115 | pathlib-readlink | `os.readlink(` should be replaced by `.readlink()` |  |
+| PTH116 | pathlib-stat | `os.stat` should be replaced by `.stat()` or `.owner()` or `.group()` |  |
+| PTH117 | pathlib-is-abs | `os.path.isabs` should be replaced by `.is_absolute()` |  |
+| PTH118 | pathlib-join | `os.path.join` should be replaced by foo_path / "bar" |  |
+| PTH119 | pathlib-basename | `os.path.basename` should be replaced by `.name` |  |
+| PTH120 | pathlib-dirname | `os.path.dirname` should be replaced by `.parent` |  |
+| PTH121 | pathlib-samefile | `os.path.samefile` should be replaced by `.samefile()` |  |
+| PTH122 | pathlib-splitext | `os.path.splitext` should be replaced by `.suffix` |  |
+| PTH123 | pathlib-open | `open("foo")` should be replaced by`Path("foo").open()` |  |
+| PTH124 | pathlib-py-path | `py.path` is in maintenance mode, use `pathlib` instead |  |
+
 ### Ruff-specific rules (RUF)
 
 | Code | Name | Message | Fix |

licenses/LICENSE_RoPP_flake8-use-pathlib

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2021 Rodolphe Pelloux-Prayer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

resources/test/fixtures/flake8_use_pathlib/full_name.py

@@ -0,0 +1,31 @@
+import os
+import os.path
+
+p = "/foo"
+
+a = os.path.abspath(p)
+aa = os.chmod(p)
+aaa = os.mkdir(p)
+os.makedirs(p)
+os.rename(p)
+os.replace(p)
+os.rmdir(p)
+os.remove(p)
+os.unlink(p)
+os.getcwd(p)
+b = os.path.exists(p)
+bb = os.path.expanduser(p)
+bbb = os.path.isdir(p)
+bbbb = os.path.isfile(p)
+bbbbb = os.path.islink(p)
+os.readlink(p)
+os.stat(p)
+os.path.isabs(p)
+os.path.join(p)
+os.path.basename(p)
+os.path.dirname(p)
+os.path.samefile(p)
+os.path.splitext(p)
+with open(p) as fp:
+    fp.read()
+open(p).close()

resources/test/fixtures/flake8_use_pathlib/import_as.py

@@ -0,0 +1,28 @@
+import os as foo
+import os.path as foo_p
+
+p = "/foo"
+
+a = foo_p.abspath(p)
+aa = foo.chmod(p)
+aaa = foo.mkdir(p)
+foo.makedirs(p)
+foo.rename(p)
+foo.replace(p)
+foo.rmdir(p)
+foo.remove(p)
+foo.unlink(p)
+foo.getcwd(p)
+b = foo_p.exists(p)
+bb = foo_p.expanduser(p)
+bbb = foo_p.isdir(p)
+bbbb = foo_p.isfile(p)
+bbbbb = foo_p.islink(p)
+foo.readlink(p)
+foo.stat(p)
+foo_p.isabs(p)
+foo_p.join(p)
+foo_p.basename(p)
+foo_p.dirname(p)
+foo_p.samefile(p)
+foo_p.splitext(p)

resources/test/fixtures/flake8_use_pathlib/import_from.py

@@ -0,0 +1,33 @@
+from os import chmod, mkdir, makedirs, rename, replace, rmdir
+from os import remove, unlink, getcwd, readlink, stat
+from os.path import abspath, exists, expanduser, isdir, isfile, islink
+from os.path import isabs, join, basename, dirname, samefile, splitext
+
+p = "/foo"
+
+a = abspath(p)
+aa = chmod(p)
+aaa = mkdir(p)
+makedirs(p)
+rename(p)
+replace(p)
+rmdir(p)
+remove(p)
+unlink(p)
+getcwd(p)
+b = exists(p)
+bb = expanduser(p)
+bbb = isdir(p)
+bbbb = isfile(p)
+bbbbb = islink(p)
+readlink(p)
+stat(p)
+isabs(p)
+join(p)
+basename(p)
+dirname(p)
+samefile(p)
+splitext(p)
+with open(p) as fp:
+    fp.read()
+open(p).close()

resources/test/fixtures/flake8_use_pathlib/import_from_as.py

@@ -0,0 +1,35 @@
+from os import chmod as xchmod, mkdir as xmkdir
+from os import makedirs as xmakedirs, rename as xrename, replace as xreplace
+from os import rmdir as xrmdir, remove as xremove, unlink as xunlink
+from os import getcwd as xgetcwd, readlink as xreadlink, stat as xstat
+from os.path import abspath as xabspath, exists as xexists
+from os.path import expanduser as xexpanduser, isdir as xisdir
+from os.path import isfile as xisfile, islink as xislink, isabs as xisabs
+from os.path import join as xjoin, basename as xbasename, dirname as xdirname
+from os.path import samefile as xsamefile, splitext as xsplitext
+
+p = "/foo"
+
+a = xabspath(p)
+aa = xchmod(p)
+aaa = xmkdir(p)
+xmakedirs(p)
+xrename(p)
+xreplace(p)
+xrmdir(p)
+xremove(p)
+xunlink(p)
+xgetcwd(p)
+b = xexists(p)
+bb = xexpanduser(p)
+bbb = xisdir(p)
+bbbb = xisfile(p)
+bbbbb = xislink(p)
+xreadlink(p)
+xstat(p)
+xisabs(p)
+xjoin(p)
+xbasename(p)
+xdirname(p)
+xsamefile(p)
+xsplitext(p)

resources/test/fixtures/flake8_use_pathlib/py_path_1.py

@@ -0,0 +1,3 @@
+import py
+
+p = py.path.local("../foo")

resources/test/fixtures/flake8_use_pathlib/py_path_2.py

@@ -0,0 +1,3 @@
+from py.path import local as path
+
+p = path("/foo")

ruff.schema.json

@@ -1633,6 +1633,36 @@
         "PT024",
         "PT025",
         "PT026",
+        "PTH",
+        "PTH1",
+        "PTH10",
+        "PTH100",
+        "PTH101",
+        "PTH102",
+        "PTH103",
+        "PTH104",
+        "PTH105",
+        "PTH106",
+        "PTH107",
+        "PTH108",
+        "PTH109",
+        "PTH11",
+        "PTH110",
+        "PTH111",
+        "PTH112",
+        "PTH113",
+        "PTH114",
+        "PTH115",
+        "PTH116",
+        "PTH117",
+        "PTH118",
+        "PTH119",
+        "PTH12",
+        "PTH120",
+        "PTH121",
+        "PTH122",
+        "PTH123",
+        "PTH124",
         "Q",
         "Q0",
         "Q00",

scripts/add_rule.py

@@ -116,7 +116,7 @@ def main(*, name: str, code: str, linter: str) -> None:
 
             if line.strip() == f"// {linter}":
                 indent = get_indent(line)
-                fp.write(f"{indent}{code} => rules::{linter}::rules::{name},")
+                fp.write(f"{indent}{code} => rules::{dir_name(linter)}::rules::{name},")
                 fp.write("\n")
                 has_written = True
 

src/checkers/ast.rs

@@ -36,8 +36,8 @@ use crate::rules::{
     flake8_bugbear, flake8_builtins, flake8_comprehensions, flake8_datetimez, flake8_debugger,
     flake8_errmsg, flake8_implicit_str_concat, flake8_import_conventions, flake8_pie, flake8_print,
     flake8_pytest_style, flake8_return, flake8_simplify, flake8_tidy_imports, flake8_type_checking,
-    flake8_unused_arguments, mccabe, pandas_vet, pep8_naming, pycodestyle, pydocstyle, pyflakes,
-    pygrep_hooks, pylint, pyupgrade, ruff, tryceratops,
+    flake8_unused_arguments, flake8_use_pathlib, mccabe, pandas_vet, pep8_naming, pycodestyle,
+    pydocstyle, pyflakes, pygrep_hooks, pylint, pyupgrade, ruff, tryceratops,
 };
 use crate::settings::types::PythonVersion;
 use crate::settings::{flags, Settings};
@@ -2545,6 +2545,35 @@ where
                 {
                     flake8_simplify::rules::open_file_with_context_handler(self, func);
                 }
+
+                // flake8-use-pathlib
+                if self.settings.rules.enabled(&Rule::PathlibAbspath)
+                    || self.settings.rules.enabled(&Rule::PathlibChmod)
+                    || self.settings.rules.enabled(&Rule::PathlibMkdir)
+                    || self.settings.rules.enabled(&Rule::PathlibMakedirs)
+                    || self.settings.rules.enabled(&Rule::PathlibRename)
+                    || self.settings.rules.enabled(&Rule::PathlibReplace)
+                    || self.settings.rules.enabled(&Rule::PathlibRmdir)
+                    || self.settings.rules.enabled(&Rule::PathlibRemove)
+                    || self.settings.rules.enabled(&Rule::PathlibUnlink)
+                    || self.settings.rules.enabled(&Rule::PathlibGetcwd)
+                    || self.settings.rules.enabled(&Rule::PathlibExists)
+                    || self.settings.rules.enabled(&Rule::PathlibExpanduser)
+                    || self.settings.rules.enabled(&Rule::PathlibIsDir)
+                    || self.settings.rules.enabled(&Rule::PathlibIsFile)
+                    || self.settings.rules.enabled(&Rule::PathlibIsLink)
+                    || self.settings.rules.enabled(&Rule::PathlibReadlink)
+                    || self.settings.rules.enabled(&Rule::PathlibStat)
+                    || self.settings.rules.enabled(&Rule::PathlibIsAbs)
+                    || self.settings.rules.enabled(&Rule::PathlibJoin)
+                    || self.settings.rules.enabled(&Rule::PathlibBasename)
+                    || self.settings.rules.enabled(&Rule::PathlibSamefile)
+                    || self.settings.rules.enabled(&Rule::PathlibSplitext)
+                    || self.settings.rules.enabled(&Rule::PathlibOpen)
+                    || self.settings.rules.enabled(&Rule::PathlibPyPath)
+                {
+                    flake8_use_pathlib::helpers::replaceable_by_pathlib(self, func);
+                }
             }
             ExprKind::Dict { keys, values } => {
                 if self

src/registry.rs

@@ -429,6 +429,32 @@ ruff_macros::define_rule_mapping!(
     // tryceratops
     TRY004 => rules::tryceratops::rules::PreferTypeError,
     TRY300 => rules::tryceratops::rules::TryConsiderElse,
+    // flake8-use-pathlib
+    PTH100 => rules::flake8_use_pathlib::violations::PathlibAbspath,
+    PTH101 => rules::flake8_use_pathlib::violations::PathlibChmod,
+    PTH102 => rules::flake8_use_pathlib::violations::PathlibMkdir,
+    PTH103 => rules::flake8_use_pathlib::violations::PathlibMakedirs,
+    PTH104 => rules::flake8_use_pathlib::violations::PathlibRename,
+    PTH105 => rules::flake8_use_pathlib::violations::PathlibReplace,
+    PTH106 => rules::flake8_use_pathlib::violations::PathlibRmdir,
+    PTH107 => rules::flake8_use_pathlib::violations::PathlibRemove,
+    PTH108 => rules::flake8_use_pathlib::violations::PathlibUnlink,
+    PTH109 => rules::flake8_use_pathlib::violations::PathlibGetcwd,
+    PTH110 => rules::flake8_use_pathlib::violations::PathlibExists,
+    PTH111 => rules::flake8_use_pathlib::violations::PathlibExpanduser,
+    PTH112 => rules::flake8_use_pathlib::violations::PathlibIsDir,
+    PTH113 => rules::flake8_use_pathlib::violations::PathlibIsFile,
+    PTH114 => rules::flake8_use_pathlib::violations::PathlibIsLink,
+    PTH115 => rules::flake8_use_pathlib::violations::PathlibReadlink,
+    PTH116 => rules::flake8_use_pathlib::violations::PathlibStat,
+    PTH117 => rules::flake8_use_pathlib::violations::PathlibIsAbs,
+    PTH118 => rules::flake8_use_pathlib::violations::PathlibJoin,
+    PTH119 => rules::flake8_use_pathlib::violations::PathlibBasename,
+    PTH120 => rules::flake8_use_pathlib::violations::PathlibDirname,
+    PTH121 => rules::flake8_use_pathlib::violations::PathlibSamefile,
+    PTH122 => rules::flake8_use_pathlib::violations::PathlibSplitext,
+    PTH123 => rules::flake8_use_pathlib::violations::PathlibOpen,
+    PTH124 => rules::flake8_use_pathlib::violations::PathlibPyPath,
     // ruff
     RUF001 => violations::AmbiguousUnicodeCharacterString,
     RUF002 => violations::AmbiguousUnicodeCharacterDocstring,
@@ -515,6 +541,8 @@ pub enum Linter {
     Flake8TypeChecking,
     #[prefix = "TRY"]
     Tryceratops,
+    #[prefix = "PTH"]
+    Flake8UsePathlib,
     #[prefix = "RUF"]
     Ruff,
 }