Python 3.12 compat (#463)

* refactor: change ArtifactoryFlavour to behave like UnixFlavour

When checking the root in a UnixFlavour system, it is / for an absolute
path, and '' for a relative one, and unix systems have no drive.

For artifactory, if we consider the drive to be "http://b/artifactory"
and root to be "/", it behaves exactly like Windows and Unix Flavours,
and no if's and exceptions to handle the root are needed in the code.

This refactor makes the migration to python 3.12 much easier, since we
can subclass pathlib.Path directly and we don't need to override as many
methods.

Notice: This is a breaking change if you are accessing the `root` property
directly, but I'm assuming that mostly everyone should be using the
`repo` accessor for that.
There is also some minor changes in leading/trailing slashes

* feat: Code works under python3.12, but not under older versions of
python

* fix: Make project work in 3.11 and 3.12

Also, if tox is installed with python3.12, some pre-commit plugins
didn't work, so I have updated those.

* Reorganize code based on python 3.11 and 3.12

This commit addresses the concerns raised in the Pull request. It helps minimize
the amount of changes (way less indentation) compared to master.

Also, used a single constant for marking code that will be removed once 3.11 is
deprecated.

This commit likely should be "merged" into the previous two once the PR review
process is over. And if not, well, you have this nice comment here forever :)

---------

Co-authored-by: allburov <[email protected]>

Author: auburus

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
 
     steps:
     - uses: actions/checkout@v3

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
-  - repo: https://github.com/humitos/mirrors-autoflake
-    rev: v1.1
+  - repo: https://github.com/PyCQA/autoflake
+    rev: v2.3.1
     hooks:
       - id: autoflake
         args: ['-i', '--remove-all-unused-imports']
@@ -19,7 +19,7 @@ repos:
       hooks:
       -   id: reorder-python-imports
   - repo: https://github.com/pycqa/flake8
-    rev: 6.0.0
+    rev: 6.1.0
     hooks:
       - id: flake8
   - repo: https://github.com/mgedmin/check-python-versions

artifactory.py

@@ -71,6 +71,11 @@
     default_config_path = "~/.artifactory_python.cfg"
 global_config = None
 
+# Pathlib.Path changed significantly in 3.12, so we will not need several
+# parts of the code once python3.11 is no longer supported. This constant helps
+# identifying those.
+_IS_PYTHON_3_12_OR_NEWER = sys.version_info >= (3, 12)
+
 
 def read_config(config_path=default_config_path):
     """
@@ -422,7 +427,7 @@ def quote_url(url):
     return quoted_url
 
 
-class _ArtifactoryFlavour(pathlib._Flavour):
+class _ArtifactoryFlavour(object if _IS_PYTHON_3_12_OR_NEWER else pathlib._Flavour):
     """
     Implements Artifactory-specific pure path manipulations.
     I.e. what is 'drive', 'root' and 'path' and how to split full path into
@@ -432,7 +437,7 @@ class _ArtifactoryFlavour(pathlib._Flavour):
     drive: in context of artifactory, it's the base URI like
       http://mysite/artifactory
 
-    root: repository, e.g. 'libs-snapshot-local' or 'ext-release-local'
+    root: like in unix, / when absolute, empty when relative
 
     path: relative artifact path within the repository
     """
@@ -458,13 +463,6 @@ def join_parsed_parts(self, drv, root, parts, drv2, root2, parts2):
             drv, root, parts, drv2, root2, parts2
         )
 
-        if not root2 and len(parts2) > 1:
-            root2 = self.sep + parts2.pop(1) + self.sep
-
-        # quick hack for https://github.com/devopshq/artifactory/issues/29
-        # drive or repository must start with / , if not - add it
-        if not drv2.endswith("/") and not root2.startswith("/"):
-            drv2 = drv2 + self.sep
         return drv2, root2, parts2
 
     def splitroot(self, part, sep=sep):
@@ -501,7 +499,7 @@ def splitroot(self, part, sep=sep):
 
             if url.path is None or url.path == sep:
                 if url.scheme:
-                    return part.rstrip(sep), "", ""
+                    return part.rstrip(sep), "/", ""
                 return "", "", part
             elif url.path.lstrip("/").startswith("artifactory"):
                 mark = sep + "artifactory" + sep
@@ -510,8 +508,8 @@ def splitroot(self, part, sep=sep):
                 path = self._get_path(part)
                 drv = part.rpartition(path)[0]
                 path_parts = path.strip(sep).split(sep)
-                root = sep + path_parts[0] + sep
-                rest = sep.join(path_parts[1:])
+                root = sep
+                rest = sep.join(path_parts[0:])
                 return drv, root, rest
 
         if len(parts) >= 2:
@@ -524,14 +522,14 @@ def splitroot(self, part, sep=sep):
             rest = part
 
         if not rest:
-            return drv, "", ""
+            return drv, "/", ""
 
         if rest == sep:
-            return drv, "", ""
+            return drv, "/", ""
 
         if rest.startswith(sep):
-            root, _, part = rest[1:].partition(sep)
-            root = sep + root + sep
+            root = sep
+            part = rest.lstrip("/")
 
         return drv, root, part
 
@@ -587,6 +585,29 @@ def make_uri(self, path):
         """
         return path
 
+    def normcase(self, path):
+        return path
+
+    def splitdrive(self, path):
+        drv, root, part = self.splitroot(path)
+        return (drv + root, self.sep.join(part))
+
+    # This function is consumed by PurePath._load_parts() after python 3.12
+    def join(self, path, *paths):
+        drv, root, part = self.splitroot(path)
+
+        for next_path in paths:
+            drv2, root2, part2 = self.splitroot(next_path)
+            if drv2 != "":
+                drv, root, part = drv2, root2, part2
+                continue
+            if root2 != "":
+                root, part = root2, part2
+                continue
+            part = part + self.sep + part2
+
+        return drv + root + part
+
 
 class _ArtifactorySaaSFlavour(_ArtifactoryFlavour):
     def _get_base_url(self, url):
@@ -877,7 +898,11 @@ def get_stat_json(self, pathobj, key=None):
         )
         code = response.status_code
         text = response.text
-        if code == 404 and ("Unable to find item" in text or "Not Found" in text or "File not found" in text):
+        if code == 404 and (
+            "Unable to find item" in text
+            or "Not Found" in text
+            or "File not found" in text
+        ):
             raise OSError(2, f"No such file or directory: {url}")
 
         raise_for_status(response)
@@ -1479,6 +1504,21 @@ class PureArtifactoryPath(pathlib.PurePath):
     _flavour = _artifactory_flavour
     __slots__ = ()
 
+    def _init(self, *args):
+        super()._init(*args)
+
+    @classmethod
+    def _split_root(cls, part):
+        cls._flavour.splitroot(part)
+
+    @classmethod
+    def _parse_parts(cls, parts):
+        return super()._parse_parts(parts)
+
+    @classmethod
+    def _format_parsed_parts(cls, drv, root, tail):
+        return super()._format_parsed_parts(drv, root, tail)
+
 
 class _FakePathTemplate(object):
     def __init__(self, accessor):
@@ -1513,7 +1553,11 @@ def __new__(cls, *args, **kwargs):
         So we have to first construct ArtifactoryPath by Pathlib and
         only then add auth information.
         """
+
         obj = pathlib.Path.__new__(cls, *args, **kwargs)
+        if _IS_PYTHON_3_12_OR_NEWER:
+            # After python 3.12, all this logic can be moved to __init__
+            return obj
 
         cfg_entry = get_global_config_entry(obj.drive)
 
@@ -1565,6 +1609,56 @@ def _init(self, *args, **kwargs):
 
         super(ArtifactoryPath, self)._init(*args, **kwargs)
 
+    def __init__(self, *args, **kwargs):
+        # Up until python3.12, pathlib.Path was not designed to be initialized
+        # through __init__, so all that logic is in the __new__ method.
+        if not _IS_PYTHON_3_12_OR_NEWER:
+            return
+
+        super().__init__(*args, **kwargs)
+
+        cfg_entry = get_global_config_entry(self.drive)
+
+        # Auth section
+        apikey = kwargs.get("apikey")
+        token = kwargs.get("token")
+        auth_type = kwargs.get("auth_type")
+
+        if apikey:
+            logger.debug("Use XJFrogApiAuth apikey")
+            self.auth = XJFrogArtApiAuth(apikey=apikey)
+        elif token:
+            logger.debug("Use XJFrogArtBearerAuth token")
+            self.auth = XJFrogArtBearerAuth(token=token)
+        else:
+            auth = kwargs.get("auth")
+            self.auth = auth if auth_type is None else auth_type(*auth)
+
+        if self.auth is None and cfg_entry:
+            auth = (cfg_entry["username"], cfg_entry["password"])
+            self.auth = auth if auth_type is None else auth_type(*auth)
+
+        self.cert = kwargs.get("cert")
+        self.session = kwargs.get("session")
+        self.timeout = kwargs.get("timeout")
+
+        if self.cert is None and cfg_entry:
+            self.cert = cfg_entry["cert"]
+
+        if "verify" in kwargs:
+            self.verify = kwargs.get("verify")
+        elif cfg_entry:
+            self.verify = cfg_entry["verify"]
+        else:
+            self.verify = True
+
+        if self.session is None:
+            self.session = requests.Session()
+            self.session.auth = self.auth
+            self.session.cert = self.cert
+            self.session.verify = self.verify
+            self.session.timeout = self.timeout
+
     def __reduce__(self):
         # pathlib.PurePath.__reduce__ doesn't include instance state, but we
         # have state that needs to be included when pickling
@@ -1635,6 +1729,16 @@ def stat(self, pathobj=None):
         pathobj = pathobj or self
         return self._accessor.stat(pathobj=pathobj)
 
+    def exists(self):
+        try:
+            self.stat()
+        except OSError:
+            return False
+        except ValueError:
+            # Non-encodable path
+            return False
+        return True
+
     def mkdir(self, mode=0o777, parents=False, exist_ok=False):
         """
         Create a new directory at this given path.
@@ -2367,12 +2471,12 @@ def promote_docker_image(
 
     @property
     def repo(self):
-        return self._root.replace("/", "")
+        return self.parts[1]
 
     @property
     def path_in_repo(self):
         parts = self.parts
-        path_in_repo = "/" + "/".join(parts[1:])
+        path_in_repo = "/" + "/".join(parts[2:])
         return path_in_repo
 
     def find_user(self, name):

setup.py

@@ -46,6 +46,7 @@
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
         "Topic :: Software Development :: Libraries",
         "Topic :: System :: Filesystems",
     ],