Added exception to base class

Author: sgaisser

src/cfdppy/filestore.py

@@ -38,6 +38,8 @@ def read_data(self, file: Path, offset: int | None, read_len: int) -> bytes:
         :param offset: Offset to read from
         :param read_len: Number of bytes to read
         :return: The read data
+        :raises PermissionError: In case the file is not readable
+        :raises FileNotFoundError: In case the file does not exist.
         """
 
     @abc.abstractmethod
@@ -55,7 +57,7 @@ def is_directory(self, path: Path) -> bool:
         """Check if a given path is a directory.
 
         :param path: Path to check
-        :return: True if the path is
+        :return: True if the path is a directory
         """
 
     @abc.abstractmethod
@@ -79,6 +81,7 @@ def truncate_file(self, file: Path) -> None:
         """Truncate a file to zero bytes.
 
         :param file: File to truncate
+        :raises FileNotFoundError: In case the file does not exist
         """
 
     @abc.abstractmethod
@@ -87,16 +90,21 @@ def file_size(self, file: Path) -> int:
 
         :param file: File to get the size of as number of bytes
         :return: Size of the file in bytes
+        :raises FileNotFoundError: In case the file does not exist
         """
 
     @abc.abstractmethod
     def write_data(self, file: Path, data: bytes, offset: int | None) -> None:
         """This is not used as part of a filestore request, it is used to build up the received
         file.
 
+        The file needs to exist before writing to it.
+
         :param file: File to write to
         :param data: Data to write
         :param offset: Offset to write, may be None for no offset
+        :raises PermissionError: In case the file is not writable
+        :raises FileNotFoundError: In case the file does not exist
         """
 
     @abc.abstractmethod