Merge pull request #313 from BCG-Gamma/dev/1.2.5

BUILD: release pytools 1.2.5

Author: j-ittner

RELEASE_NOTES.rst

@@ -4,6 +4,12 @@ Release Notes
 *pytools* 1.2
 -------------
 
+1.2.5
+~~~~~
+
+This is a maintenance release to catch up with *pytools* 1.1.10.
+
+
 1.2.4
 ~~~~~
 
@@ -53,6 +59,20 @@ This is a maintenance release to catch up with *pytools* 1.1.4.
 *pytools* 1.1
 -------------
 
+1.1.10
+~~~~~~
+
+This release addresses additional issues in the release process, focusing on the
+`make_base.py` script for Sphinx builds used across *gamma-pytools*, *sklearndf*, and
+*gamma-facet*.
+
+
+1.1.9
+~~~~~
+
+This is a bugfix release to restore the GitHub release process.
+
+
 1.1.8
 ~~~~~
 

azure-pipelines.yml

@@ -465,9 +465,9 @@ stages:
                 set -eux
                 echo "Getting version"
                 pip install packaging~=20.9
-                cd $(System.DefaultWorkingDirectory)/$(project_root)/src
+                package_path=$(System.DefaultWorkingDirectory)/$(project_root)/src/$(project_name)
                 export PYTHONPATH=$(System.DefaultWorkingDirectory)/pytools/sphinx/base
-                version=$(python -c "import make_base; print(make_base.get_package_version())")
+                version=$(python -c "import make_util; print(make_util.get_package_version(package_path='$package_path'))")
                 echo "Current version: $version"
                 echo "Detecting pre-release ('dev' or 'rc' in version)"
                 prerelease=False
@@ -525,7 +525,7 @@ stages:
                 )
               )
             inputs:
-              gitHubConnection: github_release
+              gitHubConnection: github-release
               repositoryName: $(Build.Repository.Name)
               action: create
               target: $(Build.SourceVersion)

make.py

@@ -17,9 +17,15 @@
 
 import toml
 
-CWD = os.getcwd()
 SCRIPT_DIR = os.path.abspath(os.path.dirname(__file__))
 
+sys.path.insert(
+    0,
+    os.path.normpath(os.path.join(SCRIPT_DIR, "sphinx", "base")),
+)
+# noinspection PyUnresolvedReferences
+from make_util import get_package_version
+
 FACET_PATH_ENV = "FACET_PATH"
 FACET_PATH_URI_ENV = "FACET_PATH_URI"
 FACET_BUILD_PKG_VERSION_ENV = "FACET_BUILD_{project}_VERSION"
@@ -77,30 +83,8 @@ def __init__(self, project: str, dependency_type: str) -> None:
 
         project_root_path = os.path.abspath(os.path.join(projects_root_path, project))
         src_root_path = os.path.join(project_root_path, "src", project)
-        init_path = os.path.join(src_root_path, "__init__.py")
-
-        print(f"Retrieving package version from {init_path}")
-
-        with open(init_path, "rt") as init_file:
-            init_lines = init_file.readlines()
 
-        matches = {
-            match[1] or match[2]
-            for match in (RE_VERSION_DECLARATION.match(line) for line in init_lines)
-            if match
-        }
-
-        if len(matches) == 0:
-            raise RuntimeError(f"No valid __version__ declaration found in {init_path}")
-
-        elif len(matches) > 1:
-            raise RuntimeError(
-                f"Multiple conflicting __version__ declarations found in {init_path}: "
-                f"{matches}"
-            )
-
-        else:
-            package_version = next(iter(matches))
+        package_version = str(get_package_version(package_path=src_root_path))
 
         os.environ[
             FACET_BUILD_PKG_VERSION_ENV.format(project=project.upper())
@@ -154,7 +138,7 @@ def get_pyproject_toml(self) -> Dict[str, Any]:
         pyproject_toml_path = os.path.join(
             os.environ[FACET_PATH_ENV], self.project, "pyproject.toml"
         )
-        print(f"Reading build configuration from {pyproject_toml_path}")
+        log(f"Reading build configuration from {pyproject_toml_path}")
         with open(pyproject_toml_path, "rt") as f:
             return toml.load(f)
 
@@ -251,7 +235,7 @@ def get_matrix_dependencies(matrix_type: str) -> Dict[str, str]:
         for package, version in requirements_to_expose.items():
             # bash ENV variables can not use dash, replace it to _
             env_var_name = "FACET_V_" + re.sub(r"[^\w]", "_", package.upper())
-            print(f"Exporting {env_var_name}={version !r}")
+            log(f"Exporting {env_var_name}={version !r}")
             os.environ[env_var_name] = version
 
     @abstractmethod
@@ -266,7 +250,7 @@ def print_build_info(self, stage: str) -> None:
             f"VERSION {self.package_version}"
         )
         separator = "=" * len(message)
-        print(f"{separator}\n{message}\n{separator}")
+        log(f"{separator}\n{message}\n{separator}")
 
     @abstractmethod
     def build(self) -> None:
@@ -321,7 +305,7 @@ def clean(self) -> None:
         # purge pre-existing build directories
         package_dist_name = self.get_package_dist_name()
         for obsolete_folder in glob(os.path.join(build_path, f"{package_dist_name}_*")):
-            print(f"Clean: Removing obsolete conda-build folder at: {obsolete_folder}")
+            log(f"Clean: Removing obsolete conda-build folder at: {obsolete_folder}")
             shutil.rmtree(obsolete_folder, ignore_errors=True)
 
         # remove broken packages
@@ -341,7 +325,7 @@ def build(self) -> None:
 
         os.makedirs(build_path, exist_ok=True)
         build_cmd = f"conda-build -c conda-forge -c bcg_gamma {recipe_path}"
-        print(
+        log(
             f"Building: {self.project}\n"
             f"Build path: {build_path}\n"
             f"Build Command: {build_cmd}"
@@ -384,9 +368,9 @@ def build(self) -> None:
             os.chdir(build_path)
 
             build_cmd = f"tox -e {tox_env} -v"
-            print(f"Build Command: {build_cmd}")
+            log(f"Build Command: {build_cmd}")
             subprocess.run(args=build_cmd, shell=True, check=True)
-            print("Tox build completed – creating local PyPi index")
+            log("Tox build completed – creating local PyPi index")
 
             # Create/update a local PyPI PEP 503 (the simple repository API) compliant
             # folder structure, so that it can be used with PIP's --extra-index-url
@@ -418,7 +402,7 @@ def build(self) -> None:
             with open(project_index_html_path, "wt") as f:
                 f.writelines(package_file_links)
 
-            print(f"Local PyPi Index created at: {pypi_index_path}")
+            log(f"Local PyPi Index created at: {pypi_index_path}")
 
         finally:
             os.chdir(original_dir)
@@ -471,6 +455,15 @@ def print_usage() -> None:
     print(usage)
 
 
+def log(message: str) -> None:
+    """
+    Write a message to `stderr`.
+
+    :param message: the message to write
+    """
+    print(message, file=sys.stderr)
+
+
 def run_make() -> None:
     """
     Run this build script with the given arguments.
@@ -495,7 +488,7 @@ def run_make() -> None:
     ):
 
         if arg_value not in valid_values:
-            print(
+            log(
                 f"Wrong value for {arg_name} argument: "
                 f"got {arg_value} but expected one of {', '.join(valid_values)}"
             )

sphinx/base/conf_base.py

@@ -45,13 +45,22 @@ def set_config(
     Add required modules to the python path, and set custom configuration options
     """
 
+    from make_util import get_package_version
+
     globals_["project"] = project
+    globals_["version"] = str(
+        get_package_version(
+            package_path=(
+                os.path.join(os.getcwd(), os.pardir, os.pardir, "src", project)
+            )
+        )
+    )
 
     if html_logo:
         globals_["html_logo"] = html_logo
         globals_["latex_logo"] = html_logo
 
-    modules = set(modules) | {"pytools"}
+    modules = {"pytools", *modules}
     for module in modules:
         module_path = os.path.normpath(os.path.join(_dir_repo_root, module, "src"))
         if module_path not in sys.path:
@@ -73,8 +82,8 @@ def set_config(
 
 # -- Project information -----------------------------------------------------
 
-project = "pytools"
-copyright = "2021, Boston Consulting Group (BCG)"
+# noinspection PyShadowingBuiltins
+copyright = "2022, Boston Consulting Group (BCG)"
 author = "FACET Team"
 
 # -- General configuration ---------------------------------------------------
@@ -177,31 +186,13 @@ def set_config(
 # Class documentation to include docstrings both global to the class, and from __init__
 autoclass_content = "both"
 
-
-def _get_package_version() -> str:
-    """
-    Get the package version for the project being built.
-    :return: string with Python package version
-    """
-    # NOTE: sphinx-make changes the CWD into sphinx/source
-    #       while FACET's make_base expects a CWD <project>/src
-    #       hence: save current CWD, navigate to <project>/src, then go back
-    cwd = os.getcwd()
-    os.chdir(os.path.join(cwd, os.pardir, os.pardir, "src"))
-    import make_base
-
-    version_ = str(make_base.get_package_version())
-    os.chdir(cwd)
-    return version_
-
-
-version = _get_package_version()
 # -- End of options section ------------------------------------------------------------
 
 
 def setup(app: Sphinx) -> None:
     """
-    Add event handlers to the Sphinx application object
+    Add event handlers to the Sphinx application object.
+
     :param app: the Sphinx application object
     """