portable-python 1.8.4__tar.gz → 1.8.6__tar.gz

{portable-python-1.8.4/src/portable_python.egg-info → portable-python-1.8.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: portable-python
-Version: 1.8.4
+Version: 1.8.6
 Summary: Portable python binaries
 Home-page: https://github.com/codrsquad/portable-python
 Author: Zoran Simic

portable-python-1.8.6/pyproject.toml

@@ -0,0 +1,76 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+
+[tool.ruff]
+cache-dir = ".tox/.ruff_cache"
+line-length = 140
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+extend-select = [
+    "A",   # flake8-builtins
+#    "ARG", # flake8-unused-arguments
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "C90", # mccabe
+    "D",   # pydocstyle
+    "DTZ", # flake8-datetimez
+    "E",   # pycodestyle errors
+    "EM",  # flake8-errmsg
+    "ERA", # eradicate
+    "EXE", # flake8-executable
+    "F",   # pyflakes
+    "FLY", # flynt
+    "G",   # flake8-logging-format
+    "I",   # isort
+    "INT", # flake8-gettext
+    "PGH", # pygrep-hooks
+    "PIE", # flake8-pie
+    "PT", # flake8-pytest
+    "PYI", # flake8-pyi
+    "Q",   # flake8-quotes
+    "RSE", # flake8-raise
+    "RET", # flake8-return
+    "RUF", # ruff-specific
+    "S",   # flake8-bandit
+#    "SIM", # flake8-simplify
+    "SLF", # flake8-self
+    "SLOT", # flake8-slots
+    "T10", # flake8-debugger
+    "TID", # flake8-tidy-imports
+    "TCH", # flake8-type-checking
+#    "TD", # flake8-todos
+    "TRY", # tryceratops
+    "W",   # pycodestyle warnings
+]
+ignore = [
+    # TODO: gradually remove these (document all the things)
+    "D100",  # Missing docstring in public module
+    "D101",  # Missing docstring in public class
+    "D102",  # Missing docstring in public method
+    "D103",  # Missing docstring in public function
+    "D104",  # Missing docstring in public package
+    "D105",  # Missing docstring in magic method
+    "D200",  # One-line docstring should fit on one line with quotes
+    "D205",  # 1 blank line required between summary line and description
+    "D400",  # First line should end with a period
+    # Not useful:
+    "RET503",  # Missing explicit `return` at the end of function able to return non-`None` value
+]
+
+[tool.ruff.lint.flake8-builtins]
+builtins-ignorelist = ["bin", "compile"]
+
+[tool.ruff.lint.isort]
+order-by-type = false
+
+[tool.ruff.lint.mccabe]
+max-complexity = 14
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.per-file-ignores]
+"tests/*" = [
+    "S",  # No security checks for tests
+]

{portable-python-1.8.4 → portable-python-1.8.6}/setup.py

@@ -1,6 +1,5 @@
 from setuptools import setup
 
-
 setup(
     name="portable-python",
     setup_requires="setupmeta",

{portable-python-1.8.4 → portable-python-1.8.6}/src/portable_python/__init__.py

@@ -15,7 +15,7 @@ import multiprocessing
 import os
 import pathlib
 import re
-from typing import List
+from typing import ClassVar, List
 
 import runez
 from runez.http import RestClient
@@ -24,7 +24,6 @@ from runez.render import Header, PrettyTable
 
 from portable_python.versions import PPG
 
-
 LOG = logging.getLogger(__name__)
 RX_BINARY = re.compile(r"^.*\.(dylib|gmo|icns|ico|nib|prof.*|tar)$")
 
@@ -36,11 +35,16 @@ def is_binary_file(path):
 def patch_folder(folder, regex, replacement, ignore=None):
     """Replace all occurrences of 'old_text' by 'new_text' in all files in 'folder'
 
-    Args:
-        folder (pathlib.Path): Folder to scan
-        regex: Regex to replace
-        replacement (str): Replacement text
-        ignore: Regex stating what to ignore
+    Parameters
+    ----------
+    folder : pathlib.Path
+        Folder to scan
+    regex : str
+        Regex to replace
+    replacement : str
+        Replacement text
+    ignore : re.Pattern | None
+        Regex stating what to ignore
     """
     for path in runez.ls_dir(folder):
         if not path.is_symlink() and (not ignore or not ignore.match(path.name)):
@@ -53,21 +57,21 @@ def patch_folder(folder, regex, replacement, ignore=None):
 
 def patch_file(path, regex, replacement):
     try:
-        with open(path, "rt") as fh:
+        with open(path) as fh:
             text = fh.read()
 
         new_text = re.sub(regex, replacement, text, flags=re.MULTILINE)
         if text != new_text:
-            with open(path, "wt") as fh:
+            with open(path, "w") as fh:
                 fh.write(new_text)
 
-            LOG.info("Patched '%s' in %s" % (regex, runez.short(path)))
+            LOG.info("Patched '%s' in %s", regex, runez.short(path))
 
     except Exception as e:
-        with open(path, "rt", errors="ignore") as fh:
+        with open(path, errors="ignore") as fh:
             text = fh.read()
             if re.search(regex, text):
-                LOG.warning("Can't patch '%s': %s" % (runez.short(path), e))
+                LOG.warning("Can't patch '%s': %s", runez.short(path), e)
 
 
 class FolderMask:
@@ -81,7 +85,7 @@ class FolderMask:
     """
 
     def __init__(self, target_folder):
-        LOG.info("Applying isolation hack/mask to %s" % target_folder)
+        LOG.info("Applying isolation hack/mask to %s", target_folder)
         self.target_folder = target_folder
         r = runez.run("hdiutil", "attach", "-nomount", "ram://2048", fatal=Exception)
         self.ram_disk = r.output.strip()
@@ -93,7 +97,7 @@ class FolderMask:
         self.mounted = True
 
     def cleanup(self):
-        LOG.info("Cleaning up isolation hack/mask for %s" % self.target_folder)
+        LOG.info("Cleaning up isolation hack/mask for %s", self.target_folder)
         if self.mounted:
             runez.run("umount", self.target_folder, fatal=False)
 
@@ -118,8 +122,12 @@ class BuildContext:
 
     def _resolved_isolation(self):
         """
-        Returns:
-            (str | None): What strategy to use to work around the fact that python's ./configure script looks at /usr/local
+        Isolation setting currently configured.
+
+        Returns
+        -------
+        str | None
+            What strategy to use to work around the fact that python's ./configure script looks at /usr/local
         """
         v = PPG.config.get_value("isolate-usr-local")
         if v == "auto":
@@ -182,7 +190,7 @@ class BuildContext:
 
 class BuildSetup:
     """
-    This class drives the compilation, external modules first, then the target python itself.
+    Drives the compilation, external modules first, then the target python itself.
     All modules are compiled in the same manner, follow the same conventional build layout.
     """
 
@@ -191,10 +199,14 @@ class BuildSetup:
 
     def __init__(self, python_spec=None, modules=None, prefix=None):
         """
-        Args:
-            python_spec (str | PythonSpec | None): Python to build (family and version)
-            modules (str | None): Modules to build (default: from config)
-            prefix (str | None): --prefix to use
+        Parameters
+        ----------
+        python_spec : str | PythonSpec | None
+            Python to build (family and version)
+        modules : str | None
+            Modules to build (default: from config)
+        prefix : str | None
+            --prefix to use
         """
         if not python_spec or python_spec == "latest":
             python_spec = PPG.cpython.latest
@@ -267,11 +279,11 @@ class BuildSetup:
         with BuildContext(self) as build_context:
             self.build_context = build_context
             modules = self.python_builder.modules
-            LOG.info("portable-python v%s, current folder: %s" % (runez.get_version(__name__), os.getcwd()))
+            LOG.info("portable-python v%s, current folder: %s", runez.get_version(__name__), os.getcwd())
             LOG.info(runez.joined(modules, list(modules)))
             LOG.info(PPG.config.config_files_report())
-            LOG.info("Platform: %s" % PPG.target)
-            LOG.info("Build report:\n%s" % self.python_builder.modules.report())
+            LOG.info("Platform: %s", PPG.target)
+            LOG.info("Build report:\n%s", self.python_builder.modules.report())
             self.validate_module_selection(fatal=not runez.DRYRUN and not self.x_debug)
             self.ensure_clean_folder(self.folders.components)
             self.ensure_clean_folder(self.folders.deps)
@@ -375,7 +387,6 @@ class ModuleCollection:
 
 
 class LinkerOutcome(enum.Enum):
-
     absent = "orange"
     failed = "red"
     shared = "blue"
@@ -389,6 +400,7 @@ class ModuleBuilder:
     m_build_cwd: str = None  # Optional: relative (to unpacked source) folder where to run configure/make from
     m_debian = None
     m_include: str = None  # Optional: subfolder to automatically list in CPATH when this module is active
+    m_telltale: ClassVar[list]  # Optional: list of files that, if present, indicate this module is installed
 
     setup: BuildSetup
     parent_module: "ModuleBuilder" = None
@@ -396,8 +408,10 @@ class ModuleBuilder:
 
     def __init__(self, parent_module):
         """
-        Args:
-            parent_module (BuildSetup | ModuleBuilder): Associated parent
+        Parameters
+        ----------
+        parent_module : BuildSetup | ModuleBuilder
+            Associated parent
         """
         self.m_name = ModuleCollection.get_module_name(self.__class__)
         if isinstance(parent_module, BuildSetup):
@@ -458,7 +472,7 @@ class ModuleBuilder:
         if self.resolved_telltale:
             return "has %s" % self.resolved_telltale
 
-        return "no %s" % getattr(self, "m_telltale")
+        return "no %s" % self.m_telltale
 
     def _find_telltale(self):
         telltales = getattr(self, "m_telltale", runez.UNSET)
@@ -525,8 +539,7 @@ class ModuleBuilder:
 
     def run_configure(self, program, *args, prefix=None):
         """
-        Calling ./configure is similar across all components.
-        This allows to have descendants customize each part relatively elegantly
+        Run ./configure script for this module.
         """
         if prefix is None:
             prefix = self.deps
@@ -564,7 +577,8 @@ class ModuleBuilder:
             yield
 
         except Exception as e:
-            LOG.error("Error while compiling %r: %r", self, e)
+            overview = repr(e)
+            LOG.exception("Error while compiling %s: %s", self, overview)
             raise
 
         finally:
@@ -598,7 +612,7 @@ class ModuleBuilder:
                 env_vars = self._get_env_vars()
                 prev_env_vars = {}
                 for var_name, value in env_vars.items():
-                    LOG.info("env %s=%s" % (var_name, runez.short(value, size=2048)))
+                    LOG.info("env %s=%s", var_name, runez.short(value, size=2048))
                     prev_env_vars[var_name] = os.environ.get(var_name)
                     os.environ[var_name] = value
 
@@ -672,7 +686,6 @@ class ModuleBuilder:
 
 
 class PythonBuilder(ModuleBuilder):
-
     _bin_python: pathlib.Path = None
 
     def __init__(self, parent_module):
@@ -692,8 +705,10 @@ class PythonBuilder(ModuleBuilder):
     @property
     def bin_python(self):
         """
-        Returns:
-            (pathlib.Path | None): Path to freshly compiled bin/python, real file (not symlink)
+        Returns
+        -------
+            pathlib.Path | None
+                Path to freshly compiled bin/python, real file (not symlink)
         """
         if self._bin_python is None:
             self._bin_python = PPG.config.find_main_file(self.bin_folder / "python", self.version)
@@ -724,5 +739,5 @@ class PythonBuilder(ModuleBuilder):
                 expected = 0o755 if path.is_dir() else 0o644
                 current = path.stat().st_mode & 0o777
                 if current != expected:
-                    LOG.info("Corrected permissions for %s (was %s)" % (runez.short(path), oct(current)))
+                    LOG.info("Corrected permissions for %s (was %s)", runez.short(path), oct(current))
                     path.chmod(expected)

{portable-python-1.8.4 → portable-python-1.8.6}/src/portable_python/cli.py

@@ -8,7 +8,6 @@ from runez.render import PrettyTable
 from portable_python import BuildSetup, PPG
 from portable_python.inspector import LibAutoCorrect, PythonInspector
 
-
 LOG = logging.getLogger(__name__)
 
 
@@ -60,10 +59,6 @@ def build_report(modules, python_spec):
 def diagnostics():
     """Show diagnostics info"""
     with runez.Anchored("."):
-        def _diagnostics():
-            yield "invoker python", runez.SYS_INFO.invoker_python
-            yield from runez.SYS_INFO.diagnostics()
-
         config = PPG.config.represented()
         print(PrettyTable.two_column_diagnostics(_diagnostics(), config))
 
@@ -106,6 +101,11 @@ def list_cmd(json, family):
         print("  %s: %s" % (runez.bold(mm), v))
 
 
+def _diagnostics():
+    yield "invoker python", runez.SYS_INFO.invoker_python
+    yield from runez.SYS_INFO.diagnostics()
+
+
 def _find_recompress_source(folders, path):
     candidate = runez.to_path(path)
     if candidate.exists() or candidate.is_absolute():
@@ -158,7 +158,7 @@ def recompress(path, ext):
 
     \b
     Mildly useful for comparing sizes from different compressions
-    """
+    """  # noqa: D301
     extension = runez.SYS_INFO.platform_id.canonical_compress_extension(ext)
     pspec = PythonSpec.from_text(path)
     folders = PPG.get_folders(base=".", family=pspec and pspec.family, version=pspec and pspec.version)
@@ -203,6 +203,6 @@ def lib_auto_correct(commit, prefix, path):
 
 
 if __name__ == "__main__":
-    from portable_python.cli import main  # noqa, re-import with proper package
+    from portable_python.cli import main
 
     main()

{portable-python-1.8.4 → portable-python-1.8.6}/src/portable_python/config.py

@@ -9,7 +9,6 @@ import runez
 import yaml
 from runez.pyenv import Version
 
-
 LOG = logging.getLogger(__name__)
 
 DEFAULT_CONFIG = """
@@ -79,9 +78,12 @@ class Config:
 
     def __init__(self, paths=None, target=None):
         """
-        Args:
-            paths (str | list | None): Path(s) to config file(s)
-            target (str | runez.system.PlatformId | None): Target platform (for testing, defaults to current platform)
+        Parameters
+        ----------
+        paths : str | list | None
+            Path(s) to config file(s)
+        target : str | runez.system.PlatformId | None
+            Target platform (for testing, defaults to current platform)
         """
         self.paths = runez.flattened(paths, split=",")
         if not isinstance(target, runez.system.PlatformId):
@@ -98,17 +100,21 @@ class Config:
         return "%s [%s]" % (runez.plural(self._sources, "config source"), self.target)
 
     def completions(self, **given):
-        res = dict(arch=self.target.arch, platform=self.target.platform, subsystem=self.target.subsystem, target=str(self.target))
+        res = {"arch": self.target.arch, "platform": self.target.platform, "subsystem": self.target.subsystem, "target": str(self.target)}
         res.update(given)
         return res
 
     def get_value(self, *key, by_platform=True):
         """
-        Args:
-            key (str | tuple): Key to look up, tuple represents hierarchy, ie: a/b -> (a, b)
-            by_platform (bool): If True, value can be configured by platform
-
-        Returns:
+        Parameters
+        ----------
+        key : strzz | tuple
+            Key to look up, tuple represents hierarchy, ie: a/b -> (a, b)
+        by_platform : bool
+            If True, value can be configured by platform
+
+        Returns
+        -------
             Associated value, if any
         """
         value, _ = self.get_entry(*key, by_platform=by_platform)
@@ -116,18 +122,23 @@ class Config:
 
     def get_entry(self, *key, by_platform=True):
         """
-        Args:
-            key (str | tuple): Key to look up, tuple represents hierarchy, ie: a/b -> (a, b)
-            by_platform (bool): If True, value can be configured by platform
-
-        Returns:
-            Associated value, if any
+        Parameters
+        ----------
+        key : str | tuple
+            Key to look up, tuple represents hierarchy, ie: a/b -> (a, b)
+        by_platform : bool
+            If True, value can be configured by platform
+
+        Returns
+        -------
+        (str | int | float | bool | dict | list | None, ConfigSource | None)
+            Associated value (if any), together with the source that defined it
         """
         if by_platform:
             keys = (self.target.platform, self.target.arch, *key), (self.target.platform, *key), key
 
         else:
-            keys = (key, )
+            keys = (key,)
 
         for k in keys:
             for source in self._sources:
@@ -150,7 +161,7 @@ class Config:
         return value
 
     def config_files_report(self):
-        """One liner describing which config files are used, if any"""
+        """One-liner describing which config files are used, if any"""
         if len(self._sources) > 1:
             return "Config files: %s" % runez.joined(self._sources[:-1], delimiter=", ")
 
@@ -174,7 +185,7 @@ class Config:
     def delete(path):
         size = runez.filesize(path)
         runez.delete(path, logger=None)
-        LOG.info("Deleted %s (%s)" % (runez.short(path), runez.represented_bytesize(size)))
+        LOG.info("Deleted %s (%s)", runez.short(path), runez.represented_bytesize(size))
         return size
 
     @staticmethod
@@ -187,10 +198,14 @@ class Config:
 
     def cleanup_configured_globs(self, title, module, *keys):
         """
-        Args:
-            title (str): Title to use in log messages
-            module (portable_python.PythonBuilder): Associated python builder module
-            *keys (str): Config keys to lookup
+        Parameters
+        ----------
+        title : str
+            Title to use in log messages
+        module : portable_python.PythonBuilder
+            Associated python builder module
+        *keys : str
+            Config keys to lookup
         """
         globs = [(x, f"{x}-{self.target.platform}") for x in keys]
         globs = runez.flattened(globs, transform=self.get_value)
@@ -199,16 +214,20 @@ class Config:
 
     def cleanup_globs(self, title, module, *globs):
         """
-        Args:
-            title (str): Title to use in log messages
-            module (portable_python.PythonBuilder): Associated python builder module
-            *globs (str): Glob patterns to clean up
+        Parameters
+        ----------
+        title : str
+            Title to use in log messages
+        module : portable_python.PythonBuilder
+            Associated python builder module
+        *globs : str
+            Glob patterns to clean up
         """
         if globs:
             spec = [module.setup.folders.formatted(x) for x in globs]
             deleted_size = 0
             matcher = FileMatcher(spec)
-            LOG.info("Applying clean-up spec: %s" % matcher)
+            LOG.info("Applying clean-up spec: %s", matcher)
             cleaned = []
             for dirpath, dirnames, filenames in os.walk(module.install_folder):
                 removed = []
@@ -241,7 +260,7 @@ class Config:
             _find_file_duplicates(seen, folder)
             duplicates = {k: v for k, v in seen.items() if len(v) > 1}
             for dupes in duplicates.values():
-                LOG.info("Found duplicates: %s" % runez.joined(dupes, delimiter=", "))
+                LOG.info("Found duplicates: %s", runez.joined(dupes, delimiter=", "))
                 dupes = sorted(dupes, key=lambda x: len(str(x)))
                 if len(dupes) == 2:
                     shorter, longer = dupes
@@ -261,14 +280,19 @@ class Config:
         return basename, "%s%s" % (basename, version.major), "%s%s" % (basename, version.mm)
 
     @staticmethod
-    def find_main_file(desired: pathlib.Path, version: Version):
+    def find_main_file(desired, version):
         """
-        Args:
-            desired: Desired path (base name considered if path not directly available)
-            version: Associated version
-
-        Returns:
-            (pathlib.Path | None): Path to associated real file (not symlink)
+        Parameters
+        ----------
+        desired : pathlib.Path
+            Desired path (base name considered if path not directly available)
+        version : Version
+            Associated version
+
+        Returns
+        -------
+        pathlib.Path | None
+            Path to associated real file (not symlink)
         """
         p = Config.real_path(desired)
         if p:
@@ -335,10 +359,14 @@ class ConfigSource:
 
     def get_value(self, key):
         """
-        Args:
-            key (str | tuple): Key to look up, tuple represents hierarchy, ie: a/b -> (a, b)
-
-        Returns:
+        Parameters
+        ----------
+        key : str | tuple
+            Key to look up, tuple represents hierarchy, ie: a/b -> (a, b)
+
+        Returns
+        -------
+        str | int | float | bool | dict | list | None
             Associated value, if any
         """
         return self._deep_get(self.data, key)
@@ -360,7 +388,6 @@ class ConfigSource:
 
 
 class FileMatcher:
-
     def __init__(self, clean_spec):
         self.matches = []
         for spec in clean_spec:
@@ -376,7 +403,6 @@ class FileMatcher:
 
 
 class SingleFileMatch:
-
     _on_folder = False
     _rx_basename = None
     _rx_path = None