#24 Use PyProject.toml

* Update pyproject.toml * renamed script lotuspc to lrpcg * Moved some files around
tzijnge · Oct 17, 2024 · fe62b16 · fe62b16
1 parent f9fa118
commit fe62b16
Show file tree

Hide file tree

Showing 76 changed files with 26 additions and 29 deletions.
diff --git a/package/lrpc/__init__.py → lrpc/__init__.py b/package/lrpc/__init__.py → lrpc/__init__.py
diff --git a/package/lrpc/client/__init__.py → lrpc/client/__init__.py b/package/lrpc/client/__init__.py → lrpc/client/__init__.py
diff --git a/package/lrpc/client/client_cli_visitor.py → lrpc/client/client_cli_visitor.py b/package/lrpc/client/client_cli_visitor.py → lrpc/client/client_cli_visitor.py
diff --git a/package/lrpc/client/decoder.py → lrpc/client/decoder.py b/package/lrpc/client/decoder.py → lrpc/client/decoder.py
diff --git a/package/lrpc/client/encoder.py → lrpc/client/encoder.py b/package/lrpc/client/encoder.py → lrpc/client/encoder.py
diff --git a/package/lrpc/client/lrpc_client.py → lrpc/client/lrpc_client.py b/package/lrpc/client/lrpc_client.py → lrpc/client/lrpc_client.py
diff --git a/package/lrpc/codegen/__init__.py → lrpc/codegen/__init__.py b/package/lrpc/codegen/__init__.py → lrpc/codegen/__init__.py
diff --git a/package/lrpc/codegen/common.py → lrpc/codegen/common.py b/package/lrpc/codegen/common.py → lrpc/codegen/common.py
diff --git a/package/lrpc/codegen/constants.py → lrpc/codegen/constants.py b/package/lrpc/codegen/constants.py → lrpc/codegen/constants.py
diff --git a/package/lrpc/codegen/enum.py → lrpc/codegen/enum.py b/package/lrpc/codegen/enum.py → lrpc/codegen/enum.py
diff --git a/package/lrpc/codegen/server_include.py → lrpc/codegen/server_include.py b/package/lrpc/codegen/server_include.py → lrpc/codegen/server_include.py
diff --git a/package/lrpc/codegen/service_include.py → lrpc/codegen/service_include.py b/package/lrpc/codegen/service_include.py → lrpc/codegen/service_include.py
diff --git a/package/lrpc/codegen/service_shim.py → lrpc/codegen/service_shim.py b/package/lrpc/codegen/service_shim.py → lrpc/codegen/service_shim.py
diff --git a/package/lrpc/codegen/struct.py → lrpc/codegen/struct.py b/package/lrpc/codegen/struct.py → lrpc/codegen/struct.py
diff --git a/package/lrpc/codegen/utils.py → lrpc/codegen/utils.py b/package/lrpc/codegen/utils.py → lrpc/codegen/utils.py
diff --git a/package/lrpc/core/__init__.py → lrpc/core/__init__.py b/package/lrpc/core/__init__.py → lrpc/core/__init__.py
diff --git a/package/lrpc/core/constant.py → lrpc/core/constant.py b/package/lrpc/core/constant.py → lrpc/core/constant.py
diff --git a/package/lrpc/core/definition.py → lrpc/core/definition.py b/package/lrpc/core/definition.py → lrpc/core/definition.py
diff --git a/package/lrpc/core/enum.py → lrpc/core/enum.py b/package/lrpc/core/enum.py → lrpc/core/enum.py
diff --git a/package/lrpc/core/function.py → lrpc/core/function.py b/package/lrpc/core/function.py → lrpc/core/function.py
diff --git a/package/lrpc/core/service.py → lrpc/core/service.py b/package/lrpc/core/service.py → lrpc/core/service.py
diff --git a/package/lrpc/core/struct.py → lrpc/core/struct.py b/package/lrpc/core/struct.py → lrpc/core/struct.py
diff --git a/package/lrpc/core/var.py → lrpc/core/var.py b/package/lrpc/core/var.py → lrpc/core/var.py
diff --git a/package/lrpc/lrpcc.py → lrpc/lrpcc.py b/package/lrpc/lrpcc.py → lrpc/lrpcc.py
diff --git a/package/lrpc/lotusrpc.py → lrpc/lrpcg.py b/package/lrpc/lotusrpc.py → lrpc/lrpcg.py
@@ -41,7 +41,7 @@ def generate_rpc(lrpc_def: LrpcDef, output: os.PathLike[str]) -> None:
 )
 @click.option("-o", "--output", help="Path to put the generated files", required=False, default=".", type=click.Path())
 @click.argument("input_file", type=click.File("r"), metavar="input")
-def generate(warnings_as_errors: bool, output: os.PathLike[str], input_file: TextIO) -> None:
+def run_cli(warnings_as_errors: bool, output: os.PathLike[str], input_file: TextIO) -> None:
     """Generate code for file INPUT"""
 
     try:
@@ -59,4 +59,4 @@ def generate(warnings_as_errors: bool, output: os.PathLike[str], input_file: Tex
 if __name__ == "__main__":
     # parameters are inserted by Click
     # pylint: disable=no-value-for-parameter
-    generate()
+    run_cli()
diff --git a/package/lrpc/schema/__init__.py → lrpc/schema/__init__.py b/package/lrpc/schema/__init__.py → lrpc/schema/__init__.py
diff --git a/package/lrpc/schema/load.py → lrpc/schema/load.py b/package/lrpc/schema/load.py → lrpc/schema/load.py
@@ -6,7 +6,7 @@
 
 def load_lrpc_schema() -> dict[str, Any]:
     schema_file = resources.files(__package__).joinpath("lotusrpc-schema.json")
-    schema_text = schema_file.read_text()
+    schema_text = schema_file.read_text(encoding="utf-8")
     schema = yaml.safe_load(schema_text)
 
     if not isinstance(schema, dict):

diff --git a/package/lrpc/schema/lotusrpc-schema.json → lrpc/schema/lotusrpc-schema.json b/package/lrpc/schema/lotusrpc-schema.json → lrpc/schema/lotusrpc-schema.json
diff --git a/package/lrpc/utils/__init__.py → lrpc/utils/__init__.py b/package/lrpc/utils/__init__.py → lrpc/utils/__init__.py
diff --git a/package/lrpc/utils/load_definition.py → lrpc/utils/load_definition.py b/package/lrpc/utils/load_definition.py → lrpc/utils/load_definition.py
diff --git a/package/lrpc/validation/__init__.py → lrpc/validation/__init__.py b/package/lrpc/validation/__init__.py → lrpc/validation/__init__.py
diff --git a/package/lrpc/validation/custom_types.py → lrpc/validation/custom_types.py b/package/lrpc/validation/custom_types.py → lrpc/validation/custom_types.py
diff --git a/package/lrpc/validation/enum.py → lrpc/validation/enum.py b/package/lrpc/validation/enum.py → lrpc/validation/enum.py
diff --git a/package/lrpc/validation/function.py → lrpc/validation/function.py b/package/lrpc/validation/function.py → lrpc/validation/function.py
diff --git a/package/lrpc/validation/names.py → lrpc/validation/names.py b/package/lrpc/validation/names.py → lrpc/validation/names.py
diff --git a/package/lrpc/validation/semantic_analyzer.py → lrpc/validation/semantic_analyzer.py b/package/lrpc/validation/semantic_analyzer.py → lrpc/validation/semantic_analyzer.py
diff --git a/package/lrpc/validation/service.py → lrpc/validation/service.py b/package/lrpc/validation/service.py → lrpc/validation/service.py
diff --git a/package/lrpc/validation/validator.py → lrpc/validation/validator.py b/package/lrpc/validation/validator.py → lrpc/validation/validator.py
diff --git a/package/lrpc/visitors/__init__.py → lrpc/visitors/__init__.py b/package/lrpc/visitors/__init__.py → lrpc/visitors/__init__.py
diff --git a/package/lrpc/visitors/lrpc_visitor.py → lrpc/visitors/lrpc_visitor.py b/package/lrpc/visitors/lrpc_visitor.py → lrpc/visitors/lrpc_visitor.py
diff --git a/package/lrpc/visitors/puml_visitor.py → lrpc/visitors/puml_visitor.py b/package/lrpc/visitors/puml_visitor.py → lrpc/visitors/puml_visitor.py
diff --git a/package/README b/package/README
diff --git a/package/pyproject.toml → pyproject.toml b/package/pyproject.toml → pyproject.toml
@@ -8,17 +8,16 @@ version = "0.1.0"
 description = "A code generator for remote procedure calls on embedded systems"
 readme = "README.md"
 requires-python = ">=3.9"
-license = { text = "MIT" }
-authors = [{ name = "T Zijnge", email = "[email protected]" }]
+license = { file = "LICENSE" }
+authors = [{ name = "T Zijnge" }]
 keywords = ["code generation", "embedded systems", "rpc"]
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
-    "Programming Language :: Python",
+    "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.9",
-    "Programming Language :: Python :: 3.10",
+    "Programming Language :: C++",
     "Topic :: Software Development :: Code Generators",
     "Topic :: Software Development :: Embedded Systems",
 ]
@@ -29,17 +28,17 @@ dependencies = [
     "click==8.1.7",
 ]
 
+[project.optional-dependencies]
+serial = ["pyserial==3.5"]
+
 [project.urls]
 homepage = "https://github.com/tzijnge/LotusRpc"
 "Bug Tracker" = "https://github.com/tzijnge/LotusRpc/issues"
 "Documentation" = "https://github.com/tzijnge/LotusRpc/wiki"
 "Source Code" = "https://github.com/tzijnge/LotusRpc"
 
-[project.optional-dependencies]
-serial = ["pyserial==3.5"]
-
 [project.scripts]
-lotusrpc = "lrpc.lotusrpc:generate"
+lrpcg = "lrpc.lrpcg:run_cli"
 lrpcc = "lrpc.lrpcc:run_cli"
 
 [tool.setuptools.package-data]
@@ -64,7 +63,6 @@ disable = ["line-too-long"]
 allow-reexport-from-package = true
 
 [tool.mypy]
-exclude = "external"
 strict = true
 # Increase strictness of checks
 disallow_any_decorated = true

diff --git a/...uage/cpp/include/lrpc/EtlRwExtensions.hpp → ...rces/cpp/include/lrpc/EtlRwExtensions.hpp b/...uage/cpp/include/lrpc/EtlRwExtensions.hpp → ...rces/cpp/include/lrpc/EtlRwExtensions.hpp
diff --git a/language/cpp/include/lrpc/Server.hpp → resources/cpp/include/lrpc/Server.hpp b/language/cpp/include/lrpc/Server.hpp → resources/cpp/include/lrpc/Server.hpp
diff --git a/language/cpp/include/lrpc/Service.hpp → resources/cpp/include/lrpc/Service.hpp b/language/cpp/include/lrpc/Service.hpp → resources/cpp/include/lrpc/Service.hpp
diff --git a/language/cpp/tests/CMakeLists.txt → tests/cpp/CMakeLists.txt b/language/cpp/tests/CMakeLists.txt → tests/cpp/CMakeLists.txt
@@ -12,31 +12,31 @@ mark_as_advanced(
     gtest_hide_internal_symbols
 )
 
-add_subdirectory(../../../external/gtest External/gtest EXCLUDE_FROM_ALL)
+add_subdirectory(../../external/gtest External/gtest EXCLUDE_FROM_ALL)
 
 add_custom_command(OUTPUT ${CMAKE_CURRENT_SOURCE_DIR}/generated/Server1/Server1.hpp
-                  WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/package
+                  WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
                   COMMENT "Generate TestServer1 LRPC files"
-                  DEPENDS ${CMAKE_SOURCE_DIR}/testdata/TestServer1.lrpc.yaml
-                  COMMAND python -m lrpc.lotusrpc -w ${CMAKE_SOURCE_DIR}/testdata/TestServer1.lrpc.yaml -o ${CMAKE_CURRENT_SOURCE_DIR}/generated/Server1)
+                  DEPENDS ${CMAKE_SOURCE_DIR}/tests/testdata/TestServer1.lrpc.yaml
+                  COMMAND python -m lrpc.lrpcg -w ${CMAKE_SOURCE_DIR}/tests/testdata/TestServer1.lrpc.yaml -o ${CMAKE_CURRENT_SOURCE_DIR}/generated/Server1)
 
 add_custom_command(OUTPUT ${CMAKE_CURRENT_SOURCE_DIR}/generated/Server2/Server2.hpp
-                  WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/package
+                  WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
                   COMMENT "Generate TestServer2 LRPC files"
-                  DEPENDS ${CMAKE_SOURCE_DIR}/testdata/TestServer2.lrpc.yaml
-                  COMMAND python -m lrpc.lotusrpc -w ${CMAKE_SOURCE_DIR}/testdata/TestServer2.lrpc.yaml -o ${CMAKE_CURRENT_SOURCE_DIR}/generated/Server2)
+                  DEPENDS ${CMAKE_SOURCE_DIR}/tests/testdata/TestServer2.lrpc.yaml
+                  COMMAND python -m lrpc.lrpcg -w ${CMAKE_SOURCE_DIR}/tests/testdata/TestServer2.lrpc.yaml -o ${CMAKE_CURRENT_SOURCE_DIR}/generated/Server2)
 
 add_custom_command(OUTPUT ${CMAKE_CURRENT_SOURCE_DIR}/generated/Server3/Server3.hpp
-                  WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/package
+                  WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
                   COMMENT "Generate TestServer3 LRPC files"
-                  DEPENDS ${CMAKE_SOURCE_DIR}/testdata/TestServer3.lrpc.yaml
-                  COMMAND python -m lrpc.lotusrpc -w ${CMAKE_SOURCE_DIR}/testdata/TestServer3.lrpc.yaml -o ${CMAKE_CURRENT_SOURCE_DIR}/generated/Server3)
+                  DEPENDS ${CMAKE_SOURCE_DIR}/tests/testdata/TestServer3.lrpc.yaml
+                  COMMAND python -m lrpc.lrpcg -w ${CMAKE_SOURCE_DIR}/tests/testdata/TestServer3.lrpc.yaml -o ${CMAKE_CURRENT_SOURCE_DIR}/generated/Server3)
 
 add_custom_command(OUTPUT ${CMAKE_CURRENT_SOURCE_DIR}/generated/Server4/Server4.hpp
-                  WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/package
+                  WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
                   COMMENT "Generate TestServer4 LRPC files"
-                  DEPENDS ${CMAKE_SOURCE_DIR}/testdata/TestServer4.lrpc.yaml
-                  COMMAND python -m lrpc.lotusrpc -w ${CMAKE_SOURCE_DIR}/testdata/TestServer4.lrpc.yaml -o ${CMAKE_CURRENT_SOURCE_DIR}/generated/Server4)
+                  DEPENDS ${CMAKE_SOURCE_DIR}/tests/testdata/TestServer4.lrpc.yaml
+                  COMMAND python -m lrpc.lrpcg -w ${CMAKE_SOURCE_DIR}/tests/testdata/TestServer4.lrpc.yaml -o ${CMAKE_CURRENT_SOURCE_DIR}/generated/Server4)
 
 set_directory_properties(PROPERTIES ADDITIONAL_CLEAN_FILES ${CMAKE_CURRENT_SOURCE_DIR}/generated)
 
@@ -53,8 +53,8 @@ add_executable(UnitTests
                 ${CMAKE_CURRENT_SOURCE_DIR}/generated/Server4/Server4.hpp)
 
 target_include_directories(UnitTests PRIVATE .)
-target_include_directories(UnitTests PRIVATE ../include)
-target_include_directories(UnitTests SYSTEM PRIVATE ../../../external/etl/include)
+target_include_directories(UnitTests PRIVATE ${CMAKE_SOURCE_DIR}/resources/cpp/include)
+target_include_directories(UnitTests SYSTEM PRIVATE ${CMAKE_SOURCE_DIR}/external/etl/include)
 
 if(MSVC)
   target_compile_options(UnitTests PRIVATE /W4)

diff --git a/language/cpp/tests/TestEtlRwExtensions.cpp → tests/cpp/TestEtlRwExtensions.cpp b/language/cpp/tests/TestEtlRwExtensions.cpp → tests/cpp/TestEtlRwExtensions.cpp
diff --git a/language/cpp/tests/TestServer1.cpp → tests/cpp/TestServer1.cpp b/language/cpp/tests/TestServer1.cpp → tests/cpp/TestServer1.cpp
diff --git a/language/cpp/tests/TestServer2_s0.cpp → tests/cpp/TestServer2_s0.cpp b/language/cpp/tests/TestServer2_s0.cpp → tests/cpp/TestServer2_s0.cpp
diff --git a/language/cpp/tests/TestServer2_s1.cpp → tests/cpp/TestServer2_s1.cpp b/language/cpp/tests/TestServer2_s1.cpp → tests/cpp/TestServer2_s1.cpp
diff --git a/language/cpp/tests/TestServer3.cpp → tests/cpp/TestServer3.cpp b/language/cpp/tests/TestServer3.cpp → tests/cpp/TestServer3.cpp
diff --git a/language/cpp/tests/TestServer4.cpp → tests/cpp/TestServer4.cpp b/language/cpp/tests/TestServer4.cpp → tests/cpp/TestServer4.cpp
diff --git a/language/cpp/tests/etl_profile.h → tests/cpp/etl_profile.h b/language/cpp/tests/etl_profile.h → tests/cpp/etl_profile.h
diff --git a/language/cpp/tests/ext_files/MyEnum2.hpp → tests/cpp/ext_files/MyEnum2.hpp b/language/cpp/tests/ext_files/MyEnum2.hpp → tests/cpp/ext_files/MyEnum2.hpp
diff --git a/language/cpp/tests/ext_files/MyEnum3.hpp → tests/cpp/ext_files/MyEnum3.hpp b/language/cpp/tests/ext_files/MyEnum3.hpp → tests/cpp/ext_files/MyEnum3.hpp
diff --git a/language/cpp/tests/ext_files/MyStruct1.hpp → tests/cpp/ext_files/MyStruct1.hpp b/language/cpp/tests/ext_files/MyStruct1.hpp → tests/cpp/ext_files/MyStruct1.hpp
diff --git a/language/cpp/tests/ext_files/MyStruct2.hpp → tests/cpp/ext_files/MyStruct2.hpp b/language/cpp/tests/ext_files/MyStruct2.hpp → tests/cpp/ext_files/MyStruct2.hpp
diff --git a/package/tests/__init__.py → tests/python/__init__.py b/package/tests/__init__.py → tests/python/__init__.py
diff --git a/package/tests/test_lrpc_client.py → tests/python/test_lrpc_client.py b/package/tests/test_lrpc_client.py → tests/python/test_lrpc_client.py
diff --git a/package/tests/test_lrpc_constant.py → tests/python/test_lrpc_constant.py b/package/tests/test_lrpc_constant.py → tests/python/test_lrpc_constant.py
diff --git a/package/tests/test_lrpc_decode.py → tests/python/test_lrpc_decode.py b/package/tests/test_lrpc_decode.py → tests/python/test_lrpc_decode.py
diff --git a/package/tests/test_lrpc_def.py → tests/python/test_lrpc_def.py b/package/tests/test_lrpc_def.py → tests/python/test_lrpc_def.py
diff --git a/package/tests/test_lrpc_encode.py → tests/python/test_lrpc_encode.py b/package/tests/test_lrpc_encode.py → tests/python/test_lrpc_encode.py
diff --git a/...e/tests/test_lrpc_encode_decode.lrpc.yaml → .../python/test_lrpc_encode_decode.lrpc.yaml b/...e/tests/test_lrpc_encode_decode.lrpc.yaml → .../python/test_lrpc_encode_decode.lrpc.yaml
diff --git a/package/tests/test_lrpc_encode_decode.py → tests/python/test_lrpc_encode_decode.py b/package/tests/test_lrpc_encode_decode.py → tests/python/test_lrpc_encode_decode.py
diff --git a/package/tests/test_lrpc_enum.py → tests/python/test_lrpc_enum.py b/package/tests/test_lrpc_enum.py → tests/python/test_lrpc_enum.py
diff --git a/package/tests/test_lrpc_fun.py → tests/python/test_lrpc_fun.py b/package/tests/test_lrpc_fun.py → tests/python/test_lrpc_fun.py
diff --git a/package/tests/test_lrpc_service.py → tests/python/test_lrpc_service.py b/package/tests/test_lrpc_service.py → tests/python/test_lrpc_service.py
diff --git a/package/tests/test_lrpc_struct.py → tests/python/test_lrpc_struct.py b/package/tests/test_lrpc_struct.py → tests/python/test_lrpc_struct.py
diff --git a/package/tests/test_lrpc_var.py → tests/python/test_lrpc_var.py b/package/tests/test_lrpc_var.py → tests/python/test_lrpc_var.py
diff --git a/package/tests/test_schema.py → tests/python/test_schema.py b/package/tests/test_schema.py → tests/python/test_schema.py
diff --git a/testdata/TestServer1.lrpc.yaml → tests/testdata/TestServer1.lrpc.yaml b/testdata/TestServer1.lrpc.yaml → tests/testdata/TestServer1.lrpc.yaml
diff --git a/testdata/TestServer2.lrpc.yaml → tests/testdata/TestServer2.lrpc.yaml b/testdata/TestServer2.lrpc.yaml → tests/testdata/TestServer2.lrpc.yaml
diff --git a/testdata/TestServer3.lrpc.yaml → tests/testdata/TestServer3.lrpc.yaml b/testdata/TestServer3.lrpc.yaml → tests/testdata/TestServer3.lrpc.yaml
diff --git a/testdata/TestServer4.lrpc.yaml → tests/testdata/TestServer4.lrpc.yaml b/testdata/TestServer4.lrpc.yaml → tests/testdata/TestServer4.lrpc.yaml