Add update_init command to make updating __init__.py easier

- Implemented for now as a setup.py subcommand because it's a lot simpler... maybe
  if we move away from setuptools we can make it a robotpy-build command instead

Author: virtuald

docs/tools.rst

@@ -40,3 +40,15 @@ python package.
 .. code-block:: sh
 
     $ python -m robotpy_build create-imports rpydemo rpydemo._rpydemo
+
+Use the ``--write`` argument to write the file.
+
+To write a list of ``__init__.py`` files, you can specify them in the ``pyproject.toml``
+file like so:
+
+.. code-block:: toml
+
+    [tool.robotpy-build]
+    update_init = ["rpydemo rpydemo._rpydemo"]
+
+To actually update the files, run ``python setup.py update_init``.

robotpy_build/command/update_init.py

@@ -0,0 +1,73 @@
+import json
+import os
+import subprocess
+import sys
+import typing
+
+try:
+    from setuptools.errors import BaseError
+except ImportError:
+    from distutils.errors import DistutilsError as BaseError
+
+from ._built_env import _BuiltEnv, _PackageFinder
+
+
+class UpdateInitError(BaseError):
+    pass
+
+
+class UpdateInit(_BuiltEnv):
+    update_list: typing.List[str]
+
+    command_name = "update_init"
+    description = (
+        "Updates __init__.py files using settings from tool.robotpy-build.update_init"
+    )
+
+    def run(self):
+        # cannot use when cross-compiling
+        if (
+            "_PYTHON_HOST_PLATFORM" in os.environ
+            or "PYTHON_CROSSENV" in os.environ
+            or not self.update_list
+        ):
+            return
+
+        data, env = self.setup_built_env()
+        data["update_list"] = self.update_list
+
+        data_json = json.dumps(data)
+
+        # Execute in a subprocess in case it crashes
+        args = [sys.executable, "-m", __name__]
+        try:
+            subprocess.run(args, input=data_json.encode("utf-8"), env=env, check=True)
+        except subprocess.CalledProcessError:
+            raise UpdateInitError(
+                "Failed to generate .pyi file (see above, or set RPYBUILD_SKIP_PYI=1 to ignore) via %s"
+                % (args,)
+            ) from None
+
+
+def main():
+    cfg = json.load(sys.stdin)
+
+    # Configure custom loader
+    _PackageFinder.mapping = cfg["mapping"]
+    sys.meta_path.insert(0, _PackageFinder)
+
+    from .. import tool
+
+    # Update init
+
+    for to_update in cfg["update_list"]:
+
+        sys.argv = ["<dummy>", "create-imports", "-w"] + to_update.split(" ", 1)
+
+        retval = tool.main()
+        if retval != 0:
+            break
+
+
+if __name__ == "__main__":
+    main()

robotpy_build/config/pyproject_toml.py

@@ -416,6 +416,11 @@ class RobotpyBuildConfig(Model):
     #: Python package to store version information and robotpy-build metadata in
     base_package: str
 
+    #: 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
+    #: may contain a space and the second argument to create-imports.
+    update_init: List[str] = []
+
     #:
     #: .. seealso:: :class:`.SupportedPlatform`
     #:

robotpy_build/setup.py

@@ -23,6 +23,7 @@ def finalize_options(self):
 from .command.build_ext import BuildExt
 from .command.build_pyi import BuildPyi
 from .command.develop import Develop
+from .command.update_init import UpdateInit
 
 try:
     from .command.editable_wheel import EditableWheel
@@ -155,6 +156,7 @@ def _xform(v: str):
             "build_ext": BuildExt,
             "build_pyi": BuildPyi,
             "develop": Develop,
+            "update_init": UpdateInit,
         }
         if EditableWheel:
             self.setup_kwargs["cmdclass"]["editable_wheel"] = EditableWheel
@@ -165,6 +167,7 @@ def _xform(v: str):
             cls.static_libs = self.static_libs
             cls.rpybuild_pkgcfg = self.pkgcfg
         BuildPyi.base_package = self.base_package
+        UpdateInit.update_list = self.project.update_init
 
         # We already know some of our packages, so collect those in addition
         # to using find_packages()

robotpy_build/static_libs.py

@@ -33,6 +33,9 @@ def set_root(self, root: os.PathLike) -> None:
         self.incdir = join(self.root, self.name, "include")
 
     def get_include_dirs(self) -> Optional[List[str]]:
+        if self.incdir is None:
+            return
+
         includes = [self.incdir]
         if self.cfg.download:
             for dl in self.cfg.download:
@@ -41,7 +44,8 @@ def get_include_dirs(self) -> Optional[List[str]]:
         return includes
 
     def get_library_dirs(self) -> Optional[List[str]]:
-        return [self.libdir]
+        if self.libdir:
+            return [self.libdir]
 
     def get_library_dirs_rel(self) -> Optional[List[str]]:
         pass
@@ -60,7 +64,8 @@ def get_extra_objects(self) -> Optional[List[str]]:
         if self.platform.os == "windows":
             return
 
-        return [join(self.libdir, lib) for lib in self._get_libnames()]
+        if self.libdir:
+            return [join(self.libdir, lib) for lib in self._get_libnames()]
 
     def get_type_casters_cfg(self, casters: Dict[str, Dict[str, Any]]) -> None:
         pass

robotpy_build/tool.py

@@ -29,11 +29,6 @@
 def get_setup() -> Setup:
     s = Setup()
     s.prepare()
-
-    temp_path = join(get_build_temp_path(), "dlstatic")
-    for static_lib in s.static_libs:
-        static_lib.set_root(temp_path)
-
     return s
 
 
@@ -544,8 +539,8 @@ def main():
     else:
         retval = 0
 
-    exit(retval)
+    return retval
 
 
 if __name__ == "__main__":
-    main()
+    exit(main())

robotpy_build/wrapper.py

@@ -288,7 +288,9 @@ def all_deps(self):
     def _all_includes(self, include_rpyb):
         includes = self.get_include_dirs()
         for dep in self.all_deps():
-            includes.extend(dep.get_include_dirs())
+            dep_inc = dep.get_include_dirs()
+            if dep_inc:
+                includes.extend(dep_inc)
         if include_rpyb:
             includes.extend(self.pkgcfg.get_pkg("robotpy-build").get_include_dirs())
         return includes