Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request - support flake8-use-pathlib plugin #2060

Closed
Kilo59 opened this issue Jan 21, 2023 · 4 comments
Closed

Feature request - support flake8-use-pathlib plugin #2060

Kilo59 opened this issue Jan 21, 2023 · 4 comments
Labels
plugin Implementing a known but unsupported plugin

Comments

@Kilo59
Copy link

Kilo59 commented Jan 21, 2023

Would love to see support for the flake8-use-pathlib plugin for enforcing use of pathlib over os.

https://gitlab.com/RoPP/flake8-use-pathlib
https://pypi.org/project/flake8-use-pathlib/

For justification on why using pathlib is "better" than os.

https://realpython.com/python-pathlib/
https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/
https://treyhunner.com/2019/01/no-really-pathlib-is-great/

os.path operations and their pathlib equivalents

https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module

@charliermarsh charliermarsh added the plugin Implementing a known but unsupported plugin label Jan 21, 2023
@JonathanPlasse
Copy link
Contributor

JonathanPlasse commented Jan 21, 2023

  • PL100: os.path.abspath("foo") should be replaced by foo_path.resolve()
  • PL101: os.chmod("foo", 0o444) should be replaced by foo_path.chmod(0o444)
  • PL102: os.mkdir("foo") should be replaced by foo_path.mkdir()
  • PL103: os.makedirs("foo/bar") should be replaced by bar_path.mkdir(parents=True)
  • PL104: os.rename("foo", "bar") should be replaced by foo_path.rename(Path("bar"))
  • PL105: os.replace("foo", "bar") should be replaced by foo_path.replace(Path("bar"))
  • PL106: os.rmdir("foo") should be replaced by foo_path.rmdir()
  • PL107: os.remove("foo") should be replaced by foo_path.unlink()
  • PL108: os.unlink("foo") should be replaced by foo_path.unlink()
  • PL109: os.getcwd() should be replaced by Path.cwd()
  • PL110: os.path.exists("foo") should be replaced by foo_path.exists()
  • PL111: os.path.expanduser("~/foo") should be replaced by foo_path.expanduser()
  • PL112: os.path.isdir("foo") should be replaced by foo_path.is_dir()
  • PL113: os.path.isfile("foo") should be replaced by foo_path.is_file()
  • PL114: os.path.islink("foo") should be replaced by foo_path.is_symlink()
  • PL115: os.readlink("foo") should be replaced by foo_path.readlink()
  • PL116: os.stat("foo") should be replaced by foo_path.stat() or foo_path.owner() or foo_path.group
  • PL117: os.path.isabs should be replaced by foo_path.is_absolute()
  • PL118: os.path.join("foo", "bar") should be replaced by foo_path / "bar"
  • PL119: os.path.basename("foo/bar") should be replaced by bar_path.name
  • PL120: os.path.dirname("foo/bar") should be replaced by bar_path.parent
  • PL121: os.path.samefile("foo", "bar") should be replaced by foo_path.samefile(bar_path)
  • PL122: os.path.splitext("foo.bar") should be replaced by foo_path.suffix
  • PL123: open("foo") should be replaced by Path("foo").open()
  • PL124: py.path.local is in maintenance mode, use pathlib instead

@sbrugman
Copy link
Contributor

I'll make a PR for this today, super useful plugin
(and hopefully get more expose for pathlib than another attempt for a couple of years back: https://github.com/sbrugman/pathlad)

@charliermarsh
Copy link
Member

Awesome. We should be well-positioned to implement this via checker.resolve_call_path. (I doubt we can autofix these though... maybe some subset of them?)

@charliermarsh
Copy link
Member

Done by @sbrugman! #2090

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
plugin Implementing a known but unsupported plugin
Projects
None yet
Development

No branches or pull requests

4 participants