aboutsummaryrefslogtreecommitdiffstats
path: root/config_file/parse_value.py
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2020-08-05 20:39:28 -0500
committerEugene Triguba <eugenetriguba@gmail.com>2020-08-05 20:39:28 -0500
commit59eeb1321fbad41dce7c971778e37ac1943fda3b (patch)
tree0ccb143e1094784e9b149977d6f0cabf6f6220b2 /config_file/parse_value.py
parentAdd ConfigFilePath to refactor out file specific code (diff)
downloadconfig-file-59eeb1321fbad41dce7c971778e37ac1943fda3b.zip
Redo package to have a flat package structure
By having a flat package structure like this, it'll avoid exposing packages and things we don't want to be exposed.
Diffstat (limited to 'config_file/parse_value.py')
-rw-r--r--config_file/parse_value.py218
1 files changed, 218 insertions, 0 deletions
diff --git a/config_file/parse_value.py b/config_file/parse_value.py
new file mode 100644
index 0000000..12032d6
--- /dev/null
+++ b/config_file/parse_value.py
@@ -0,0 +1,218 @@
+"""This module allows you to parse a string into its native type."""
+import ast
+import re
+from distutils.util import strtobool
+from typing import Any
+
+
+def parse_value(value: Any) -> Any:
+ """Parse a value into native type.
+
+ parse_value('5') -> 5 (int)
+ parse_value('-5') -> -5 (int)
+
+ parse_value('5.52') -> 5.52 (float)
+ parse_value('-53.2') -> -53.2 (float)
+
+ parse_value('blahfafda') -> 'blahfafda' (string)
+
+ parse_value('true') -> True (bool)
+ parse_value('FALSE') -> False (bool)
+
+ parse_value(" [ [ [ [] ]] ] ") -> [[[[]]]] (list)
+
+ Args:
+ value: The value to parse.
+
+ Returns:
+ The parsed value, if it could be parsed
+ as a dictionary, list, int, float, or bool.
+ Otherwise, it simply returns the original
+ passed in value.
+ """
+ if isinstance(value, dict):
+ parsed = {}
+
+ for item in value:
+ parsed[item] = parse_value(value[item])
+
+ return parsed
+
+ if isinstance(value, list):
+ parsed = []
+
+ for item in value:
+ parsed.append(parse_value(item))
+
+ return parsed
+
+ if can_be_parsed_as_int(value):
+ return int(value.strip()) if isinstance(value, str) else int(value)
+
+ if can_be_parsed_as_float(value):
+ return float(value.strip()) if isinstance(value, str) else float(value)
+
+ if can_be_parsed_as_bool(value):
+ return bool(value) if isinstance(value, bool) else bool(strtobool(value))
+
+ if can_be_parsed_as_dict(value):
+ return parse_value(ast.literal_eval(value.strip()))
+
+ if can_be_parsed_as_list(value):
+ return parse_value(ast.literal_eval(value.strip()))
+
+ return value
+
+
+def can_be_parsed_as_int(value: Any) -> bool:
+ """Check whether a value can be parsed as a integer.
+
+ can_be_parsed_as_int(5) -> True
+ can_be_parsed_as_int("5") -> True
+ can_be_parsed_as_int("-5") -> True
+ can_be_parsed_as_int(True) -> False
+
+ Args:
+ value: The value to check if it can be parsed as an integer.
+
+ Returns:
+ True if we can parse the value as a integer. False otherwise.
+ """
+ if isinstance(value, int) and not isinstance(value, bool):
+ return True
+
+ if not isinstance(value, str):
+ return False
+
+ value = value.strip()
+
+ if value.startswith("-"):
+ return value[1:].isdigit()
+
+ return value.isdigit()
+
+
+def can_be_parsed_as_float(value: Any) -> bool:
+ """Checks whether a value can be parsed as a float.
+
+ can_be_parsed_as_float(45) -> False
+ can_be_parsed_as_float(1.1) -> True
+ can_be_parsed_as_float("1.1") -> True
+ can_be_parsed_as_float("-1.1") -> True
+ can_be_parsed_as_float(".1") -> True
+
+ Args:
+ value: The value to be parsed.
+
+ Returns:
+ True if the value can be parsed as a float. False otherwise.
+ """
+ FLOAT_REGEX = r"^\d*\.\d+$"
+
+ if isinstance(value, float):
+ return True
+
+ if not isinstance(value, str):
+ return False
+
+ value = value.strip()
+
+ if value.startswith("-"):
+ value = value[1:]
+
+ return bool(re.match(FLOAT_REGEX, value))
+
+
+def can_be_parsed_as_bool(value: Any) -> bool:
+ """Checks whether a value can be parsed as a boolean.
+
+ can_be_parsed_as_bool(True) -> True
+ can_be_parsed_as_bool("true") -> True
+ can_be_parsed_as_bool("false") -> True
+ can_be_parsed_as_bool("TRUE") -> True
+ can_be_parsed_as_bool(0) -> False
+
+ Args:
+ value: The value to be parsed.
+
+ Returns:
+ True if the value can be parsed as a boolean. False otherwise.
+ """
+ if isinstance(value, bool):
+ return True
+
+ if not isinstance(value, str):
+ return False
+
+ value = value.lower().strip()
+
+ return value == "true" or value == "false"
+
+
+def can_be_parsed_as_dict(value: Any) -> bool:
+ """Checks whether a value can be parsed as a dictionary.
+
+ can_be_parsed_as_dict({}) -> True
+ can_be_parsed_as_dict("{}") -> True
+ can_be_parsed_as_dict(" { } ") -> True
+ can_be_parsed_as_dict("{ 'hello': 5 }") -> True
+ can_be_parsed_as_dict([]]) -> False
+ can_be_parsed_as_dict(" { invalid } ") -> False
+
+ Args:
+ value: The value to be parsed.
+
+ Returns:
+ True if the value can be parsed as a dictionary. False otherwise.
+ """
+ if isinstance(value, dict):
+ return True
+
+ if not isinstance(value, str):
+ return False
+
+ value = value.strip()
+
+ if value[0] == "{" and value[-1] == "}":
+ try:
+ ast.literal_eval(value)
+ return True
+ except Exception:
+ return False
+
+ return False
+
+
+def can_be_parsed_as_list(value: Any) -> bool:
+ """Checks whether a value can be parsed as a list.
+
+ can_be_parsed_as_list([]) -> True
+ can_be_parsed_as_list([1, 2]) -> True
+ can_be_parsed_as_list("[]") -> True
+ can_be_parsed_as_list(" [] ") -> True
+ can_be_parsed_as_list("[1, 2]") -> True
+ can_be_parsed_as_list({}) -> False
+ can_be_parsed_as_list(" [ invalid ] ") -> False
+
+ Args:
+ value: The value to be parsed.
+
+ Returns:
+ True if the value can be parsed as a list. False otherwise.
+ """
+ if isinstance(value, list):
+ return True
+
+ if not isinstance(value, str):
+ return False
+
+ value = value.strip()
+
+ if value[0] == "[" and value[-1] == "]":
+ try:
+ ast.literal_eval(value)
+ return True
+ except Exception:
+ return False
+
+ return False