dqx-code-standards

What problem does it solve?

Concise code standards checklist for writing DQX Python code. This skill provides focused guidance without loading the full AGENTS.md document.

Core Features & Use Cases

• Import order: Always follow a recommended import sequence (future imports, standard library, third-party, local) with clear separation and explicit typing considerations.
• Type hints: STRICT MODE ensures complete type annotations for all functions; leverages Python 3.11 features, TYPE_CHECKING for circular imports, and Protocol for structural typing.
• Docstrings: Google-style docstrings for all public APIs to document summaries, arguments, returns, and exceptions.
• Naming conventions: Enforce consistent naming for classes (PascalCase), functions (snake_case), constants (UPPER_SNAKE_CASE), and private members (leading underscore).
• Dataclasses: Prefer frozen dataclasses for immutable data structures.
• Formatting: Align with Ruff configuration, 120-character line length, 4-space indentation, and Python 3.11 target.
• Error handling: Use the returns library for functional error handling; define and raise descriptive custom exceptions.
• When to use me: Ideal for teams codifying internal coding standards and for quick-reference guidance during implementation.
• Verification: Pre-commit hooks (ruff format/check, mypy) ensure ongoing adherence to standards.
• Reference: Directs to AGENTS.md for comprehensive guidance and testing patterns.

Quick Start

Apply these Python code standards to your DQX projects to ensure consistency and quality across modules.