"""Base class for pseudopotential parsers."""
from __future__ import annotations
import abc
import os
[docs]
class ParserError(Exception):
"""Exceptions raised by Parser objects."""
[docs]
class BaseParser(metaclass=abc.ABCMeta):
"""
Abstract class defining the interface that must be provided
by the parsers used to extract results from the output file of
a pseudopotential generator a.k.a. ppgen
Attributes:
errors: List of strings with errors reported by the pp generator
warnings: List of strings with the warnings reported by the pp generator.
"""
Error = ParserError
def __init__(self, filepath: str) -> None:
"""
Args:
filepath: Path to the output file.
"""
self.filepath = os.path.abspath(filepath)
self.workdir = os.path.abspath(os.path.dirname(filepath))
self.run_completed = False
self._errors = []
self._warnings = []
@property
def errors(self) -> list[str]:
"""List of strings with possible errors reported by the generator at run-time."""
return self._errors
@property
def warnings(self) -> list[str]:
"""List of strings with possible errors reported by the generator at run-time."""
return self._warnings
[docs]
@abc.abstractmethod
def get_results(self) -> dict:
"""Return the most important results in a dictionary."""