Some checks failed
Test Suite / unit-tests (3.11) (push) Has been cancelled
Test Suite / unit-tests (3.12) (push) Has been cancelled
Test Suite / integration-tests (push) Has been cancelled
Test Suite / e2e-tests (push) Has been cancelled
Test Suite / performance-tests (push) Has been cancelled
Test Suite / code-quality (push) Has been cancelled
Test Suite / security-scan (push) Has been cancelled
Test Suite / test-summary (push) Has been cancelled
Major Features: - Implement comprehensive validation error reporting system (Issue #8) - Add direct CLI access with 'markitect' command - Create extensive makefile targets for CLI usage - Enhance schema validation with detailed error collection Components Added: - markitect/validation_error.py: ValidationError system with 8 error types - Enhanced markitect/schema_validator.py: Detailed error reporting methods - markitect/cli.py: Enhanced with --detailed-errors and --error-format options - visualize_schema.py: Schema visualization with ASCII and colorful modes - Comprehensive test suite for validation error reporting CLI Enhancements: - Direct 'markitect' command access for all operations - Makefile targets for typical CLI usage (cli-help, cli-ingest, etc.) - Support for text, JSON, and markdown error output formats - Backward compatibility with existing validation functionality Testing: - 11 comprehensive tests for Issue #8 validation error reporting - Tests for schema validation, visualization, and CLI integration - 100% test coverage for validation error scenarios 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
171 lines
4.1 KiB
Python
171 lines
4.1 KiB
Python
"""
|
|
Markitect domain-specific exceptions.
|
|
|
|
This module provides a hierarchy of exceptions for the Markitect markdown processing system.
|
|
All exceptions preserve context and support proper exception chaining.
|
|
"""
|
|
|
|
from typing import Optional, Dict, Any
|
|
|
|
|
|
class MarkitectError(Exception):
|
|
"""Base exception for all Markitect operations.
|
|
|
|
Provides enhanced error context and proper exception chaining support.
|
|
|
|
Args:
|
|
message: Human-readable error description
|
|
cause: Original exception that caused this error (for chaining)
|
|
context: Additional context information as key-value pairs
|
|
"""
|
|
|
|
def __init__(self, message: str, cause: Optional[Exception] = None, context: Optional[Dict[str, Any]] = None):
|
|
super().__init__(message)
|
|
self.cause = cause
|
|
self.context = context or {}
|
|
|
|
# Automatically chain if cause is provided
|
|
if cause:
|
|
self.__cause__ = cause
|
|
|
|
def __str__(self) -> str:
|
|
"""Enhanced string representation with context."""
|
|
base_message = super().__str__()
|
|
|
|
if self.context:
|
|
context_info = ", ".join(f"{k}={v}" for k, v in self.context.items())
|
|
base_message = f"{base_message} [Context: {context_info}]"
|
|
|
|
return base_message
|
|
|
|
|
|
class DocumentError(MarkitectError):
|
|
"""Errors related to document processing and management.
|
|
|
|
Raised when:
|
|
- Document parsing fails
|
|
- Document structure is invalid
|
|
- Document metadata is corrupt
|
|
"""
|
|
pass
|
|
|
|
|
|
class ASTError(MarkitectError):
|
|
"""Errors related to Abstract Syntax Tree operations.
|
|
|
|
Raised when:
|
|
- AST parsing fails
|
|
- AST structure is invalid
|
|
- AST transformation fails
|
|
"""
|
|
pass
|
|
|
|
|
|
class CacheError(MarkitectError):
|
|
"""Errors related to cache operations.
|
|
|
|
Raised when:
|
|
- Cache read/write operations fail
|
|
- Cache corruption is detected
|
|
- Cache invalidation fails
|
|
"""
|
|
pass
|
|
|
|
|
|
class DatabaseError(MarkitectError):
|
|
"""Errors related to database operations.
|
|
|
|
Raised when:
|
|
- Database connection fails
|
|
- Query execution fails
|
|
- Data integrity violations occur
|
|
"""
|
|
pass
|
|
|
|
|
|
class SchemaError(MarkitectError):
|
|
"""Errors related to schema validation and processing.
|
|
|
|
Raised when:
|
|
- Schema validation fails
|
|
- Schema parsing errors occur
|
|
- Schema generation fails
|
|
"""
|
|
pass
|
|
|
|
|
|
class ValidationError(MarkitectError):
|
|
"""Errors related to document validation against schemas.
|
|
|
|
Raised when:
|
|
- Document doesn't match schema
|
|
- Validation rules are violated
|
|
- Required fields are missing
|
|
"""
|
|
pass
|
|
|
|
|
|
class GraphQLError(MarkitectError):
|
|
"""Errors related to GraphQL operations.
|
|
|
|
Raised when:
|
|
- GraphQL query parsing fails
|
|
- GraphQL execution errors occur
|
|
- GraphQL schema issues are encountered
|
|
"""
|
|
pass
|
|
|
|
|
|
class ConfigurationError(MarkitectError):
|
|
"""Errors related to configuration and setup.
|
|
|
|
Raised when:
|
|
- Configuration files are missing or invalid
|
|
- Environment setup is incomplete
|
|
- Required settings are not configured
|
|
"""
|
|
pass
|
|
|
|
|
|
class FileNotFoundError(MarkitectError):
|
|
"""Errors when requested files cannot be found.
|
|
|
|
Raised when:
|
|
- Markdown files don't exist at specified paths
|
|
- Required resource files are missing
|
|
- Cache files cannot be located
|
|
"""
|
|
pass
|
|
|
|
|
|
class InvalidDepthError(MarkitectError):
|
|
"""Errors related to invalid depth parameters.
|
|
|
|
Raised when:
|
|
- Depth parameters are negative or zero
|
|
- Depth values exceed reasonable limits
|
|
- Depth configuration is invalid
|
|
"""
|
|
pass
|
|
|
|
|
|
class SchemaValidationError(MarkitectError):
|
|
"""Errors during schema validation process.
|
|
|
|
Raised when:
|
|
- Schema validation process fails
|
|
- Document structure analysis fails
|
|
- Validation comparison encounters errors
|
|
"""
|
|
pass
|
|
|
|
|
|
class InvalidSchemaError(MarkitectError):
|
|
"""Errors related to invalid JSON schemas.
|
|
|
|
Raised when:
|
|
- JSON schema format is invalid
|
|
- Schema doesn't conform to JSON Schema specification
|
|
- Schema file cannot be loaded or parsed
|
|
"""
|
|
pass |