Designing Python APIs

Python bibliotek API-design: navngivning, signaturer, avskrivning, fail-loud feilhåndtering.

av wdm0006 · wdm0006/python-skills

Bestått ★ 9.2/10

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

Hva den gjør

Veileder design av Python bibliotek API-er — progressiv avsløring, mønstre for kun-nøkkelordsargumenter, egendefinerte unntakshierarkier, og en detaljert 'fail loud, not silent' sjekkliste for å unngå maskerte feil. Utløses ved design av et nytt bibliotek-API, gjennomgang av et eksisterende, eller planlegging av en avskrivnings-/versjonsendring; lenker ut til en ledsagende utgivelsesstyringsferdighet for avskrivningsmekanikken.

Testrapport

Kjørte en reell API-designoppgave (add_task med valgfri priority/due/recurring/notify): ferdighetens versjon håndhevet kun-nøkkelordsargumenter for å eliminere en boolean-fellefeil som baseline leverte som den var, pluss et egendefinert unntakshierarki med hint i stedet for en bar Exception.

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

Installer

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, avskrivning, fail-loud feilhåndtering.

Skills utløses av vanlige forespørsler — ingen kommandoer å huske. Etter installasjonen 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?