docs: detailed documentation of pidog/action_flow.py - #1
Merged
Conversation
Co-Authored-By: Pascal Desmet <dpwp81@outlook.com>
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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.
Summary
Adds
docs/action_flow.md, a documentation-only deep dive intopidog/action_flow.py(ActionFlow,Posetures,ActionStatus). No code changes.Covers: where
ActionFlowsits in the stack (app →ActionFlow→preset_actions→Pidog→actions_dictionary), theOPERATIONSrecipe schema and every entry, posture/head-pitch compensation, therun()execution orderposeture → before → function → after(each stage followed by a blockingwait_all_done()), the worker-thread state machine (STANDBY/THINK/ACTIONS), the public API, and the concurrency model.It also records concrete findings from reading the code alongside
preset_actions.py/pidog.py:standby_actions = ['waiting', 'feet_left_right']—'feet_left_right'is not a key inOPERATIONS, andrun()ignores unknown names silently, so ~23% of idle ticks are no-ops (likely meant'feet shake').enum.StrEnumrequires Python ≥ 3.11, butpyproject.tomldeclaresrequires-python = ">=3.7".last_actions(last action name) instead ofself.posture, and is only updated for actions that declareposeture, sosit → bark → sitskips the second sit transition.self.OPERATIONS[before]["function"]assumes the key exists —KeyErrorfor entries like"stop"(currently unreachable).action_queue.get()has no timeout, sostop()/join()can hang if the state isACTIONSwith an empty queue.run()relies onrandomleaking in viafrom .preset_actions import *.HEAD_ANGLE,ActionStatus.ACTIONS_DONE, thehead_pitchkey on"nod";"stop"is an empty recipe and does not callPidog.body_stop().Link to Devin session: https://app.devin.ai/sessions/7111583235ea4084a505cf2a925fd7aa
Requested by: @PascalDesmet