Generator for ProtoBuf (proto3) #476

TomGneuss · 2024-04-19T13:43:34Z

As by issue #475, we requested a new generator for ProtoBuf. With this pull-request we present a possible solution for that.
In contrast to other generators, it only requires the structure module.
Since ProtoBuf is only a configuration language, it does not support functionalities like verification or object-oriented patterns like Visitor.
Thus, the code-base is minimal because also the expected output is reduced compared to the normal Core SDK.

…red modules `constants` and `structure`

…-works#1

…ish two subclasses of the same interface

mristin · 2024-04-20T00:14:03Z

@TomGneuss thanks a lot! Before I dig deeper, would you mind creating a separate smaller pull request for the renaming pascal to snake case? I was at first quite confused why other generators were changed, and this might make exploration of the history more difficult down the line.

If you lack time, I can do it for you -- please let me know what is easier for you.

TomGneuss · 2024-04-20T13:12:41Z

@mristin thanks for the hint. Please review the new pull request #478

TomGneuss · 2024-04-22T10:46:23Z

I ran the code-formatting script. As in #478, the mypy part fails.

I also discovered an issue in the generated proto files regarding properties that are not concrete types but interfaces. Since proto3 does not support interfaces (and inheritance in general), i fixed it by using the "oneof" keyword or introduced a *choice-message where necessary.

g1zzm0

Remove unnecessary blanks and empty lines

aas_core_codegen/golang/common.py

aas_core_codegen/golang/constants/_generate.py

g1zzm0 · 2024-04-23T03:31:42Z

aas_core_codegen/golang/description.py

@@ -1,4 +1,5 @@
 """Render descriptions to documentation comments."""
+


Suggested change

g1zzm0 · 2024-04-23T03:31:54Z

aas_core_codegen/golang/enhancing/__init__.py

@@ -1,4 +1,5 @@
 """Generate Golang code for enhancing model classes."""
+


Suggested change

g1zzm0 · 2024-04-23T03:32:04Z

aas_core_codegen/golang/jsonization/__init__.py

@@ -1,4 +1,5 @@
 """Generate the Golang code for de/serialization of AAS classes from and to JSON."""
+


Suggested change

g1zzm0 · 2024-04-23T04:00:40Z

aas_core_codegen/typescript/unrolling.py

@@ -1,4 +1,5 @@
 """Provide code generation for unrolling recursive calls and iterations."""
+


Suggested change

g1zzm0 · 2024-04-23T04:01:03Z

aas_core_codegen/typescript/verification/_generate.py

@@ -1,4 +1,5 @@
 """Generate the invariant verifiers from the intermediate representation."""
+


Suggested change

g1zzm0 · 2024-04-23T04:01:30Z

aas_core_codegen/xsd/naming.py

@@ -5,6 +5,7 @@
 :py:mod:`aas_core_codegen.naming`, which are used with different generators,
 these identifiers are used only for the XSD.
 """
+


Suggested change

g1zzm0 · 2024-04-23T04:01:57Z

aas_core_codegen/yielding/linear.py

@@ -1,4 +1,5 @@
 """Translate control flows to linear flows with goto-statements and co-routines."""
+


Suggested change

g1zzm0 · 2024-04-23T04:02:22Z

setup.py

@@ -4,6 +4,7 @@
 https://packaging.python.org/en/latest/distributing.html
 https://github.com/pypa/sampleproject
 """
+


Suggested change

Remove empty lines and blanks

g1zzm0

lgtm

mristin · 2024-04-23T05:51:51Z

~~@g1zzm0 why did you remove the empty lines? Wouldn't black take care of that?~~

I think i misread the emails that GitHub sent me as I see no diffs in that regard to the main branch anymore when I look at the changed files here on the web site.

g1zzm0 · 2024-04-23T06:04:46Z

@g1zzm0 why did you remove the empty lines? Wouldn't black take care of that?

idk. Didn't work for us. Fixed minor bugs in the proto gen.

mristin · 2024-04-23T06:05:53Z

@TomGneuss please let me know when you sync the pull request with the main branch and when it is ready for review.

mristin · 2024-04-23T06:08:32Z

@g1zzm0 @TomGneuss please make sure that you create separate pull requests for all the non-protobuf related changes. Otherwise, it is very hard to follow the git history and also to review.

g1zzm0 · 2024-04-23T06:12:51Z

@g1zzm0 @TomGneuss please make sure that you create separate pull requests for all the non-protobuf related changes. Otherwise, it is very hard to follow the git history and also to review.

We dont want to change the other non-proto related files. Black eddited some line endings, so i removed this changes from this branch.

mristin · 2024-04-23T06:15:48Z

@g1zzm0 why did you remove the empty lines? Wouldn't black take care of that?

idk. Didn't work for us. Fixed minor bugs in the proto gen.

I see the changes now also in the web. Please revert them (the removal of blank lines). We intentionally put a blank line after the module docstring (and I think black does so to?) for readability. Let's leave the formatting as it is for now.

mristin · 2024-04-23T06:17:35Z

@g1zzm0 @TomGneuss please make sure that you create separate pull requests for all the non-protobuf related changes. Otherwise, it is very hard to follow the git history and also to review.

We dont want to change the other non-proto related files. Black eddited some line endings, so i removed this changes from this branch.

Ah, I see now. Are you sure you have the exact version of black as is specified in setup.py?

mristin · 2024-04-23T06:20:12Z

You can try in your virtual environment:

pip3 uninstall black
pip3 install -e .[dev]
pip3 list 
black --version

Maybe you have a system-wide installed black which eclipses the local one?

g1zzm0 · 2024-04-23T06:45:03Z

You can try in your virtual environment:
We used the virtual Env like described in: https://github.com/aas-core-works/aas-core-codegen/blob/main/CONTRIBUTING.rst#create-a-development-environment

mristin · 2024-04-23T06:48:36Z

You can try in your virtual environment:
We used the virtual Env like described in: https://github.com/aas-core-works/aas-core-codegen/blob/main/CONTRIBUTING.rst#create-a-development-environment

Have you also installed black in this step?
https://github.com/aas-core-works/aas-core-codegen/blob/main/CONTRIBUTING.rst#install-development-dependencies

What do you get in the activated virtual environment when you call:

black --version

?

… gh-protobuf # Conflicts: # aas_core_codegen/protobuf/structure/_generate.py

g1zzm0 · 2024-04-23T06:59:27Z

Have you also installed black in this step? https://github.com/aas-core-works/aas-core-codegen/blob/main/CONTRIBUTING.rst#install-development-dependencies

Yes.

What do you get in the activated virtual environment when you call:
black --version
?
22.3.0

mristin · 2024-04-23T07:32:36Z

@g1zzm0 @TomGneuss can you give me some hint what changed here?

aas_core_codegen/intermediate/_translate.py

Only formatting, right?

Tom Gneuß and others added 21 commits April 4, 2024 08:20

excluded generated output from git

4ec5294

created package structure for protobuf-generator containing the requi…

9bb7c74

…red modules `constants` and `structure`

corrected naming of "pascal case" to "snake case"

4a05ae0

using renamed "snake case" method in naming.py

c633781

adapted naming.py and common.py methods for ProtoBuf generator

013ce88

created _generate.py for ProtoBuf constants (there will be none)

c4af68d

adapted method generate_enum in _generate.py

21c06b0

added generate_class method to _generate.py

53c4334

added generate method to _generate.py

d94fe54

added main function to ProtoBuf generator

ceb4e1d

created new case for choosing the protobuf entry point

2b3a50e

finalized ProtoBuf type aas-core-works#3 and enum generation aas-core…

a360a0c

…-works#1

added protobuf target to README

afa0822

corrected keyword stacking of "optional" and "repeated"

6b55cce

fixed syntax error in generated enums

9f7b9de

fixed syntax error for last literal in generated enums

5c234bc

prefixing enum literals with enum name

7f44e42

do not generate proto-messages for Has* classes

6056b5b

added TODO for proto generation

b689657

adding a field message_type to each proto message that shall distingu…

0c7e955

…ish two subclasses of the same interface

Merge branch 'main' into protobuf

199ade3

Tom Gneuß added 5 commits April 22, 2024 09:56

reformatted code according to pre-commit guide

7bfe5e3

generating properties with interface types as "oneof"

320fead

also considering properties of interfaces of a concrete type

c1d78c1

introduced choice-message for repeated oneof's

beac72a

code-formatting

f44e71f

only generating each *choice message once

c3b9a4a

Update aas_core_codegen/csharp/unrolling.py

4dfd1ac

mristin mentioned this pull request Apr 22, 2024

Rename of pascal case to snake case #478

Merged

g1zzm0 requested changes Apr 23, 2024

View reviewed changes

Apply suggestions from code review

81fb62e

Remove empty lines and blanks

g1zzm0 approved these changes Apr 23, 2024

View reviewed changes

Merge branch 'main' into protobuf

4fcd0a2

Fix interface missmatch

33ee108

Merge branch 'main' into protobuf

02a8f2e

Tom Gneuß added 4 commits April 23, 2024 08:23

commented unimplemented methods in naming.py

b30b3a6

commented unimplemented methods in common.py

9f830d9

removed constants generation

c0cd860

corrected f-strings

967f259

g1zzm0 and others added 4 commits April 23, 2024 08:55

Fix Todos and f-string error

78e1272

Merg f-string

f6e0663

fixed too long lines

bb00a99

Merge branch 'protobuf' of github.com:TomGneuss/aas-core-codegen into…

a66ed76

… gh-protobuf # Conflicts: # aas_core_codegen/protobuf/structure/_generate.py

g1zzm0 merged commit beffb92 into aas-core-works:main Apr 23, 2024
8 checks passed

TomGneuss mentioned this pull request May 14, 2024

Add a new generator for ProtoBuf (proto3) #475

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generator for ProtoBuf (proto3) #476

Generator for ProtoBuf (proto3) #476

TomGneuss commented Apr 19, 2024

mristin commented Apr 20, 2024

TomGneuss commented Apr 20, 2024

TomGneuss commented Apr 22, 2024

g1zzm0 left a comment

g1zzm0 Apr 23, 2024

g1zzm0 Apr 23, 2024

g1zzm0 Apr 23, 2024

g1zzm0 Apr 23, 2024

g1zzm0 Apr 23, 2024

g1zzm0 Apr 23, 2024

g1zzm0 Apr 23, 2024

g1zzm0 Apr 23, 2024

g1zzm0 left a comment

mristin commented Apr 23, 2024 •

edited

Loading

g1zzm0 commented Apr 23, 2024

mristin commented Apr 23, 2024

mristin commented Apr 23, 2024

g1zzm0 commented Apr 23, 2024

mristin commented Apr 23, 2024

mristin commented Apr 23, 2024

mristin commented Apr 23, 2024

g1zzm0 commented Apr 23, 2024

mristin commented Apr 23, 2024

g1zzm0 commented Apr 23, 2024

mristin commented Apr 23, 2024

		@@ -1,4 +1,5 @@
		"""Render descriptions to documentation comments."""

		@@ -1,4 +1,5 @@
		"""Generate Golang code for enhancing model classes."""

		@@ -1,4 +1,5 @@
		"""Generate the Golang code for de/serialization of AAS classes from and to JSON."""

		@@ -1,4 +1,5 @@
		"""Provide code generation for unrolling recursive calls and iterations."""

		@@ -1,4 +1,5 @@
		"""Generate the invariant verifiers from the intermediate representation."""

		@@ -1,4 +1,5 @@
		"""Translate control flows to linear flows with goto-statements and co-routines."""

Generator for ProtoBuf (proto3) #476

Generator for ProtoBuf (proto3) #476

Conversation

TomGneuss commented Apr 19, 2024

mristin commented Apr 20, 2024

TomGneuss commented Apr 20, 2024

TomGneuss commented Apr 22, 2024

g1zzm0 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

g1zzm0 left a comment

Choose a reason for hiding this comment

mristin commented Apr 23, 2024 • edited Loading

g1zzm0 commented Apr 23, 2024

mristin commented Apr 23, 2024

mristin commented Apr 23, 2024

g1zzm0 commented Apr 23, 2024

mristin commented Apr 23, 2024

mristin commented Apr 23, 2024

mristin commented Apr 23, 2024

g1zzm0 commented Apr 23, 2024

mristin commented Apr 23, 2024

g1zzm0 commented Apr 23, 2024

mristin commented Apr 23, 2024

mristin commented Apr 23, 2024 •

edited

Loading