mirror of
https://github.com/rennf93/roboco.git
synced 2026-08-03 07:23:24 +02:00
879afc14a4
* fix(board): LEARN decisions name the item, not its per-cycle index A cycle's reject reasons are rendered into the NEXT cycle's exploration prompt, but the ref recorded alongside each reason was the item's stored id (item-0/item-1) — a per-cycle index that means something different every cycle and appears nowhere the explorer can resolve. The reason survived the loop; what it was about did not. Record the item's title instead, via a shared learn_ref() helper (falls back to the id when title-less, and reads target_task_title for Scales, whose items name the live task they mutate). * chore(lint): satisfy ruff 0.16 — keyword-only signatures and markdown formatting The dev toolchain resolved ruff 0.16.0, which stabilises PLR0917 (too many positional arguments) and formats python code blocks inside markdown. Both fired repo-wide and neither had anything to do with the code they flagged. - 36 signatures gain a `*` so their tail arguments are keyword-only, and the 104 call sites that passed them positionally are converted. mypy was the safety net for the static ones; the full suite caught nine more that only bind at runtime (the MCP tool functions, whose real callers already pass named JSON arguments). - 28 markdown files reformatted by 0.16's code-block formatter. - One RUF036 (`None` mid-union) autofixed in the GitLab provider. * fix(gateway): log the reason when a verb rejects A rejected envelope rides an HTTP 200, its body is never logged, and there is no trace table — so in the access log a verb an agent could not satisfy looks identical to one that worked. On 2026-07-25 four Board Programs (Periscope, Sentinel, Scales, Barfly) each POSTed their propose verb three or four times, persisted nothing, and left their exploration tasks PENDING; the reason was unrecoverable afterwards, from the logs or from the agents' own transcripts. Log error/message/remediate/missing plus the calling agent at envelope_to_response — the one chokepoint every v1 flow and do route returns through. Success envelopes stay silent. --------- Co-authored-by: Renn F <rennf93@users.noreply.github.com>
102 lines
1.7 KiB
Markdown
102 lines
1.7 KiB
Markdown
# Python Coding Standards
|
|
|
|
## Package Manager
|
|
|
|
Use `uv` for all Python operations.
|
|
|
|
```bash
|
|
# Add dependency
|
|
uv add package-name
|
|
|
|
# Add dev dependency
|
|
uv add --dev package-name
|
|
|
|
# Sync dependencies
|
|
uv sync
|
|
|
|
# Run command
|
|
uv run pytest
|
|
```
|
|
|
|
## Before Every Commit
|
|
|
|
```bash
|
|
uv run ruff format . # Format code
|
|
uv run ruff check . # Lint
|
|
uv run mypy roboco/ # Type check
|
|
uv run pytest # Tests
|
|
```
|
|
|
|
## Type Hints Required
|
|
|
|
All functions MUST have type hints:
|
|
|
|
```python
|
|
# Good
|
|
async def fetch_user(user_id: UUID) -> User | None: ...
|
|
|
|
|
|
# Bad - no type hints
|
|
def fetch_user(user_id): ...
|
|
```
|
|
|
|
## Naming Conventions
|
|
|
|
| Type | Convention | Example |
|
|
|------|------------|---------|
|
|
| Classes | PascalCase | `TaskService` |
|
|
| Functions | snake_case | `get_user` |
|
|
| Variables | snake_case | `user_id` |
|
|
| Constants | SCREAMING | `MAX_RETRIES` |
|
|
| Private | Leading `_` | `_cache` |
|
|
|
|
## Line Length
|
|
|
|
Maximum 88 characters (Black default).
|
|
|
|
## Imports
|
|
|
|
Sorted order: stdlib, third-party, local.
|
|
|
|
```python
|
|
import asyncio
|
|
from pathlib import Path
|
|
|
|
from fastapi import FastAPI
|
|
from pydantic import BaseModel
|
|
|
|
from roboco.models import Task
|
|
from roboco.services import TaskService
|
|
```
|
|
|
|
## Async by Default
|
|
|
|
ALL I/O operations must be async:
|
|
|
|
```python
|
|
# Good
|
|
async def fetch_user(user_id: str) -> User:
|
|
return await db.users.get(user_id)
|
|
|
|
|
|
# Bad - blocking
|
|
def fetch_user(user_id: str) -> User:
|
|
return db.users.get(user_id) # Blocks!
|
|
```
|
|
|
|
## Concurrent Operations
|
|
|
|
Use `asyncio.gather` for independent async calls:
|
|
|
|
```python
|
|
# Good - parallel
|
|
task, comments = await asyncio.gather(
|
|
get_task(task_id),
|
|
get_comments(task_id),
|
|
)
|
|
|
|
# Bad - sequential
|
|
task = await get_task(task_id)
|
|
comments = await get_comments(task_id) # Waits unnecessarily
|
|
```
|