flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FLINK-2017) Add predefined required parameters to ParameterTool
Date Sun, 25 Oct 2015 11:19:27 GMT

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

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

Github user mliesenberg commented on a diff in the pull request:

    https://github.com/apache/flink/pull/1097#discussion_r42943773
  
    --- Diff: flink-java/src/main/java/org/apache/flink/api/java/utils/RequiredParameter.java
---
    @@ -0,0 +1,149 @@
    +/*
    + * 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.
    + */
    +
    +package org.apache.flink.api.java.utils;
    +
    +import java.util.HashMap;
    +import java.util.Map;
    +import java.util.Objects;
    +
    +/**
    + * Facility to manage required parameters in user defined functions.
    + */
    +public class RequiredParameter {
    +
    +	private static final String HELP_TEXT_PARAM_DELIMITER = "\t";
    +	private static final String HELP_TEXT_LINE_DELIMITER = "\n";
    +
    +	private HashMap<String, Option> data;
    +
    +	public RequiredParameter() {
    +		this.data = new HashMap<>();
    +	}
    +
    +	public void add(Option option) throws RequiredParameterException {
    --- End diff --
    
    We could add an additional method, though then we do have an implicit coupling between
that add method and the constructor of Option. If, and that is probably a big if, the constructor
were to change, we would have to update the add method as well. 
    
    Only providing a String based version of the add method would lead to code like that:
    ```
    Option option = req.add("name")
    option.type(...).values(...)
    ```
    
    which in my opinion is a little bit awkward compared to instantiation, setting the right
 type and values and then adding the object.
    
    what do you think?


> Add predefined required parameters to ParameterTool
> ---------------------------------------------------
>
>                 Key: FLINK-2017
>                 URL: https://issues.apache.org/jira/browse/FLINK-2017
>             Project: Flink
>          Issue Type: Improvement
>    Affects Versions: 0.9
>            Reporter: Robert Metzger
>              Labels: starter
>
> In FLINK-1525 we've added the {{ParameterTool}}.
> During the PR review, there was a request for required parameters.
> This issue is about implementing a facility to define required parameters. The tool should
also be able to print a help menu with a list of all parameters.
> This test case shows my initial ideas how to design the API
> {code}
> 	@Test
> 	public void requiredParameters() {
> 		RequiredParameters required = new RequiredParameters();
> 		Option input = required.add("input").alt("i").help("Path to input file or directory");
// parameter with long and short variant
> 		required.add("output"); // parameter only with long variant
> 		Option parallelism = required.add("parallelism").alt("p").type(Integer.class); // parameter
with type
> 		Option spOption = required.add("sourceParallelism").alt("sp").defaultValue(12).help("Number
specifying the number of parallel data source instances"); // parameter with default value,
specifying the type.
> 		Option executionType = required.add("executionType").alt("et").defaultValue("pipelined").choices("pipelined",
"batch");
> 		ParameterUtil parameter = ParameterUtil.fromArgs(new String[]{"-i", "someinput", "--output",
"someout", "-p", "15"});
> 		required.check(parameter);
> 		required.printHelp();
> 		required.checkAndPopulate(parameter);
> 		String inputString = input.get();
> 		int par = parallelism.getInteger();
> 		String output = parameter.get("output");
> 		int sourcePar = parameter.getInteger(spOption.getName());
> 	}
> {code}



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message