bossenti commented on code in PR #140: URL: https://github.com/apache/incubator-streampipes/pull/140#discussion_r1020907300
########## streampipes-client-python/streampipes_client/client/client_config.py: ########## @@ -0,0 +1,58 @@ +# +# 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. +# + +""" +Implementation of a config class for the StreamPipes client. +""" + + +from dataclasses import dataclass +from typing import Optional + +__all__ = [ + "StreamPipesClientConfig", +] + +from streampipes_client.client.credential_provider import CredentialProvider + + +@dataclass +class StreamPipesClientConfig: + """Configure the StreamPipes client in accordance to the actual StreamPipes instance to connect to. + An instance is provided to the `StreamPipesClient` to configure it properly. + + Parameters + ---------- + credential_provider: CredentialProvider + Provides the credentials to authenticate with the StreamPipes API. + host_address: + Host address of the StreamPipes instance to connect to. + Should be provided without the protocol/scheme, e.g. as `localhost` or `streampipes.xyz`. + https_disabled: Optional[bool] + Determines whether https is used to connect to StreamPipes. + port: Optional[int] + Specifies the port under which the StreamPipes API is available, e.g., 80. + + Examples + -------- + see `StreamPipesClient` + """ + + credential_provider: CredentialProvider + host_address: str + https_disabled: Optional[bool] = False + port: Optional[int] = 80 Review Comment: Which default should we provide here? Is `80` appropriate? Or would you prefer to make it a required parameter? -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
