Designing Python APIs

Python library API-ontwerp: naamgeving, signatures, deprecation, fail-loud error handling.

Door wdm0006 · wdm0006/python-skills

Getest · Werkt ★ 9.2/10

Designing Python APIs — Python library API-ontwerp: naamgeving, signatures, deprecation, fail-loud error handling.

Wat het doet

Begeleidt het ontwerp van Python library API's — progressive disclosure, keyword-only argument patterns, custom exception hierarchies, en een gedetailleerde 'fail loud, not silent' checklist om gemaskerde fouten te voorkomen. Activeert bij het ontwerpen van een nieuwe library API, het reviewen van een bestaande, of het plannen van een deprecation/versioning wijziging; linkt naar een companion release-management skill voor de deprecation mechanics.

Testrapport

Voerde een echte API-ontwerptaak uit (add_task met optionele priority/due/recurring/notify): de versie van de skill dwong keyword-only args af om een boolean-trap bug te elimineren die de baseline as-is leverde, plus een aangepaste exception hierarchy met hints in plaats van een kale Exception.

Getest op: 2026-07-14 · Claude Code 2.x (agent harness)

Installatie

git clone https://github.com/wdm0006/python-skills
cd python-skills
mkdir -p ~/.claude/skills
cp -r skills/python/api-design ~/.claude/skills/designing-python-apis

Commando's en voorbeeldprompts

  • /designing-python-apisPython library API-ontwerp: naamgeving, signatures, deprecation, fail-loud error handling.

Skills reageren op gewone verzoeken — geen commando's om te onthouden. Na installatie activeren prompts zoals deze de skill (in het Engels):

  • Help me design the public API for a new Python caching library.
  • Review this library's function signatures before we hit v1.0.
  • How should I deprecate a parameter without breaking callers?