sjs/vdirsyncer
1
0
Fork 0
mirror of https://github.com/samsonjs/vdirsyncer.git synced 2026-03-25 08:55:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document checkfile()

Browse source
This commit is contained in:
Hugo Osvaldo Barrera 2025-04-09 14:00:40 +02:00
parent 17e43fd633
commit ecdd565be4
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
vdirsyncer/utils.py
View file

@ -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):