python-standards

What problem does it solve?

Inconsistent Python code style, missing type hints, and poor documentation lead to unreadable, hard-to-maintain codebases. This Skill provides a definitive guide to Python code quality standards, ensuring your code is always clean, consistent, and easy for others (and future you) to understand.

Core Features & Use Cases

• PEP 8 & Formatting: Adherence to PEP 8, enforced by black and isort for consistent code style and import organization.
• Type Hinting: Comprehensive guidance on using type hints for function signatures, generic types, and class attributes to improve code clarity and catch errors early.
• Google-Style Docstrings: Standards for writing clear, informative docstrings for functions and classes, including Args, Returns, Raises, and Examples sections.
• Use Case: When writing a new Python module, activate this Skill to quickly reference best practices for naming conventions, error handling, and code organization, ensuring your code integrates seamlessly and is easily understood by other developers and AI agents.

Quick Start

Format your code with Black and isort

black --line-length=100 src/ tests/

isort --profile=black --line-length=100 src/ tests/

Use type hints for clarity

from pathlib import Path

def process_file(input_path: Path) -> Dict[str, any]:

pass

Use Google-style docstrings

def my_func(arg: str) -> str:

"""Does something.

Args:

arg: An argument.

Returns:

A string.

"""