[flake8-use-pathlib] Make PTH100 fix unsafe because it can change behavior

[chirizxc]

Summary

Fixes #20088

Test Plan

cargo nextest run flake8_use_pathlib

[github-actions]

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

ℹ️ ecosystem check detected linter changes. (+0 -0 violations, +0 -208 fixes in 6 projects; 49 projects unchanged)

apache/airflow (+0 -0 violations, +0 -56 fixes)

ruff check --no-cache --exit-zero --ignore RUF9 --no-fix --output-format concise --preview --select ALL

- airflow-core/docs/conf.py:330:29: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ airflow-core/docs/conf.py:330:29: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- airflow-core/src/airflow/config_templates/default_webserver_config.py:32:11: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ airflow-core/src/airflow/config_templates/default_webserver_config.py:32:11: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- airflow-core/src/airflow/utils/cli.py:224:18: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ airflow-core/src/airflow/utils/cli.py:224:18: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- airflow-core/src/airflow/utils/cli.py:363:15: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ airflow-core/src/airflow/utils/cli.py:363:15: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- airflow-core/src/airflow/utils/log/file_processor_handler.py:145:25: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ airflow-core/src/airflow/utils/log/file_processor_handler.py:145:25: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- airflow-core/tests/integration/otel/dags/otel_test_dag_with_pause_between_tasks.py:114:34: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ airflow-core/tests/integration/otel/dags/otel_test_dag_with_pause_between_tasks.py:114:34: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- airflow-core/tests/integration/otel/dags/otel_test_dag_with_pause_in_task.py:50:34: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
... 43 additional changes omitted for project

apache/superset (+0 -0 violations, +0 -10 fixes)

ruff check --no-cache --exit-zero --ignore RUF9 --no-fix --output-format concise --preview --select ALL

- docker/pythonpath_dev/superset_config.py:124:21: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ docker/pythonpath_dev/superset_config.py:124:21: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- scripts/cypress_run.py:135:34: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ scripts/cypress_run.py:135:34: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- setup.py:23:12: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ setup.py:23:12: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- superset/cli/update.py:76:20: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ superset/cli/update.py:76:20: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- superset/translations/utils.py:27:23: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ superset/translations/utils.py:27:23: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`

bokeh/bokeh (+0 -0 violations, +0 -44 fixes)

ruff check --no-cache --exit-zero --ignore RUF9 --no-fix --output-format concise --preview --select ALL

- scripts/sri.py:9:7: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ scripts/sri.py:9:7: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- src/bokeh/application/handlers/code_runner.py:182:39: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ src/bokeh/application/handlers/code_runner.py:182:39: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- src/bokeh/command/subcommands/serve.py:924:20: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ src/bokeh/command/subcommands/serve.py:924:20: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- src/bokeh/command/util.py:117:12: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ src/bokeh/command/util.py:117:12: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- src/bokeh/embed/bundle.py:277:21: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ src/bokeh/embed/bundle.py:277:21: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
... 34 additional changes omitted for project

latchbio/latch (+0 -0 violations, +0 -2 fixes)

ruff check --no-cache --exit-zero --ignore RUF9 --no-fix --output-format concise --preview

- docs/source/conf.py:18:20: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ docs/source/conf.py:18:20: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`

milvus-io/pymilvus (+0 -0 violations, +0 -2 fixes)

ruff check --no-cache --exit-zero --ignore RUF9 --no-fix --output-format concise --preview

- docs/source/conf.py:15:20: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ docs/source/conf.py:15:20: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`

zulip/zulip (+0 -0 violations, +0 -94 fixes)

ruff check --no-cache --exit-zero --ignore RUF9 --no-fix --output-format concise --preview --select ALL

- docs/conf.py:11:20: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ docs/conf.py:11:20: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- manage.py:7:28: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ manage.py:7:28: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- scripts/lib/check_rabbitmq_queue.py:10:62: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ scripts/lib/check_rabbitmq_queue.py:10:62: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- scripts/lib/clean_emoji_cache.py:6:62: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ scripts/lib/clean_emoji_cache.py:6:62: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- scripts/lib/clean_unused_caches.py:7:62: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ scripts/lib/clean_unused_caches.py:7:62: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- scripts/lib/puppet_cache.py:13:62: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ scripts/lib/puppet_cache.py:13:62: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- scripts/lib/queue_workers.py:5:60: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ scripts/lib/queue_workers.py:5:60: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- scripts/lib/setup_path.py:10:64: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ scripts/lib/setup_path.py:10:64: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- scripts/lib/setup_venv.py:5:62: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ scripts/lib/setup_venv.py:5:62: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- scripts/lib/sharding.py:9:60: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ scripts/lib/sharding.py:9:60: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
- scripts/lib/zulip_tools.py:562:19: PTH100 [*] `os.path.abspath()` should be replaced by `Path.resolve()`
+ scripts/lib/zulip_tools.py:562:19: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()`
... 72 additional changes omitted for project

Changes by rule (1 rules affected)

code	total	+ violation	- violation	+ fix	- fix
PTH100	208	0	0	0	208

[ntBre]

Thanks! Just a couple of small suggestions.

[ntBre]

I don't think it's so important to mention the comment issue now that the rule is always unsafe. I'd probably say something like:

This rule's fix is always marked as unsafe because Path.resolve() resolves symlinks, while os.path.abspath() does not. If resolving symlinks is important, you may need to use Path.absolute(). However, Path.absolute() also does not remove any .. components in a path, unlike os.path.abspath() and Path.resolve(), so if that specific combination of behaviors is required, there's no existing pathlib alternative. See CPython issue #69200.

That's a bit wordy, so it could be nice to include @dscorbett's nice table from the issue instead, up to you.

[ntBre]

I can't comment on the line below, but as I mentioned on the issue, we should also update the Correspondence between os and pathlib link below (#20088 (comment)). The new link is https://docs.python.org/3/library/pathlib.html#corresponding-tools

[chirizxc]

It seems to me that if a fix is going to change behavior in any way, it's better to leave it as a unsafe

[chirizxc]

Should I change links in this PR in the same way in all PTH rules?

[chirizxc]

I also see that there are many more functions in the table for which there are no rules and fixes, can we start adding them?

[ntBre]

Should I change links in this PR in the same way in all PTH rules?

Sure, but let's do that in a follow-up documentation PR. I think this one is good to go now.

I also see that there are many more functions in the table for which there are no rules and fixes, can we start adding them?

I think we've implemented all of the rules in the upstream flake8-use-pathlib, and it's not a high priority to add more rules right now, so I don't think we need to exhaustively cover the table. You could open an issue to track interest in any of the ones we're missing, though, if you want!