CI: Use ccache

Author: jonashaag

.github/actions/build_pandas/action.yml renamed to .github/actions/build-pandas/action.yml

@@ -5,11 +5,20 @@ runs:
   steps:
 
     - name: Environment Detail
+      id: env-detail
       run: |
+        echo ::group::{Environment Detail}
         micromamba info
         micromamba list
+        echo ::set-output name=python-version::$(micromamba list -f python --json | jq -r '.[0].version')
+        echo ::endgroup::
       shell: bash -el {0}
 
+    - name: Set up Ccache
+      uses: ./.github/actions/setup-ccache
+      with:
+        extra-cache-key: ${{ steps.env-detail.outputs.python-version }}
+
     - name: Build Pandas
       if : ${{ runner.os != 'Windows' }}
       run: |

.github/actions/setup-ccache/action.yml

@@ -0,0 +1,28 @@
+name: Setup sccache
+inputs:
+  extra-cache-key:
+    required: false
+    default: ''
+runs:
+  using: composite
+  steps:
+    - name: Get Date
+      id: get-date
+      run: echo "::set-output name=today::$(/bin/date -u '+%Y%m%d')"
+      shell: bash
+
+    - name: Fix Windows temporary directory
+      # On Windows, for some reason the default temporary directory provided to sccache
+      # may become read-only at some point. Work around by having a private tempdir.
+      id: mktemp
+      run: echo "::set-output name=tmpdir::$(cygpath -w $(mktemp -d))"
+      shell: bash
+      if: ${{ runner.os == 'Windows' }}
+
+    - name: Setup sccache
+      uses: hendrikmuhs/ccache-action@v1.2
+      with:
+        variant: sccache
+        key: ${{ runner.os }}--${{ runner.arch }}--${{ github.workflow }}--${{ steps.get-date.outputs.today }}--${{ inputs.extra-cache-key }}
+      env:
+        TMP: "${{ steps.mktemp.outputs.tmpdir }}"

.github/workflows/code-checks.yml

@@ -62,7 +62,7 @@ jobs:
 
     - name: Build Pandas
       id: build
-      uses: ./.github/actions/build_pandas
+      uses: ./.github/actions/build-pandas
 
     # The following checks are independent of each other and should still be run if one fails
     - name: Check for no warnings when building single-page docs
@@ -125,7 +125,7 @@ jobs:
 
     - name: Build Pandas
       id: build
-      uses: ./.github/actions/build_pandas
+      uses: ./.github/actions/build-pandas
 
     - name: Run ASV benchmarks
       run: |

.github/workflows/docbuild-and-upload.yml

@@ -44,7 +44,7 @@ jobs:
       uses: ./.github/actions/setup-conda
 
     - name: Build Pandas
-      uses: ./.github/actions/build_pandas
+      uses: ./.github/actions/build-pandas
 
     - name: Set up maintainers cache
       uses: actions/cache@v3

.github/workflows/macos-windows.yml

@@ -56,7 +56,7 @@ jobs:
         pyarrow-version: ${{ matrix.os == 'macos-latest' && '9' || '' }}
 
     - name: Build Pandas
-      uses: ./.github/actions/build_pandas
+      uses: ./.github/actions/build-pandas
 
     - name: Test
       uses: ./.github/actions/run-tests

.github/workflows/ubuntu.yml

@@ -173,7 +173,7 @@ jobs:
         pyarrow-version: ${{ matrix.pyarrow_version }}
 
     - name: Build Pandas
-      uses: ./.github/actions/build_pandas
+      uses: ./.github/actions/build-pandas
 
     - name: Test
       uses: ./.github/actions/run-tests

ci/run_tests.sh

@@ -1,4 +1,6 @@
 #!/bin/bash -e
+python -c 'import pandas; pandas.show_versions()'
+exit 0
 
 # Workaround for pytest-xdist (it collects different tests in the workers if PYTHONHASHSEED is not set)
 # https://github.com/pytest-dev/pytest/issues/920

setup.py

@@ -73,7 +73,48 @@ def is_platform_mac():
     _pxi_dep[module] = pxi_files
 
 
-class build_ext(_build_ext):
+class CompilerLauncherMixin:
+    """Add "compiler launchers" to distutils.
+
+    We use this to be able to run the Pandas build using "ccache".
+
+    A compiler launcher is a program that is invoked instead of invoking the
+    compiler directly. It is passed the full compiler invocation command line.
+
+    A similar feature exists in CMake, see
+    https://cmake.org/cmake/help/latest/prop_tgt/LANG_COMPILER_LAUNCHER.html.
+    """
+
+    __is_set_up = False
+
+    def build_extensions(self):
+        # Integrate into "build_ext"
+        self.__setup()
+        super().build_extensions()
+
+    def build_libraries(self):
+        # Integrate into "build_clib"
+        self.__setup()
+        super().build_extensions()
+
+    def __setup(self):
+        if self.__is_set_up:
+            return
+        self.__is_set_up = True
+        compiler_launcher = os.getenv("DISTUTILS_C_COMPILER_LAUNCHER")
+        if compiler_launcher:
+
+            def spawn_with_compiler_launcher(cmd):
+                exclude_programs = ("link.exe",)
+                if not cmd[0].endswith(exclude_programs):
+                    cmd = [compiler_launcher] + cmd
+                return original_spawn(cmd)
+
+            original_spawn = self.compiler.spawn
+            self.compiler.spawn = spawn_with_compiler_launcher
+
+
+class build_ext(CompilerLauncherMixin, _build_ext):
     @classmethod
     def render_templates(cls, pxifiles):
         for pxifile in pxifiles: