[ 
https://issues.apache.org/jira/browse/FLINK-10279?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16639582#comment-16639582
 ] 

ASF GitHub Bot commented on FLINK-10279:
----------------------------------------

mxm closed pull request #6761: [FLINK-10279] [documentation] Make jython 
limitations more obvious in documentation.
URL: https://github.com/apache/flink/pull/6761
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/docs/dev/stream/python.md b/docs/dev/stream/python.md
index af9c393b3ea..e7c2fb267ba 100644
--- a/docs/dev/stream/python.md
+++ b/docs/dev/stream/python.md
@@ -24,6 +24,10 @@ specific language governing permissions and limitations
 under the License.
 -->
 
+<span class="label label-danger">Attention</span> *This API is based on Jython,
+which is not a full Python replacement and may restrict the libraries you are 
able
+to use with your application (see below for more information).*
+
 Analysis streaming programs in Flink are regular programs that implement 
transformations on
 streaming data sets (e.g., filtering, mapping, joining, grouping). The 
streaming data sets are initially
 created from certain sources (e.g., by reading files, or from collections).
@@ -50,7 +54,12 @@ existing Java streaming APIs.
 There are two main constraints for using Jython:
 
 * The latest Python supported version is 2.7
-* It is not straightforward to use Python C extensions
+* It is not straightforward to use Python C extensions, which may prevent use 
of some libraries
+
+(For more information please see 
<https://wiki.python.org/jython/JythonFaq/GeneralInfo>.)
+
+One possible alternative for streaming that allows for native Python execution 
would be the [Apache Beam
+portability framework](https://beam.apache.org/contribute/portability/) with 
the Flink runner.
 
 Streaming Program Example
 -------------------------


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
[email protected]


> Make jython limitations more obvious in documentation
> -----------------------------------------------------
>
>                 Key: FLINK-10279
>                 URL: https://issues.apache.org/jira/browse/FLINK-10279
>             Project: Flink
>          Issue Type: Task
>          Components: Documentation, Python API
>            Reporter: Thomas Weise
>            Assignee: Thomas Weise
>            Priority: Major
>              Labels: pull-request-available
>
> The "Python Programming Guide (Streaming) Beta" at 
> [https://ci.apache.org/projects/flink/flink-docs-master/dev/stream/python.html]
>  does not sufficiently highlight limitations of the API. It should probably 
> have a prominent disclaimer right at the top stating that this actually isn't 
> a "Python" API but Jython, which likely means that the user looking for a 
> solution to run native Python code won't be able to use many important 
> libraries, which is often the reason to look for Python support in first 
> place.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Reply via email to