python-coding-standards

Standards for writing and editing Python, so every file in a project reads consistently regardless of which session wrote it. Every piece of runnable Python — a demo script, a one-off, an example saved to a file, or code left in the chat to copy-paste and run — is real code the rules below apply to. The one exemption is a snippet written purely to illustrate a concept in prose, with no runnable entry point (e.g. what a decorator looks like); if you can't tell whether something has a runnable entry point, assume it does.

Core Rules

1. [NEVER VIOLATE] Functions the user is going to run get complete type hints. Every parameter and the return type. When editing an existing file, this applies to the function you're adding or touching; the rest of the file keeps its signatures as they are unless asked.