[`flake8-use-pathlib`] Implement `os-path-getsize` and `os-path-get(a|m|c)-time` (`PTH202-205`) #5835

sbrugman · 2023-07-17T15:54:24Z

Reviving #2348 step by step

Pt 3. implement detection for:

os.path.getsize
os.path.getmtime
os.path.getctime
os.path.getatime

github-actions · 2023-07-17T16:07:47Z

PR Check Results

Ecosystem

ℹ️ ecosystem check detected changes. (+19, -0, 0 error(s))

airflow (+8, -0)

+ airflow/dag_processing/manager.py:1134:51: PTH204 `os.path.getmtime` should be replaced by `Path.stat().st_mtime`
+ airflow/models/dagbag.py:293:64: PTH204 `os.path.getmtime` should be replaced by `Path.stat().st_mtime`
+ airflow/models/dagcode.py:117:17: PTH204 `os.path.getmtime` should be replaced by `Path.stat().st_mtime`
+ airflow/providers/amazon/aws/transfers/dynamodb_to_s3.py:200:16: PTH202 `os.path.getsize` should be replaced by `Path.stat().st_size`
+ airflow/sensors/filesystem.py:68:60: PTH204 `os.path.getmtime` should be replaced by `Path.stat().st_mtime`
+ airflow/triggers/file.py:66:34: PTH204 `os.path.getmtime` should be replaced by `Path.stat().st_mtime`
+ dev/breeze/src/airflow_breeze/utils/parallel.py:308:24: PTH202 `os.path.getsize` should be replaced by `Path.stat().st_size`
+ docs/exts/docs_build/fetch_inventories.py:93:71: PTH204 `os.path.getmtime` should be replaced by `Path.stat().st_mtime`

bokeh (+2, -0)

+ src/bokeh/sphinxext/bokeh_gallery.py:122:26: PTH204 `os.path.getmtime` should be replaced by `Path.stat().st_mtime`
+ src/bokeh/sphinxext/bokeh_gallery.py:143:41: PTH204 `os.path.getmtime` should be replaced by `Path.stat().st_mtime`

zulip (+9, -0)

+ scripts/lib/zulip_tools.py:356:12: PTH205 `os.path.getctime` should be replaced by `Path.stat().st_ctime`
+ scripts/setup/generate_secrets.py:66:47: PTH202 `os.path.getsize` should be replaced by `Path.stat().st_size`
+ tools/lib/test_server.py:64:45: PTH202 `os.path.getsize` should be replaced by `Path.stat().st_size`
+ zerver/data_import/mattermost.py:356:21: PTH202 `os.path.getsize` should be replaced by `Path.stat().st_size`
+ zerver/data_import/mattermost.py:357:24: PTH204 `os.path.getmtime` should be replaced by `Path.stat().st_mtime`
+ zerver/lib/compatibility.py:32:9: PTH204 `os.path.getmtime` should be replaced by `Path.stat().st_mtime`
+ zerver/lib/test_fixtures.py:355:33: PTH204 `os.path.getmtime` should be replaced by `Path.stat().st_mtime`
+ zerver/lib/test_fixtures.py:384:33: PTH204 `os.path.getmtime` should be replaced by `Path.stat().st_mtime`
+ zerver/lib/upload/local.py:114:43: PTH204 `os.path.getmtime` should be replaced by `Path.stat().st_mtime`

Rules changed: 3

Rule	Changes	Additions
PTH204	13	13
PTH202	5	5
PTH205	1	1

Benchmark

Linux

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.00     10.1±0.26ms     4.0 MB/sec    1.02     10.3±0.29ms     3.9 MB/sec
formatter/numpy/ctypeslib.py               1.00      2.0±0.07ms     8.2 MB/sec    1.04      2.1±0.08ms     7.9 MB/sec
formatter/numpy/globals.py                 1.01   235.9±11.80µs    12.5 MB/sec    1.00    233.5±8.24µs    12.6 MB/sec
formatter/pydantic/types.py                1.00      4.4±0.12ms     5.7 MB/sec    1.02      4.6±0.20ms     5.6 MB/sec
linter/all-rules/large/dataset.py          1.00     14.5±0.38ms     2.8 MB/sec    1.02     14.9±0.42ms     2.7 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      3.7±0.10ms     4.5 MB/sec    1.00      3.7±0.08ms     4.5 MB/sec
linter/all-rules/numpy/globals.py          1.00   489.4±11.78µs     6.0 MB/sec    1.01   494.0±15.31µs     6.0 MB/sec
linter/all-rules/pydantic/types.py         1.00      6.5±0.18ms     3.9 MB/sec    1.03      6.8±0.15ms     3.8 MB/sec
linter/default-rules/large/dataset.py      1.03      7.6±0.17ms     5.4 MB/sec    1.00      7.4±0.19ms     5.5 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.03  1622.9±45.46µs    10.3 MB/sec    1.00  1580.2±45.19µs    10.5 MB/sec
linter/default-rules/numpy/globals.py      1.01    177.2±5.46µs    16.7 MB/sec    1.00    175.4±6.87µs    16.8 MB/sec
linter/default-rules/pydantic/types.py     1.00      3.4±0.09ms     7.6 MB/sec    1.00      3.4±0.08ms     7.6 MB/sec

Windows

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.00     12.1±0.31ms     3.4 MB/sec    1.00     12.1±0.42ms     3.4 MB/sec
formatter/numpy/ctypeslib.py               1.00      2.3±0.09ms     7.4 MB/sec    1.01      2.3±0.06ms     7.3 MB/sec
formatter/numpy/globals.py                 1.00    251.3±6.37µs    11.7 MB/sec    1.04   262.4±17.92µs    11.2 MB/sec
formatter/pydantic/types.py                1.00      5.0±0.17ms     5.1 MB/sec    1.02      5.1±0.20ms     5.0 MB/sec
linter/all-rules/large/dataset.py          1.00     16.9±0.52ms     2.4 MB/sec    1.00     16.9±0.33ms     2.4 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      4.4±0.21ms     3.8 MB/sec    1.01      4.4±0.30ms     3.7 MB/sec
linter/all-rules/numpy/globals.py          1.00   528.7±25.59µs     5.6 MB/sec    1.00   530.2±28.58µs     5.6 MB/sec
linter/all-rules/pydantic/types.py         1.00      7.7±0.31ms     3.3 MB/sec    1.00      7.7±0.24ms     3.3 MB/sec
linter/default-rules/large/dataset.py      1.01      8.9±0.28ms     4.6 MB/sec    1.00      8.8±0.25ms     4.6 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.02  1802.2±35.79µs     9.2 MB/sec    1.00  1773.4±38.57µs     9.4 MB/sec
linter/default-rules/numpy/globals.py      1.02   202.1±11.76µs    14.6 MB/sec    1.00    199.0±6.63µs    14.8 MB/sec
linter/default-rules/pydantic/types.py     1.02      3.9±0.10ms     6.5 MB/sec    1.00      3.8±0.08ms     6.7 MB/sec

sbrugman · 2023-07-17T16:17:37Z

Ecosystem changes are correct

konstin · 2023-07-18T17:15:12Z

crates/ruff/src/rules/flake8_use_pathlib/rules/os_path_getatime.rs

+/// PTH203
+
+/// ## What it does
+/// Detects the use of `os.path.getatime`.


Suggested change

/// Detects the use of `os.path.getatime`.

/// Checks for the use of `os.path.getatime`.

konstin · 2023-07-18T17:16:07Z

crates/ruff/src/rules/flake8_use_pathlib/rules/os_path_getctime.rs

+/// PTH205
+
+/// ## What it does
+/// Detects the use of `os.path.getatime`.


Suggested change

/// Detects the use of `os.path.getatime`.

/// Checks for the use of `os.path.getctime`.

konstin · 2023-07-18T17:19:06Z

crates/ruff/src/rules/flake8_use_pathlib/rules/replaceable_by_pathlib.rs

@@ -41,6 +44,10 @@ pub(crate) fn replaceable_by_pathlib(checker: &mut Checker, expr: &Expr) {
                ["os", "path", "dirname"] => Some(OsPathDirname.into()),
                ["os", "path", "samefile"] => Some(OsPathSamefile.into()),
                ["os", "path", "splitext"] => Some(OsPathSplitext.into()),
+                ["os", "path", "getsize"] => Some(OsPathGetsize.into()),


konstin · 2023-07-18T17:20:30Z

crates/ruff/src/rules/flake8_use_pathlib/rules/os_path_getatime.rs

+use ruff_diagnostics::Violation;
+use ruff_macros::{derive_message_formats, violation};
+
+/// PTH203


I think i'd rather place this (and the other two respectively) at [Ref1]. Currently, it's a doc comment (/// vs //), so it would be the first line of the documentation ahead of "#What it does"

konstin · 2023-07-18T17:20:53Z

crates/ruff/src/rules/flake8_use_pathlib/rules/os_path_getmtime.rs

+/// PTH204
+
+/// ## What it does
+/// Detects the use of `os.path.getatime`.


Suggested change

/// Detects the use of `os.path.getatime`.

/// Checks for the use of `os.path.getmtime`.

konstin · 2023-07-18T17:22:36Z

crates/ruff/src/rules/flake8_use_pathlib/rules/os_path_getatime.rs

+/// Detects the use of `os.path.getatime`.
+///
+/// ## Why is this bad?
+/// `pathlib` offers high-level path manipulations of paths, `os` offers low-level manipulation of paths.


nit (and kinda annoying since it's not automated, sorry): The rule description doc comment are generally wrapped at 80 characters

feat: implement PTH202-205

f58b8e0

sbrugman changed the title ~~[flake8-use-path] Implement os-path-getsize and os-path-get(a|m|c)-time (PTH202-205)~~ [flake8-use-pathlib] Implement os-path-getsize and os-path-get(a|m|c)-time (PTH202-205) Jul 17, 2023

konstin approved these changes Jul 18, 2023

View reviewed changes

charliermarsh added 4 commits July 19, 2023 21:51

Comments

21c36b5

Merge branch 'main' into pathlib-getsize-time

ac7f660

fmt

93d3523

Tweak docs

e29b052

charliermarsh added the rule Implementing or modifying a lint rule label Jul 20, 2023

charliermarsh enabled auto-merge (squash) July 20, 2023 01:57

charliermarsh merged commit 4bba0bc into astral-sh:main Jul 20, 2023

sbrugman deleted the pathlib-getsize-time branch July 20, 2023 08:41

chenrui333 mentioned this pull request Jul 21, 2023

ruff 0.0.279 Homebrew/homebrew-core#137262

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[`flake8-use-pathlib`] Implement `os-path-getsize` and `os-path-get(a|m|c)-time` (`PTH202-205`) #5835

[`flake8-use-pathlib`] Implement `os-path-getsize` and `os-path-get(a|m|c)-time` (`PTH202-205`) #5835

sbrugman commented Jul 17, 2023

github-actions bot commented Jul 17, 2023 •

edited

Loading

sbrugman commented Jul 17, 2023

konstin Jul 18, 2023

konstin Jul 18, 2023

konstin Jul 18, 2023

konstin Jul 18, 2023

konstin Jul 18, 2023

konstin Jul 18, 2023

	/// Detects the use of `os.path.getatime`.
	/// Checks for the use of `os.path.getatime`.

	/// Detects the use of `os.path.getatime`.
	/// Checks for the use of `os.path.getctime`.

	/// Detects the use of `os.path.getatime`.
	/// Checks for the use of `os.path.getmtime`.

[flake8-use-pathlib] Implement os-path-getsize and os-path-get(a|m|c)-time (PTH202-205) #5835

[flake8-use-pathlib] Implement os-path-getsize and os-path-get(a|m|c)-time (PTH202-205) #5835

Conversation

sbrugman commented Jul 17, 2023

github-actions bot commented Jul 17, 2023 • edited Loading

PR Check Results

Ecosystem

Benchmark

Linux

Windows

sbrugman commented Jul 17, 2023

konstin Jul 18, 2023

Choose a reason for hiding this comment

konstin Jul 18, 2023

Choose a reason for hiding this comment

konstin Jul 18, 2023

Choose a reason for hiding this comment

konstin Jul 18, 2023

Choose a reason for hiding this comment

konstin Jul 18, 2023

Choose a reason for hiding this comment

konstin Jul 18, 2023

Choose a reason for hiding this comment

[`flake8-use-pathlib`] Implement `os-path-getsize` and `os-path-get(a|m|c)-time` (`PTH202-205`) #5835

[`flake8-use-pathlib`] Implement `os-path-getsize` and `os-path-get(a|m|c)-time` (`PTH202-205`) #5835

github-actions bot commented Jul 17, 2023 •

edited

Loading