Update dependency clang to v17 (#233)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Nick <[email protected]>
speedyleion · Jan 8, 2024 · 87a7fd4 · 87a7fd4
1 parent 35e3995
commit 87a7fd4
Show file tree

Hide file tree

Showing 8 changed files with 61 additions and 29 deletions.
diff --git a/.github/codecov.yml b/.github/codecov.yml
@@ -0,0 +1,8 @@
+ coverage:
+  status:
+    project:
+      default:
+        target: 100%
+        threshold: 0%
+        paths: 
+          - "src"
diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml
@@ -24,14 +24,14 @@ jobs:
         uses: actions/cache@v3
         with:
           path: llvm/lib/libclang.so*
-          key: llvm-16
+          key: llvm-17
       - name: Install LLVM and Clang
         uses: KyleMayes/install-llvm-action@v1
         with:
-          version: "16.0"
+          version: "17.0"
           cached: ${{ steps.cache-llvm.outputs.cache-hit }}
       - name: Symlink libclang.so
-        run: sudo ln -s ${{ env.LLVM_PATH }}/lib/libclang.so /usr/lib/x86_64-linux-gnu/libclang-16.so
+        run: sudo ln -s ${{ env.LLVM_PATH }}/lib/libclang.so /usr/lib/x86_64-linux-gnu/libclang-17.so
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
@@ -49,14 +49,14 @@ jobs:
         uses: actions/cache@v3
         with:
           path: llvm/lib/libclang.so*
-          key: llvm-16
+          key: llvm-17
       - name: Install LLVM and Clang
         uses: KyleMayes/install-llvm-action@v1
         with:
-          version: "16.0"
+          version: "17.0"
           cached: ${{ steps.cache-llvm.outputs.cache-hit }}
       - name: Symlink libclang.so
-        run: sudo ln -s ${{ env.LLVM_PATH }}/lib/libclang.so /usr/lib/x86_64-linux-gnu/libclang-16.so
+        run: sudo ln -s ${{ env.LLVM_PATH }}/lib/libclang.so /usr/lib/x86_64-linux-gnu/libclang-17.so
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
@@ -68,8 +68,9 @@ jobs:
         uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
-          files: ./tests/coverage.xml
+          files: ./coverage.xml
           verbose: true
+          fail_ci_if_error: true
 
   checks:
     runs-on: ubuntu-latest
@@ -83,14 +84,14 @@ jobs:
         uses: actions/cache@v3
         with:
           path: llvm/lib/libclang.so*
-          key: llvm-16
+          key: llvm-17
       - name: Install LLVM and Clang
         uses: KyleMayes/install-llvm-action@v1
         with:
-          version: "16.0"
+          version: "17.0"
           cached: ${{ steps.cache-llvm.outputs.cache-hit }}
       - name: Symlink libclang.so
-        run: sudo ln -s ${{ env.LLVM_PATH }}/lib/libclang.so /usr/lib/x86_64-linux-gnu/libclang-16.so
+        run: sudo ln -s ${{ env.LLVM_PATH }}/lib/libclang.so /usr/lib/x86_64-linux-gnu/libclang-17.so
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
@@ -108,14 +109,14 @@ jobs:
         uses: actions/cache@v3
         with:
           path: llvm/lib/libclang.so*
-          key: llvm-16
+          key: llvm-17
       - name: Install LLVM and Clang
         uses: KyleMayes/install-llvm-action@v1
         with:
-          version: "16.0"
+          version: "17.0"
           cached: ${{ steps.cache-llvm.outputs.cache-hit }}
       - name: Symlink libclang.so
-        run: sudo ln -s ${{ env.LLVM_PATH }}/lib/libclang.so /usr/lib/x86_64-linux-gnu/libclang-16.so
+        run: sudo ln -s ${{ env.LLVM_PATH }}/lib/libclang.so /usr/lib/x86_64-linux-gnu/libclang-17.so
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -39,6 +39,7 @@ sphinxcontrib-autoprogram = "0.1.8"
 types-docutils = "0.20.0.20240106"
 pylint = "^3.0.0"
 furo = "^2023.5.20"
+setuptools = "^69.0.3"
 
 [build-system]
 requires = ["poetry-core"]

diff --git a/src/sphinx_c_autodoc/loader.py b/src/sphinx_c_autodoc/loader.py
@@ -712,9 +712,9 @@ def _find_declaration_type(self) -> str:
         )
         try:
             type_ = tokens[-2].spelling
-        except IndexError:
-            # For array variables with unknown types libclang fails to provide the
-            # tokens.
+        except IndexError:  # pragma: no cover
+            # For versions 16 and before, libclang fails to provide the tokens for array
+            # variables with unknown types
             pass
 
         # clang doesn't provide the storage class in the type name, so we'll add it here

diff --git a/tests/assets/c_source/variables.c b/tests/assets/c_source/variables.c
@@ -22,9 +22,7 @@ static MAYBE_CONST /* throw in a pinch of comment to the mix */
 
 /**
  * A an array variable with an unknown type.
- * For whatever reason clang will come back with no extent on this so
- * we have to fall back to this being treated as an int
-*/
+ */
 unknown_type unknown_array_type_var[24];
 
 /**

diff --git a/tests/directives/test_autocdata.py b/tests/directives/test_autocdata.py
@@ -4,9 +4,12 @@
 from textwrap import dedent
 
 import pytest
+import pkg_resources
 
 from sphinx.ext.autodoc.directive import AutodocDirective
 
+CLANG_VERSION = pkg_resources.get_distribution("clang").parsed_version
+
 
 class TestAutoCData:
     """
@@ -36,10 +39,8 @@ class TestAutoCData:
         MAYBE_CONST is the type."""
 
     unknown_file_level_array_type = """\
-        int unknown_array_type_var[24]
-        A an array variable with an unknown type.
-        For whatever reason clang will come back with no extent on this so
-        we have to fall back to this being treated as an int"""
+        unknown_type unknown_array_type_var[24]
+        A an array variable with an unknown type."""
 
     unknown_extern_file_variable = """\
         extern unknown_type *unknown_extern_type_var
@@ -49,7 +50,14 @@ class TestAutoCData:
         ("variables.c::file_level_variable", file_level_variable),
         ("example.c::inline_struct_variable", inline_struct_variable),
         ("variables.c::unknown_type_var", unknown_file_level_variable_type),
-        ("variables.c::unknown_array_type_var", unknown_file_level_array_type),
+        pytest.param(
+            "variables.c::unknown_array_type_var",
+            unknown_file_level_array_type,
+            marks=pytest.mark.skipif(
+                CLANG_VERSION.release < (17,),
+                reason="Clang 17+ fixes array type parsing",
+            ),
+        ),
         ("variables.c::unknown_extern_type_var", unknown_extern_file_variable),
     ]
 

diff --git a/tox.ini b/tox.ini
@@ -24,7 +24,7 @@ commands =
     flake8: flake8 {toxinidir}/src/sphinx_c_autodoc
     black: black --check {toxinidir}/src/sphinx_c_autodoc {toxinidir}/tests {posargs}
     mypy: poetry run mypy {toxinidir}/src/sphinx_c_autodoc {posargs}
-    cov: poetry run pytest --cov=sphinx_c_autodoc --cov-config={[coverage]file} --cov-report=xml --cov-fail-under=100 {posargs}
+    cov: poetry run pytest --cov=sphinx_c_autodoc --cov-config={[coverage]file} --cov-report=xml {posargs}
     docs: poetry run sphinx-build {toxinidir}/docs {toxinidir}/docs/_build
 
 [testenv:py{38, 39, 310, 311, 312}]