Designing Python APIs

Python bibliotek API design: navngivning, signaturer, deprecation, fail-loud fejlhåndtering.

Af wdm0006 · wdm0006/python-skills

Testet · Virker ★ 9.2/10

Designing Python APIs — Python bibliotek API design: navngivning, signaturer, deprecation, fail-loud fejlhåndtering.

Hvad det gør

Vejleder design af Python bibliotek API'er — progressiv afsløring, keyword-only argumentmønstre, brugerdefinerede undtagelseshierarkier og en detaljeret 'fail loud, not silent' tjekliste for at undgå maskerede fejl. Udløses ved design af en ny biblioteks-API, gennemgang af en eksisterende eller planlægning af en deprecation/versioneringsændring; linker til en ledsagende release-management skill for deprecation-mekanikken.

Testrapport

Kørte en reel API-designopgave (add_task med valgfri priority/due/recurring/notify): skill'ens version håndhævede keyword-only args for at eliminere en boolean-trap bug, som baseline leverede som den var, plus et brugerdefineret undtagelseshierarki med hints i stedet for en bar Exception.

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

Installation

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

Kommandoer og eksempelprompter

  • /designing-python-apisPython bibliotek API design: navngivning, signaturer, deprecation, fail-loud fejlhåndtering.

Skills udløses af almindelige forespørgsler — ingen kommandoer at huske. Efter installationen aktiverer prompter som disse skillen (på engelsk):

  • 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?