autophagy opened a new pull request, #26510:
URL: https://github.com/apache/flink/pull/26510

   ## What is the purpose of the change
   
   Currently, the `pdf` argument of `TableEnvironment.from_pandas` and the 
return type of `Table.to_pandas` are not type annotated. This PR adds a pandas 
import during type checking (and so should not affect/import it outside of 
that, since it's an optional module) so that users get better type information 
out of these functions.
   
   I also enabled the 
[intersphinx](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html)
 extension for Sphinx so that type annotations for `pandas` classes link to 
their corresponding classes in the `pandas` documentation. So the live docs 
currently show:
   
   
![20250426_16h14m52s_grim](https://github.com/user-attachments/assets/e74effe9-8275-41ac-8bbd-9c29ac4fbc02)
   
   After this change:
   
   
![20250426_16h02m09s_grim](https://github.com/user-attachments/assets/3396a77b-fb2e-4be1-8997-b536dbc29d95)
   
   Where the `pandas.DataFrame` return type links to 
https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html#pandas.DataFrame
   
   ## Brief change log
   
     - *Added pandas type annotions to `TableEnvironment.from_pandas` and 
`Table.to_pandas`*
     - *Enabled intersphinx extension so pandas type annotations in the docs 
link to the corresponding pandas documentation*
   
   ## Verifying this change
   
   This change is already covered by existing docs building and type checking 
tests.
   
   ## Does this pull request potentially affect one of the following parts:
   
     - Dependencies (does it add or upgrade a dependency): (no)
     - The public API, i.e., is any changed class annotated with 
`@Public(Evolving)`: (no)
     - The serializers: (no)
     - The runtime per-record code paths (performance sensitive): (no)
     - Anything that affects deployment or recovery: JobManager (and its 
components), Checkpointing, Kubernetes/Yarn, ZooKeeper: (no)
     - The S3 file system connector: (no)
   
   ## Documentation
   
     - Does this pull request introduce a new feature? (no)
     - If yes, how is the feature documented? (not applicable)
   


-- 
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: issues-unsubscr...@flink.apache.org

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

Reply via email to