bikeshed

Author: virtuald

examples/demo/meson.build

@@ -1,31 +1,23 @@
 project('demo', ['cpp'],
-        default_options: ['warning_level=1', 'cpp_std=gnu++17',
+        default_options: ['warning_level=1', 'cpp_std=c++20',
                           'b_colorout=auto', 'optimization=2', 'b_pie=true'])
 
 # Include autogenerated wrapcfg/meson.build
 subdir('wrapcfg')
 
 # Add additional source files to predefined variable in wrapcfg/meson.build
-demo_module_sources += files(
+demo_sources += files(
   'swdemo/src/demo.cpp',
   'swdemo/src/main.cpp',
 )
 
 # You can add extra compilation arguments by adding a dependency to predefined
 # variable
-demo_module_deps += [
+demo_deps += [
   declare_dependency(include_directories: ['swdemo/include'])
 ]
 
 # Include autogenerated wrapcfg/modules/meson.build
+# - Builds the extension modules
+# - Generates the pyi file for the extension modules
 subdir('wrapcfg/modules')
-
-# add this here
-# - if this is complicated, then it needs to be autogenerated
-# - or sw_module_NAME_pyi_deps
-#   .. easy way is to just make the module dependent on it, then pyi
-#      only has to depend on that
-# custom_target(
-#     command: [sw_cmd_gen_pyi],
-#     depends: [rpydemo_module, init_py],
-# )

examples/demo/pyproject.toml

@@ -31,8 +31,8 @@ version = "0.0.1"
 
 [tool.semiwrap]
 
-[tool.semiwrap.modules."swdemo"]
+[tool.semiwrap.extension_modules."swdemo._demo"]
 name = "demo"
 
-[tool.semiwrap.modules.swdemo.headers]
+[tool.semiwrap.extension_modules."swdemo._demo".headers]
 demo = "swdemo/include/demo.h"

src/semiwrap/cmd_gen_libinit.py

@@ -121,8 +121,8 @@ def main():
 
     pyproject = PyProject(pathlib.Path(pyproject_toml))
 
-    module = pyproject.get_module(package_name)
-    depends = pyproject.get_module_deps(module)
+    module = pyproject.get_extension(package_name)
+    depends = pyproject.get_extension_deps(module)
 
     # TODO: libs
     # .. oh, those were going to get created by the downloader hatch plugin

src/semiwrap/cmd_gen_modinit_hpp.py

@@ -68,7 +68,7 @@ def _write_wrapper_hpp(
         #include <robotpy_build.h>
 
         // Use this to define your module instead of PYBIND11_MODULE
-        #define SEMIWRAP_PYBIND11_MODULE(variable) PYBIND11_MODULE(_{module_name}, variable)
+        #define SEMIWRAP_PYBIND11_MODULE(variable) PYBIND11_MODULE({module_name}, variable)
 
         // TODO: namespace semiwrap::autogen {{
 

src/semiwrap/cmd_genmeson.py

@@ -14,7 +14,7 @@
     InputFile,
     OutputFile,
     BuildTarget,
-    Module,
+    ExtensionModule,
     makeplan,
 )
 from .util import maybe_write_file
@@ -46,14 +46,14 @@ def _make_string(s: str):
 
 class VarCache:
     def __init__(self) -> None:
-        self.cache: T.Dict[T.Union[InputFile, OutputFile, BuildTarget, Module], str] = (
+        self.cache: T.Dict[T.Union[InputFile, OutputFile, BuildTarget, ExtensionModule], str] = (
             {}
         )
 
         # this might get annoying to debug, but for now this is easier...
         self.idx = 1
 
-    def getvar(self, item: T.Union[InputFile, OutputFile, BuildTarget, Module]) -> str:
+    def getvar(self, item: T.Union[InputFile, OutputFile, BuildTarget, ExtensionModule]) -> str:
         var = self.cache.get(item)
         if var is None:
 
@@ -70,7 +70,7 @@ def getvar(self, item: T.Union[InputFile, OutputFile, BuildTarget, Module]) -> s
                 # var = f"sw_out_{self.idx}"
             elif isinstance(item, BuildTarget):
                 var = f"_sw_target_{self.idx}"
-            elif isinstance(item, Module):
+            elif isinstance(item, ExtensionModule):
                 var = f"{item.name}_module"
             else:
                 assert False
@@ -103,7 +103,7 @@ def _render_build_target(r: RenderBuffer, vc: VarCache, bt: BuildTarget):
             assert depfile is None, bt
             cmd.append("'@DEPFILE@'")
             depfile = _make_string(arg.name)
-        elif isinstance(arg, Module):
+        elif isinstance(arg, ExtensionModule):
             cmd.append(f"'@INPUT{len(tinput)}@'")
             tinput.append(vc.getvar(arg))
         else:
@@ -131,14 +131,14 @@ def _render_build_target(r: RenderBuffer, vc: VarCache, bt: BuildTarget):
     r.writeln(")")
 
 
-def _render_module_stage0(r: RenderBuffer, vc: VarCache, m: Module):
+def _render_module_stage0(r: RenderBuffer, vc: VarCache, m: ExtensionModule):
 
     # variables generated here should be deterministic so that users can add
     # their own things to it, or use it directly
 
     r.writeln(f"# {m.package_name}")
-    r.writeln(f"{m.name}_module_sources = []")
-    r.writeln(f"{m.name}_module_deps = [declare_dependency(")
+    r.writeln(f"{m.name}_sources = []")
+    r.writeln(f"{m.name}_deps = [declare_dependency(")
     with r.indent():
 
         if m.sources:
@@ -156,23 +156,23 @@ def _render_module_stage0(r: RenderBuffer, vc: VarCache, m: Module):
     r.writeln(")]")
 
 
-def _render_module_stage1(r: RenderBuffer, vc: VarCache, m: Module):
+def _render_module_stage1(r: RenderBuffer, vc: VarCache, m: ExtensionModule):
 
     # variables generated here should be deterministic so that users can
     # use it directly if they wish
 
     subdir = _make_string(m.install_path.as_posix())
-    package_name = _make_string(m.package_name)
+    module_name = _make_string(m.package_name.split(".")[-1])
     mvar = vc.getvar(m)
 
     r.writeln(f"# {m.package_name}")
     r.writeln(f"{mvar} = sw_py.extension_module(")
     with r.indent():
         r.write_trim(
             f"""
-            '_{m.name}',
-            sources: [{m.name}_module_sources],
-            dependencies: [{m.name}_module_deps],
+            {module_name},
+            sources: [{m.name}_sources],
+            dependencies: [{m.name}_deps],
             install: true,
             subdir: {subdir},        
         """
@@ -196,12 +196,12 @@ def gen_meson(project_root: pathlib.Path) -> T.Tuple[str, str, T.List[Entrypoint
     # standard boilerplate here
     r0.write_trim(
         """
-       # This file is automatically generated, DO NOT EDIT
-       #
-       # The generator's stable API includes variables that do not start with
-       # an underscore. Any variables with an underscore may change in the future
-       # without warning
-       #
+        # This file is automatically generated, DO NOT EDIT
+        #
+        # The generator's stable API includes variables that do not start with
+        # an underscore. Any variables with an underscore may change in the future
+        # without warning
+        #
                  
         sw_py = import('python').find_installation()
         
@@ -228,7 +228,7 @@ def gen_meson(project_root: pathlib.Path) -> T.Tuple[str, str, T.List[Entrypoint
     #     is simpler to generate
 
     plan = makeplan(pathlib.Path(project_root))
-    modules: T.List[Module] = []
+    modules: T.List[ExtensionModule] = []
     pyi_targets: T.List[BuildTarget] = []
 
     for item in plan:
@@ -238,7 +238,7 @@ def gen_meson(project_root: pathlib.Path) -> T.Tuple[str, str, T.List[Entrypoint
                 pyi_targets.append(item)
             else:
                 _render_build_target(r0, vc, item)
-        elif isinstance(item, Module):
+        elif isinstance(item, ExtensionModule):
             # defer these to the end
             modules.append(item)
         elif isinstance(item, Entrypoint):
@@ -250,9 +250,9 @@ def gen_meson(project_root: pathlib.Path) -> T.Tuple[str, str, T.List[Entrypoint
         r0.writeln()
         r0.write_trim(
             """
-           #
-           # Module configurations
-           #
+            #
+            # Module configurations
+            #
         """
         )
         r0.writeln()

src/semiwrap/config/pyproject_toml.py

@@ -13,13 +13,13 @@
 @dataclasses.dataclass
 class TypeCasterConfig:
     """
-    Specifies type casters that this package exports. robotpy-build
+    Specifies type casters that this package exports. semiwrap
     will attempt to detect these types at generation time and include
     them in generated wrappers.
 
     .. code-block:: toml
 
-       [[tool.robotpy-build.wrappers."PACKAGENAME".type_casters]]
+       [[tool.semiwrap.modules."PACKAGENAME".type_casters]]
        header = "my_type_caster.h"
        types = ["foo_t", "ns::ins::bar_t"]
 
@@ -41,25 +41,34 @@ class TypeCasterConfig:
 
 
 @dataclasses.dataclass
-class ModuleConfig:
+class ExtensionModuleConfig:
     """
     Configuration for generating pybind11 wrappers around specified header files.
-    The
+
+    .. code-block:: toml
+
+        [tool.semiwrap.extension_modules."PACKAGE.NAME"]
+
     """
 
-    #: Name that other projects/wrappers use in their 'depends' list
-    name: str
+    #: The name used internally to refer to this extension module. The name is
+    #: used as the prefix of variable names in build files.
+    #:
+    #: If not specified, the default name is the package name with invalid
+    #: characters replaced by underscores.
+    name: Optional[str] = None
 
     #: Name of generated file that ensures the shared libraries and any
-    #: dependencies are loaded. Defaults to ``_init_{name}.py``
+    #: dependencies are loaded. Defaults to ``_init_XXX.py``, where XXX
+    #: is the last element of the package name
     #:
     #: Generally, you should create an ``__init__.py`` file that imports
     #: this module, otherwise your users will need to do so.
     libinit: Optional[str] = None
 
     #: Name of pkgconf libraries that this is wrapping. This is also added to
     #: depends list.
-    wraps: List[str] = []
+    wraps: List[str] = dataclasses.field(default_factory=list)
 
     #: List of pkgconf library dependencies. This affects this wrapper
     #: library in the following ways:
@@ -75,10 +84,6 @@ class ModuleConfig:
     #: project root.
     extra_includes: List[str] = dataclasses.field(default_factory=list)
 
-    # #: Optional source files to compile. Path is relative to the root of
-    # #: the project.
-    # sources: List[str] = dataclasses.field(default_factory=list)
-
     #: Specifies header files that autogenerated pybind11 wrappers will be
     #: created for. Simple C++ headers will most likely 'just work', but
     #: complex headers will need to have an accompanying :attr:`generation_data`
@@ -92,21 +97,21 @@ class ModuleConfig:
     #:
     #: .. code-block:: toml
     #:
-    #:    [tool.robotpy-build.wrappers."PACKAGENAME".headers]
+    #:    [tool.semiwrap.extension_modules."PACKAGE.NAME".headers]
     #:    Name = "header.h"
     #:
     #: .. seealso:: :ref:`autowrap`
     #:
-    headers: Dict[str, str] = {}
+    headers: Dict[str, str] = dataclasses.field(default_factory=dict)
 
     #: Path to a directory of yaml files. Generation data will be looked up
     #: using the key in the generate dictionary.
     #:
-    #: These YAML files can be generated via the robotpy-build command line tool:
+    #: These YAML files can be generated via the semiwrap command line tool:
     #:
     #: .. code-block:: sh
     #:
-    #:    robotpy-build create-gen --write
+    #:    semiwrap create-gen --write
     #:
     #: .. seealso:: :ref:`gendata`
     #:
@@ -116,7 +121,7 @@ class ModuleConfig:
     type_casters: List[TypeCasterConfig] = dataclasses.field(default_factory=list)
 
     #: Preprocessor definitions to apply when compiling this wrapper.
-    pp_defines: List[str] = dataclasses.field(default_factory=list)
+    # pp_defines: List[str] = dataclasses.field(default_factory=list)
 
     #: If True, skip this wrapper; typically used in conjection with an override.
     ignore: bool = False
@@ -138,13 +143,14 @@ class SemiwrapToolConfig:
     scan_headers_ignore: List[str] = dataclasses.field(default_factory=list)
 
     #: List of python packages with __init__.py to update when ``python setup.py update_init``
-    #: is called -- this is an argument to the ``robotpy-build create-imports`` command, and
+    #: is called -- this is an argument to the ``semiwrap create-imports`` command, and
     #: may contain a space and the second argument to create-imports.
     # update_init: List[str] = []
 
-    #: Modules to autogenerate. The key is the python package name
-    #: that the module will live in
-    modules: Dict[str, ModuleConfig] = dataclasses.field(default_factory=dict)
+    #: Modules to autogenerate. The key is the name of the python package that will
+    #: be generated. For example, "package.name" will cause the shared library
+    #: 'package/name-{abi tag}.so' to be installed in 
+    extension_modules: Dict[str, ExtensionModuleConfig] = dataclasses.field(default_factory=dict)
 
 
 @dataclasses.dataclass

src/semiwrap/config/util.py

@@ -11,7 +11,7 @@ class ValidationError(Exception):
 
 
 def _convert_validation_error(
-    fname: str, ve: errors.ValidationError
+    fname, ve: errors.ValidationError
 ) -> ValidationError:
     locs = []
     msg = []
@@ -36,7 +36,7 @@ def _convert_validation_error(
     return ValidationError(vmsg)
 
 
-def parse_input(value: typing.Any, spec: typing.Type[T], fname: str) -> T:
+def parse_input(value: typing.Any, spec: typing.Type[T], fname) -> T:
     try:
         return validobj.validation.parse_input(value, spec)
     except errors.ValidationError as ve: