X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2Fparsers%2FJsonParser.py;h=50a920bee09c3c76eac92a361a62ec7f4ef02421;hp=1d177670fffd26834bf22e74a647659bbdafb62a;hb=8c12ff59f1a5e750151f5eb0e806dcc80e91c3c2;hpb=4a7f950c10ca9bcf86e5ccbc3d49a3d7e3cb9809 diff --git a/resources/libraries/python/parsers/JsonParser.py b/resources/libraries/python/parsers/JsonParser.py index 1d177670ff..50a920bee0 100644 --- a/resources/libraries/python/parsers/JsonParser.py +++ b/resources/libraries/python/parsers/JsonParser.py @@ -11,35 +11,42 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""Used to parse Json files or Json data strings to dictionaries""" +"""Used to parse JSON files or JSON data strings to dictionaries""" import json class JsonParser(object): - """Parses Json data string or files containing Json data strings""" + """Parses JSON data string or files containing JSON data strings""" def __init__(self): pass @staticmethod def parse_data(json_data): - """Return list parsed from json data string. + """Return list parsed from JSON data string. - Translates json data into list of values/dictionaries/lists - :param json_data: data in json format - :return: json data parsed as python list + Translates JSON data into list of values/dictionaries/lists. + + :param json_data: Data in JSON format. + :type json_data: str + :return: JSON data parsed as python list. + :rtype: list """ parsed_data = json.loads(json_data) return parsed_data - def parse_file(self, json_file): - """Return list parsed from file containing json string. + @staticmethod + def parse_file(json_file): + """Return list parsed from file containing JSON string. + + Translates JSON data found in file into list of + values/dictionaries/lists. - Translates json data found in file into list of - values/dictionaries/lists - :param json_file: file with json type data - :return: json data parsed as python list + :param json_file: File with JSON type data. + :type json_file: str + :return: JSON data parsed as python list. + :rtype: list """ input_data = open(json_file).read() - parsed_data = self.parse_data(input_data) + parsed_data = JsonParser.parse_data(input_data) return parsed_data