[PR #3957/79fe2045 backport][3.10] Improve test suite handling of paths, temp files

[webknjaz]

This is a backport of PR #3957 as merged into master (79fe204).

• Improve test suite handling of paths, temp files

This updates most uses of os.path to instead use pathlib.Path. Relatedly, and following up from #3955 (which replaced pytest's tmpdir fixture with tmp_path), this removes most ad-hoc tempfile creation in favor of the tmp_path fixture. Following conversion, unnecessary os and tempfile imports were removed.

Most pathlib changes involve straightforward changes from os functions such as os.mkdir or os.path.abspath to their equivalent methods in pathlib.Path.

Changing ad-hoc temporary path to tmp_path involved removing the tmp_dir_path fixture and replacing its functionality with tmp_path in test_save_load and test_guess_filename_with_tempfile.

On test_static_route_user_home function:

• I think that the intention of this test is to ensure that aiohttp correctly expands the home path if passed in a string. I refactored it to pathlib.Path and cut out duplication of relative_to() calls. But if it's not doing anything but expanding ~, then it's testing the functionality of pathlib.Path, not aiohttp.

On unix_sockname fixture:

This fixture uses tempfile.TemporaryDirectory. Because it's a somewhat complicated fixture used across multiple test modules, I left it as-is for now.

On str(tmp_path) and even pathlib.Path(str(tmp_path)):

pytest uses pathlib2 to provide tmp_path for Python 3.5 (only). This is mostly fine but it fails on a couple of corner cases, such as os.symlink() which blocks all but str and PurePath via isinstance type checking. In several cases, this requires conversion to string or conversion to string and then into pathlib.Path to maintain code compatibility. See: pytest-dev/pytest/issues/5017

• Correct test_guess_filename to use file object

• Update symlink in tests; more guess_filename tests

(cherry picked from commit 79fe204)

What do these changes do?

This updates most uses of os.path to instead use pathlib.Path.
Relatedly, and following up from #3955 (which replaced pytest's tmpdir
fixture with tmp_path), this removes most ad-hoc tempfile creation in
favor of the tmp_path fixture. Following conversion, unnecessary os
and tempfile imports were removed.

Most pathlib changes involve straightforward changes from os functions
such as os.mkdir or os.path.abspath to their equivalent methods in
pathlib.Path.

Changing ad-hoc temporary path to tmp_path involved removing the
tmp_dir_path fixture and replacing its functionality with tmp_path
in test_save_load and test_guess_filename_with_tempfile.

On test_static_route_user_home function:

• I think that the intention of this test is to ensure that aiohttp
  correctly expands the home path if passed in a string. I refactored it
  to pathlib.Path and cut out duplication of relative_to() calls.
  But if it's not doing anything but expanding ~, then it's testing the
  functionality of pathlib.Path, not aiohttp.

On unix_sockname fixture:

This fixture uses tempfile.TemporaryDirectory. Because it's a somewhat
complicated fixture used across multiple test modules, I left it as-is
for now.

On str(tmp_path) and even pathlib.Path(str(tmp_path)):

pytest uses pathlib2 to provide tmp_path for Python 3.5 (only).
This is mostly fine but it fails on a couple of corner cases, such as
os.symlink() which blocks all but str and PurePath via isinstance
type checking. In several cases, this requires conversion to string or
conversion to string and then into pathlib.Path to maintain code
compatibility. See: pytest-dev/pytest/issues/5017

Are there changes in behavior for the user?

These changes only affect the test suite and have no impact on the end user.

Related issue number

This is intended to address discussion following the simplistic changes from tmpdir to tmp_path of #3955.

Checklist

• I think the code is well written
• Unit tests for the changes exist
• Documentation reflects the changes
• If you provide code modification, please add yourself to CONTRIBUTORS.txt
  • The format is <Name> <Surname>.
  • Please keep alphabetical order, the file is sorted by names.
• Add a new news fragment into the CHANGES folder
  • name it <issue_id>.<type> for example (588.bugfix)
  • if you don't have an issue_id change it to the pr id after creating the pr
  • ensure type is one of the following:
    • .feature: Signifying a new feature.
    • .bugfix: Signifying a bug fix.
    • .doc: Signifying a documentation improvement.
    • .removal: Signifying a deprecation or removal of public API.
    • .misc: A ticket has been closed, but it is not of interest to users.
  • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (6018c7f) 97.31% compared to head (38af807) 97.31%.

Additional details and impacted files

@@            Coverage Diff             @@
##             3.10    #8083      +/-   ##
==========================================
- Coverage   97.31%   97.31%   -0.01%     
==========================================
  Files         108      108              
  Lines       32944    32932      -12     
  Branches     3927     3926       -1     
==========================================
- Hits        32061    32049      -12     
  Misses        674      674              
  Partials      209      209              

Flag	Coverage Δ
CI-GHA	97.23% <100.00%> (-0.01%)	⬇️
OS-Linux	96.92% <100.00%> (-0.01%)	⬇️
OS-Windows	94.45% <99.06%> (+<0.01%)	⬆️
OS-macOS	96.74% <100.00%> (+<0.01%)	⬆️
Py-3.10.11	94.35% <99.06%> (+<0.01%)	⬆️
Py-3.10.13	96.70% <100.00%> (-0.01%)	⬇️
Py-3.11.7	96.37% <100.00%> (-0.04%)	⬇️
Py-3.12.1	96.37% <100.00%> (?)
Py-3.8.10	94.33% <99.06%> (+<0.01%)	⬆️
Py-3.8.18	96.63% <100.00%> (-0.01%)	⬇️
Py-3.9.13	94.34% <99.06%> (+<0.01%)	⬆️
Py-3.9.18	96.69% <100.00%> (-0.01%)	⬇️
Py-pypy7.3.15	96.23% <100.00%> (+<0.01%)	⬆️
VM-macos	96.74% <100.00%> (+<0.01%)	⬆️
VM-ubuntu	96.92% <100.00%> (-0.01%)	⬇️
VM-windows	94.45% <99.06%> (+<0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.