Add Python 3.12 to the test suite #764

browniebroke · 2022-12-21T15:40:58Z

Describe the changes

I know this is quite early 😄 but I was trying to test one of my packages to see if it worked and noticed that pyfakefs was returning some errors. I fixed a few issues to make it work on my machine (macOS) but it looks like it now fails due to pandas not installing yet. Also Windows fails but I don't have such a machine, so I might not be the best person to fix these...

Let me know how I should proceed with this. I understand if you want to close or leave this pull request open until all the jobs pass. I'm also happy to split the fixes and leave the CI updates out for now.

However, I do think that having basic support in this package might help others packages to add Python 3.12 compatibility.

Tasks

Unit tests added that reproduce the issue or prove feature is working
Fix or feature added
Entry to release notes added
Pre-commit CI shows no errors
Unit tests passing
For documentation changes: The Read the Docs preview builds and looks as expected

browniebroke · 2022-12-21T15:49:04Z

pyfakefs/fake_pathlib.py

@@ -383,6 +385,7 @@ class _FakeWindowsFlavour(_FakeFlavour):
        | {"COM%d" % i for i in range(1, 10)}
        | {"LPT%d" % i for i in range(1, 10)}
    )
+    pathmod = ntpath


This class attribute was present but seemingly unused before python/cpython#95450

browniebroke · 2022-12-21T15:49:34Z

pyfakefs/tests/fake_pathlib_test.py

@@ -632,6 +632,7 @@ def test_symlink_to(self):
        self.assertTrue(path.is_symlink())

    @unittest.skipIf(sys.version_info < (3, 8), "link_to new in Python 3.8")
+    @unittest.skipIf(sys.version_info >= (3, 12), "link_to removed in Python 3.12")


https://github.com/python/cpython/blob/0397f040e239c82848f51dedef9af7b9bd99ef55/Lib/pathlib.py#L1222-L1225

Yes, this had been deprecated before (actually renamed to hardlink_to).

browniebroke · 2022-12-21T16:08:52Z

The Windows tests are failing because of this new feature that was added: python/cpython#99548

os.DirEntry now includes an os.DirEntry.is_junction method to check if the entry is a junction.

mrbean-bremen

Thank you for that, this is helpful! If you will exclude the extra requirement tests for Python 3.12, and add a release note (under Infrastructure), I will happily merge this.

mrbean-bremen · 2022-12-21T18:08:40Z

pyfakefs/fake_filesystem.py

+    @property
+    def is_junction(self) -> bool:
+        # TODO: implement junctions
+        return False


This should probably return `self.filesystem.is_junction(self.path).

mrbean-bremen · 2022-12-21T18:13:23Z

.github/workflows/testsuite.yml

+            experimental: true
+          - os: windows-latest
+            python-version: "3.12-dev"
+            experimental: true


I would probably just disable the tests with extra requirements for 3.12 (by adding a version check to the respective steps). It is common that larger packages do not support a new Python in early development stages. We can remove the check later.

mrbean-bremen · 2022-12-21T18:24:16Z

pyfakefs/fake_filesystem.py

+            TypeError: if path is None.
+        """
+        # TODO: implement junction on Windows
+        return False


I think for the time being it is ok to just return False here - I would adapt the description accordingly, though. Later, we may add some convenience function to make a junction in pyfakefs - as far as I can see, this is not possible in Python yet. We also need to adapt os.stat, os.lstat and possibly other functions that will support junctions.

mrbean-bremen · 2022-12-21T18:26:06Z

pyfakefs/tests/fake_pathlib_test.py

@@ -632,6 +632,7 @@ def test_symlink_to(self):
        self.assertTrue(path.is_symlink())

    @unittest.skipIf(sys.version_info < (3, 8), "link_to new in Python 3.8")
+    @unittest.skipIf(sys.version_info >= (3, 12), "link_to removed in Python 3.12")


Yes, this had been deprecated before (actually renamed to hardlink_to).

browniebroke · 2022-12-21T21:10:29Z

I'll do that tomorrow

mrbean-bremen · 2022-12-22T10:17:54Z

pyfakefs/fake_filesystem.py

-            TypeError: if path is None.
-        """
-        # TODO: implement junction on Windows
+        """Junction are never faked."""


Typo: Junction -> Junctions.
You may also add something like "Returns False - junctions are never faked."

mrbean-bremen · 2022-12-22T10:21:13Z

.github/workflows/testsuite.yml

@@ -70,17 +58,17 @@ jobs:
        fi
      shell: bash
    - name: Install extra dependencies
-      if: ${{ ! matrix.experimental }}
+      if: ${{ python-version == "3.12-dev" }}


Shouldn't that be != ?

Of course 🤦🏻

The string literal must be written using single quotes: https://docs.github.com/en/actions/learn-github-actions/expressions#literals

browniebroke · 2022-12-22T10:37:12Z

Do I need to update the documentation anywhere?

mrbean-bremen

👍

mrbean-bremen · 2022-12-22T10:39:27Z

Do I need to update the documentation anywhere?

No, there is no need. The API documentation is automatically generated, and at this stage I wouldn't announce support for Python 3.12 yet.

browniebroke · 2022-12-22T10:43:10Z

The API documentation is automatically generated

Yes, I noticed that the new methods I've added aren't showing up because of the conditionals I added here since the docs aren't generated using Python 3.12. It's probably fine for now, but something to keep in mind when official support is added.

mrbean-bremen · 2022-12-22T11:20:35Z

Good point, I wasn't aware of this.

browniebroke added 3 commits December 21, 2022 16:33

Add Python 3.12 to the test suite

ccd41d2

Fix failures under Python 3.12

3748e6a

Mark Python 3.12 as experimental

39a80cf

browniebroke commented Dec 21, 2022

View reviewed changes

browniebroke added 2 commits December 21, 2022 17:40

Add is_junction method to DirEntry class on Python 3.12

d0cfd0e

Implement stub functions for os.path.isjunction()

887d6b0

browniebroke force-pushed the upgrade/python-3.12 branch from 13d6c7a to 887d6b0 Compare December 21, 2022 16:40

browniebroke marked this pull request as ready for review December 21, 2022 16:59

mrbean-bremen reviewed Dec 21, 2022

View reviewed changes

browniebroke added 3 commits December 22, 2022 10:57

Always return false in stub junction functions

164879d

Skip extra deps tests for experimental jobs

ebd31f2

Update changelog to mention support for Python 3.12

2a60d68

browniebroke marked this pull request as draft December 22, 2022 10:10

Make junction APIs conditional on Python 3.12

dcdb458

mrbean-bremen reviewed Dec 22, 2022

View reviewed changes

browniebroke added 2 commits December 22, 2022 11:18

Simplify test suite workflow by removing experimental flag

be93897

Enable performance tests on Python 3.12

a0d1f72

mrbean-bremen reviewed Dec 22, 2022

View reviewed changes

browniebroke added 2 commits December 22, 2022 11:24

Fix condition

cb03c5c

Fix grammar in docstrings

311c982

browniebroke marked this pull request as ready for review December 22, 2022 10:26

Fix condition in workflow

f1b954b

browniebroke force-pushed the upgrade/python-3.12 branch from 17c9017 to f1b954b Compare December 22, 2022 10:29

mrbean-bremen approved these changes Dec 22, 2022

View reviewed changes

mrbean-bremen merged commit 50a2761 into pytest-dev:main Dec 22, 2022

browniebroke deleted the upgrade/python-3.12 branch December 22, 2022 10:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Python 3.12 to the test suite #764

Add Python 3.12 to the test suite #764

browniebroke commented Dec 21, 2022 •

edited

Loading

browniebroke Dec 21, 2022

browniebroke Dec 21, 2022

mrbean-bremen Dec 21, 2022

browniebroke commented Dec 21, 2022

mrbean-bremen left a comment

mrbean-bremen Dec 21, 2022

mrbean-bremen Dec 21, 2022

mrbean-bremen Dec 21, 2022

mrbean-bremen Dec 21, 2022

browniebroke commented Dec 21, 2022

mrbean-bremen Dec 22, 2022

mrbean-bremen Dec 22, 2022 •

edited

Loading

browniebroke Dec 22, 2022

browniebroke Dec 22, 2022

browniebroke commented Dec 22, 2022

mrbean-bremen left a comment

mrbean-bremen commented Dec 22, 2022

browniebroke commented Dec 22, 2022

mrbean-bremen commented Dec 22, 2022

Add Python 3.12 to the test suite #764

Add Python 3.12 to the test suite #764

Conversation

browniebroke commented Dec 21, 2022 • edited Loading

Describe the changes

Tasks

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

browniebroke commented Dec 21, 2022

mrbean-bremen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

browniebroke commented Dec 21, 2022

Choose a reason for hiding this comment

mrbean-bremen Dec 22, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

browniebroke commented Dec 22, 2022

mrbean-bremen left a comment

Choose a reason for hiding this comment

mrbean-bremen commented Dec 22, 2022

browniebroke commented Dec 22, 2022

mrbean-bremen commented Dec 22, 2022

browniebroke commented Dec 21, 2022 •

edited

Loading

mrbean-bremen Dec 22, 2022 •

edited

Loading