You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2019/07/23 01:11:37 UTC
[GitHub] [flink] dianfu commented on a change in pull request #9199:
[FLINK-13368][python] Add Configuration Class for Python Table API to Align
with Java.
dianfu commented on a change in pull request #9199: [FLINK-13368][python] Add Configuration Class for Python Table API to Align with Java.
URL: https://github.com/apache/flink/pull/9199#discussion_r306092023
##########
File path: flink-python/pyflink/common/configuration.py
##########
@@ -0,0 +1,258 @@
+################################################################################
+# 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.
+################################################################################
+from pyflink.java_gateway import get_gateway
+
+
+class Configuration:
+ """
+ Lightweight configuration object which stores key/value pairs.
+ """
+
+ def __init__(self, other=None, j_configuration=None):
+ """
+ Creates a new configuration.
+
+ :param other: Optional, if this parameter exists, creates a new configuration with a
+ copy of the given configuration.
+ :type other: Configuration
+ :param j_configuration: Optional, the py4j java configuration object, if this parameter
+ exists, creates a wrapper for it.
+ :type j_configuration: py4j.java_gateway.JavaObject
+ """
+ if j_configuration is not None:
+ self._j_configuration = j_configuration
+ else:
+ gateway = get_gateway()
+ JConfiguration = gateway.jvm.org.apache.flink.configuration.Configuration
+ if other is not None:
+ self._j_configuration = JConfiguration(other._j_configuration)
+ else:
+ self._j_configuration = JConfiguration()
+
+ def get_string(self, key, default_value):
+ """
+ Returns the value associated with the given key as a string.
+
+ :param key: The key pointing to the associated value.
+ :type key: str
+ :param default_value: The default value which is returned in case there is no value
+ associated with the given key.
+ :type default_value: str
+ :return: The (default) value associated with the given key.
+ :rtype: str
+ """
+ return self._j_configuration.getString(key, default_value)
+
+ def set_string(self, key, value):
+ """
+ Adds the given key/value pair to the configuration object.
+
+ :param key: The key of the key/value pair to be added.
+ :type key: str
+ :param value: The value of the key/value pair to be added.
+ :type value: str
+ """
+ self._j_configuration.setString(key, value)
+
+ def get_integer(self, key, default_value):
+ """
+ Returns the value associated with the given key as an integer.
+
+ :param key: The key pointing to the associated value.
+ :type key: str
+ :param default_value: The default value which is returned in case there is no value
+ associated with the given key.
+ :type default_value: int
+ :return: The (default) value associated with the given key.
+ :rtype: int
+ """
+ return self._j_configuration.getLong(key, default_value)
+
+ def set_integer(self, key, value):
+ """
+ Adds the given key/value pair to the configuration object.
+
+ :param key: The key of the key/value pair to be added.
+ :type key: str
+ :param value: The value of the key/value pair to be added.
+ :type value: int
+ """
+ self._j_configuration.setLong(key, value)
+
+ def get_boolean(self, key, default_value):
+ """
+ Returns the value associated with the given key as a boolean.
+
+ :param key: The key pointing to the associated value.
+ :type key: str
+ :param default_value: The default value which is returned in case there is no value
+ associated with the given key.
+ :type default_value: bool
+ :return: The (default) value associated with the given key.
+ :rtype: bool
+ """
+ return self._j_configuration.getBoolean(key, default_value)
+
+ def set_boolean(self, key, value):
+ """
+ Adds the given key/value pair to the configuration object.
+
+ :param key: The key of the key/value pair to be added.
+ :type key: str
+ :param value: The value of the key/value pair to be added.
+ :type value: int
+ """
+ self._j_configuration.setBoolean(key, value)
+
+ def get_float(self, key, default_value):
+ """
+ Returns the value associated with the given key as a float.
+
+ :param key: The key pointing to the associated value.
+ :type key: str
+ :param default_value: The default value which is returned in case there is no value
+ associated with the given key.
+ :type default_value: float
+ :return: The (default) value associated with the given key.
+ :rtype: float
+ """
+ return self._j_configuration.getDouble(key, float(default_value))
+
+ def set_float(self, key, value):
+ """
+ Adds the given key/value pair to the configuration object.
+
+ :param key: The key of the key/value pair to be added.
+ :type key: str
+ :param value: The value of the key/value pair to be added.
+ :type value: float
+ """
+ self._j_configuration.setDouble(key, float(value))
+
+ def get_bytearray(self, key, default_value):
+ """
+ Returns the value associated with the given key as a byte array.
+
+ :param key: The key pointing to the associated value.
+ :type key: str
+ :param default_value: The default value which is returned in case there is no value
+ associated with the given key.
+ :type default_value: bytearray
+ :return: The (default) value associated with the given key.
+ :rtype: bytearray
+ """
+ return bytearray(self._j_configuration.getBytes(key, default_value))
+
+ def set_bytearray(self, key, value):
+ """
+ Adds the given byte array to the configuration object.
+
+ :param key: The key under which the bytes are added.
+ :type key: str
+ :param value: The byte array to be added.
+ :type value: bytearray
+ """
+ self._j_configuration.setBytes(key, value)
+
+ def key_set(self):
+ """
+ Returns the keys of all key/value pairs stored inside this configuration object.
+
+ :return: The keys of all key/value pairs stored inside this configuration object.
+ :rtype: set
+ """
+ return set(self._j_configuration.keySet())
+
+ def add_all_to_dict(self, target_dict):
+ """
+ Adds all entries in this configuration to the given dict.
+
+ :param target_dict: The dict to be updated.
+ :type target_dict: dict
+ """
+ properties = get_gateway().jvm.java.util.Properties()
+ self._j_configuration.addAllToProperties(properties)
+ target_dict.update(properties)
+
+ def add_all(self, other, prefix=None):
+ """
+ Adds all entries from the given configuration into this configuration. The keys are
+ prepended with the given prefix if exist.
+
+ :param other: The configuration whose entries are added to this configuration.
+ :type other: Configuration
+ :param prefix: Optional, the prefix to prepend.
+ :type prefix: str
+ """
+ if prefix is None:
+ self._j_configuration.addAll(other._j_configuration)
+ else:
+ self._j_configuration.addAll(other._j_configuration, prefix)
+
+ def clone(self):
Review comment:
should use copy and deepcopy instead.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services