p34709852
/
monkey
forked from p15670423/monkey
1
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity

Common: Add docstrings to static methods in AgentConfiguration

This commit is contained in:
Mike Salvatore 2022-06-24 13:30:43 -04:00
parent 8cb045d635
commit 568eb4ff3b
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
monkey/common/configuration/agent_configuration.py
View File

@ -46,6 +46,15 @@ class AgentConfiguration:
@staticmethod @staticmethod
def from_mapping(config_mapping: Mapping[str, Any]) -> AgentConfiguration: def from_mapping(config_mapping: Mapping[str, Any]) -> AgentConfiguration:
"""
Construct an AgentConfiguration from a Mapping
:param config_mapping: A Mapping that represents an AgentConfiguration
:return: An AgentConfiguration
:raises: InvalidConfigurationError if the provided Mapping does not represent a valid
AgentConfiguration
"""
try: try:
config_dict = AgentConfigurationSchema().load(config_mapping) config_dict = AgentConfigurationSchema().load(config_mapping)
return AgentConfiguration(**config_dict) return AgentConfiguration(**config_dict)
@ -54,6 +63,14 @@ class AgentConfiguration:
@staticmethod @staticmethod
def from_json(config_json: str) -> AgentConfiguration: def from_json(config_json: str) -> AgentConfiguration:
"""
Construct an AgentConfiguration from a JSON string
:param config_json: A JSON string that represents an AgentConfiguration
:return: An AgentConfiguration
:raises: InvalidConfigurationError if the provided JSON does not represent a valid
AgentConfiguration
"""
try: try:
config_dict = AgentConfigurationSchema().loads(config_json) config_dict = AgentConfigurationSchema().loads(config_json)
return AgentConfiguration(**config_dict) return AgentConfiguration(**config_dict)
@ -62,6 +79,12 @@ class AgentConfiguration:
@staticmethod @staticmethod
def to_json(config: AgentConfiguration) -> str: def to_json(config: AgentConfiguration) -> str:
"""
Serialize an AgentConfiguration to JSON
:param config: An AgentConfiguration
:return: A JSON string representing the AgentConfiguration
"""
return AgentConfigurationSchema().dumps(config) return AgentConfigurationSchema().dumps(config)