typed-failures

Convert untyped Python exceptions into SDK-defined AppError subclasses.

26|16|Updated May 23, 2024
One-click install
npx skills add https://github.com/atlanhq/application-sdk --skill typed-failures
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: typed-failures
Source: https://github.com/atlanhq/application-sdk/tree/main/.claude/skills/typed-failures
Command: npx skills add https://github.com/atlanhq/application-sdk --skill typed-failures

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

It streamlines the process of transforming untyped exception handling into structured, typed errors, enabling better error classification and observability.

Core Features & Use Cases

  • Error Typing: Converts untyped exceptions like ValueError and RuntimeError into SDK-defined AppError subclasses.
  • Failure Attribution: Automatically attaches categories, codes, and audience to errors in an application, facilitating monitoring and alerting.
  • Use Case: For a data pipeline that frequently raises generic exceptions, this Skill helps standardize failure reports and improves failure diagnostics, especially in production environments.

Quick Start

Ask the AI to onboard an application by converting existing exception handling code into typed errors for structured failure reporting.

Frequently Asked Questions about typed-failures

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I convert untyped Python exceptions into structured error classes?

Typed errors enable structured failure reporting by automatically attaching categories, codes, and audience to application failures. Converting untyped exceptions into SDK AppError subclasses improves failure attribution and observability in production environments like data pipelines.

How do I standardize application error handling for a Python data pipeline?

Standardize application error handling by onboarding your app to convert existing exception handling code into SDK-typed AppError subclasses. This enforces strict coding conventions and standardizes failure reports for better production monitoring and alerting.

Does converting to typed errors require an existing application SDK?

Yes, converting to typed errors requires an existing application SDK with predefined failure classes. The process relies on these SDK classes to transform untyped exceptions and enforce strict coding conventions for error semantics.

What is the best way to classify and report application failures in production?

The best way to classify application failures is converting untyped exceptions into SDK-typed AppError subclasses. This approach automatically attaches categories, codes, and audience to errors, facilitating structured failure reporting and production alerting.

Why do I need typed errors instead of standard Python exceptions for application onboarding?

You need typed errors instead of standard Python exceptions to enable structured failure reporting and automatic attribution. Typed AppError subclasses provide better error semantics, classification, and observability for application onboarding and SDK updates.