Skip to content

Don't let user override fire_event, register_event_handler, or unregister_event_handler in a mechanism #258

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

Merged
merged 1 commit into from
Sep 26, 2025
Merged

Don't let user override fire_event, register_event_handler, or unregister_event_handler in a mechanism #258

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
14 changes: 11 additions & 3 deletions src/toolbox/methods_category.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,21 +73,29 @@ class MethodsCategory {
// TODO(lizlooney): We need a way to mark a method in python as not overridable.
// For example, in RobotBase, define_hardware, register_event_handler,
// unregister_event_handler, and fire_event should not be overridden in a user's robot.
const methodNamesNotOverrideable: string[] = [
const robotMethodNamesNotOverrideable: string[] = [
'define_hardware',
'fire_event',
'register_event_handler',
'unregister_event_handler',
];
// Add the methods for a Robot.
this.addClassBlocksForCurrentModule(
'More Robot Methods', this.robotClassBlocks, methodNamesNotOverrideable,
'More Robot Methods', this.robotClassBlocks, robotMethodNamesNotOverrideable,
methodNamesAlreadyOverridden, contents);
break;
case storageModule.ModuleType.MECHANISM:
// TODO(lizlooney): We need a way to mark a method in python as not overridable.
// For example, in Mechanism, register_event_handler, unregister_event_handler, and
// fire_event should not be overridden in a user's mechamism.
const mechanismMethodNamesNotOverrideable: string[] = [
'fire_event',
'register_event_handler',
'unregister_event_handler',
];
// Add the methods for a Mechanism.
this.addClassBlocksForCurrentModule(
'More Mechanism Methods', this.mechanismClassBlocks, [],
'More Mechanism Methods', this.mechanismClassBlocks, mechanismMethodNamesNotOverrideable,
methodNamesAlreadyOverridden, contents);
break;
case storageModule.ModuleType.OPMODE:
Expand Down