From ecdd565be4703c67a442ee4d73e98b8903da1953 Mon Sep 17 00:00:00 2001 From: Hugo Osvaldo Barrera Date: Wed, 9 Apr 2025 14:00:40 +0200 Subject: [PATCH] Document checkfile() --- vdirsyncer/utils.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/vdirsyncer/utils.py b/vdirsyncer/utils.py index b1925c6..f5a5581 100644 --- a/vdirsyncer/utils.py +++ b/vdirsyncer/utils.py @@ -127,12 +127,13 @@ def checkdir(path: str, create: bool = False, mode: int = 0o750) -> None: raise exceptions.CollectionNotFound(f"Directory {path} does not exist.") -def checkfile(path, create=False): - """ - Check whether ``path`` is a file. +def checkfile(path, create=False) -> None: + """Check whether ``path`` is a file. :param create: Whether to create the file's parent directories if they do not exist. + :raises CollectionNotFound: if path does not exist. + :raises OSError: if path exists but is not a file. """ checkdir(os.path.dirname(path), create=create) if not os.path.isfile(path):