Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions test/ci_tests/check_docstring_coverage.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ def _parse_interrogate_output(output: str, repo_root: Path) -> list[str]:

for line in output.splitlines():
### Section header
# Interrogate section headers vary by version ("==== ... ====" vs
# "===== ... ====="), so accept both 4+ and 5+ equals styles.
m = re.match(r"={4,}\s+Coverage for (.+?)\s*={4,}", line)
# Interrogate section headers vary by version and use different
# numbers of equals signs, e.g. "= Coverage ... =" or "===== ... =====".
m = re.match(r"=+\s+Coverage for (.+?)\s*=+", line)
if m:
current_dir = m.group(1).rstrip("/")
current_file = ""
Expand Down
43 changes: 43 additions & 0 deletions test/ci_tests/test_check_docstring_coverage.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# SPDX-FileCopyrightText: Copyright (c) 2023 - 2026 NVIDIA CORPORATION & AFFILIATES.
# SPDX-FileCopyrightText: All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from pathlib import Path

from check_docstring_coverage import _parse_interrogate_output
Comment thread
Thabhelo marked this conversation as resolved.


def test_parse_interrogate_output_single_equals_header():
"""Interrogate 1.7 uses single-equals section headers."""
repo_root = Path("/repo")
output = """
= Coverage for /repo/examples/structural_mechanics/crash/ =
| datapipe.py | |
| SimSample.to (L70) | MISSED |
"""
results = _parse_interrogate_output(output, repo_root)
assert results == ["examples/structural_mechanics/crash/datapipe.py:SimSample.to"]


def test_parse_interrogate_output_multi_equals_header():
"""Older interrogate versions may use longer equals runs."""
repo_root = Path("/repo")
output = """
===== Coverage for /repo/physicsnemo/utils/ =====
| logging.py | |
| PythonLogger.info (L10) | MISSED |
"""
results = _parse_interrogate_output(output, repo_root)
assert results == ["physicsnemo/utils/logging.py:PythonLogger.info"]