ZacharyZhang-NY
e74dafcd36
Three independently ugly bugs that all fed the same log flood:
* Electron's `WebFrameMain.send` writes every "Render frame was disposed"
to stderr via `console.error`. When the worker fans a second
agent-event past a reloading renderer, we produced thousands of
identical lines and stalled the main loop on stderr I/O. Added a
`mainFrame.detached` guard so the send is short-circuited before
Electron's own catch block fires, and installed a targeted filter in
`suppress-warnings.ts` (now actually imported from the entry point)
so the specific `console.error("Error sending from webFrameMain:"…)`
noise never reaches the terminal. Any other payload still surfaces.
* `dispatchAgentMessage` accepted the human-reader sentinel as a wake
target when an agent replied to `__board__` — `wakeAgentIfPossible`
then called `db.getAgent("__board__")`, threw, and the dispatcher
kept repeating on every send. Strip `HUMAN_SENDER_ID` at
`resolveMessageWakeTargets`, and keep a defense-in-depth guard in the
heartbeat so a stray caller (future automation fan-out) cannot
reintroduce the crash.
* Pi's skills loader rejects any SKILL.md whose frontmatter `name`
diverges from its parent directory. The four bundled `my-writing-style`
copies declared `name: writing-style-skill`, so every install emitted
a warning and dropped the skill. They also lived as orphan gitlinks
(mode 160000 without .gitmodules), and the global `*.md` gitignore
hid every other SKILL.md from version control. Fixed the frontmatter
to match the dir, converted the dangling submodules to plain trees,
and allowlisted `builtin-skills/**/*.md` so a fresh clone carries the
catalogue instead of silently losing it.
67 lines
1.5 KiB
Markdown
67 lines
1.5 KiB
Markdown
---
|
|
name: clean-functions
|
|
description: Use when writing, fixing, editing, or refactoring Python functions. Enforces Clean Code principles—maximum 3 arguments, single responsibility, no flag parameters.
|
|
---
|
|
|
|
# Clean Functions
|
|
|
|
## F1: Too Many Arguments (Maximum 3)
|
|
|
|
```python
|
|
# Bad - too many parameters
|
|
def create_user(name, email, age, country, timezone, language, newsletter):
|
|
...
|
|
|
|
# Good - use a dataclass or dict
|
|
@dataclass
|
|
class UserData:
|
|
name: str
|
|
email: str
|
|
age: int
|
|
country: str
|
|
timezone: str
|
|
language: str
|
|
newsletter: bool
|
|
|
|
def create_user(data: UserData):
|
|
...
|
|
```
|
|
|
|
More than 3 arguments means your function is doing too much or needs
|
|
a data structure.
|
|
|
|
## F2: No Output Arguments
|
|
|
|
Don't modify arguments as side effects. Return values instead.
|
|
|
|
```python
|
|
# Bad - modifies argument
|
|
def append_footer(report: Report) -> None:
|
|
report.append("\n---\nGenerated by System")
|
|
|
|
# Good - returns new value
|
|
def with_footer(report: Report) -> Report:
|
|
return report + "\n---\nGenerated by System"
|
|
```
|
|
|
|
## F3: No Flag Arguments
|
|
|
|
Boolean flags mean your function does at least two things.
|
|
|
|
```python
|
|
# Bad - function does two different things
|
|
def render(is_test: bool):
|
|
if is_test:
|
|
render_test_page()
|
|
else:
|
|
render_production_page()
|
|
|
|
# Good - split into two functions
|
|
def render_test_page(): ...
|
|
def render_production_page(): ...
|
|
```
|
|
|
|
## F4: Delete Dead Functions
|
|
|
|
If it's not called, delete it. No "just in case" code. Git preserves history.
|