Analysis Integration

.github/ISSUE_TEMPLATE.md

@@ -26,4 +26,4 @@
   - Subsystem:
 
 
-* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc)
+* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc)

.github/workflows/check_copyright.yml

@@ -10,6 +10,6 @@ jobs:
       - name: Check license & copyright headers
         uses: viperproject/check-license-header@v2
         with:
-          path: 
+          path:
           config: .github/workflows/check_copyright_config.json
-          # strict: true
+          # strict: true

.github/workflows/check_mkdocs_build.yml

@@ -21,4 +21,4 @@ jobs:
         uses: astral-sh/setup-uv@v4
       # - run: cp -r examples/ docs/examples/
       - run: uv pip install .[docs] --system
-      - run: mkdocs build
+      - run: mkdocs build

.github/workflows/copyright.txt

@@ -10,4 +10,4 @@
 # 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.
+# limitations under the License.

.github/workflows/pytest.yml

@@ -11,35 +11,34 @@ permissions:
   contents: read
 
 jobs:
-  build:
-    runs-on: ${{ matrix.os }}
+  test:
     strategy:
       fail-fast: false
       matrix:
-        version:
+        python-version:
           - "3.10"
           - "3.11"
           - "3.12"
           - "3.13"
-        os: ["ubuntu-latest", "windows-latest", "macos-latest"]
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
         arch:
           - x64
     name: Test ${{ matrix.version }} on ${{ matrix.os }} (${{ matrix.arch }})
-
+    runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python
-        uses: actions/setup-python@v4
+      - name: Checkout repo
+        uses: actions/checkout@v4
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
         with:
-          python-version: ${{ matrix.version }}
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v4
-        # with:
-          # enable-cache: true
-
-      - name: Install the project
-        run: uv pip install .[tests] --system
-
+          enable-cache: true
+          python-version: ${{ matrix.python-version }}
+      - name: Install repo
+        run: |
+          uv sync --extra tests
       - name: Run tests
-        run: uv run pytest tests
+        run: |
+          uv run pytest tests -vv

README.md

@@ -11,10 +11,9 @@
 [![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
-
-
 ### What's here:
-This repository contains the supporting infrastructure, base classes, and abstractions 
+
+This repository contains the supporting infrastructure, base classes, and abstractions
 for creating custom compiler analysis, verification, and transformation passes.
 The modules in the repository are utilized for, e.g., lowering from the analog to atomic
 intermediate representations, and the atomic representation to bare metal descriptions of
@@ -23,11 +22,13 @@ quantum programs.
 ## Installation
 
 Install with `pip`:
+
 ```bash
 pip install oqd-compiler-infrastructure
 ```
 
 or alternatively from `git`:
+
 ```bash
 pip install git+https://github.com/OpenQuantumDesign/oqd-compiler-infrastructure.git
 ```
@@ -37,6 +38,7 @@ pip install git+https://github.com/OpenQuantumDesign/oqd-compiler-infrastructure
 You can use this package with Nix in several ways:
 
 1. Using the development environment:
+
 ```bash
 # Clone the repository
 git clone https://github.com/OpenQuantumDesign/oqd-compiler-infrastructure.git
@@ -47,6 +49,7 @@ nix develop
 ```
 
 2. Building the package:
+
 ```bash
 nix build github:OpenQuantumDesign/oqd-compiler-infrastructure
 ```
@@ -187,6 +190,7 @@ block-beta
    class IR normal
    class RealTime normal
 ```
+
 The lowering and compilation passes, used in the vertical lines connecting
-abstraction layers, are based on the compiler infrastructure components contained 
-in this repository.
+abstraction layers, are based on the compiler infrastructure components contained
+in this repository.

docs/index.md

@@ -1,4 +1,4 @@
-# 
+#
 
 <p align="center">
   <img src="img/oqd-logo-black.png#only-light" alt="Logo" style="max-height: 200px;">
@@ -18,7 +18,8 @@
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
 ### What's here:
-This repository contains the supporting infrastructure, base classes, and abstractions 
+
+This repository contains the supporting infrastructure, base classes, and abstractions
 for creating custom compiler analysis, verification, and transformation passes.
 The modules in the repository are utilized for, e.g., lowering from the analog to atomic
 intermediate representations, and the atomic representation to base metal descriptions of
@@ -115,6 +116,7 @@ block-beta
    class IR normal
    class RealTime normal
 ```
+
 The lowering and compilation passes, used in the vertical lines connecting
-abstraction layers, are based on the compiler infrastructure components contained 
-in this repository.
+abstraction layers, are based on the compiler infrastructure components contained
+in this repository.

docs/stylesheets/admonition_template.css

@@ -14,4 +14,4 @@
     background-color: #FFFFFF;
     -webkit-mask-image: var(--md-admonition-icon--template);
             mask-image: var(--md-admonition-icon--template);
-  }
+  }

docs/stylesheets/extra_admonitions.css

@@ -130,6 +130,3 @@
   -webkit-mask-image: var(--md-admonition-icon--acknowledgement);
   mask-image: var(--md-admonition-icon--acknowledgement);
 }
-
-
-

docs/tutorial/calculator.ipynb

@@ -28,7 +28,6 @@
    "outputs": [],
    "source": [
     "class MyExpr(TypeReflectBaseModel):\n",
-    "\n",
     "    def __add__(self, other):\n",
     "        return MyAdd(left=self, right=other)\n",
     "\n",

pyproject.toml

@@ -8,7 +8,7 @@ name = "oqd-compiler-infrastructure"
 version = "0.1.0"
 requires-python = ">=3.10"
 readme = "README.md"
-license = {text = "Apache 2.0"}
+license = { text = "Apache 2.0" }
 keywords = ["quantum", "computing", "compiler", "transpilation"]
 classifiers = [
   "Development Status :: 3 - Alpha",
@@ -27,26 +27,32 @@ classifiers = [
 ]
 
 
-dependencies = [
-  "pydantic>=2, <3",
-]
+dependencies = ["pydantic>=2, <3"]
 
 [project.optional-dependencies]
 docs = [
-    "pymdown-extensions",
-    "mkdocstrings",
-    "mkdocs-material",
-    "mkdocstrings-python",
-    "mdx_truly_sane_lists",
+  "pymdown-extensions",
+  "mkdocstrings",
+  "mkdocs-material",
+  "mkdocstrings-python",
+  "mdx_truly_sane_lists",
 ]
 tests = ["pytest"]
 
 [tool.setuptools.packages.find]
 where = ["src"]
 include = ["oqd_compiler_infrastructure*"]
 
+[dependency-groups]
+dev = ["jupyter>=1.1.1", "pre-commit>=4.1.0", "ruff>=0.9.7"]
+
 
 [project.urls]
 Homepage = "https://github.com/OpenQuantumDesign/oqd-compiler-infrastructure"
 Repository = "https://github.com/OpenQuantumDesign/oqd-compiler-infrastructure.git"
 Issues = "https://github.com/OpenQuantumDesign/oqd-compiler-infrastructure/issues"
+
+
+[tool.ruff.lint]
+select = ["E4", "E7", "E9", "F", "I"]
+fixable = ["ALL"]

src/oqd_compiler_infrastructure/__init__.py

@@ -12,10 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from .analysis import AnalysisCache, AnalysisRequirements, AnalysisResult
 from .base import PassBase
 from .interface import TypeReflectBaseModel, VisitableBaseModel
 from .rewriter import Chain, FixedPoint, RewriterBase
-from .rule import ConversionRule, PrettyPrint, RewriteRule, RuleBase
+from .rule import AnalysisRule, ConversionRule, PrettyPrint, RewriteRule, RuleBase
 from .walk import In, Level, Post, Pre, WalkBase
 
 __all__ = [
@@ -24,6 +25,7 @@
     "PassBase",
     "RewriteRule",
     "ConversionRule",
+    "AnalysisRule",
     "PrettyPrint",
     "RuleBase",
     "Pre",
@@ -34,4 +36,7 @@
     "Chain",
     "FixedPoint",
     "RewriterBase",
+    "AnalysisResult",
+    "AnalysisCache",
+    "AnalysisRequirements",
 ]

src/oqd_compiler_infrastructure/analysis.py

@@ -0,0 +1,84 @@
+# Copyright 2024-2025 Open Quantum Design
+
+# 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 __future__ import annotations
+
+from typing import Annotated, Any, Dict, List, Tuple, Type
+
+from pydantic import BeforeValidator, ConfigDict
+
+########################################################################################
+from oqd_compiler_infrastructure.interface import TypeReflectBaseModel
+
+########################################################################################
+
+
+def _analysis_name(value):
+    if isinstance(value, str):
+        return value
+    else:
+        return value.__class__.__name__
+
+
+class AnalysisCache(TypeReflectBaseModel):
+    store: List[AnalysisResult] = []
+
+    def __getitem__(self, idx):
+        return [entry for entry in self.store if entry.name == idx]
+
+    def invalidate(self, name):
+        name = _analysis_name(name)
+
+        relevant_entries = filter(lambda entry: entry.valid, self[name])
+        for entry in relevant_entries:
+            entry.valid = False
+
+    def append(self, entry: AnalysisResult):
+        self.store.append(entry)
+
+
+class AnalysisResult(TypeReflectBaseModel):
+    name: Annotated[str, BeforeValidator(_analysis_name)]
+    valid: bool = True
+    data: Dict[str, Any]
+
+
+########################################################################################
+
+
+def validate_analysis_requirement(value):
+    if isinstance(value, tuple):
+        return value
+    else:
+        return (value, Post)
+
+
+class AnalysisRequirements(TypeReflectBaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    requirements: List[
+        Annotated[
+            Tuple[Type[AnalysisRule], Type[WalkBase]],
+            BeforeValidator(validate_analysis_requirement),
+        ]
+    ] = []
+
+
+########################################################################################
+
+from oqd_compiler_infrastructure.rule import AnalysisRule  # noqa: E402
+from oqd_compiler_infrastructure.walk import Post, WalkBase  # noqa: E402
+
+AnalysisRequirements.model_rebuild()