aboutsummaryrefslogtreecommitdiffstats
path: root/config_file
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2020-06-20 13:41:35 -0500
committerEugene Triguba <eugenetriguba@gmail.com>2020-06-20 13:41:35 -0500
commit94fe938075c4edba742db66280c8e02198d79e1e (patch)
tree86979be9a12d6563de34914927be6413535ffb6c /config_file
parentdocs: Tweak project description (diff)
downloadconfig-file-94fe938075c4edba742db66280c8e02198d79e1e.zip
Add python 3.5 support, ConfigFileError, and more type hints
Also, get_all, set_all, and delete_all in JsonParser have been renamed to just all.
Diffstat (limited to 'config_file')
-rw-r--r--config_file/__init__.py4
-rw-r--r--config_file/config_file.py18
-rw-r--r--config_file/exceptions.py6
-rw-r--r--config_file/parsers/base_parser.py3
-rw-r--r--config_file/parsers/ini_parser.py7
-rw-r--r--config_file/parsers/json_parser.py21
-rw-r--r--config_file/parsers/toml_parser.py0
-rw-r--r--config_file/parsers/yaml_parser.py0
8 files changed, 33 insertions, 26 deletions
diff --git a/config_file/__init__.py b/config_file/__init__.py
index 3bae28a..f37019a 100644
--- a/config_file/__init__.py
+++ b/config_file/__init__.py
@@ -1,10 +1,12 @@
from config_file.config_file import ConfigFile
-from config_file.parsers.base_parser import BaseParser, ParsingError
+from config_file.parsers.base_parser import BaseParser
+from config_file.exceptions import ParsingError, ConfigFileError
__version__ = "0.10.0"
__all__ = [
"ConfigFile",
"ParsingError",
+ "ConfigFileError",
"BaseParser",
]
diff --git a/config_file/config_file.py b/config_file/config_file.py
index 91202da..805fc49 100644
--- a/config_file/config_file.py
+++ b/config_file/config_file.py
@@ -1,15 +1,17 @@
import inspect
from pathlib import Path, PurePath
from shutil import copyfile
+from typing import Type, Union
-from config_file.parsers.base_parser import BaseParser, ParsingError
+from config_file.parsers.base_parser import BaseParser
from config_file.parsers.ini_parser import IniParser
from config_file.parsers.json_parser import JsonParser
from config_file.utils import split_on_dot
+from config_file.exceptions import ParsingError
class ConfigFile:
- def __init__(self, file_path, parser: BaseParser = None):
+ def __init__(self, file_path: Type[Union[str, PurePath]], parser: Type[BaseParser] = None) -> None:
"""
Saves the config file path and expands it if needed, reads in
the file contents, and determines what parser should be used for
@@ -17,7 +19,6 @@ class ConfigFile:
:param file_path: The path to your configuration file.
:param parser: A custom parser you'd like used for your config file.
- It must be a concrete implementation of BaseParser.
:raises ValueError: If the specified file path does not have an extension
that is supported or it is a directory.
@@ -27,7 +28,7 @@ class ConfigFile:
self.parser = self.__determine_parser(file_path, parser)
@staticmethod
- def __create_config_path(file_path, original: bool = False) -> str:
+ def __create_config_path(file_path: Type[Union[str, PurePath]], original: bool = False) -> str:
if isinstance(file_path, PurePath):
file_path = str(file_path)
@@ -40,11 +41,11 @@ class ConfigFile:
file_path = ".".join(file_parts)
if Path(file_path).is_dir():
- raise ValueError(f"The specified config file ({file_path}) is a directory.")
+ raise ValueError("The specified config file ({}) is a directory.".format(file_path))
return file_path
- def __determine_parser(self, file_path, parser: BaseParser):
+ def __determine_parser(self, file_path: Type[Union[str, PurePath]], parser: Type[BaseParser]) -> BaseParser:
if isinstance(file_path, PurePath):
file_path = str(file_path)
@@ -58,8 +59,7 @@ class ConfigFile:
return JsonParser(self.contents)
else:
raise ValueError(
- f"File path contains an unsupported or "
- f"unrecognized file type: {file_path}"
+ "File path contains an unsupported or unrecognized file type: {}".format(file_path)
)
def __read_config_file(self):
@@ -134,7 +134,7 @@ class ConfigFile:
if not Path(original_file_path).exists():
raise OSError(
- f"The {original_file_path} file to restore to does not exist."
+ "The {} file to restore to does not exist.".format(original_file_path)
)
Path(self.path).expanduser().unlink()
diff --git a/config_file/exceptions.py b/config_file/exceptions.py
new file mode 100644
index 0000000..cd7e236
--- /dev/null
+++ b/config_file/exceptions.py
@@ -0,0 +1,6 @@
+class ConfigFileError(Exception):
+ """A generic error from the package."""
+
+class ParsingError(ConfigFileError):
+ """Unable to parse the configuration file."""
+ \ No newline at end of file
diff --git a/config_file/parsers/base_parser.py b/config_file/parsers/base_parser.py
index 42f93b1..5fc47c2 100644
--- a/config_file/parsers/base_parser.py
+++ b/config_file/parsers/base_parser.py
@@ -74,6 +74,3 @@ class BaseParser(ABC):
"""
raise NotImplementedError
-
-class ParsingError(Exception):
- """Unable to parse the configuration file"""
diff --git a/config_file/parsers/ini_parser.py b/config_file/parsers/ini_parser.py
index 81f2d1b..31b0dcf 100644
--- a/config_file/parsers/ini_parser.py
+++ b/config_file/parsers/ini_parser.py
@@ -1,9 +1,10 @@
import configparser
from io import StringIO
-from config_file.parsers.base_parser import BaseParser, ParsingError
+from config_file.parsers.base_parser import BaseParser
from config_file.parsers.parse_value import parse_value
from config_file.utils import split_on_dot
+from config_file.exceptions import ParsingError
class IniParser(BaseParser):
@@ -95,7 +96,7 @@ class IniParser(BaseParser):
if "." not in section_key:
if not self.parsed_content.has_section(section_key):
raise ValueError(
- f"Cannot delete {section_key} because it is not in the config file."
+ "Cannot delete {} because it is not in the config file.".format(section_key)
)
self.parsed_content.remove_section(section_key)
@@ -104,7 +105,7 @@ class IniParser(BaseParser):
section, key = split_on_dot(section_key, only_last_dot=True)
if key not in self.parsed_content[section]:
raise ValueError(
- f"Cannot delete {section}.{key} because {key} is not in {section}."
+ "Cannot delete {section}.{key} because {key} is not in {section}.".format(section = section, key = key)
)
self.parsed_content.remove_option(section, key)
diff --git a/config_file/parsers/json_parser.py b/config_file/parsers/json_parser.py
index 20eb085..4d93ca3 100644
--- a/config_file/parsers/json_parser.py
+++ b/config_file/parsers/json_parser.py
@@ -7,9 +7,10 @@ from nested_lookup import (
nested_update,
)
-from config_file.parsers.base_parser import BaseParser, ParsingError
+from config_file.parsers.base_parser import BaseParser
from config_file.parsers.parse_value import parse_value
from config_file.utils import split_on_dot
+from config_file.exceptions import ParsingError
class JsonParser(BaseParser):
@@ -34,7 +35,7 @@ class JsonParser(BaseParser):
>>> { "key2": "foo", "key1": "bar" }
parser.get('key1.key2')
>>> "foo"
- parser.get('key1', get_all=True)
+ parser.get('key1', all=True)
>>> [{ "key2": "foo", "key1": "bar" }, "bar"]
"""
@@ -48,7 +49,7 @@ class JsonParser(BaseParser):
except json.decoder.JSONDecodeError as error:
raise ParsingError(error)
- def get(self, key: str, parse_types: bool = False, get_all: bool = False):
+ def get(self, key: str, parse_types: bool = False, all: bool = False):
"""
Retrieve values using a dot syntax.
@@ -56,14 +57,14 @@ class JsonParser(BaseParser):
:param parse_types: Whether you'd like the type parsed into its native one.
- :param get_all: Specify whether you'd like to recursively receive
+ :param all: Specify whether you'd like to recursively receive
all values that match the given key. Returned as a list.
e.g. 'foo' would retrieve all values that have the key 'foo', anywhere
in the json.
:return: the value of the given key
"""
- if get_all:
+ if all:
result = nested_lookup(key, self.parsed_content)
elif "." in key:
split_keys = split_on_dot(key)
@@ -77,15 +78,15 @@ class JsonParser(BaseParser):
result = result[key]
except TypeError:
raise ParsingError(
- f"Cannot get {key} because {key_for_error} is not subscriptable."
+ "Cannot get {} because {} is not subscriptable.".format(key, key_for_error)
)
else:
result = self.parsed_content[key]
return parse_value(result) if parse_types else result
- def set(self, key: str, value, set_all: bool = False):
- if set_all:
+ def set(self, key: str, value, all: bool = False):
+ if all:
nested_update(self.parsed_content, key, value, in_place=True)
elif "." in key:
indexes = split_on_dot(key)
@@ -103,8 +104,8 @@ class JsonParser(BaseParser):
return True
- def delete(self, key, delete_all: bool = False):
- if delete_all:
+ def delete(self, key, all: bool = False):
+ if all:
nested_delete(self.parsed_content, key, in_place=True)
elif "." in key:
indexes = split_on_dot(key)
diff --git a/config_file/parsers/toml_parser.py b/config_file/parsers/toml_parser.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/config_file/parsers/toml_parser.py
diff --git a/config_file/parsers/yaml_parser.py b/config_file/parsers/yaml_parser.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/config_file/parsers/yaml_parser.py