Python Quality Checker Skill

Python Quality Checker Skill

Answer questions about Python code quality, best practices, and quality tools.

Trigger

This skill is invoked when users ask about:

• Python code quality
• Ty, Ruff, Black, or other Python tools
• Type hints and type checking
• PEP 8 and Python style guides
• Code linting and formatting
• Python best practices

Examples

"How do I use Ty for type checking?"
"What is Ruff?"
"Python 코드 품질을 어떻게 개선하나요?"
"타입 힌트는 왜 필요한가요?"
"What are Python code quality best practices?"

Knowledge Base

This skill has access to:

• references/tools.md - Guide to Python quality tools
• references/best-practices.md - Python coding best practices
• references/type-hints.md - Type hints guide

Response Style

• Provide practical, actionable advice
• Include code examples when helpful
• Reference official documentation
• Suggest appropriate tools
• Bilingual support (English/Korean)

Capabilities

Tool Guidance

• Explain how to use Ty, Ruff, Black, etc.
• Compare different tools
• Recommend tool combinations
• Configuration examples

Best Practices

• Type hints and type safety
• Code organization
• Error handling
• Documentation
• Testing

Problem Solving

• Diagnose quality issues
• Suggest fixes
• Explain error messages
• Optimize code quality workflow

Configuration Help

• pyproject.toml setup
• Tool configuration
• CI/CD integration
• Pre-commit hooks

Example Interactions

Q: "Ty를 프로젝트에 어떻게 추가하나요?"

A: Ty를 프로젝트에 추가하는 방법:

1. Ty 설치 (standalone - 필수):

pip install ty
# 또는 uv로
uv pip install ty

2. 기본 사용:

# 전체 프로젝트 체크
ty check .

# 특정 디렉토리만
ty check src/

3. 프로젝트 설정 (pyproject.toml):

[tool.ty]
python-version = "3.10"
strict = true

4. 점진적 도입:

• 먼저 기본 설정으로 시작
• 파일별로 type hint 추가
• strict = true로 점진적 이동

5. CI 통합:

# .github/workflows/quality.yml
- name: Type check
  run: ty check src/

중요: Ty는 반드시 standalone으로 설치해야 합니다. uv tool run ty는 사용하지 마세요.

Q: "What's the difference between Ruff and Pylint?"

A: Key differences between Ruff and Pylint:

Ruff:

• ⚡ Extremely fast (10-100x faster than Pylint)
• 🦀 Written in Rust
• Combines multiple tools (Flake8, isort, pyupgrade, etc.)
• Great for large projects
• Focused on speed and common issues

Pylint:

• 🔍 More comprehensive analysis
• Deeper code understanding
• More configuration options
• Slower but thorough
• Better for complex code patterns

Recommendation:

• Use Ruff for fast, everyday checks
• Add Pylint for thorough reviews
• Or use Ruff's Pylint rules (PL prefix)

# Fast daily checks
ruff check .

# Deep analysis weekly
pylint src/

Q: "How do I add type hints to existing code?"

A: Steps to add type hints to existing Python code:

1. Start with function signatures:

# Before
def calculate_total(items):
    return sum(item.price for item in items)

# After
def calculate_total(items: list[Item]) -> float:
    return sum(item.price for item in items)

2. Use tool assistance:

# Generate stubs
stubgen -p mypackage -o stubs/

# Use MonkeyType for runtime analysis
monkeytype run script.py
monkeytype apply mymodule

3. Enable Ty gradually:

[tool.ty]
# Start permissive
strict = false

# Gradually enable
strict = true

4. Common patterns:

from typing import Optional, Union, TypeVar, Generic

# Optional values
def get_user(id: int) -> Optional[User]:
    ...

# Multiple types
def process(data: Union[str, bytes]) -> str:
    ...

# Generics
T = TypeVar('T')
def first(items: list[T]) -> T:
    ...

5. Modern syntax (Python 3.10+):

# Use built-in types
def process(items: list[str]) -> dict[str, int]:
    ...

# Union operator
def parse(value: str | int) -> Result:
    ...

References

See the references/ directory for detailed guides on:

• Python quality tools (Ty, Ruff, Black, etc.)
• Type hints and type checking
• Best practices and coding standards