forked from frequenz-floss/frequenz-sdk-python
-
Couldn't load subscription status.
- Fork 0
Protobuf wrappers guideline
Leandro Lucarella edited this page Feb 14, 2024
·
5 revisions
-
x/y/z.protoshould go tox/y.pyif it is the only file in thex/y/directory. - If a symbol in package
x.y.pkgstarts withpkg, likePkgInfo, then the python symbol should be named without the prefix (Info), unless it is fundamental to the name. - Wrappers in
frequenz-client-common-pythontarget API client developers, not end users. In general the wrappers should be suitable for end user consumption, but there might be wrappers that clients should never export because they are just implementation details, likepagination. - Because of the above, client repos should re-export wrappers in the
frequenz-client-common-pythonrepo when appropriate, they should never require the user to declare the dependency offrequenz-client-common-pythonmanually, or to import stuff fromfrequenz.client.commondirectly.