Generalized error messages for not implmented

src/fiat/gis/crs.py

@@ -2,13 +2,15 @@
 
 from osgeo import osr
 
+from fiat.util import DD_NOT_IMPLEMENTED
+
 
 def get_srs_repr(
     srs: osr.SpatialReference,
 ) -> str:
     """_summary_."""
     if srs is None:
-        raise ValueError("SRS can not be None.")
+        raise ValueError("'srs' can not be 'None'.")
     _auth_c = srs.GetAuthorityCode(None)
     _auth_n = srs.GetAuthorityName(None)
 
@@ -31,7 +33,7 @@ def __del__(self):
         pass
 
     def __eq__(self, other):
-        pass
+        raise NotImplementedError(DD_NOT_IMPLEMENTED)
 
     @classmethod
     def from_user_input(

src/fiat/io.py

@@ -17,8 +17,12 @@
 
 from fiat.error import DriverNotFoundError
 from fiat.util import (
+    DD_NEED_IMPLEMENTED,
+    DD_NOT_IMPLEMENTED,
     GEOM_DRIVER_MAP,
     GRID_DRIVER_MAP,
+    NEED_IMPLEMENTED,
+    NOT_IMPLEMENTED,
     DummyLock,
     _dtypes_from_string,
     _dtypes_reversed,
@@ -121,7 +125,7 @@ def closed(self):
 
     @abstractmethod
     def flush(self):
-        raise NotImplementedError("Method needs to be implemented.")
+        raise NotImplementedError(NEED_IMPLEMENTED)
 
 
 class _BaseHandler(metaclass=ABCMeta):
@@ -144,7 +148,7 @@ def __del__(self):
 
     @abstractmethod
     def __repr__(self):
-        raise NotImplementedError("Dunder method needs to be implemented.")
+        raise NotImplementedError(DD_NEED_IMPLEMENTED)
 
     def __enter__(self):
         return super().__enter__()
@@ -163,7 +167,7 @@ def __init__(self):
 
     @abstractmethod
     def __del__(self):
-        raise NotImplementedError("Dunder method needs to be implemented.")
+        raise NotImplementedError(DD_NEED_IMPLEMENTED)
 
     def __repr__(self):
         _mem_loc = f"{id(self):#018x}".upper()
@@ -775,7 +779,7 @@ def _write(
         data : array
             _description_
         """
-        raise NotImplementedError("Method not yet implemented")
+        raise NotImplementedError(NOT_IMPLEMENTED)
 
     @_BaseIO._check_mode
     def write_chunk(
@@ -1139,7 +1143,7 @@ def copy_layer(
 
     def _get_layer(self, l_id):
         """_summary_."""
-        raise NotImplementedError("Method not yet implemented.")
+        raise NotImplementedError(NOT_IMPLEMENTED)
 
     @_BaseIO._check_state
     def get_srs(self):
@@ -1581,7 +1585,7 @@ def _write_array(
         band: int,
     ):
         """_summary_."""
-        raise NotImplementedError("Method not yet implemented.")
+        raise NotImplementedError(NOT_IMPLEMENTED)
 
 
 class _Table(_BaseStruct, metaclass=ABCMeta):
@@ -1638,7 +1642,7 @@ def __len__(self):
 
     @abstractmethod
     def __getitem__(self, key):
-        raise NotImplementedError("Dunder method needs to be implemented.")
+        raise NotImplementedError(DD_NEED_IMPLEMENTED)
 
     # @abstractmethod
     # def __iter__(self):
@@ -1712,10 +1716,10 @@ def __init__(
         )
 
     def __iter__(self):
-        raise NotImplementedError("Dunder method needs to be implemented.")
+        raise NotImplementedError(DD_NOT_IMPLEMENTED)
 
     def __next__(self):
-        raise NotImplementedError("Dunder method needs to be implemented.")
+        raise NotImplementedError(DD_NOT_IMPLEMENTED)
 
     def __getitem__(self, keys):
         """_summary_."""
@@ -1733,7 +1737,7 @@ def __setitem__(self, key, value):
         self.data[key] = value
 
     def __eq__(self, other):
-        raise NotImplementedError("Dunder method needs to be implemented.")
+        raise NotImplementedError(DD_NOT_IMPLEMENTED)
 
     def __str__(self):
         if len(self.columns) > 6:
@@ -1791,7 +1795,7 @@ def _build_from_dict(
         data: dict,
     ):
         """_summary_."""
-        raise NotImplementedError("Method not yet implemented.")
+        raise NotImplementedError(NOT_IMPLEMENTED)
 
     def _build_from_list(
         self,
@@ -1802,11 +1806,11 @@ def _build_from_list(
 
     def mean(self):
         """_summary_."""
-        raise NotImplementedError("Method not yet implemented.")
+        raise NotImplementedError(NOT_IMPLEMENTED)
 
     def max(self):
         """_summary_."""
-        raise NotImplementedError("Method not yet implemented.")
+        raise NotImplementedError(NOT_IMPLEMENTED)
 
     def upscale(
         self,
@@ -1915,10 +1919,10 @@ def __init__(
         )
 
     def __iter__(self):
-        raise NotImplementedError("Dunder method needs to be implemented.")
+        raise NotImplementedError(DD_NOT_IMPLEMENTED)
 
     def __next__(self):
-        raise NotImplementedError("Dunder method needs to be implemented.")
+        raise NotImplementedError(DD_NOT_IMPLEMENTED)
 
     def __getitem__(
         self,
@@ -1935,7 +1939,7 @@ def __getitem__(
         return self.data.readline().strip()
 
     def _build_lazy(self):
-        raise NotImplementedError("Method not yet implemented.")
+        raise NotImplementedError(NOT_IMPLEMENTED)
 
     def get(
         self,

src/fiat/log.py

@@ -14,6 +14,8 @@
 from string import Formatter as StrFormatter
 from warnings import warn
 
+from fiat.util import NOT_IMPLEMENTED
+
 DEFAULT_FMT = "{asctime:20s}{levelname:8s}{message}"
 DEFAULT_TIME_FMT = "%Y-%m-%d %H:%M:%S"
 STREAM_COUNT = 1
@@ -236,11 +238,11 @@ def close(self):
 
     def emit(self):
         """_summary_."""
-        NotImplementedError("Method not yet implemented.")
+        NotImplementedError(NOT_IMPLEMENTED)
 
     def flush(self):
         """_summary_."""
-        NotImplementedError("Method not yet implemented.")
+        NotImplementedError(NOT_IMPLEMENTED)
 
     def format(
         self,
@@ -768,7 +770,7 @@ def level(
 
     def _direct(self, msg):
         """_summary_."""
-        raise NotImplementedError("Method not yet implemented.")
+        raise NotImplementedError(NOT_IMPLEMENTED)
 
     @handle_log
     def debug(self, msg: str):

src/fiat/models/base.py

@@ -20,7 +20,7 @@
 from fiat.io import open_csv, open_grid
 from fiat.log import spawn_logger
 from fiat.models.calc import calc_rp_coef
-from fiat.util import deter_dec
+from fiat.util import NEED_IMPLEMENTED, deter_dec
 
 logger = spawn_logger("fiat.model")
 
@@ -229,11 +229,11 @@ def _set_num_threads(
         self,
     ):
         """_summary_."""
-        raise NotImplementedError("Method needs to be implemented.")
+        raise NotImplementedError(NEED_IMPLEMENTED)
 
     @abstractmethod
     def run(
         self,
     ):
         """_summary_."""
-        raise NotImplementedError("Method needs to be implemented.")
+        raise NotImplementedError(NEED_IMPLEMENTED)

src/fiat/util.py

@@ -16,8 +16,12 @@
 from osgeo import gdal
 
 BLACKLIST = type, ModuleType, FunctionType
+DD_NEED_IMPLEMENTED = "Dunder method needs to be implemented."
+DD_NOT_IMPLEMENTED = "Dunder method not yet implemented."
 FILE_ATTRIBUTE_HIDDEN = 0x02
 NEWLINE_CHAR = os.linesep
+NEED_IMPLEMENTED = "Method needs to be implemented."
+NOT_IMPLEMENTED = "Method not yet implemented."
 
 
 _dtypes = {