Island: Add ValueError to IFileRepository docstring

This commit is contained in:
Mike Salvatore 2022-06-21 13:16:00 -04:00
parent 5c97d6bdbf
commit f60c2f1dde
1 changed files with 3 additions and 0 deletions

View File

@ -20,6 +20,7 @@ class IFileRepository(metaclass=abc.ABCMeta):
:param unsafe_file_name: An unsanitized file name that will identify the file
:param file_contents: The data to be stored in the file
:raises ValueError: If the file name is an attempted directory traversal
"""
pass
@ -32,6 +33,7 @@ class IFileRepository(metaclass=abc.ABCMeta):
:return: A file-like object providing access to the file's contents
:raises FileNotFoundError: if the file does not exist
:raises RetrievalError: if the file exists but cannot be retrieved
:raises ValueError: If the file name is an attempted directory traversal
"""
pass
@ -44,6 +46,7 @@ class IFileRepository(metaclass=abc.ABCMeta):
idempotent and will succeed if the file to be deleted does not exist.
:param unsafe_file_name: An unsanitized file name that identifies the file to be deleted
:raises ValueError: If the file name is an attempted directory traversal
"""
pass