Merge pull request #53 from hit9/fix-issue-52

Fix bug: invalid generation of enum's field name importing from another bitproto

Author: hit9

.github/workflows/bench.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        os: [ubuntu-20.04, ubuntu-18.04, macos-latest]
+        os: [ubuntu-22.04, macos-latest]
         python: ["3.11"]
         go: ["1.19"]
 

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        os: [ubuntu-18.04]
+        os: [ubuntu-22.04]
         python: [3.7, 3.8, "3.10", "3.11"]
         go: ["1.19", "1.16"]
 

changes.rst

@@ -1,5 +1,13 @@
 .. currentmodule:: bitproto
 
+Version 1.1.1
+-------------
+
+.. _version-1.1.1
+
+- Fix bug: enum importting other bitproto's field name generation bug. #53 #52
+- Fix bug: import statements of bitproto importings should be placed ahead of other declarations. #53
+
 Version 1.1.0
 -------------
 

compiler/bitproto/__init__.py

@@ -4,9 +4,9 @@
 
 Bit level data interchange format.
 
-:copyright: (c) 2020~2022 by Chao Wang <[email protected]>.
+:copyright: (c) 2020~2023 by Chao Wang <[email protected]>.
 
 """
 
-__version__ = "1.1.0"
+__version__ = "1.1.1"
 __description__ = "bit level data interchange format."

compiler/bitproto/linter.py

@@ -80,7 +80,6 @@ def lint(self, proto: Proto) -> int:
         """
         warning_count: int = 0
         for definition_type in SUPPORTED_TYPES:
-
             items: List[Tuple[str, Definition]]
             if definition_type is Proto:  # proto is not a member of itself.
                 items = [(proto.name, proto)]

compiler/bitproto/renderer/formatter.py

@@ -64,7 +64,6 @@
 
 @unique
 class CaseStyle(Enum_):
-
     KEEP = 0
     SNAKE = 1
     UPPER = 2
@@ -401,17 +400,23 @@ def format_definition_name(
         Joins a with a dot delimer if given definition is a definition imported.
         """
         definition_name = self.format_definition_name_inner_proto(d, class_)
-        protos = [scope for scope in d.scope_stack if isinstance(scope, Proto)]
 
-        if len(protos) <= 1:
+        parent = d.scope_stack[-1]
+
+        if not isinstance(parent, Proto):
+            # Member of Non-Proto scopes: message, enum etc.
             return definition_name
 
         if not self.support_import_as_member():
             return definition_name
 
-        proto = protos[-1]  # Last is the imported parent.
-        items = [self._get_definition_name(proto), definition_name]
-        return self.delimer_cross_proto().join(items)
+        if not parent.scope_stack:
+            # `parent` is the top proto.
+            return definition_name
+        # `parent` is imported in another proto.
+        return self.delimer_cross_proto().join(
+            [self._get_definition_name(parent), definition_name]
+        )
 
     @final
     def format_name_related_to_definition(

compiler/bitproto/renderer/impls/go/renderer.py

@@ -54,13 +54,6 @@ def render(self) -> None:
         self.push(f'bp "{GO_LIB_IMPORT_PATH}"', indent=1)
         self.push(f")")
 
-        self.push_empty_line()
-
-        self.push_comment("Avoid possible golang import not used error")
-        self.push(f"var formatInt = strconv.FormatInt")
-        self.push(f"var jsonMarshal = json.Marshal")
-        self.push(f"var _ = bp.Useless")
-
 
 class BlockImportChildProto(BlockBindProto[F]):
     @override(Block)
@@ -81,6 +74,15 @@ def separator(self) -> str:
         return "\n"
 
 
+class BlockAvoidGeneralImportsNotUsed(Block):
+    @override(Block)
+    def render(self) -> None:
+        self.push_comment("Avoid possible golang import not used error")
+        self.push(f"var formatInt = strconv.FormatInt")
+        self.push(f"var jsonMarshal = json.Marshal")
+        self.push(f"var _ = bp.Useless")
+
+
 class BlockAliasMethodBase(BlockBindAlias[F]):
     @cached_property
     def method_receiver(self) -> str:
@@ -750,6 +752,7 @@ def blocks(self) -> List[Block[F]]:
             BlockPackageName(self.bound),
             BlockGeneralImports(),
             BlockImportChildProtoList(),
+            BlockAvoidGeneralImportsNotUsed(),
             BlockBoundDefinitionList(),
         ]
 

compiler/bitproto/utils.py

@@ -206,7 +206,6 @@ def __delattr__(self, name):
         setattr(class_, "__delattr__", __delattr__)
 
         if post_init:
-
             init_func = getattr(class_, "__init__")
 
             def decorate_init(func):

lib/py/bitprotolib/bp.py

@@ -191,7 +191,9 @@ class MessageBase(Accessor):
 
     def to_dict(self) -> Dict[str, Any]:
         """Converts this message to a dict."""
-        return asdict(self, dict_factory=getattr(self, "dict_factory", dict))
+        return asdict(
+            self, dict_factory=getattr(self, "dict_factory", dict)  # type:ignore
+        )
 
     def to_json(
         self, indent: Optional[int] = None, separators: Optional[Tuple[str, str]] = None

tests/test_encoding/encoding-cases/issue-52/Makefile

@@ -0,0 +1,47 @@
+PY_SOURCE_FILE=main.py
+BIN=main
+
+BP_LIB_DIR=../../../../../lib/c
+BP_LIC_C_PATH=$(BP_LIB_DIR)/bitproto.c
+
+C_SOURCE_FILE=main.c
+C_SOURCE_FILE_LIST=$(C_SOURCE_FILE) a_bp.c b_bp.c $(BP_LIC_C_PATH)
+C_BIN=$(BIN)
+CC_OPTIMIZATION_ARG?=
+
+GO_BIN=$(BIN)
+
+
+bp-c:
+	@bitproto c a.bitproto c/
+	@bitproto c b.bitproto c/
+
+bp-py:
+	@bitproto py a.bitproto py/
+	@bitproto py b.bitproto py/
+
+bp-go:
+	@bitproto go a.bitproto go/bp/a $(OPTIMIZATION_MODE_ARGS)
+	@bitproto go b.bitproto go/bp/b $(OPTIMIZATION_MODE_ARGS)
+
+build-c: bp-c
+	@cd c && $(CC) $(C_SOURCE_FILE_LIST) -I. -I$(BP_LIB_DIR) -o $(C_BIN) $(CC_OPTIMIZATION_ARG)
+
+build-go: bp-go
+	@cd go && go build -o $(GO_BIN)
+
+build-py: bp-py
+
+run-c: build-c
+	@cd c && ./$(C_BIN)
+
+run-go: build-go
+	@cd go && ./$(GO_BIN)
+
+run-py: build-py
+	@cd py && python $(PY_SOURCE_FILE)
+
+clean:
+	@rm -fr c/$(C_BIN) go/$(GO_BIN) */*_bp.* */**/*_bp.* py/__pycache__
+
+run: run-py run-c run-go

tests/test_encoding/encoding-cases/issue-52/a.bitproto

@@ -0,0 +1,7 @@
+proto a
+
+import bb "b.bitproto"
+
+message A {
+    bb.X x = 1;
+}

tests/test_encoding/encoding-cases/issue-52/b.bitproto

@@ -0,0 +1,7 @@
+proto b;
+
+option go.package_path = "github.com/hit9/bitproto/tests/test_encoding/encoding-cases/issue-52/go/bp/b";
+
+enum X : uint1 {
+    OK = 0;
+}

tests/test_encoding/encoding-cases/issue-52/c/main.c

@@ -0,0 +1,9 @@
+#include "a_bp.h"
+#include "b_bp.h"
+#include <assert.h>
+
+int main(void) {
+  struct A a = {.x = OK};
+  assert(a.x == OK);
+  return 0;
+}

tests/test_encoding/encoding-cases/issue-52/go/bp/a/.gitkeep

@@ -0,0 +1,3 @@
+module github.com/hit9/bitproto/tests/test_encoding/encoding-cases/issue-52/go/bp/a
+
+go 1.15

tests/test_encoding/encoding-cases/issue-52/go/bp/a/go.mod

@@ -0,0 +1 @@
+module github.com/hit9/bitproto/tests/test_encoding/encoding-cases/issue-52/go/bp/b

tests/test_encoding/encoding-cases/issue-52/go/bp/b/.gitkeep

@@ -0,0 +1,14 @@
+module github.com/hit9/bitproto/tests/test_encoding/encoding-cases/issue-52
+
+replace github.com/hit9/bitproto/lib/go => ../../../../../lib/go
+
+replace github.com/hit9/bitproto/tests/test_encoding/encoding-cases/issue-52/go/bp/a => ./bp/a
+replace github.com/hit9/bitproto/tests/test_encoding/encoding-cases/issue-52/go/bp/b => ./bp/b
+
+go 1.15
+
+require (
+	github.com/hit9/bitproto/lib/go v0.0.0-00010101000000-000000000000 // indirect
+	github.com/hit9/bitproto/tests/test_encoding/encoding-cases/issue-52/go/bp/a v0.0.0-00010101000000-000000000000
+	github.com/hit9/bitproto/tests/test_encoding/encoding-cases/issue-52/go/bp/b v0.0.0-00010101000000-000000000000
+)

tests/test_encoding/encoding-cases/issue-52/go/bp/b/go.mod

@@ -0,0 +1,17 @@
+package main
+
+import (
+	a "github.com/hit9/bitproto/tests/test_encoding/encoding-cases/issue-52/go/bp/a"
+	b "github.com/hit9/bitproto/tests/test_encoding/encoding-cases/issue-52/go/bp/b"
+)
+
+func assert(condition bool) {
+	if !condition {
+		panic("assertion failed")
+	}
+}
+
+func main() {
+	v := a.A{X: b.OK}
+	assert(v.X == b.OK)
+}

tests/test_encoding/encoding-cases/issue-52/go/go.mod

@@ -0,0 +1,11 @@
+import a_bp
+import b_bp
+
+
+def main():
+    a = a_bp.A()
+    assert a.x == b_bp.X.OK
+
+
+if __name__ == "__main__":
+    main()

tests/test_encoding/encoding-cases/issue-52/go/main.go

@@ -135,3 +135,13 @@ def test_encoding_signed() -> None:
 
 def test_encoding_complexx() -> None:
     _TestCase("complexx", support_optimization_mode=False).run()
+
+
+def test_encoding_issue52() -> None:
+    _TestCase(
+        "issue-52",
+        langs=["py", "c"],
+        compare_output=False,
+        compare_output_as_json=False,
+        support_optimization_mode=False,
+    )