damccorm commented on code in PR #35914: URL: https://github.com/apache/beam/pull/35914#discussion_r2292036590
########## sdks/python/apache_beam/yaml/examples/README.md: ########## @@ -229,6 +233,27 @@ gcloud dataflow yaml run $JOB_NAME \ --region $REGION ``` +### Jinja + +Jinja [templatization](https://beam.apache.org/documentation/sdks/yaml/#jinja-templatization) +can be used to build off of different contexts and/or with different +configurations. + +Several examples will be created based on the already used word count example +by leveraging Jinja templating engine for dynamic pipeline generation based on +inputs from the user through `% include`, `% import`, and inheritance +directives. + +% import: Review Comment: Should these be code blocks? Also looks like some pieces are still missing, we should probably not include them for now ########## sdks/python/apache_beam/yaml/examples/README.md: ########## @@ -229,6 +233,27 @@ gcloud dataflow yaml run $JOB_NAME \ --region $REGION ``` +### Jinja + +Jinja [templatization](https://beam.apache.org/documentation/sdks/yaml/#jinja-templatization) +can be used to build off of different contexts and/or with different +configurations. + +Several examples will be created based on the already used word count example +by leveraging Jinja templating engine for dynamic pipeline generation based on +inputs from the user through `% include`, `% import`, and inheritance +directives. + +% import: +- [wordCount.yaml](#TODO: pending) + +% include: +- [wordCount.yaml](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/yaml/examples/transforms/jinja/include/wordCount.yaml) Review Comment: Should this be `wordCountInclude.yaml`? ########## sdks/python/apache_beam/yaml/examples/transforms/jinja/include/wordCountInclude.yaml: ########## @@ -0,0 +1,71 @@ +# coding=utf-8 +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +# This examples reads from a public file stored on Google Cloud. This +# requires authenticating with Google Cloud, or setting the file in +#`ReadFromText` to a local file. +# +# To set up Application Default Credentials, +# see https://cloud.google.com/docs/authentication/external/set-up-adc. +# +# This pipeline reads in a text file, counts distinct words found in the text, +# then logs a row containing each word and its count. + +pipeline: + transforms: + - name: Read from GCS + type: ReadFromText + config: +{% include 'apache_beam/yaml/examples/transforms/jinja/include/submodules/readFromText.yaml' %} Review Comment: Practically, I don't think it would be common to include just the config like this, especially if it is very simple (and also parameterized) ########## sdks/python/apache_beam/yaml/examples/transforms/jinja/include/wordCountInclude.yaml: ########## @@ -0,0 +1,71 @@ +# coding=utf-8 +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +# This examples reads from a public file stored on Google Cloud. This +# requires authenticating with Google Cloud, or setting the file in +#`ReadFromText` to a local file. +# +# To set up Application Default Credentials, +# see https://cloud.google.com/docs/authentication/external/set-up-adc. +# +# This pipeline reads in a text file, counts distinct words found in the text, +# then logs a row containing each word and its count. + +pipeline: + transforms: + - name: Read from GCS + type: ReadFromText + config: +{% include 'apache_beam/yaml/examples/transforms/jinja/include/submodules/readFromText.yaml' %} Review Comment: Rather than just including the config, could we maybe map in whole transforms for simple ones like this? Since this is an example, we should also explain what we're doing in comments ########## sdks/python/apache_beam/yaml/examples/README.md: ########## @@ -229,6 +233,27 @@ gcloud dataflow yaml run $JOB_NAME \ --region $REGION ``` +### Jinja + +Jinja [templatization](https://beam.apache.org/documentation/sdks/yaml/#jinja-templatization) +can be used to build off of different contexts and/or with different +configurations. + +Several examples will be created based on the already used word count example +by leveraging Jinja templating engine for dynamic pipeline generation based on +inputs from the user through `% include`, `% import`, and inheritance +directives. + +% import: +- [wordCount.yaml](#TODO: pending) + +% include: +- [wordCount.yaml](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/yaml/examples/transforms/jinja/include/wordCount.yaml) Review Comment: It would also be good to give an example of invoking this (and how you would pass in appropriate parameters) ########## sdks/python/apache_beam/yaml/examples/transforms/jinja/include/wordCountInclude.yaml: ########## @@ -0,0 +1,71 @@ +# coding=utf-8 +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +# This examples reads from a public file stored on Google Cloud. This +# requires authenticating with Google Cloud, or setting the file in +#`ReadFromText` to a local file. +# +# To set up Application Default Credentials, +# see https://cloud.google.com/docs/authentication/external/set-up-adc. +# +# This pipeline reads in a text file, counts distinct words found in the text, +# then logs a row containing each word and its count. + +pipeline: + transforms: + - name: Read from GCS + type: ReadFromText + config: +{% include 'apache_beam/yaml/examples/transforms/jinja/include/submodules/readFromText.yaml' %} Review Comment: I'd also recommend using more descriptive file names. So for examples: `readFromTextTransform.yaml` (assuming we put the whole transform there) or `mapToFieldsCountConfig.yaml` (assuming we keep that one as config since it is more complicated) -- 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-unsubscr...@beam.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
