refactor: get rid of compat.py35path

shutil and os modules in python 3.5 doesn't accept pathlib.Path (yet).

compat.py35path() wrapper was used to mark code which requires extra
str() conversion on Python <= 3.5.

Introduce new apkg.util.shutil35 wrapper module for selected shutil and
os functions in order to address this without polluting code with
redundant py35path/str conversions.

apkg.compat was removed in favor of new shutil35 which can be easily
removed in the future once Python 3.5 support is dropped.

Fixes: #36

apkg/cache.py

@@ -6,7 +6,6 @@ import hashlib
 import json
 from pathlib import Path
 
-from apkg.compat import py35path
 from apkg.log import getLogger
 
 
@@ -15,7 +14,7 @@ log = getLogger(__name__)
 
 def file_checksum(path):
     chsum = hashlib.sha256()
-    with open(py35path(path), "rb") as f:
+    with Path(path).open("rb") as f:
         for chunk in iter(lambda: f.read(4096), b""):
             chsum.update(chunk)
     return chsum.hexdigest()[:20]

apkg/compat.py

-"""
-python version compatibility helpers
-"""
-import sys
-
-
-# python 3.5 doesn't have pathlib fully integrated so str() conversion is
-# needed in some places - use py35path() for easy removal later
-if sys.version_info.minor <= 5:
-    def py35path(s):
-        return str(s)
-else:
-    def py35path(s):
-        return s

apkg/lib/ar.py

@@ -2,16 +2,15 @@
 apkg lib for handling source archives
 """
 from pathlib import Path
-import shutil
 import requests
 
 from apkg import exception
 from apkg.lib import common
 from apkg.log import getLogger
-from apkg.compat import py35path
 from apkg.parse import split_archive_fn, parse_version
 from apkg.project import Project
 from apkg.util.run import run
+import apkg.util.shutil35 as shutil
 
 
 log = getLogger(__name__)
@@ -74,7 +73,7 @@ def make_archive(
     archive_path = ar_base_path / archive_fn
     log.info("copying archive to: %s", archive_path)
     ar_base_path.mkdir(parents=True, exist_ok=True)
-    shutil.copy(py35path(in_archive_path), py35path(archive_path))
+    shutil.copy(in_archive_path, archive_path)
     log.success("made archive: %s", archive_path)
     results = [archive_path]
     if use_cache:

apkg/lib/build.py

@@ -2,7 +2,6 @@
 apkg lib for handling package builds
 """
 from pathlib import Path
-import shutil
 
 from apkg import adistro
 from apkg.cache import file_checksum
@@ -11,6 +10,7 @@ from apkg.lib import srcpkg as _srcpkg
 from apkg.lib import common
 from apkg.log import getLogger
 from apkg.project import Project
+import apkg.util.shutil35 as shutil
 
 
 log = getLogger(__name__)

apkg/lib/common.py

 from pathlib import Path
-import shutil
 import sys
 
 from apkg.log import getLogger
-from apkg.compat import py35path
 from apkg import exception
+import apkg.util.shutil35 as shutil
 
 
 log = getLogger(__name__)
@@ -24,7 +23,7 @@ def copy_paths(paths, dst):
         else:
             p_dst = dst / p.name
             log.verbose("copying file: %s -> %s", p, p_dst)
-            shutil.copy(py35path(p), py35path(p_dst))
+            shutil.copy(p, p_dst)
             new_paths.append(p_dst)
     return new_paths
 

apkg/lib/srcpkg.py

@@ -2,17 +2,16 @@
 apkg lib for handling source archives
 """
 from pathlib import Path
-import shutil
 
 from apkg import adistro
 from apkg.cache import file_checksum
-from apkg.compat import py35path
 from apkg import exception
 from apkg.lib import ar
 from apkg.lib import common
 from apkg.log import getLogger
 from apkg.project import Project
 from apkg.util.archive import unpack_archive
+import apkg.util.shutil35 as shutil
 
 
 log = getLogger(__name__)
@@ -112,7 +111,7 @@ def make_srcpkg(
     # prepare new build dir
     if build_path.exists():
         log.info("removing existing build dir: %s", build_path)
-        shutil.rmtree(py35path(build_path))
+        shutil.rmtree(build_path)
     build_path.mkdir(parents=True, exist_ok=True)
     # ensure output dir doesn't exist unless it was specified
     if not result_dir and out_path.exists():

apkg/pkgstyles/arch.py

@@ -9,12 +9,11 @@ apkg package style for **Arch** linux.
 """
 import glob
 from pathlib import Path
-import shutil
 
 from apkg import exception
 from apkg.log import getLogger
-from apkg.compat import py35path
 from apkg.util.run import cd, run, sudo
+import apkg.util.shutil35 as shutil
 
 
 log = getLogger(__name__)
@@ -77,7 +76,7 @@ def build_packages(
             % srcpkg_path.name)
     isolated = kwargs.get('isolated')
     log.info("copying source package to build dir: %s", build_path)
-    shutil.copytree(py35path(srcpkg_path.parent), py35path(build_path))
+    shutil.copytree(srcpkg_path.parent, build_path)
     # build package using makepkg
     if not isolated:
         msg = "arch doesn't support direct host build - using isolated"
@@ -91,7 +90,7 @@ def build_packages(
     # find and copy resulting packages
     for src_pkg in glob.iglob('%s/*.zst' % build_path):
         dst_pkg = out_path / Path(src_pkg).name
-        shutil.copyfile(py35path(src_pkg), py35path(dst_pkg))
+        shutil.copyfile(src_pkg, dst_pkg)
         pkgs.append(dst_pkg)
 
     return pkgs

apkg/pkgstyles/deb.py

@@ -12,13 +12,12 @@ or `--isolated` using `pbuilder`
 import glob
 from pathlib import Path
 import re
-import shutil
 
-from apkg.compat import py35path
 from apkg import exception
 from apkg.log import getLogger
 from apkg import parse
 from apkg.util.run import cd, run, sudo
+import apkg.util.shutil35 as shutil
 
 
 log = getLogger(__name__)
@@ -61,7 +60,7 @@ def _copy_srcpkg_files(src_path, dst_path):
     for pattern in ['*.dsc', '*.debian.tar.*', '*.orig.tar.*', '*.diff.*']:
         for f in glob.iglob('%s/%s' % (src_path, pattern)):
             srcp = Path(f)
-            shutil.copyfile(py35path(f), py35path(dst_path / srcp.name))
+            shutil.copyfile(f, dst_path / srcp.name)
 
 
 # pylint: disable=too-many-locals
@@ -91,7 +90,7 @@ def build_srcpkg(
     debian_ar = "%s_%s.orig%s" % (env['name'], env['version'], ext)
     debian_ar_path = build_path / debian_ar
     log.info("copying archive into source package: %s", debian_ar_path)
-    shutil.copyfile(py35path(archive_path), py35path(debian_ar_path))
+    shutil.copyfile(archive_path, debian_ar_path)
 
     log.info("building deb source-only package...")
     with cd(source_path):
@@ -163,7 +162,7 @@ def build_packages(
     log.info("copying built packages to result dir: %s", out_path)
     for src_pkg in glob.iglob('%s/*.deb' % build_path):
         dst_pkg = out_path / Path(src_pkg).name
-        shutil.copyfile(py35path(src_pkg), py35path(dst_pkg))
+        shutil.copyfile(src_pkg, dst_pkg)
         pkgs.append(dst_pkg)
 
     return pkgs

apkg/pkgstyles/rpm.py

@@ -12,13 +12,12 @@ or `--isolated` using `mock`
 import glob
 from pathlib import Path
 import re
-import shutil
 import subprocess
 
-from apkg.compat import py35path
 from apkg import exception
 from apkg.log import getLogger
 from apkg.util.run import run, sudo
+import apkg.util.shutil35 as shutil
 
 
 log = getLogger(__name__)
@@ -107,7 +106,7 @@ def build_srcpkg(
     log.info("copying archive files into SOURCES: %s", rpmbuild_src)
     for src_path in archive_paths:
         dst_path = rpmbuild_src / src_path.name
-        shutil.copyfile(py35path(src_path), py35path(dst_path))
+        shutil.copyfile(src_path, dst_path)
     log.info("building .src.rpm using rpmbuild")
     out = run('rpmbuild', '-bs',
               '--define', '_topdir %s' % rpmbuild_topdir.resolve(),
@@ -120,7 +119,7 @@ def build_srcpkg(
         srpm = m.group(1)
         src_srpm = Path(srpm)
         dst_srpm = out_path / src_srpm.name
-        shutil.copyfile(py35path(src_srpm), py35path(dst_srpm))
+        shutil.copyfile(src_srpm, dst_srpm)
         srcpkgs.append(dst_srpm)
     if not srcpkgs:
         raise exception.ParsingFailed(
@@ -151,7 +150,7 @@ def build_packages(
         for rpm in glob.iglob('%s/*.rpm' % build_path):
             src_pkg = Path(rpm)
             dst_pkg = out_path / src_pkg.name
-            shutil.copyfile(py35path(src_pkg), py35path(dst_pkg))
+            shutil.copyfile(src_pkg, dst_pkg)
             pkgs.append(dst_pkg)
     else:
         log.info("starting direct host .rpm build using rpmbuild")
@@ -166,7 +165,7 @@ def build_packages(
             rpm = m.group(1)
             src_pkg = Path(rpm)
             dst_pkg = out_path / src_pkg.name
-            shutil.copyfile(py35path(src_pkg), py35path(dst_pkg))
+            shutil.copyfile(src_pkg, dst_pkg)
             pkgs.append(dst_pkg)
         if not pkgs:
             raise exception.ParsingFailed(

apkg/pkgtemplate.py

 """
 module for handling and rendering apkg package templates
 """
-import os
 from pathlib import Path
 import jinja2
 
-from apkg.compat import py35path
 from apkg.log import getLogger
 from apkg import pkgstyle as _pkgstyle
+import apkg.util.shutil35 as shutil
 
 
 log = getLogger(__name__)
@@ -35,7 +34,7 @@ class PackageTemplate:
             out_path.mkdir(parents=True, exist_ok=True)
 
         # recursively render all files
-        for d, _, files in os.walk(py35path(self.path)):
+        for d, _, files in shutil.walk(self.path):
             rel_dir = Path(d).relative_to(self.path)
             dst_dir = out_path / rel_dir
             dst_dir.mkdir(parents=True, exist_ok=True)

apkg/util/run.py

@@ -4,7 +4,6 @@ import os
 import subprocess
 import sys
 
-from apkg.compat import py35path
 from apkg import exception
 from apkg.log import getLogger, T, LOG_LEVEL, INFO
 
@@ -133,7 +132,7 @@ def cd(newdir):
     Temporarily change current directory.
     """
     olddir = os.getcwd()
-    os.chdir(os.path.expanduser(py35path(newdir)))
+    os.chdir(os.path.expanduser(str(newdir)))
     try:
         yield
     finally:

apkg/util/shutil35.py

+"""
+A wrapper around selected shutil and os functions in order
+to ensure compatibility with pathlib.Path in Python 3.5.
+
+TODO: Once Python 3.5 support is dropped, replace all
+
+    import apkg.util.shutil35 as shutil
+
+with
+
+    import shutil
+
+and remove this compat module.
+"""
+import shutil
+import os
+
+
+def copy(src, dst, **kwargs):
+    return shutil.copy(str(src), str(dst), **kwargs)
+
+
+def copyfile(src, dst, **kwargs):
+    return shutil.copyfile(str(src), str(dst), **kwargs)
+
+
+def copytree(src, dst, **kwargs):
+    return shutil.copytree(str(src), str(dst), **kwargs)
+
+
+def rmtree(path, **kwargs):
+    return shutil.rmtree(str(path), **kwargs)
+
+
+def walk(top, **kwargs):
+    return os.walk(str(top), **kwargs)

apkg/util/test.py

 """
 shared apkg testing functions
 """
-import os
 from pathlib import Path
-import shutil
 
-from apkg.compat import py35path
+import apkg.util.shutil35 as shutil
 
 
 def init_testing_repo(repo_path, test_path, ignore_dirs=[]):
@@ -24,7 +22,7 @@ def inject_tree(src_path, dst_path, ignore_dirs=[]):
         dst_path.mkdir(parents=True, exist_ok=True)
 
     # recursively copy all files
-    for d, subdirs, files in os.walk(py35path(src_path)):
+    for d, subdirs, files in shutil.walk(src_path):
         if ignore_dirs:
             # ignore selected dirs
             ignored = []
@@ -41,7 +39,7 @@ def inject_tree(src_path, dst_path, ignore_dirs=[]):
         for fn in files:
             dst = dst_dir / fn
             src = Path(d) / fn
-            shutil.copy(py35path(src), py35path(dst))
+            shutil.copy(src, dst)
 
 
 def log_contains(string, caplog):

tests/integration/test_knot_resolver.py

@@ -4,9 +4,8 @@ integration tests for Knot Resolver
 import glob
 from pathlib import Path
 import pytest
-import shutil
+import apkg.util.shutil35 as shutil
 
-from apkg.compat import py35path
 from apkg.util import test
 from apkg.util.run import cd
 from apkg.util.git import git
@@ -40,7 +39,7 @@ def kresd_path(kresd_git, tmpdir):
     """
     # NOTE(py35): use tmp_path once py3.5 is dropped
     p = '%s/knot-resolver' % tmpdir
-    shutil.copytree(py35path(kresd_git), p, symlinks=True)
+    shutil.copytree(kresd_git, p, symlinks=True)
     return Path(p)