aboutsummaryrefslogtreecommitdiffstats
path: root/config_file
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2020-08-16 22:07:34 -0500
committerEugene Triguba <eugenetriguba@gmail.com>2020-08-16 22:07:34 -0500
commit7c478473ddd3278dbbbd1520c6a290a270663e53 (patch)
tree7fe97702ddf56709d71db0a0100fee37189f8ebf /config_file
parentEnforce `parsed_content` property in AbstractParser (diff)
downloadconfig-file-7c478473ddd3278dbbbd1520c6a290a270663e53.zip
Document ParsingError and ConfigFile init errors
Diffstat (limited to 'config_file')
-rw-r--r--config_file/config_file.py1
-rw-r--r--config_file/config_file_path.py1
2 files changed, 2 insertions, 0 deletions
diff --git a/config_file/config_file.py b/config_file/config_file.py
index 2a8d9ae..934c198 100644
--- a/config_file/config_file.py
+++ b/config_file/config_file.py
@@ -21,6 +21,7 @@ class ConfigFile:
ValueError: If the specified file path does not have an extension
that is supported or it is a directory.
FileNotFoundError: If the specified file path does not exist.
+ ParsingError: If the file_path could not be parsed.
"""
self.__path = ConfigFilePath(file_path).validate()
self.__parser = self.__path.parser
diff --git a/config_file/config_file_path.py b/config_file/config_file_path.py
index 11a5daa..ecb6531 100644
--- a/config_file/config_file_path.py
+++ b/config_file/config_file_path.py
@@ -58,6 +58,7 @@ class ConfigFilePath(_Path_):
Raises:
ValueError: If the extension of the file is not recognized.
+ ParsingError: If the contents could not be parsed.
Returns:
The instantiated parser that should be used for this file.