Skip to content
  • API documentation
  • careamics
  • utils
  • path_utils

path_utils

Utility functions for paths.

check_path_exists(path) #

Check if a path exists. If not, raise an error.

Note that it returns path as a Path object.

Parameters:

Name Type Description Default
path Union[str, Path]

Path to check.

 required

Returns:

Type Description
Path

Path as a Path object.
Source code in src/careamics/utils/path_utils.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
def check_path_exists(path: Union[str, Path]) -> Path:
    """Check if a path exists. If not, raise an error.

    Note that it returns `path` as a Path object.

    Parameters
    ----------
    path : Union[str, Path]
        Path to check.

    Returns
    -------
    Path
        Path as a Path object.
    """
    path = Path(path)
    if not path.exists():
        raise FileNotFoundError(f"Data path {path} is incorrect or does not exist.")

    return path