Skip to content

Refactor generation script #287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Gold856 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Refactor generation script #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 15 additions & 40 deletions subprojects/robotpy-commands-v2/tools/hids/generate_hids.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,17 @@
# Open Source Software; you can modify and/or share it under the terms of
# the WPILib BSD license file in the root directory of this project.

import argparse
import json
import re
import sys
from pathlib import Path

from jinja2 import Environment, FileSystemLoader

# When invoked directly, Python puts the script directory on sys.path.
# Add the repo root so absolute package imports still work.
sys.path.insert(0, str(Path(__file__).absolute().parent.parent))

def write_controller_file(output_dir: Path, controller_name: str, contents: str):
output_dir.mkdir(parents=True, exist_ok=True)
output_file = output_dir / controller_name
output_file.write_text(contents, encoding="utf-8", newline="\n")
from jinja2 import Environment, FileSystemLoader
from shared.generation import write_file, add_jinja_args, make_arg_parser


def generate_hids(
Expand All @@ -38,8 +37,7 @@ def generate_hids(
template = env.get_template("commandhid.java.jinja")
for controller in controllers:
controllerName = f"Command{controller['ConsoleName']}Controller.java"
output = template.render(controller)
write_controller_file(root_path, controllerName, output)
write_file(root_path, controllerName, template.render(controller))

# C++ headers
hdr_subdirectory = "main/native/include/wpi/commands2/button"
Expand All @@ -52,8 +50,7 @@ def generate_hids(
template = env.get_template("commandhid.hpp.jinja")
for controller in controllers:
controllerName = f"Command{controller['ConsoleName']}Controller.hpp"
output = template.render(controller)
write_controller_file(root_path, controllerName, output)
write_file(root_path, controllerName, template.render(controller))

# C++ files
cpp_subdirectory = "main/native/cpp/wpi/commands2/button"
Expand All @@ -65,8 +62,7 @@ def generate_hids(
template = env.get_template("commandhid.cpp.jinja")
for controller in controllers:
controllerName = f"Command{controller['ConsoleName']}Controller.cpp"
output = template.render(controller)
write_controller_file(root_path, controllerName, output)
write_file(root_path, controllerName, template.render(controller))


def _capitalize_first(name: str) -> str:
Expand Down Expand Up @@ -181,8 +177,7 @@ def generate_first_ds_hids(
template = env.get_template("first_ds_commandhid.java.jinja")
for controller in controllers:
controller_name = f"Command{controller['ClassName']}Controller.java"
output = template.render(controller)
write_controller_file(root_path, controller_name, output)
write_file(root_path, controller_name, template.render(controller))

# C++ headers
hdr_subdirectory = "main/native/include/wpi/commands2/button"
Expand All @@ -195,8 +190,7 @@ def generate_first_ds_hids(
template = env.get_template("first_ds_commandhid.hpp.jinja")
for controller in controllers:
controller_name = f"Command{controller['ClassName']}Controller.hpp"
output = template.render(controller)
write_controller_file(root_path, controller_name, output)
write_file(root_path, controller_name, template.render(controller))

# C++ files
cpp_subdirectory = "main/native/cpp/wpi/commands2/button"
Expand All @@ -209,8 +203,7 @@ def generate_first_ds_hids(
template = env.get_template("first_ds_commandhid.cpp.jinja")
for controller in controllers:
controller_name = f"Command{controller['ClassName']}Controller.cpp"
output = template.render(controller)
write_controller_file(root_path, controller_name, output)
write_file(root_path, controller_name, template.render(controller))

if python_output_directory is not None:
python_subdirectory = "commands2/button"
Expand All @@ -223,33 +216,15 @@ def generate_first_ds_hids(
template = env.get_template("first_ds_commandhid.py.jinja")
for controller in controllers:
controller_name = f"command{controller['ClassName'].lower()}controller.py"
output = template.render(controller)
write_controller_file(root_path, controller_name, output)
write_file(root_path, controller_name, template.render(controller))


def main():
script_path = Path(__file__).resolve()
dirname = script_path.parent

parser = argparse.ArgumentParser()
parser.add_argument(
"--output_directory",
help="Optional. If set, will output the generated files to this directory, otherwise it will use a path relative to the script",
default=dirname / "src/generated",
type=Path,
)
parser.add_argument(
"--template_root",
help="Optional. If set, will use this directory as the root for the jinja templates",
default=dirname / "src/generate",
type=Path,
)
parser.add_argument(
"--schema_file",
help="Optional. If set, will use this file for the joystick schema",
default="wpilibj/src/generate/hids.json",
type=Path,
)
parser = make_arg_parser(dirname, dirname.parent)
add_jinja_args(parser, dirname, "wpilibj/src/generate/hids.json")
parser.add_argument(
"--first_ds_schema_file",
help="Optional. If set, will use this file for the FIRST Driver Station HID schema",
Expand Down
191 changes: 191 additions & 0 deletions subprojects/robotpy-commands-v2/tools/shared/generation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
# Copyright (c) FIRST and other WPILib contributors.
# Open Source Software; you can modify and/or share it under the terms of
# the WPILib BSD license file in the root directory of this project.
import argparse
import subprocess
import sys

from enum import Enum, auto
from pathlib import Path


class GeneratorTypes(Enum):
QUICKBUF = auto()
NANOPB = auto()


def make_arg_parser(
subproject_root: Path, repo_root: Path, *args
) -> argparse.ArgumentParser:
"""Creates an ArgumentParser configured for QuickBuffers or nanopb generation.

Keyword arguments:
subproject_root -- Path to the subproject root. Determines default output and proto directories.
repo_root -- Path to the repo root. Used to find the nanopb generator.

Returns:
The ArgumentParser with the necessary arguments.
"""
parser = argparse.ArgumentParser()
parser.add_argument(
"--output_directory",
help="Optional. If set, will output the generated files to this directory, otherwise it will use a path relative to the script",
default=subproject_root / "src/generated",
type=Path,
)
if GeneratorTypes.QUICKBUF in args or GeneratorTypes.NANOPB in args:
parser.add_argument(
"--proto_directory",
help="Optional. If set, will use this directory to glob for protobuf files",
default=subproject_root / "src/main/proto",
type=Path,
)
if GeneratorTypes.QUICKBUF in args:
parser.add_argument(
"--protoc",
help="Protoc executable command",
default="protoc",
)
parser.add_argument(
"--quickbuf_plugin",
help="Optional if you use protoc-quickbuf as protoc. Path to the quickbuf protoc plugin.",
)
parser.set_defaults(
output_directory=subproject_root / "src/generated/main/java"
)
if GeneratorTypes.NANOPB in args:
parser.add_argument(
"--nanopb",
help="Nanopb generator command",
default=repo_root
/ "wpiutil/src/main/native/thirdparty/nanopb/generator/nanopb_generator.py",
)
parser.set_defaults(
output_directory=subproject_root / "src/generated/main/native/cpp"
)
return parser


def add_jinja_args(
parser: argparse.ArgumentParser,
subproject_root: Path,
default_schema_file: str | Path | None,
) -> None:
"""Configures an ArgumentParser for Jinja generation.

Keyword arguments:
parser -- The ArgumentParser to configure.
subproject_root -- Path to the subproject root. Determines default template directory.
default_schema_file -- The path to the schema file, or None to skip using a schema file.
"""
parser.add_argument(
"--template_root",
help="Optional. If set, will use this directory as the root for the jinja templates",
default=subproject_root / "src/generate",
type=Path,
)
if default_schema_file is not None:
parser.add_argument(
"--schema_file",
help="Optional. If set, will use this file for the joystick schema",
default=default_schema_file,
type=Path,
)


def write_file(output_dir: Path, outfn: str, contents: str) -> None:
"""Writes contents to a file.

Keyword arguments:
output_dir -- The output directory.
outfn -- The output file name.
contents -- The contents of the file.
"""
output_dir.mkdir(parents=True, exist_ok=True)
output_file = output_dir / outfn
output_file.write_text(contents, encoding="utf-8", newline="\n")


def generate_quickbuf(
protoc: Path, quickbuf_plugin: Path | None, output_directory: Path, proto_dir: Path
) -> None:
"""Generates QuickBuffers files.

Keyword arguments:
protoc -- The Protocol Buffers compiler.
quickbuf_plugin -- The QuickBuffers protoc plugin, or None if using protoc-quickbuf.
output_directory -- The base output directory to write generated files to.
proto_dir -- The base directory with protobuf files.
"""
# Wipe away all protobuf files (and only protobuf files) first to ensure correctness
for file in output_directory.glob("**/Protobuf*.java"):
file.unlink()
# Nice to have if you delete the whole generated directory
output_directory.mkdir(parents=True, exist_ok=True)
for path in proto_dir.glob("**/*.proto"):
args = [str(protoc)]
if quickbuf_plugin:
# Optional if using protoc-quickbuf
args += [f"--plugin=protoc-gen-quickbuf={quickbuf_plugin}"]
args += [
f"--quickbuf_out=gen_descriptors=true:{str(output_directory.absolute())}",
f"-I{proto_dir.absolute()}",
str(path.absolute()),
]
subprocess.check_call(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
# Prepend files with license
for java_file in output_directory.glob("**/Protobuf*.java"):
with java_file.open(encoding="utf-8") as f:
content = f.read()

java_file.write_text(
"// Copyright (c) FIRST and other WPILib contributors.\n// Open Source Software; you can modify and/or share it under the terms of\n// the WPILib BSD license file in the root directory of this project.\n"
+ content,
encoding="utf-8",
newline="\n",
)


def generate_nanopb(
nanopb: Path,
output_directory: Path,
proto_dir: Path,
extra_search_dirs: list[Path] = [],
) -> None:
"""Generates QuickBuffers files.

Keyword arguments:
nanopb -- The nanopb generator.
output_directory -- The base output directory to write generated files to.
proto_dir -- The base directory with protobuf files.
extra_search_dirs -- Extra directories to search for protobuf files.,
"""
# Wipe away all protobuf files (and only protobuf files) first to ensure correctness
for file in output_directory.glob("**/*.npb.*"):
file.unlink()
# Nice to have if you delete the whole generated directory
output_directory.mkdir(parents=True, exist_ok=True)
for path in proto_dir.glob("**/*.proto"):
subprocess.check_call(
([sys.executable] if str(nanopb).endswith(".py") else [])
+ [
str(nanopb),
*extra_search_dirs,
f"-I{proto_dir.absolute()}",
f"-D{output_directory.absolute()}",
"-S.cpp",
"-e.npb",
str(path.absolute()),
],
)
# Prepend files with license
for file in output_directory.glob("**/*.npb.*"):
with file.open(encoding="utf-8") as f:
content = f.read()

file.write_text(
"// Copyright (c) FIRST and other WPILib contributors.\n// Open Source Software; you can modify and/or share it under the terms of\n// the WPILib BSD license file in the root directory of this project.\n"
+ content,
encoding="utf-8",
newline="\n",
)
Loading