Skip to content

git_submodules

admin.git_submodules

check_submodules 

check_submodules()

Function checking the status of Git submodules

Source code in yaptide/admin/git_submodules.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
def check_submodules():
    """Function checking the status of Git submodules"""
    try:
        git_path = find_git_executable()

        if git_path is None:
            logging.info("Git executable not found")
            check_submodules_folders_exist()
            return

        logging.info("Found git executable path: %s", git_path)
        result = subprocess.run([git_path, "submodule", "status"], capture_output=True, text=True, check=True)
        for line in result.stdout.splitlines():
            if line.startswith('-') or line.startswith('+'):
                submodule_name = line.split()[-1]
                raise RuntimeError(
                    f"Submodule: '{submodule_name}' is missing! Please use: git submodule update --init --recursive")

    except subprocess.CalledProcessError as e:
        logging.error("Error running 'git submodule status': %s", e)

check_submodules_folders_exist 

check_submodules_folders_exist()

Function checking if submodules folders exists on system

Source code in yaptide/admin/git_submodules.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
def check_submodules_folders_exist():
    """Function checking if submodules folders exists on system"""
    with open('.gitmodules') as f:
        logging.info("Found .gitmodules file")
        for line in f:
            if 'path' in line:
                logging.info("Found submodule line in .gitmodules: %s", line)
                submodule_path = line.split('=')[-1].strip()

                # Check if folder exists and is not empty
                if not Path(submodule_path).exists() or not list(Path(submodule_path).iterdir()):
                    submodule_name = submodule_path.split("/")[-1]
                    raise RuntimeError(
                        f"Submodule: '{submodule_name}' is missing! Please use: git submodule update --init --recursive"
                    )

find_git_executable 

find_git_executable()

Function returns git executable path or None

Source code in yaptide/admin/git_submodules.py 
 7
 8
 9
10
def find_git_executable():
    """Function returns git executable path or None"""
    git_path = shutil.which('git')
    return git_path