lbkit 0.9.11__tar.gz → 0.9.12__tar.gz

{lbkit-0.9.11 → lbkit-0.9.12}/MANIFEST.in

@@ -1,3 +1,4 @@
 recursive-include lbkit/codegen/template *.mako
+include lbkit/codegen/.clang-format
 recursive-include lbkit/tasks/template *.mako
 recursive-include lbkit/component/template *.mako

{lbkit-0.9.11/lbkit.egg-info → lbkit-0.9.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lbkit
-Version: 0.9.11
+Version: 0.9.12
 Summary: Tools provided by litebmc.com
 Home-page: https://www.litebmc.com
 Author: xuhj@litebmc.com

lbkit-0.9.12/lbkit/__commit__.py

@@ -0,0 +1 @@
+__commit__ = 'e5ea324'

lbkit-0.9.12/lbkit/__init__.py

@@ -0,0 +1,2 @@
+
+__version__ = '0.9.12'

lbkit-0.9.12/lbkit/codegen/.clang-format

@@ -0,0 +1,70 @@
+---
+# LiteBMC 代码生成默认格式化配置
+# 参考 Linux 内核风格, 适配 GLib/C 项目
+# BasedOnStyle: LLVM
+
+AccessModifierOffset: -4
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: Left
+AlignOperands: true
+AlignTrailingComments: false
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: None
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+BinPackArguments: true
+BinPackParameters: true
+BraceWrapping:
+  AfterControlStatement: false
+  AfterEnum: false
+  AfterFunction: true
+  AfterStruct: false
+  BeforeCatch: false
+  BeforeElse: false
+  IndentBraces: false
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Custom
+BreakBeforeTernaryOperators: false
+BreakStringLiterals: false
+ColumnLimit: 120
+CommentPragmas: '^ IWYU pragma:'
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: false
+DerivePointerAlignment: false
+FixNamespaceComments: false
+IndentCaseLabels: false
+IndentGotoLabels: false
+IndentPPDirectives: None
+IndentWidth: 4
+IndentWrappedFunctionNames: false
+KeepEmptyLinesAtTheStartOfBlocks: false
+MaxEmptyLinesToKeep: 1
+PointerAlignment: Right
+ReflowComments: false
+SortIncludes: false
+SpaceAfterCStyleCast: false
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: ControlStatementsExceptForEachMacros
+SpacesBeforeTrailingComments: 1
+SpacesInAngles: false
+SpacesInContainerLiterals: false
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+TabWidth: 4
+UseTab: Never
+PenaltyBreakAssignment: 10
+PenaltyBreakBeforeFirstCallParameter: 30
+PenaltyBreakComment: 10
+PenaltyBreakFirstLessLess: 0
+PenaltyBreakString: 10
+PenaltyExcessCharacter: 100
+PenaltyReturnTypeOnItsOwnLine: 60

{lbkit-0.9.11 → lbkit-0.9.12}/lbkit/codegen/codegen.py

@@ -13,6 +13,8 @@ import re
 import json
 import yaml
 import argparse
+import shutil
+import subprocess
 from concurrent.futures import ProcessPoolExecutor, as_completed
 from lbkit.codegen.idf_interface import IdfInterface
 
@@ -68,45 +70,93 @@ class Version():
             return True
         return False
 
-# 历史自动生成版本号，计划用于用于生成代码稳定性测试
-# TODO： 支持生成代码稳定性测试，确保生成的代码一致性
+# 历史自动生成版本号，用于管理代码生成版本与lb_base的兼容性
+# 新增兼容性变更时添加条目，格式："版本号": CodeGenHistory("lb_base依赖范围", "变更描述", "compatible_required值")
 history_versions = {
-    "5.3": CodeGenHistory("lb_base/[>=0.8.5 <0.9.0]", "支持32位操作系统", "8004"),
     "5.4": CodeGenHistory("lb_base/[>=0.9.0 <0.10.0]", "LBInterface增加alias", "9000"),
 }
+
+# 最新的版本号
 __version__=Version("5.4")
 
 
 def version_check(ver_str: str):
     if not re.match("^([0-9]|([1-9][0-9]*))\\.([0-9]|([1-9][0-9]*))$", ver_str):
         raise Exception(f"Version string {ver_str} not match with regex ^([0-9]|([1-9][0-9]*))\\.([0-9]|([1-9][0-9]*))$")
-    if "x" not in ver_str:
+    if history_versions.get(ver_str):
+        return ver_str
+    if not history_versions:
         return ver_str
-    if not history_versions.get(ver_str):
-        log.error(f"Unkonw codegen version {ver_str}, supported versions:")
-        for ver, msg in history_versions.items():
-            log.error(f"    {ver}: {msg}")
-        raise Exception(f"Can't found the valid version for {ver_str}")
-
-def codegen_version_max():
-    max_v = __version__
-    for ver_str, _ in history_versions.items():
-        next_ver = Version(ver_str)
-        if next_ver.bt(max_v.str):
-            max_v = next_ver
-    return max_v.str
+    log.error(f"Unkonw codegen version {ver_str}, supported versions:")
+    for ver, msg in history_versions.items():
+        log.error(f"    {ver}: {msg}")
+    raise Exception(f"Can't found the valid version for {ver_str}")
 
 def codegen_version_arg(parser: argparse.ArgumentParser, default=__version__.str, short_arg="-cv", full_arg="--codegen_version"):
-    # 默认的自动生成工具版本号为2
-    help=f'''must less than or equal to {codegen_version_max()}, default: {default}
-
-        codegen versions:
-        '''
+    help=f'''default: {default}'''
     for ver, detail in history_versions.items():
-        help += f"- {ver}: compatible with {detail.lb_base}, {detail.description}\n"
+        help += f"\n    - {ver}: compatible with {detail.lb_base}, {detail.description}"
     parser.add_argument(short_arg, full_arg, help=help, type=str, default=__version__.str)
 
 
+def _find_clang_format_config(idf_file):
+    """查找 .clang-format 配置文件，优先级：IDF目录 > 组件目录 > toolkit默认"""
+    # 优先级1：IDF文件所在目录（接口仓库级配置）
+    idf_dir = os.path.dirname(os.path.realpath(idf_file))
+    candidate = os.path.join(idf_dir, ".clang-format")
+    if os.path.isfile(candidate):
+        return candidate
+    # 优先级2：组件源码目录（组件仓库级配置）
+    candidate = os.path.join(os.getcwd(), ".clang-format")
+    if os.path.isfile(candidate):
+        return candidate
+    # 优先级3：toolkit自带的默认配置
+    candidate = os.path.join(lb_cwd, ".clang-format")
+    if os.path.isfile(candidate):
+        return candidate
+    return None
+
+
+def _format_generated_files(idf_file, directory, interface_alias):
+    """使用 clang-format 格式化生成的 .c 和 .h 文件"""
+    clang_format_bin = shutil.which("clang-format")
+    if not clang_format_bin:
+        log.warn("clang-format not found, skipping auto-formatting of generated files")
+        return
+
+    style_file = _find_clang_format_config(idf_file)
+    if not style_file:
+        log.warn("No .clang-format config found, skipping auto-formatting")
+        return
+
+    files_to_format = []
+    for ct in ["server", "client", "public"]:
+        ct_dir = os.path.join(directory, ct)
+        if not os.path.isdir(ct_dir):
+            continue
+        for ext in [".c", ".h"]:
+            fpath = os.path.join(ct_dir, interface_alias + ext)
+            if os.path.isfile(fpath):
+                files_to_format.append(fpath)
+
+    if not files_to_format:
+        return
+
+    log.debug(f"Formatting {len(files_to_format)} generated files with clang-format (style: {style_file})")
+    for fpath in files_to_format:
+        try:
+            subprocess.run(
+                [clang_format_bin, f"--style=file:{style_file}", "-i", fpath],
+                check=True, capture_output=True, timeout=30
+            )
+        except subprocess.TimeoutExpired:
+            log.warn(f"clang-format timed out on {fpath}, skipping")
+        except subprocess.CalledProcessError as e:
+            log.warn(f"clang-format failed on {fpath}: {e.stderr.strip() if e.stderr else 'unknown error'}")
+        except Exception as e:
+            log.warn(f"clang-format error on {fpath}: {str(e)}")
+
+
 def _gen_interface(idf_file, directory=".", code_type="all", codegen_version_str="5.4", log_level="NOTSET"):
     """模块级函数，供多进程调用"""
     directory = os.path.realpath(directory)
@@ -143,6 +193,8 @@ def _gen_interface(idf_file, directory=".", code_type="all", codegen_version_str
     with open(json_file, "w", encoding="utf-8") as fp:
         yaml.dump(data, fp, encoding='utf-8', allow_unicode=True)
 
+    _format_generated_files(idf_file, directory, interface.alias)
+
 
 class CodeGen(object):
     def __init__(self, args):
@@ -221,7 +273,7 @@ class CodeGen(object):
             raise ArgException(f"argument error, arguments -c/--cdf_file and -i/--idf_file are not set")
         if not os.path.isfile(intf_file):
             raise ArgException(f"argument -i/--idf_file: {args.idf_file} not exist")
-        if self.codegen_version.bt(codegen_version_max()):
+        if self.codegen_version.bt(__version__.str):
             raise ArgException(f"argument -cv/--codegen_version: validate failed, must less than or equal to {__version__.str}")
         out_dir = os.path.join(os.getcwd(), args.directory)
         if not intf_file.endswith(".yaml"):

{lbkit-0.9.11 → lbkit-0.9.12}/lbkit/codegen/template/client.c.mako

@@ -91,10 +91,8 @@ static LBInterface _${class_name}_interface = {
     .name = "${intf.name}",
     .properties = (LBProperty *)&${properties},
     .interface = NULL, /* load from usr/share/dbus-1/interfaces/${intf.name}.xml by lb_init */
-#ifdef LB_CODEGEN_BE_5_4
     .alias = "${class_name}",
     .object_template = "${intf.object_path}",
-#endif
 };
 
 static LBBase *_get_real_object(LBO *obj)

{lbkit-0.9.11 → lbkit-0.9.12}/lbkit/codegen/template/public.c.mako

@@ -1045,7 +1045,6 @@ static LBBase *_get_real_object(LBO *obj)
 % endif
 <% prop_idx = 0 %>\
 % for prop in intf.properties:
-#ifdef LB_CODEGEN_BE_5_2
 % if (prop.signature in ["b", "y", "n", "q", "i", "u", "x", "t", "d", "o", "s", "g", "ab", "ay", "an", "aq", "ai", "au", "ax", "at", "ad", "as", "ao", "ag"] and prop.val_validate()):
 static gboolean ${class_name}_check_${prop.name}_variant(LBO *obj, GVariant *value, GError **error)
 {
@@ -1080,7 +1079,6 @@ static gboolean ${class_name}_check_${prop.name}_variant(LBO *obj, GVariant *val
 }
 
 % endif
-#endif
 static void ${class_name}_set_${prop.name}_variant(LBO *obj, GVariant *value)
 {
     g_assert(value && obj);
@@ -1126,7 +1124,6 @@ static ${class_name}_Properties _${class_name}_properties =
         .flags = ${prop.desc_flags},
         .set = ${class_name}_set_${prop.name}_variant,
         .get = _${class_name}_get_${prop.name}_variant,
-#ifdef LB_CODEGEN_BE_5_2
 % if (prop.signature in ["b", "y", "n", "q", "i", "u", "x", "t", "d", "o", "s", "g", "ab", "ay", "an", "aq", "ai", "au", "ax", "at", "ad", "as", "ao", "ag"] and prop.val_validate()):
         .check = ${class_name}_check_${prop.name}_variant,
 % else:
@@ -1152,7 +1149,6 @@ static ${class_name}_Properties _${class_name}_properties =
         % endif
     % endif
 % endif
-#endif
     },
 <% id = id + 1 %>\
 <% prop_idx = prop_idx + 1 %>\

{lbkit-0.9.11 → lbkit-0.9.12}/lbkit/codegen/template/server.c.mako

@@ -93,17 +93,13 @@ static LBInterface _${class_name}_interface = {
     .name = "${intf.name}",
     .properties = (LBProperty *)&${properties},
     .interface = NULL,  /* load from usr/share/dbus-1/interfaces/${intf.name} by lb_init */
-#ifdef LB_CODEGEN_BE_5_2
     % if intf.plugin.install_dir:
     .plugin_dir = "${intf.plugin.install_dir}",
     % else:
     .plugin_dir = "/opt/litebmc/plugins/${class_name}",
     % endif
-#endif
-#ifdef LB_CODEGEN_BE_5_4
     .alias = "${class_name}",
     .object_template = "${intf.object_path}",
-#endif
 };
 
 <% prop_idx = 0 %>\

{lbkit-0.9.11 → lbkit-0.9.12}/lbkit/component/build.py

@@ -105,7 +105,8 @@ class BuildComponent():
         for pkg_option in self.options.pkg_options:
             self.base_cmd += " -o " + pkg_option
         self.base_cmd += f" -o */*:codegen_version={self.options.codegen_version}"
-        self.base_cmd += f" -o */*:compatible_required={self.codegen_version.info.lb_base_compatible_required}"
+        if self.codegen_version.info:
+            self.base_cmd += f" -o */*:compatible_required={self.codegen_version.info.lb_base_compatible_required}"
 
     @staticmethod
     def _check_conanfile_if_tracked():

{lbkit-0.9.11 → lbkit-0.9.12}/lbkit/component/template/deploy.mako

@@ -66,7 +66,9 @@ class DeployConan(ConanFile):
         pass
 
     def configure(self):
+% if codegen_version.info:
         self.options["lb_base"].compatible_required = "${codegen_version.info.lb_base_compatible_required}"
+% endif
 % if len(pkg.get("requires", {})) > 0:
     % for conan in pkg["requires"].get("compile", []):
         % if conan.get("option") is not None:

{lbkit-0.9.11 → lbkit-0.9.12}/lbkit/tasks/task_build_rootfs.py

@@ -65,8 +65,6 @@ class TaskClass(Task):
                 chunk = line.split()
                 if len(chunk) < 5:
                     raise errors.PermissionFormatError(f"Permission format with error, line: {line}")
-                if not chunk[0].startswith("/"):
-                    raise errors.PermissionFormatError(f"Permission file error, must begin with \"/\", get: {chunk[0]}")
                 if (chunk[2] != "-" and not chunk[2].isnumeric()):
                     raise errors.PermissionFormatError(f"Permission mode error, must is numeric or '-', get({chunk[2]})")
                 if (chunk[3] != "-" and not chunk[3].isnumeric()) or (chunk[4] != "-" and not chunk[4].isnumeric()):

{lbkit-0.9.11 → lbkit-0.9.12/lbkit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lbkit
-Version: 0.9.11
+Version: 0.9.12
 Summary: Tools provided by litebmc.com
 Home-page: https://www.litebmc.com
 Author: xuhj@litebmc.com

{lbkit-0.9.11 → lbkit-0.9.12}/lbkit.egg-info/SOURCES.txt

@@ -20,6 +20,7 @@ lbkit.egg-info/entry_points.txt
 lbkit.egg-info/requires.txt
 lbkit.egg-info/top_level.txt
 lbkit/ci_robot/__init__.py
+lbkit/codegen/.clang-format
 lbkit/codegen/__init__.py
 lbkit/codegen/codegen.py
 lbkit/codegen/ctype_defination.py

{lbkit-0.9.11 → lbkit-0.9.12}/test/test_codegen.py

@@ -18,6 +18,7 @@ from lbkit import errors
 from lbkit.codegen.codegen import __version__ as codegen_version
 from lbkit.codegen.codegen import history_versions as codegen_history
 from lbkit.codegen.codegen import Version, CodeGen
+from lbkit.codegen.codegen import _find_clang_format_config
 from lbkit.misc import load_json_schema
 from jsonschema import validate, ValidationError
 
@@ -977,5 +978,103 @@ class TestServerGetterClass(unittest.TestCase):
         body = self._assert_getter_in_source(server_h, "path")
         self.assertIn("g_variant_get_string", body)
 
+
+class TestClangFormatClass(unittest.TestCase):
+    """测试代码生成后的 clang-format 自动格式化"""
+    intf_yaml = None
+    intf_out = None
+    tmp_dir = None
+
+    @classmethod
+    def setUpClass(cls) -> None:
+        cls.tmp_dir = tempfile.mktemp(prefix="clang_format_test", suffix=".output")
+        cls.intf_yaml = os.path.join(cls.tmp_dir, "test.yaml")
+        cls.intf_out = os.path.join(cls.tmp_dir, "output")
+        return super().setUpClass()
+
+    @classmethod
+    def tearDownClass(cls) -> None:
+        shutil.rmtree(cls.tmp_dir)
+        return super().tearDownClass()
+
+    def setUp(self):
+        shutil.rmtree(self.tmp_dir, ignore_errors=True)
+        os.makedirs(self.tmp_dir)
+        os.makedirs(self.intf_out)
+        return super().setUp()
+
+    def _mk_interface(self):
+        with open(self.intf_yaml, mode="w+") as fp:
+            fp.write(f"# yaml-language-server: $schema={schema_dir}/idf.v2.json\n")
+            fp.write("version: 1\n")
+            fp.write("description: 测试clang-format格式化\n")
+            fp.write("interface: com.litebmc.FormatTest\n")
+            fp.write("properties:\n")
+            fp.write("   - name: count\n")
+            fp.write("     description: count\n")
+            fp.write("     type: int32\n")
+
+    def test_clang_format_applied(self):
+        """验证代码生成后文件存在且格式化正常（若 clang-format 可用）"""
+        self._mk_interface()
+        args = ["-d", self.intf_out, "-i", self.intf_yaml]
+        gen = CodeGen(args)
+        gen.run()
+        for ct in ["server", "client", "public"]:
+            h_file = os.path.join(self.intf_out, ct, "test.h")
+            c_file = os.path.join(self.intf_out, ct, "test.c")
+            self.assertTrue(os.path.isfile(h_file), f"{ct}/test.h should exist")
+            self.assertTrue(os.path.isfile(c_file), f"{ct}/test.c should exist")
+
+    def test_config_lookup_idf_priority(self):
+        """验证 .clang-format 查找优先级：IDF目录 > 组件目录 > toolkit默认"""
+        self._mk_interface()
+        # 在IDF目录创建 .clang-format
+        idf_clang = os.path.join(self.tmp_dir, ".clang-format")
+        with open(idf_clang, "w") as f:
+            f.write("---\nBasedOnStyle: LLVM\n")
+        result = _find_clang_format_config(self.intf_yaml)
+        self.assertEqual(result, idf_clang)
+
+    def test_config_lookup_component_priority(self):
+        """验证无IDF目录配置时回退到组件目录"""
+        self._mk_interface()
+        # 不在IDF目录创建，只在当前目录（组件目录）创建
+        import unittest.mock
+        comp_dir = os.path.join(self.tmp_dir, "component")
+        os.makedirs(comp_dir)
+        comp_clang = os.path.join(comp_dir, ".clang-format")
+        with open(comp_clang, "w") as f:
+            f.write("---\nBasedOnStyle: LLVM\n")
+        with unittest.mock.patch("os.getcwd", return_value=comp_dir):
+            result = _find_clang_format_config(self.intf_yaml)
+        self.assertEqual(result, comp_clang)
+
+    def test_config_lookup_toolkit_default(self):
+        """验证无任何自定义配置时回退到toolkit默认"""
+        self._mk_interface()
+        import unittest.mock
+        # 使用空目录作为 CWD，确保没有 .clang-format
+        empty_dir = os.path.join(self.tmp_dir, "empty")
+        os.makedirs(empty_dir)
+        with unittest.mock.patch("os.getcwd", return_value=empty_dir):
+            result = _find_clang_format_config(self.intf_yaml)
+        # toolkit 默认 .clang-format 应该存在
+        self.assertIsNotNone(result)
+        self.assertTrue(os.path.isfile(result))
+
+    def test_missing_clang_format_graceful(self):
+        """验证 clang-format 不可用时 codegen 正常完成"""
+        self._mk_interface()
+        import unittest.mock
+        with unittest.mock.patch("shutil.which", return_value=None):
+            args = ["-d", self.intf_out, "-i", self.intf_yaml]
+            gen = CodeGen(args)
+            gen.run()
+        for ct in ["server", "client", "public"]:
+            h_file = os.path.join(self.intf_out, ct, "test.h")
+            self.assertTrue(os.path.isfile(h_file), f"{ct}/test.h should exist even without clang-format")
+
+
 if __name__ == "__main__":
     unittest.main()

{lbkit-0.9.11 → lbkit-0.9.12}/test/test_permission.py

@@ -60,14 +60,6 @@ class TestDoPermissionBasic(unittest.TestCase):
             with self.assertRaises(errors.PermissionFormatError):
                 task.do_permission(per)
 
-    def test_path_not_absolute(self):
-        """路径不以 / 开头应抛出 PermissionFormatError"""
-        with tempfile.TemporaryDirectory() as tmpdir:
-            per = _write_perm(tmpdir, ["lib/libfoo.so f 555 0 0 - - - - -"])
-            task = _make_task()
-            with self.assertRaises(errors.PermissionFormatError):
-                task.do_permission(per)
-
     def test_invalid_mode(self):
         """mode 字段不合法应抛出 PermissionFormatError"""
         with tempfile.TemporaryDirectory() as tmpdir:

lbkit-0.9.11/lbkit/__commit__.py

@@ -1 +0,0 @@
-__commit__ = '1f8eb04'

lbkit-0.9.11/lbkit/__init__.py

@@ -1,2 +0,0 @@
-
-__version__ = '0.9.11'