Overhaul hooklist API to fully catch all add/delete events#38
Merged
Conversation
rvega10
approved these changes
Sep 9, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR overhauls the HookList API to comprehensively capture all list modification events, moving the implementation to a dedicated utils module and fixing several initialization and callback issues.
Key changes:
- Moved HookList implementation from World.py to utils/collections.py with enhanced callback support
- Converted World.population and World.objects to properties with proper HookList backing
- Fixed World.quad initialization and BinaryFOVSensor handling of None quad values
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/swarmsim/world/World.py | Moved HookList to utils, converted population/objects to properties with private backing fields |
| src/swarmsim/world/RectangularWorld.py | Updated method names to snake_case and fixed quad initialization |
| src/swarmsim/util/collections.py | Added comprehensive HookList implementation with full callback support |
| src/swarmsim/sensors/BinaryFOVSensor.py | Added null check for world.quad and updated property reference |
| demo/population_hook_test.py | Updated to use new HookList callback registration methods |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
HookListtoutils.pyWorld.populationandWorld.objectsare now propertiesWorld.quadnot being defined at init timeBinaryFOVSensorwill skip update ifworld.quad is NoneHookList.__setitem__(i.e.population[:] = iterable) calls del_callback on the items being replaced and add_callback on the new itemsfunc in HookList._add_callbacksis called for:HookList.__init__(if you somehow manage to create a new one with callbacks on it)HookList.appendHookList.extendHookList.insertHookList.__iadd__HookList.__imul__HookList.__setitem__func in HookList._del_callbacksis called for:HookList.popHookList.removeHookList.__setitem__