You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by "jrmccluskey (via GitHub)" <gi...@apache.org> on 2026/04/08 16:16:08 UTC

[PR] [WIP] Migrate Common Linting Tooling to Rust-Based Packages [beam]

jrmccluskey opened a new pull request, #38107:
URL: https://github.com/apache/beam/pull/38107

   Migrates from pylint, mypy, and isort to ruff and pyrefly for common linting and static type checking workflows. Also includes updates for pre-commit hooks and agentic skills. Also adds a "dev" extra class in setup.py to A) keep versions of these packages pinned in a singular place and B) allow developers to install these tools via pip easily.
    
   ------------------------
   
   Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
   
    - [ ] Mention the appropriate issue in your description (for example: `addresses #123`), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment `fixes #<ISSUE NUMBER>` instead.
    - [ ] Update `CHANGES.md` with noteworthy changes.
    - [ ] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
   
   See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://github.com/apache/beam/blob/master/CONTRIBUTING.md#make-the-reviewers-job-easier).
   
   To check the build health, please visit [https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md](https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md)
   
   GitHub Actions Tests Status (on master branch)
   ------------------------------------------------------------------------------------------------
   [![Build python source distribution and wheels](https://github.com/apache/beam/actions/workflows/build_wheels.yml/badge.svg?event=schedule&&?branch=master)](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
   [![Python tests](https://github.com/apache/beam/actions/workflows/python_tests.yml/badge.svg?event=schedule&&?branch=master)](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
   [![Java tests](https://github.com/apache/beam/actions/workflows/java_tests.yml/badge.svg?event=schedule&&?branch=master)](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
   [![Go tests](https://github.com/apache/beam/actions/workflows/go_tests.yml/badge.svg?event=schedule&&?branch=master)](https://github.com/apache/beam/actions?query=workflow%3A%22Go+tests%22+branch%3Amaster+event%3Aschedule)
   
   See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI or the [workflows README](https://github.com/apache/beam/blob/master/.github/workflows/README.md) to see a list of phrases to trigger workflows.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Migrate Common Linting Tooling to Rust-Based Packages [beam]

Posted by "jrmccluskey (via GitHub)" <gi...@apache.org>.
jrmccluskey merged PR #38107:
URL: https://github.com/apache/beam/pull/38107


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Migrate Common Linting Tooling to Rust-Based Packages [beam]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #38107:
URL: https://github.com/apache/beam/pull/38107#issuecomment-4209066878

   Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment `assign set of reviewers`


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Migrate Common Linting Tooling to Rust-Based Packages [beam]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #38107:
URL: https://github.com/apache/beam/pull/38107#issuecomment-4245291153

   Assigning reviewers:
   
   R: @damccorm for label python.
   
   
   Note: If you would like to opt out of this review, comment `assign to next reviewer`.
   
   Available commands:
   - `stop reviewer notifications` - opt out of the automated review tooling
   - `remind me after tests pass` - tag the comment author after tests pass
   - `waiting on author` - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)
   
   The PR bot will only process comments in the main thread (not review comments).


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Migrate Common Linting Tooling to Rust-Based Packages [beam]

Posted by "gemini-code-assist[bot] (via GitHub)" <gi...@apache.org>.
gemini-code-assist[bot] commented on code in PR #38107:
URL: https://github.com/apache/beam/pull/38107#discussion_r3089508764


##########
sdks/python/tox.ini:
##########
@@ -218,7 +219,7 @@ extras =
   gcp
 commands =
   mypy --version
-  python setup.py mypy
+  time python setup.py mypy

Review Comment:
   ![high](https://www.gstatic.com/codereviewagent/high-priority.svg)
   
   This environment is broken because the `mypy` command was renamed to `pyrefly` in `setup.py`. Additionally, since `pyrefly` is now executed as part of the `lint` environment (lines 202-203), this separate environment may be redundant. If it is still needed, it should be updated to use `pyrefly` and ensure the `dev` extra is included in the environment dependencies.
   
   ```
     pyrefly --version
     time python setup.py pyrefly
   ```



##########
.pre-commit-config.yaml:
##########
@@ -31,12 +31,11 @@ repos:
                 sdks/python/apache_beam/portability/api/.*pb2.*.py
             )$
 
-  - repo: https://github.com/pycqa/pylint
-    # this rev is a release tag in the repo above and corresponds with a pylint
-    # version. make sure this matches the version of pylint in tox.ini.
-    rev: v4.0.2
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # this rev is a release tag in the repo above and corresponds with a ruff
+    # version. make sure this matches the version of yapf in setup.py

Review Comment:
   ![medium](https://www.gstatic.com/codereviewagent/medium-priority.svg)
   
   The comment incorrectly refers to `yapf`. Since this block is for the `ruff` pre-commit hook, it should be updated to say `ruff` to avoid confusion.
   
   ```yaml
       # version. make sure this matches the version of ruff in setup.py
   ```



##########
.pre-commit-config.yaml:
##########
@@ -31,12 +31,11 @@ repos:
                 sdks/python/apache_beam/portability/api/.*pb2.*.py
             )$
 
-  - repo: https://github.com/pycqa/pylint
-    # this rev is a release tag in the repo above and corresponds with a pylint
-    # version. make sure this matches the version of pylint in tox.ini.
-    rev: v4.0.2
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # this rev is a release tag in the repo above and corresponds with a ruff
+    # version. make sure this matches the version of yapf in setup.py
+    rev: v0.15.7
     hooks:
-      - id: pylint
-        args: ["--rcfile=sdks/python/.pylintrc"]
-        files: ^sdks/python/apache_beam/
-        exclude: *exclude
+      - id: ruff-check
+        files: "sdks/python/apache_beam"

Review Comment:
   ![medium](https://www.gstatic.com/codereviewagent/medium-priority.svg)
   
   The `files` pattern for pre-commit is a regular expression. The previous pattern `^sdks/python/apache_beam/` was more precise. Using `"sdks/python/apache_beam"` might match unintended paths that contain this string but are not within the target directory.
   
   ```yaml
           files: ^sdks/python/apache_beam/
   ```



##########
sdks/python/test-suites/tox/pycommon/build.gradle:
##########
@@ -41,5 +41,5 @@ check.dependsOn formatter
 toxTask "lint", "lint", "${posargs}"
 linter.dependsOn lint
 
-toxTask "mypy", "mypy", "${posargs}"
-linter.dependsOn mypy
+// toxTask "mypy", "mypy", "${posargs}"
+// linter.dependsOn mypy

Review Comment:
   ![medium](https://www.gstatic.com/codereviewagent/medium-priority.svg)
   
   Avoid leaving commented-out code in the repository. Since the `mypy` task is being replaced by `pyrefly` or integrated into the `lint` task, these lines should be removed entirely.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Migrate Common Linting Tooling to Rust-Based Packages [beam]

Posted by "jrmccluskey (via GitHub)" <gi...@apache.org>.
jrmccluskey commented on code in PR #38107:
URL: https://github.com/apache/beam/pull/38107#discussion_r3093986590


##########
sdks/python/test-suites/tox/pycommon/build.gradle:
##########
@@ -41,5 +41,5 @@ check.dependsOn formatter
 toxTask "lint", "lint", "${posargs}"
 linter.dependsOn lint
 
-toxTask "mypy", "mypy", "${posargs}"
-linter.dependsOn mypy
+// toxTask "mypy", "mypy", "${posargs}"
+// linter.dependsOn mypy

Review Comment:
   that was left over from testing, fixed



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Migrate Common Linting Tooling to Rust-Based Packages [beam]

Posted by "jrmccluskey (via GitHub)" <gi...@apache.org>.
jrmccluskey commented on PR #38107:
URL: https://github.com/apache/beam/pull/38107#issuecomment-4245276371

   assign set of reviewers


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Migrate Common Linting Tooling to Rust-Based Packages [beam]

Posted by "damccorm (via GitHub)" <gi...@apache.org>.
damccorm commented on code in PR #38107:
URL: https://github.com/apache/beam/pull/38107#discussion_r3089501627


##########
sdks/python/test-suites/tox/pycommon/build.gradle:
##########
@@ -41,5 +41,5 @@ check.dependsOn formatter
 toxTask "lint", "lint", "${posargs}"
 linter.dependsOn lint
 
-toxTask "mypy", "mypy", "${posargs}"
-linter.dependsOn mypy
+// toxTask "mypy", "mypy", "${posargs}"
+// linter.dependsOn mypy

Review Comment:
   Can we just remove this instead of commenting it out?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Migrate Common Linting Tooling to Rust-Based Packages [beam]

Posted by "damccorm (via GitHub)" <gi...@apache.org>.
damccorm commented on PR #38107:
URL: https://github.com/apache/beam/pull/38107#issuecomment-4255673292

   /gemini review


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [WIP] Migrate Common Linting Tooling to Rust-Based Packages [beam]

Posted by "gemini-code-assist[bot] (via GitHub)" <gi...@apache.org>.
gemini-code-assist[bot] commented on PR #38107:
URL: https://github.com/apache/beam/pull/38107#issuecomment-4207762028

   ## Summary of Changes
   
   Hello, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
   
   This pull request significantly upgrades the project's Python code quality infrastructure by migrating from traditional Python-based linting and type-checking tools (`pylint`, `mypy`, `flake8`) to their modern, Rust-based counterparts (`ruff`, `pyrefly`). This transition aims to enhance performance and streamline development workflows, providing a more efficient and consistent code quality enforcement mechanism. The changes encompass updates to pre-commit configurations, build scripts, and development environment setup, including a new `dev` extra for easy installation of these tools.
   
   ### Highlights
   
   * **Linting Tool Migration**: Migrated Python linting from `pylint` and `flake8` to the Rust-based `ruff`.
   * **Type Checking Tool Migration**: Migrated Python type checking from `mypy` to `pyrefly`.
   * **Pre-commit Hook Updates**: Updated `pre-commit` configurations to replace the `pylint` hook with `ruff-check`.
   * **Development Dependencies Management**: Introduced a new `dev` extra in `setup.py` to centralize and pin versions of development tools like `isort`, `pyrefly`, `ruff`, and `yapf`.
   * **Configuration and Script Updates**: Updated agentic skills documentation, `tox.ini` configurations, and `run_pylint.sh` script to reflect the new linting and type checking tooling.
   
   🧠 **New Feature in Public Preview:** You can now enable **Memory** to help **Gemini Code Assist** learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. **Click [here](https://codeassist.google/code-review/login) to enable Memory in your admin console.**
   
   <details>
   <summary><b>Using Gemini Code Assist</b></summary>
   <br>
   
   The full guide for Gemini Code Assist can be found on our [documentation page](https://developers.google.com/gemini-code-assist/docs/review-github-code), here are some quick tips.
   
   <b>Invoking Gemini</b>
   
   You can request assistance from Gemini at any point by creating a comment using either `/gemini <command>` or `@gemini-code-assist <command>`. Below is a summary of the supported commands on the current page.
   
   Feature | Command | Description
   --- | --- | ---
   Code Review | `/gemini review` | Performs a code review for the current pull request in its current state.
   Pull Request Summary | `/gemini summary` | Provides a summary of the current pull request in its current state.
   Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments.
   Help | `/gemini help` | Displays a list of available commands.
   
   <b>Customization</b>
   
   To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a `.gemini/` folder in the base of the repository. Detailed instructions can be found [here](https://developers.google.com/gemini-code-assist/docs/customize-gemini-behavior-github).
   
   <b>Limitations & Feedback</b>
   
   Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up [here](https://google.qualtrics.com/jfe/form/SV_2cyuGuTWsEw84yG).
   </details>
   
   
   [^1]: Review the [Privacy Notices](https://policies.google.com/privacy), [Generative AI Prohibited Use Policy](https://policies.google.com/terms/generative-ai/use-policy), [Terms of Service](https://policies.google.com/terms), and learn how to configure Gemini Code Assist in GitHub [here](https://developers.google.com/gemini-code-assist/docs/customize-gemini-behavior-github). Gemini can make mistakes, so double check it and [use code with caution](https://support.google.com/legal/answer/13505487).
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org