Function is_gitignored

ggshield/utils/git_shell.py:492–503

Returns True if the path is ignored by git, False if it is not, or None if git is not available or the directory is not a git repository. :param path: path to the file or directory to check

(path: Path)

def is_gitignored(path: Path) -> Optional[bool]:
    """
    Returns True if the path is ignored by git, False if it is not,
        or None if git is not available or the directory is not a git repository.
    :param path: path to the file or directory to check
    """
    working_dir = Path.cwd()
    if not is_git_available() or not is_git_dir(working_dir):
        return None
    else:
        res = git(["check-ignore", "--", path.as_posix()], cwd=working_dir, check=False)
        return res == path.as_posix()


def gitignore(path: Path):