You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by "praneetnadella (via GitHub)" <gi...@apache.org> on 2025/11/06 00:21:36 UTC

[PR] Utilizes file_interceptor parameter and sets it to get_normalized_path() function. [beam]

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

   This function is meant to be overridden.
   ------------------------
   
   Plan to replace similar to Dill through copybara.
   
   Tested:
   
   Added test_default_config_interceptor, a unit test verifying the calling of get_normalized_path.
   
   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] Utilizes file_interceptor parameter and sets it to get_normalized_path() function. [beam]

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

   Fixed transient issues. currently some issue with the RAT PreCommit which seems like a network issue?


-- 
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] Utilizes file_interceptor parameter and sets it to get_normalized_path() function. [beam]

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


##########
sdks/python/apache_beam/internal/cloudpickle_pickler.py:
##########
@@ -37,13 +37,14 @@
 
 from apache_beam.internal import code_object_pickler
 from apache_beam.internal.cloudpickle import cloudpickle
+from apache_beam.internal.code_object_pickler import get_normalized_path
 
 DEFAULT_CONFIG = cloudpickle.CloudPickleConfig(
-    skip_reset_dynamic_type_state=True)
+    skip_reset_dynamic_type_state=True, filepath_interceptor=get_normalized_path)
 NO_DYNAMIC_CLASS_TRACKING_CONFIG = cloudpickle.CloudPickleConfig(

Review Comment:
   Done.



##########
sdks/python/apache_beam/internal/cloudpickle_pickler_test.py:
##########
@@ -220,6 +224,37 @@ def test_best_effort_determinism_not_implemented(self):
           'Ignoring unsupported option: enable_best_effort_determinism',
           '\n'.join(l.output))
 
+  @mock.patch.object(
+      beam_cloudpickle.DEFAULT_CONFIG, 'filepath_interceptor', autospec=True)
+  def test_default_config_interceptor(self, mock_filepath_interceptor):
+    """Tests config.filepath_interceptor is called for CodeType pickling."""
+    mock_filepath_interceptor.side_effect = (
+        code_object_pickler.get_normalized_path)
+
+    def sample_func():
+      return "Beam"
+
+    code_obj = sample_func.__code__
+    original_filename = os.path.abspath(code_obj.co_filename)
+
+    try:
+      pickled_code = beam_cloudpickle.dumps(code_obj)
+      unpickled_code = beam_cloudpickle.loads(pickled_code)
+
+      mock_filepath_interceptor.assert_called()
+
+      unpickled_filename = os.path.abspath(unpickled_code.co_filename)
+      self.assertEqual(unpickled_filename, original_filename)
+
+    except AttributeError as e:

Review Comment:
   Done.



-- 
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] Utilizes file_interceptor parameter and sets it to get_normalized_path() function. [beam]

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


-- 
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] Utilizes file_interceptor parameter and sets it to get_normalized_path() function. [beam]

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

   ## Summary of Changes
   
   Hello @praneetnadella, 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 enhances the robustness of the pickling mechanism by introducing file path normalization for code objects. By integrating `get_normalized_path` into the `CloudPickleConfig`, it ensures that file paths are consistently handled during serialization, which is crucial for environments where path variations could lead to issues. A dedicated test case validates this new behavior, confirming the correct application of the interceptor.
   
   ### Highlights
   
   * **CloudPickle Configuration Update**: The `CloudPickleConfig` instances (`DEFAULT_CONFIG`, `NO_DYNAMIC_CLASS_TRACKING_CONFIG`, `STABLE_CODE_IDENTIFIER_CONFIG`) in `cloudpickle_pickler.py` have been updated to utilize a `filepath_interceptor` parameter, setting it to `get_normalized_path`.
   * **File Path Normalization**: The `get_normalized_path` function from `code_object_pickler` is now used to ensure consistent and normalized file paths during the pickling process of code objects.
   * **New Unit Test**: A new unit test, `test_default_config_interceptor`, has been added to `cloudpickle_pickler_test.py` to verify that the `filepath_interceptor` is correctly invoked when pickling code objects and that the unpickled code object retains its original, normalized filename.
   
   
   
   
   
   
   
   <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).
   
   <b>You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the [Gemini Code Assist IDE Extension](https://cloud.google.com/products/gemini/code-assist).</b>
   </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

Re: [PR] Utilizes file_interceptor parameter and sets it to get_normalized_path() function. [beam]

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


##########
sdks/python/apache_beam/internal/cloudpickle_pickler.py:
##########
@@ -37,13 +37,14 @@
 
 from apache_beam.internal import code_object_pickler
 from apache_beam.internal.cloudpickle import cloudpickle
+from apache_beam.internal.code_object_pickler import get_normalized_path
 
 DEFAULT_CONFIG = cloudpickle.CloudPickleConfig(
-    skip_reset_dynamic_type_state=True)
+    skip_reset_dynamic_type_state=True, filepath_interceptor=get_normalized_path)
 NO_DYNAMIC_CLASS_TRACKING_CONFIG = cloudpickle.CloudPickleConfig(

Review Comment:
   I think you can actually remove NO_DYNAMIC_CLASS_TRACKING_CONFIG



-- 
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] Utilizes file_interceptor parameter and sets it to get_normalized_path() function. [beam]

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

   Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, 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] Utilizes file_interceptor parameter and sets it to get_normalized_path() function. [beam]

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

   R: @tvalentyn 


-- 
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] Utilizes file_interceptor parameter and sets it to get_normalized_path() function. [beam]

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

   R: @claudevdm 


-- 
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] Utilizes file_interceptor parameter and sets it to get_normalized_path() function. [beam]

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

   Unit tests are failing https://github.com/apache/beam/runs/54642818003


-- 
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] Utilizes file_interceptor parameter and sets it to get_normalized_path() function. [beam]

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


##########
sdks/python/apache_beam/internal/cloudpickle_pickler_test.py:
##########
@@ -220,6 +224,37 @@ def test_best_effort_determinism_not_implemented(self):
           'Ignoring unsupported option: enable_best_effort_determinism',
           '\n'.join(l.output))
 
+  @mock.patch.object(
+      beam_cloudpickle.DEFAULT_CONFIG, 'filepath_interceptor', autospec=True)
+  def test_default_config_interceptor(self, mock_filepath_interceptor):
+    """Tests config.filepath_interceptor is called for CodeType pickling."""
+    mock_filepath_interceptor.side_effect = (
+        code_object_pickler.get_normalized_path)
+
+    def sample_func():
+      return "Beam"
+
+    code_obj = sample_func.__code__
+    original_filename = os.path.abspath(code_obj.co_filename)
+
+    try:
+      pickled_code = beam_cloudpickle.dumps(code_obj)
+      unpickled_code = beam_cloudpickle.loads(pickled_code)
+
+      mock_filepath_interceptor.assert_called()
+
+      unpickled_filename = os.path.abspath(unpickled_code.co_filename)
+      self.assertEqual(unpickled_filename, original_filename)
+
+    except AttributeError as e:

Review Comment:
   Why are we catching exceptions here? Seems unnecessary



-- 
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