Add a linter to check the images' alt text (#2060)

* Add linter to check images' alt text

* add allowlist and typing

* fix allowlist

* Add all images to the allowlist

* add test to tox and makefile

* remove unnecessary code

* incorporate feedback

* missing feedback

* fix prints

* fix plot nofigs option

* use line_index

* Allowlist by files

* Refactor for/while loops

* remove comment

* fix comment

* Update tools/verify_images.py

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>

* feedback

---------

Co-authored-by: Kevin Tian <kevin.tian@ibm.com>
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>

Makefile

@@ -16,6 +16,7 @@
 lint:
 	pylint -rn qiskit_ibm_runtime test
 	tools/verify_headers.py qiskit_ibm_runtime test
+	tools/verify_images.py
 
 mypy:
 	mypy --module qiskit_ibm_runtime --package test

tools/verify_images.py

@@ -0,0 +1,108 @@
+#!/usr/bin/env python3
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2024
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""Utility script to verify that all images have alt text"""
+
+from pathlib import Path
+import multiprocessing
+import sys
+import glob
+
+# List of allowlist files that the checker will not verify
+ALLOWLIST_MISSING_ALT_TEXT = [
+    "qiskit_ibm_runtime/fake_provider/__init__.py",
+    "qiskit_ibm_runtime/transpiler/passes/scheduling/dynamical_decoupling.py",
+    "qiskit_ibm_runtime/transpiler/passes/scheduling/__init__.py",
+]
+
+
+def is_image(line: str) -> bool:
+    return line.strip().startswith((".. image:", ".. plot:"))
+
+
+def is_option(line: str) -> bool:
+    return line.strip().startswith(":")
+
+
+def is_valid_image(options: list[str]) -> bool:
+    alt_exists = any(option.strip().startswith(":alt:") for option in options)
+    nofigs_exists = any(option.strip().startswith(":nofigs:") for option in options)
+
+    # Only `.. plot::`` directives without the `:nofigs:` option are required to have alt text.
+    # Meanwhile, all `.. image::` directives need alt text and they don't have a `:nofigs:` option.
+    return alt_exists or nofigs_exists
+
+
+def validate_image(file_path: str) -> tuple[str, list[str]]:
+    """Validate all the images of a single file"""
+
+    if file_path in ALLOWLIST_MISSING_ALT_TEXT:
+        return [file_path, []]
+
+    invalid_images: list[str] = []
+
+    lines = Path(file_path).read_text().splitlines()
+
+    image_found = False
+    options: list[str] = []
+
+    for line_index, line in enumerate(lines):
+        if image_found:
+            if is_option(line):
+                options.append(line)
+                continue
+
+            # Else, the prior image_found has no more options so we should determine if it was valid.
+            #
+            # Note that, either way, we do not early exit out of the loop iteration because this `line`
+            # might be the start of a new image.
+            if not is_valid_image(options):
+                image_line = line_index - len(options)
+                invalid_images.append(f"- Error in line {image_line}: {lines[image_line-1].strip()}")
+
+        image_found = is_image(line)
+        options = []
+
+    return (file_path, invalid_images)
+
+
+def main() -> None:
+    files = glob.glob("qiskit_ibm_runtime/**/*.py", recursive=True)
+
+    with multiprocessing.Pool() as pool:
+        results = pool.map(validate_image, files)
+
+    failed_files = {file: image_errors for file, image_errors in results if image_errors}
+
+    if not len(failed_files):
+        print("✅ All images have alt text")
+        sys.exit(0)
+
+    print("💔 Some images are missing the alt text", file=sys.stderr)
+
+    for file, image_errors in failed_files.items():
+        print(f"\nErrors found in {file}:", file=sys.stderr)
+
+        for image_error in image_errors:
+            print(image_error, file=sys.stderr)
+
+    print(
+        "\nAlt text is crucial for making documentation accessible to all users. It should serve the same purpose as the images on the page, conveying the same meaning rather than describing visual characteristics. When an image contains words that are important to understanding the content, the alt text should include those words as well.",
+        file=sys.stderr,
+    )
+
+    sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

tox.ini

@@ -25,6 +25,7 @@ commands =
   pylint -rn --rcfile={toxinidir}/.pylintrc test
   doc8 docs
   {toxinidir}/tools/verify_headers.py qiskit test
+  {toxinidir}/tools/verify_images.py
 
 [testenv:asv]
 deps =