aboutsummaryrefslogtreecommitdiffstats
path: root/config_file/parsers/base_parser.py
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2020-07-19 14:59:05 -0500
committerEugene Triguba <eugenetriguba@gmail.com>2020-07-19 14:59:05 -0500
commitc476c1ed7065910fddc15ccfe67442c81f777bbf (patch)
treef2703b3ff7cb36d68d8c55a2cffbe52bde8906dc /config_file/parsers/base_parser.py
parentTweak zsh installation info (diff)
downloadconfig-file-c476c1ed7065910fddc15ccfe67442c81f777bbf.zip
Remove zsh info and add extras sub header
Diffstat (limited to 'config_file/parsers/base_parser.py')
-rw-r--r--config_file/parsers/base_parser.py75
1 files changed, 0 insertions, 75 deletions
diff --git a/config_file/parsers/base_parser.py b/config_file/parsers/base_parser.py
deleted file mode 100644
index da6e90a..0000000
--- a/config_file/parsers/base_parser.py
+++ /dev/null
@@ -1,75 +0,0 @@
-from abc import ABC, abstractmethod
-from typing import Any
-
-
-class BaseParser(ABC):
- """
- The abstract base parser for all other parsers to implement.
-
- All the keys are specified in a 'dot' syntax. So if you have
- sections with subsections with a key that you're trying to get
- the value of, you'd use 'section.subsection.key' as the key parameter.
- """
-
- @abstractmethod
- def __init__(self, file_contents: str) -> None:
- """
- All parsers will take in the file as a string, parse
- them internally to their own representation that they
- can work with, and are able to stringify them back out
- when we need to save (write) them.
-
- It is up to the caller of the parser to read in the file to
- the parser and save the file when they are done using stringify().
- """
- self.content = file_contents
- self.parsed_content = self.parse(self.content)
-
- @abstractmethod
- def get(self, key: str, parse_types: bool = False, all: bool = False) -> Any:
- """
- Retrieve the value of a key in its native type.
- This means the string 'true' will be parsed back as the
- boolean True.
-
- If parse_types is set to False, all values will be returned
- back as strings.
- """
- raise NotImplementedError
-
- @abstractmethod
- def set(self, key: str, value: Any) -> bool:
- """Sets the value of a key."""
- raise NotImplementedError
-
- @abstractmethod
- def delete(self, section_key: str) -> bool:
- """Deletes a key/value pair or entire sections."""
- raise NotImplementedError
-
- @abstractmethod
- def stringify(self) -> str:
- """
- Using self.__contents, converts the parsed internal representation
- of the file back into a string.
- """
- raise NotImplementedError
-
- @abstractmethod
- def has(self, section_key: str) -> bool:
- """
- Check if a section, sub-section, or key exists in the file
- using a section.key format.
-
- Some formats, like JSON, do not have sections and therefore,
- it would only be checking if
- """
- raise NotImplementedError
-
- @abstractmethod
- def parse(self, file_contents: str) -> Any:
- """
- Parse the file_contents into an internal representation
- the given parser can work with.
- """
- raise NotImplementedError