[KiRi][Added] Support for uninitialized submodules

Closes #888

Author: set-soft

CHANGELOG.md

@@ -26,6 +26,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - BoM: descriptive error when using `kicad` format and no options found.
 - DRC/ERC: Configurable logo (#889)
 - iBoM: `mark_when_checked` option (#881)
+- KiRi: Support for uninitialized submodules (#888)
 - Report: `buried_vias_count` for KiCad 10
 
 ### Fixed

docs/source/Changelog.rst

@@ -48,6 +48,7 @@ Added
    found.
 -  DRC/ERC: Configurable logo (#889)
 -  iBoM: ``mark_when_checked`` option (#881)
+-  KiRi: Support for uninitialized submodules (#888)
 -  Report: ``buried_vias_count`` for KiCad 10
 
 Fixed

kibot/kiplot.py

@@ -155,10 +155,15 @@ def _run_command(command, change_to):
     return run(command, check=True, stdout=PIPE, stderr=STDOUT, cwd=change_to)
 
 
-def run_command(command, change_to=None, just_raise=False, use_x11=False, err_msg=None, err_lvl=FAILED_EXECUTE):
+def run_command(command, change_to=None, just_raise=False, use_x11=False, err_msg=None, err_lvl=FAILED_EXECUTE,
+                force_en=False):
     logger.debug('- Executing: '+GS.pasteable_cmd(command))
     if change_to is not None:
         logger.debug('- CWD: '+change_to)
+    old_lang = None
+    if force_en:
+        old_lang = os.environ['LANG']
+        os.environ['LANG'] = 'en'
     try:
         if use_x11 and not GS.on_windows:
             logger.debug('Using Xvfb to run the command')
@@ -173,6 +178,10 @@ def run_command(command, change_to=None, just_raise=False, use_x11=False, err_ms
         if err_msg is not None:
             err_msg = err_msg.format(ret=e.returncode)
         GS.exit_with_error(err_msg, err_lvl, e)
+    finally:
+        if old_lang is not None:
+            os.environ['LANG'] = old_lang
+
     msg = try_decode_utf8(res.stdout, 'output from command', logger)
     debug_output(msg)
     return msg.rstrip()

kibot/misc.py

@@ -345,6 +345,7 @@
 W_IBOMNOCHK = '(W177) '
 W_PREREDEF = '(W178) '
 W_BURIEDVIAS = '(W179) '
+W_BADGITREPO = '(W180) '
 # Somehow arbitrary, the colors are real, but can be different
 PCB_MAT_COLORS = {'fr1': "937042", 'fr2': "949d70", 'fr3': "adacb4", 'fr4': "332B16", 'fr5': "6cc290"}
 PCB_FINISH_COLORS = {'hal': "8b898c", 'hasl': "8b898c", 'imag': "8b898c", 'enig': "cfb96e", 'enepig': "cfb96e",

kibot/out_any_diff.py

@@ -70,7 +70,7 @@ def add_to_cache(self, name, hash):
     def run_git(self, cmd, cwd=None, just_raise=False):
         if cwd is None:
             cwd = self.repo_dir
-        return run_command([self.git_command]+cmd, change_to=cwd, just_raise=just_raise)
+        return run_command([self.git_command]+cmd, change_to=cwd, just_raise=just_raise, force_en=True)
 
     def git_dirty(self, file=None):
         ops = ['status', '--porcelain', '-uno']

kibot/out_kiri.py

@@ -28,12 +28,13 @@
     pass
 import os
 from shutil import copy2, rmtree
+from subprocess import CalledProcessError
 from .error import KiPlotConfigurationError
 from .gs import GS
 from .kicad.color_theme import load_color_theme
 from .kiplot import load_any_sch
 from .layer import Layer
-from .misc import W_NOTHCMP
+from .misc import W_NOTHCMP, W_BADGITREPO, try_decode_utf8
 from .out_any_diff import AnyDiffOptions, has_repo
 from .macros import macros, document, output_class  # noqa: F401
 from . import log
@@ -297,7 +298,16 @@ def run(self, name):
                     git_tmp_wd = GS.mkdtemp('kiri-checkout')
                     logger.debug('Checking out '+hash+' to '+git_tmp_wd)
                     self.run_git(['worktree', 'add', '--detach', '--force', git_tmp_wd, hash])
-                    self.run_git(['submodule', 'update', '--init', '--recursive'], cwd=git_tmp_wd)
+                    try:
+                        self.run_git(['submodule', 'update', '--init', '--recursive'], cwd=git_tmp_wd, just_raise=True)
+                    except CalledProcessError as e:
+                        if b'No url found for submodule' in e.output:
+                            # Just an uninitialized submodule, report it and continue, see #888
+                            logger.warning(W_BADGITREPO+f"Broken git repo: {e}")
+                            msg = try_decode_utf8(e.output, 'output from command', logger)
+                            logger.warning(W_BADGITREPO+msg)
+                        else:
+                            raise
                     # Generate SVGs for the schematic
                     name_sch = self.do_cache(self.sch_rel_name, git_tmp_wd, hash)
                     # Generate SVGs for the PCB