proj-flow 0.15.3__tar.gz → 0.17.0__tar.gz

{proj_flow-0.15.3 → proj_flow-0.17.0}/CHANGELOG.rst

@@ -4,6 +4,22 @@ Changelog
 
 All notable changes to this project will be documented in this file.
 
+`0.17.0 <https://github.com/mzdun/proj-flow/compare/v0.16.0...v0.17.0>`_ (2025-08-28)
+=====================================================================================
+
+New Features
+------------
+
+- use CMake presets to find binary directory (`2312366 <https://github.com/mzdun/proj-flow/commit/2312366ace1ba2152490c5aa710db82b982bbc02>`_)
+
+`0.16.0 <https://github.com/mzdun/proj-flow/compare/v0.15.3...v0.16.0>`_ (2025-03-02)
+=====================================================================================
+
+New Features
+------------
+
+- add bootstrap action (`57cf99b <https://github.com/mzdun/proj-flow/commit/57cf99bad7c34aa22d357746824647499d70eb07>`_)
+
 `0.15.3 <https://github.com/mzdun/proj-flow/compare/v0.15.2...v0.15.3>`_ (2025-02-24)
 =====================================================================================
 

{proj_flow-0.15.3 → proj_flow-0.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: proj-flow
-Version: 0.15.3
+Version: 0.17.0
 Summary: C++ project maintenance, automated
 Project-URL: Changelog, https://github.com/mzdun/proj-flow/blob/main/CHANGELOG.rst
 Project-URL: Documentation, https://proj-flow.readthedocs.io/en/latest/

proj_flow-0.17.0/actions/bootstrap/action.yml

@@ -0,0 +1,51 @@
+name: Python + Project Flow bootstrap
+description: Sets up Flow for current checkout.
+author: Marcin Zdun
+
+inputs:
+  python-version:
+    description: "Version range or exact version of Python or PyPy to use, using SemVer's version range syntax. Reads from .python-version if unset."
+
+outputs:
+  version:
+    description: Version of the `proj-flow` this project expects
+    value: ${{ steps.version.outputs.version }}
+
+  is-flow-app:
+    description: Checks, if this project is a Flow project
+    value: ${{ steps.version.outputs.is-flow-app }}
+
+runs:
+  using: composite
+  steps:
+    - name: python 3.10
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - name: check version
+      id: version
+      shell: python
+      run: |
+        import os
+        import sys
+
+        ACTION_PATH = os.environ['ACTION_PATH'].replace('/', os.sep)
+        sys.path.insert(0, ACTION_PATH)
+
+        import version
+      env:
+        ACTION_PATH: ${{ github.action_path }}
+        RUNNER_CONTEXT: ${{ toJson(runner) }}
+
+    - name: .flow/.venv cache
+      if: ${{ fromJson(steps.version.outputs.is-flow-app) }}
+      uses: actions/cache@v4
+      with:
+        path: .flow/.venv
+        key: ${{ steps.version.outputs.venv-cache-key }}
+
+    - name: bootstrap
+      if: ${{ fromJson(steps.version.outputs.is-flow-app) }}
+      run: python ./.flow/flow.py bootstrap
+      shell: bash

proj_flow-0.17.0/actions/bootstrap/version.py

@@ -0,0 +1,49 @@
+# Copyright (c) 2025 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+import json
+import os
+from platform import machine
+from typing import cast
+
+VAR_NAME = "CXX_FLOW_VERSION"
+VARIABLE = ""
+IS_FLOW_APP = False
+
+RUNNER = cast(dict, json.loads(os.environ["RUNNER_CONTEXT"]))
+RUNNER_OS = RUNNER.get("os", os.name)
+RUNNER_ARCH = RUNNER.get("arch", machine() or "unk-arch")
+
+try:
+    with open(".flow/flow.py", encoding="UTF-8") as flow_py:
+        for line in flow_py:
+            if not line.startswith(VAR_NAME):
+                continue
+
+            var_list = line.split("=", 1)
+            if len(var_list) != 2:
+                continue
+
+            var = var_list[0].strip()
+            if var != VAR_NAME:
+                continue
+
+            val = var_list[1].strip()
+            start = val[:1]
+            if start not in "\"'":
+                continue
+
+            VARIABLE = val[1:].split(start, 1)[0].strip()
+            break
+
+    IS_FLOW_APP = True
+
+except FileNotFoundError:
+    pass
+
+VENV_CACHE_KEY = f"venv-{RUNNER_OS}-{RUNNER_ARCH}-{VARIABLE}"
+
+with open(os.environ["GITHUB_OUTPUT"], "a", encoding="UTF-8") as out:
+    print(f"version={VARIABLE}", file=out)
+    print(f"venv-cache-key={VENV_CACHE_KEY}", file=out)
+    print(f"is-flow-app={json.dumps(IS_FLOW_APP)}", file=out)

{proj_flow-0.15.3 → proj_flow-0.17.0}/src/proj_flow/__init__.py

@@ -6,4 +6,4 @@ The **proj_flow** contains only ``__version__`` to be updated, nothing more.
 This is in an attempt to make this module easy to load initially.
 """
 
-__version__ = "0.15.3"
+__version__ = "0.17.0"

{proj_flow-0.15.3 → proj_flow-0.17.0}/src/proj_flow/ext/cplusplus/cmake/__init__.py

@@ -7,6 +7,6 @@ The **proj_flow.ext.cplusplus.cmake** provides ``"CMake"``, ``"Build"``,
 context.
 """
 
-from . import parser, project, steps
+from . import parser, presets, project, steps
 
-__all__ = ["parser", "project", "steps"]
+__all__ = ["parser", "presets", "project", "steps"]

proj_flow-0.17.0/src/proj_flow/ext/cplusplus/cmake/presets.py

@@ -0,0 +1,160 @@
+# Copyright (c) 2025 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+"""
+The **proj_flow.ext.cplusplus.cmake.presets** check build directories for CMake step.
+"""
+
+import json
+import os
+import platform
+from dataclasses import dataclass
+from enum import Enum
+from pathlib import Path
+from typing import cast
+
+
+class MacroType(Enum):
+    PRESET_NAME = 1
+    GENERATOR = 2
+    FILE_DIR = 3
+
+
+CMAKE_SOURCE_DIR = Path(".").resolve()
+CMAKE_HOST_SYSTEM_NAME = platform.uname().system
+
+MACROS: dict[str, Path | str | MacroType] = {
+    "${sourceDir}": CMAKE_SOURCE_DIR,
+    "${sourceParentDir}": CMAKE_SOURCE_DIR.parent,
+    "${sourceDirName}": CMAKE_SOURCE_DIR.name,
+    "${presetName}": MacroType.PRESET_NAME,
+    "${generator}": MacroType.GENERATOR,
+    "${hostSystemName}": CMAKE_HOST_SYSTEM_NAME,
+    "${fileDir}": MacroType.FILE_DIR,
+    "${dollar}": "$",
+    "${pathListSep}": os.pathsep,
+}
+
+
+@dataclass
+class Preset:
+    name: str
+    binary_dir: str | None
+    generator: str | None
+    inherits: list[str]
+    file_dir: Path
+
+    def expand(self):
+        if not self.binary_dir:
+            return None
+        chunks = self.binary_dir.split("${")
+        parts: list[str | Path | MacroType] = [chunks[0]]
+        for chunk in chunks[1:]:
+            var_suffix = chunk.split("}", 1)
+            if len(var_suffix) != 2:
+                return None
+            key = f"${{{var_suffix[0]}}}"
+            value = MACROS.get(key, "")
+            if isinstance(value, MacroType):
+                if value == MacroType.PRESET_NAME:
+                    value = self.name
+                elif value == MacroType.GENERATOR:
+                    value = self.generator or ""
+                elif value == MacroType.FILE_DIR:
+                    value = self.file_dir
+            elif isinstance(value, Path):
+                if value.is_absolute():
+                    parts = []
+                value = str(value)
+            parts.append(value)
+            parts.append(var_suffix[1])
+
+        return Path("".join(str(part) for part in parts))
+
+
+class Presets:
+    def __init__(self):
+        self.seen = cast(set[Path], set())
+        self.result = cast(dict[str, Preset], {})
+
+    def visit_file(self, filename: Path):
+        dirname = self.__parent_from_file(filename)
+        if dirname is None:
+            return self.result
+
+        includes, presets = Presets.__load_file(filename)
+        self.__visit_includes(dirname, includes)
+        for preset in presets:
+            self.__visit_preset(dirname, preset)
+        for preset in self.result.values():
+            self.__merge_preset(preset)
+
+        return self.result
+
+    def __parent_from_file(self, filename: Path):
+        key = filename.resolve()
+        if key in self.seen:
+            return None
+        self.seen.add(key)
+        return key.parent
+
+    def __visit_includes(self, dirname: Path, includes: list[str]):
+        for include in includes:
+            self.visit_file(dirname / include)
+
+    def __visit_preset(self, dirname: Path, preset: dict):
+        name = cast(str | None, preset.get("name"))
+        if name is None:
+            return
+        binary_dir = cast(str | None, preset.get("binaryDir"))
+        generator = cast(str | None, preset.get("generator"))
+        inherits = cast(list[str], preset.get("inherits", []))
+        self.result[name] = Preset(
+            name=name,
+            binary_dir=binary_dir,
+            generator=generator,
+            inherits=inherits,
+            file_dir=dirname,
+        )
+
+    def __merge_preset(self, preset: Preset):
+        inherits: list[str] = []
+        inherits.extend(preset.inherits)
+        while inherits:
+            parent = inherits[0]
+            inherits = inherits[1:]
+            if parent not in self.result:
+                continue
+            parent_preset = self.result[parent]
+            inherits.extend(parent_preset.inherits)
+
+            if parent_preset.binary_dir and not preset.binary_dir:
+                preset.binary_dir = parent_preset.binary_dir
+            if parent_preset.generator and not preset.generator:
+                preset.generator = parent_preset.generator
+
+    @staticmethod
+    def __load_file(filename: Path):
+        with open(filename, encoding="UTF-8") as f:
+            data = json.load(f)
+        includes = cast(list[str], data.get("include", []))
+        presets = cast(list[dict], data.get("configurePresets", []))
+
+        return (includes, presets)
+
+
+def get_binary_dirs():
+    presets = Presets().visit_file(Path("CMakePresets.json"))
+
+    cwd = str(Path.cwd().as_posix()) + "/"
+    result: dict[str, str] = {}
+    for preset in presets.values():
+        dirname = preset.expand()
+        if dirname is None:
+            continue
+        rel = str(dirname.as_posix())
+        if rel[: len(cwd)] == cwd:
+            rel = rel[len(cwd) :]
+        result[preset.name] = rel
+
+    return result

{proj_flow-0.15.3 → proj_flow-0.17.0}/src/proj_flow/ext/cplusplus/cmake/steps.py

@@ -12,6 +12,7 @@ from typing import Dict, List, cast
 from proj_flow import api
 from proj_flow.api import env, step
 from proj_flow.base.__cmake_version__ import CMAKE_VERSION
+from proj_flow.ext.cplusplus.cmake.presets import get_binary_dirs
 
 
 class CMakeBase(api.step.Step):
@@ -39,7 +40,7 @@ class CMakeBase(api.step.Step):
         self._runs_after = runs_after
         self._runs_before = runs_before
 
-    def is_active(self, config: api.env.Config, rt: api.env.Runtime) -> int:
+    def is_active(self, config: api.env.Config, rt: api.env.Runtime) -> bool:
         return os.path.isfile("CMakeLists.txt") and os.path.isfile("CMakePresets.json")
 
     def platform_dependencies(self):
@@ -55,12 +56,16 @@ class CMakeConfig(CMakeBase):
 
     def __init__(self):
         super().__init__(name="CMake")
+        self.binary_dirs = get_binary_dirs()
 
-    def is_active(self, config: env.Config, rt: env.Runtime) -> int:
+    def is_active(self, config: env.Config, rt: env.Runtime) -> bool:
         return os.path.isfile("CMakeLists.txt") and os.path.isfile("CMakePresets.json")
 
     def directories_to_remove(self, config: env.Config) -> List[str]:
-        return [f"build/{config.build_type}"]
+        binary_dir = self.binary_dirs.get(f"{config.preset}-{config.build_generator}")
+        if not binary_dir:
+            return []
+        return [binary_dir]
 
     def run(self, config: env.Config, rt: env.Runtime) -> int:
         cmake_vars = cast(Dict[str, str], rt._cfg.get("cmake", {}).get("vars", {}))
@@ -130,7 +135,7 @@ class PackStep(CMakeBase):
     def platform_dependencies(self):
         return self.dep_with_tool("cpack")
 
-    def is_active(self, config: env.Config, rt: env.Runtime) -> int:
+    def is_active(self, config: env.Config, rt: env.Runtime) -> bool:
         return (
             super().is_active(config, rt)
             and len(config.items.get("cpack_generator", [])) > 0

{proj_flow-0.15.3 → proj_flow-0.17.0}/src/proj_flow/minimal/ext/bug_report.py

@@ -25,6 +25,7 @@ def _version(ver: str) -> Tuple[int, int, int, str]:
         raise SystemExit(1)
     return (int(m.group(1)), int(m.group(2)), int(m.group(3)), ver)
 
+
 def _prev_version(new_version: str, tags: List[str]):
     current = _version(new_version)
     versions = [_version(tag) for tag in reversed(tags)]
@@ -40,6 +41,7 @@ def _prev_version(new_version: str, tags: List[str]):
 
     return None if index > len(versions) else versions[index][-1]
 
+
 @release.version_updaters.add
 class VersionUpdater(release.VersionUpdater):
     def on_version_change_tags(self, new_version: str, tags: List[str]):