ConnectionOptions¶
-
class
openff.evaluator.client.
ConnectionOptions
(server_address=None, server_port=None)[source]¶ The options to use when connecting to an EvaluatorServer
Methods
__init__
([server_address, server_port])- param server_address
The address of the server to connect to.
from_json
(file_path)Create this object from a JSON file.
get_attributes
([attribute_type])Returns all attributes of a specific attribute_type.
json
([file_path, format])Creates a JSON representation of this class.
parse_json
(string_contents[, encoding])Parses a typed json string into the corresponding class structure.
validate
([attribute_type])Validate the values of the attributes.
Attributes
The address of the server to connect to.
The port of the server to connect to.
-
server_address
¶ The address of the server to connect to. The default value of this attribute is
localhost
.- Type
-
server_port
¶ The port of the server to connect to. The default value of this attribute is
8000
.- Type
-
classmethod
from_json
(file_path)¶ Create this object from a JSON file.
- Parameters
file_path (str) – The path to load the JSON from.
- Returns
The parsed class.
- Return type
cls
-
classmethod
get_attributes
(attribute_type=None)¶ Returns all attributes of a specific attribute_type.
- Parameters
attribute_type (type of Attribute, optional) – The type of attribute to search for.
- Returns
The names of the attributes of the specified type.
- Return type
list of str
-
json
(file_path=None, format=False)¶ Creates a JSON representation of this class.
-
classmethod
parse_json
(string_contents, encoding='utf8')¶ Parses a typed json string into the corresponding class structure.
-
validate
(attribute_type=None)¶ Validate the values of the attributes. If attribute_type is set, only attributes of that type will be validated.
- Parameters
attribute_type (type of Attribute, optional) – The type of attribute to validate.
- Raises
ValueError or AssertionError –