Add analyze-project composite action to validate a Python project

.github/test_projects/minimal/pyproject.toml

@@ -0,0 +1,32 @@
+[project]
+name = "test-project"
+version = "0.1.0"
+description = ""
+authors = [
+    {name = "Joel Dixon",email = "joel.dixon@ni.com"}
+]
+readme = "README.md"
+requires-python = ">=3.9,<4.0"
+dynamic = ["dependencies"]
+
+[tool.poetry]
+packages = [{include = "test_project", from = "src"}]
+
+[tool.poetry.group.lint.dependencies]
+ni-python-styleguide = ">=0.4.1"
+mypy = ">=1.0"
+pyright = { version = ">=1.1.400", extras = ["nodejs"] }
+
+[tool.mypy]
+mypy_path = "."
+files = "."
+namespace_packages = true
+strict = true
+explicit_package_bases = true
+
+[tool.pyright]
+include = ["src/", "tests/"]
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"

.github/test_projects/minimal/src/test_project/__init__.py

@@ -0,0 +1 @@
+"""Docstring required."""

.github/test_projects/minimal/tests/__init__.py

@@ -0,0 +1 @@
+"""Module docstring."""

.github/workflows/test_actions.yml

@@ -212,6 +212,27 @@ jobs:
           project-directory: test-project
           expected-version: 1.0.2.dev1
 
+  test_analyze_project:
+    name: Test analyze-project
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [windows-latest, ubuntu-latest, macos-latest]
+        python-version: [3.9, '3.10', 3.11, 3.12, 3.13, pypy3.10, pypy3.11]
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - name: Set up Python
+        uses: ./setup-python
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Set up Poetry
+        uses: ./setup-poetry
+      - name: Analyze Python Project
+        uses: ./analyze-project
+        with:
+          project-directory: ${{ github.workspace }}/.github/test_projects/minimal
+
   # This job is intended to combine the test results so we don't have to list
   # each matrix combination in the required status check settings. There are a
   # lot of corner cases that make this harder than it should be; see See
@@ -225,7 +246,8 @@ jobs:
       test_setup_poetry_cache_hit,
       test_setup_poetry_no_cache,
       test_check_project_version,
-      test_update_project_version
+      test_update_project_version,
+      test_analyze_project,
     ]
     if: ${{ !cancelled() }}
     steps:

analyze-project/README.md

@@ -0,0 +1,43 @@
+# `ni/python-actions/analyze-project`
+
+The `ni/python-actions/update-project-version` action analyzes the code quality
+of a Python project using various linters and type checkers including
+ni-python-styleguide, mypy (if the 'mypy' package is installed), and pyright
+(if the 'pyright' package is installed).
+
+This action requires Poetry, so you must call `ni/python-actions/setup-python` and
+`ni/python-actions/setup-poetry` first.
+
+## Usage
+
+```yaml
+steps:
+- uses: ni/python-actions/setup-python@v0
+- uses: ni/python-actions/setup-poetry@v0
+- uses: ni/python-actions/analyze-project@v0
+```
+
+## Inputs
+
+### `project-directory`
+
+You can specify `project-directory` to indicate the location of the pyproject.toml
+file associated with the Python project you are analyzing.
+
+```yaml
+- uses: ni/python-actions/update-project-version@v0
+  with:
+    project-directory: ${{ github.workspace }}/packages/myproject
+```
+
+### `extras`
+
+If there are extras you need to install from your pyproject.toml, specify a space-separated list
+of extra groups to install. For example, 
+
+```yaml
+- uses: ni/python-actions/analyze-project@v0
+  with:
+    project-directory: ${{ github.workspace }}/packages/myproject
+    extras: 'docs drivers'
+```

analyze-project/action.yml

@@ -0,0 +1,97 @@
+name: Analyze project
+description: >
+  This workflow analyzes the code quality of a Python project using various
+  linters and type checkers including ni-python-styleguide,
+  mypy (if the 'mypy' package is installed), and pyright (if the 'pyright'
+  package is installed).
+
+inputs:
+  project-directory:
+    description: Path to the directory containing pyproject.toml.
+    default: ${{ github.workspace }}
+  extras:
+    # E.g. "docs drivers"
+    description: 'List of Poetry extras to install (separated by spaces)'
+    default: ''
+    required: false
+    type: string
+
+runs:
+  using: composite
+  steps:
+    - name: Get project info
+      id: get_project_info
+      run: |
+        result=$(poetry version)
+        name=$(echo "$result" | awk '{print $1}')
+        version=$(echo "$result" | awk '{print $2}')
+        echo "Name: $name"
+        echo "Version: $version"
+        echo "name=$name" >> "$GITHUB_OUTPUT"
+        echo "version=$version" >> "$GITHUB_OUTPUT"
+        poetry env activate
+        venv_path="$(poetry env info --path)"
+        echo "venv path: $venv_path"
+        echo "venv-path=$venv_path" >> "$GITHUB_OUTPUT"
+      shell: bash
+      working-directory: ${{ inputs.project-directory }}
+    - name: Check for lock changes
+      run: poetry check --lock -C "${{ inputs.project-directory }}"
+      shell: bash
+    - name: Cache virtualenv
+      uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
+      with:
+        path: ${{ steps.get_project_info.outputs.venv-path }}
+        key: ${{ steps.get_project_info.outputs.name }}-${{ runner.os }}-py${{ env.pythonVersion }}-${{ hashFiles(format('{0}/poetry.lock', inputs.project-directory)) }}
+    - name: Install ${{ steps.get_project_info.outputs.name }}
+      run: |
+        if [ -n "${{ inputs.extras }}" ]; then
+          poetry install -v --extras '${{ inputs.extras }}'
+        else
+          poetry install -v
+        fi
+      working-directory: ${{ inputs.project-directory }}
+      shell: bash
+    - name: Lint
+      run: poetry run ni-python-styleguide lint
+      working-directory: ${{ inputs.project-directory }}
+      shell: bash
+    - name: Check for mypy and pyright installation
+      id: check_tools
+      run: |
+        import os
+        from importlib.metadata import version, PackageNotFoundError
+
+        def is_installed(pkg_name):
+            try:
+                version(pkg_name)
+                return "true"
+            except PackageNotFoundError:
+                return "false"
+
+        with open(os.environ["GITHUB_OUTPUT"], "a") as output:
+            print(f"mypy={is_installed('mypy')}", file=output)
+            print(f"pyright={is_installed('pyright')}", file=output)
+      shell: python
+    - name: Echo check_tools outputs
+      run: |
+        echo "mypy installed: ${{ steps.check_tools.outputs.mypy }}"
+        echo "pyright installed: ${{ steps.check_tools.outputs.pyright }}"
+      shell: bash
+    - name: Mypy static analysis
+      if: steps.check_tools.outputs.mypy == 'true'
+      run: poetry run mypy
+      working-directory: ${{ inputs.project-directory }}
+      shell: bash
+    - name: Add virtualenv to the path for pyright-action
+      if: steps.check_tools.outputs.pyright == 'true'
+      shell: bash
+      run: |
+        echo "$(dirname $(poetry env info --executable))" >> $GITHUB_PATH
+      working-directory: ${{ inputs.project-directory }}
+    - name: Pyright static analysis
+      if: steps.check_tools.outputs.pyright == 'true'
+      uses: jakebailey/pyright-action@b5d50e5cde6547546a5c4ac92e416a8c2c1a1dfe # v2.3.2
+      with:
+        version: PATH
+        working-directory: ${{ inputs.project-directory }}