[PyOV] Migrate from pre-commit git hook to automatic PR for stubs generation (#30744)

~~Blocked: currently waiting for a formal approval from security team~~

### Details:
- Example PR generated by the GHA job to my fork:
p-wysocki#182
 - The PR is automatically generated daily on weekdays
 - The PR can also be generated manually
- The new GHA job is working correctly on my fork, there may be some
corrections needed to get it working on OpenVINO master (for example, in
repository settings the ability for GHA to make PRs has to be checked,
also I can't test openvino_provider tool on fork since it doesn't have
artifacts mounted)
- This approach is miles better than unstable per-dev-machine generation
- The hook install step has been replaced with hook uninstall step,
which will be removed altogether in the future
 - Removed the CI check for keeping the stubs updated

### Tickets:
 - CVS-167922

---------

Signed-off-by: p-wysocki <przemyslaw.wysocki@intel.com>
Co-authored-by: Alicja Miloszewska <alicja.miloszewska@intel.com>

Author: p-wysocki

.github/actions/validate_pyi_files/action.yml

@@ -94,10 +94,6 @@ jobs:
       - name: Install Python API tests dependencies
         run: python3 -m pip install -r ${INSTALL_TEST_DIR}/bindings/python/requirements_test.txt
 
-      - name: Verify Python stub .pyi files
-        uses: ./.github/actions/validate_pyi_files
-        continue-on-error: true
-
       #
       # Tests
       #

.github/actions/validate_pyi_files/compare_pyi_files.py

@@ -0,0 +1,63 @@
+name: Update Python API Stubs
+
+permissions:
+  contents: write
+  pull-requests: write
+
+on:
+  schedule:
+  - cron: "0 2 * * 1-5"
+  workflow_dispatch:  # Allow manual triggering
+
+jobs:
+  update-stubs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
+
+      - name: Set up Python
+        uses: actions/setup-python@0ae58361cdfd39e2950bed97a1e26aa20c3d8955  # v4
+        with:
+          python-version: '3.10'
+          
+      - name: Get latest OpenVINO artifacts
+        id: openvino_download
+        uses: openvinotoolkit/openvino/.github/actions/openvino_provider@master
+        with:
+          platform: 'ubuntu22'
+          revision: latest_available_commit
+
+      - name: Install OpenVINO and stubgen
+        run: |
+          python -m pip install openvino==${{ steps.openvino_download.outputs.ov_version }} ${{ steps.openvino_download.outputs.ov_wheel_source }}
+          STUBGEN_VERSION=$(grep pybind11-stubgen src/bindings/python/requirements_test.txt)
+          python -m pip install "$STUBGEN_VERSION"
+
+      - name: Regenerate Python API stubs
+        run: |
+          find ./ -name "*.pyi" -delete
+          python src/bindings/python/scripts/generate_pyapi_stubs.py
+
+      - name: Add and commit .pyi files
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          find src/bindings/python -name "*.pyi" -exec git add {} \;
+          git diff --quiet && git diff --staged --quiet || git commit -m "Update Python API stub files"
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e  # v7.0.8
+        with:
+            token: ${{ secrets.GITHUB_TOKEN }}
+            commit-message: Update Python API stub files
+            title: "[PyOV] Update Python API stub files"
+            signoff: true
+            sign-commits: true
+            reviewers: openvinotoolkit/openvino-ie-python-api-maintainers
+            body: |
+              - Updated Python API stub (.pyi) files from the latest available artifacts
+
+              Auto-generated by GitHub Actions
+            branch: update-pyapi-stubs
+            base: master

.github/workflows/job_python_api_tests.yml

@@ -416,6 +416,7 @@ if(OpenVINODeveloperPackage_FOUND)
 endif()
 
 # only for developers, skip on CI
+# to be removed once developers remove hook from their .git: CVS-168334
 if(NOT (DEFINED ENV{CI} OR DEFINED ENV{TF_BUILD} OR DEFINED ENV{JENKINS_URL}))
 
     # check pybind11-stubgen package
@@ -436,15 +437,15 @@ if(NOT (DEFINED ENV{CI} OR DEFINED ENV{TF_BUILD} OR DEFINED ENV{JENKINS_URL}))
         message(WARNING "pre-commit package is not installed or version is not detected. This package is necessary for developing Python API.")
     endif()
 
-    # attach the pre-commit hook for Python stub generation
-    execute_process(COMMAND pre-commit install -c "${CMAKE_CURRENT_SOURCE_DIR}/scripts/stub_generation_precommit.yaml"
-                    RESULT_VARIABLE precommit_install_result
-                    ERROR_VARIABLE precommit_install_error
+    # uninstall the pre-commit hook for Python stub generation (now handled by GitHub Actions)
+    execute_process(COMMAND pre-commit uninstall
+                    RESULT_VARIABLE precommit_uninstall_result
+                    ERROR_VARIABLE precommit_uninstall_error
                     OUTPUT_STRIP_TRAILING_WHITESPACE
                     ERROR_STRIP_TRAILING_WHITESPACE)
-    if(NOT precommit_install_result EQUAL "0")
-        message(WARNING "Python stub generation pre-commit hook install failed with error: ${precommit_install_error}. It is necessary for developing Python API.")
+    if(NOT precommit_uninstall_result EQUAL "0")
+        message(WARNING "Failed to uninstall Python stub generation pre-commit hook: ${precommit_uninstall_error}")
     else()
-        message(STATUS "pre-commit hook for Python API stub generation has been installed")
+        message(STATUS "Pre-commit hook for Python API stub generation has been uninstalled. Stubs are now generated by GitHub Actions workflow.")
     endif()
 endif()

.github/workflows/update_pyapi_stubs.yml

@@ -6,20 +6,9 @@ Stub files (`.pyi`) are used to provide type hints for Python code. They describ
 
 ## Automation of stub file generation in OpenVINO
 
-In OpenVINO, the generation of stub files is automated as part of the development workflow. When building the Python API for the first time, a Git pre-commit hook is installed into the OpenVINO repository's `.git` directory. The related Python dependencies are `pybind11-stubgen` for stub generation and `pre-commit` for automating git hooks.
+In OpenVINO, the generation of stub files is automated as part of the development workflow. This is now handled by a GitHub Actions workflow that runs on a schedule (weekdays at 2:00 AM UTC) and can be triggered manually when needed. The workflow is defined in [.github/workflows/update_pyapi_stubs.yml](../../../../.github/workflows/update_pyapi_stubs.yml). The related Python dependency is `pybind11-stubgen` for stub generation.
 
-### What is a git pre-commit hook?
-
-A Git pre-commit hook is a script that runs automatically before a commit is finalized. It allows developers to enforce specific checks or perform automated tasks, such as code formatting, linting, or file generation, ensuring that the repository maintains a consistent and high-quality state.
-
-### What happens during the pre-commit hook?
-
-When the pre-commit hook is triggered, the following steps occur:
-
-1. **Stub file generation**: The `pybind11-stubgen` tool is executed to generate new `.pyi` stub files for the OpenVINO Python API. This tool uses the Python package `openvino` to extract type information and create the stub files, so it's important that currently installed OpenVINO version contains all changes related to your Pull Request.
-2. **Automatic addition to commit**: The newly generated `.pyi` files are automatically staged and added to the current commit. This ensures that the stub files are always up-to-date with the latest changes in the Python API.
-
-### Ensuring changes are installed
+### Running stub generation manually
 
 To ensure that `pybind11-stubgen` works correctly, the `openvino` Python package must include your latest changes. This can be achieved by:
 
@@ -31,23 +20,10 @@ To ensure that `pybind11-stubgen` works correctly, the `openvino` Python package
 
 - Installing an up-to-date wheel containing your changes using `pip install`.
 
-### Skipping the pre-commit hook
-
-If you need to skip the pre-commit hook for any reason, you can do so by setting the `SKIP` environment variable before running the `git commit` command:
-
-```bash
-SKIP=generate_stubs git commit -m "Your commit message"
-```
-
-This bypasses the stub file generation process, allowing you to commit without triggering the hook.
-
-### Uninstalling the pre-commit hook
-
-If you wish to remove the hook, you can run:
-
-```bash
-pre-commit uninstall
-```
+Then, to run stub generation manually, ensure your changes are installed and run:
+    ```bash
+    python openvino/src/bindings/python/scripts/generate_pyapi_stubs.py
+    ```
 
 ## See also