← GDG /

#068 gdtest_exceptions

#068 gdtest_exceptions OK INIT
Custom exception class hierarchy
Custom exception hierarchy: AppError (base), ValidationError, NotFoundError, PermissionError_, TimeoutError_. On the Reference page you should see a 'Classes' section with all five exceptions. Key test: exception classes (inheriting from Exception) render like normal classes.
View Site → Build Log 🧪 Test Coverage

Build Mode

○ No great-docs.yml

This package has no pre-supplied config. It tests the full great-docs init → great-docs build pipeline from scratch, relying entirely on auto-detection of the package layout, docstring style, and exports.

Dimensions

A1 B1 C23 D1 E6 F6 G1 H7
A1Flat layoutlayout
B1Explicit __all__exports
C23Custom exceptionsobjects
D1NumPydocstrings
E6No directivesdirectives
F6No user guideuser_guide
G1README.mdlanding
H7No extrasextras

Source Files

📁 gdtest_exceptions/
📄 __init__.py
"""Package with a custom exception hierarchy."""

__version__ = "0.1.0"
__all__ = [
    "AppError",
    "ValidationError",
    "NotFoundError",
    "PermissionError_",
    "TimeoutError_",
]


class AppError(Exception):
    """
    Base exception for the application.

    Parameters
    ----------
    message
        Human-readable error message.
    code
        Machine-readable error code.
    """

    def __init__(self, message: str, code: int = 0):
        super().__init__(message)
        self.code = code


class ValidationError(AppError):
    """
    Raised when input validation fails.

    Parameters
    ----------
    field
        The field that failed validation.
    message
        Description of the validation failure.
    """

    def __init__(self, field: str, message: str):
        super().__init__(f"{field}: {message}", code=400)
        self.field = field


class NotFoundError(AppError):
    """
    Raised when a requested resource is not found.

    Parameters
    ----------
    resource
        Name or ID of the missing resource.
    """

    def __init__(self, resource: str):
        super().__init__(f"Not found: {resource}", code=404)
        self.resource = resource


class PermissionError_(AppError):
    """
    Raised when the user lacks permission.

    Parameters
    ----------
    action
        The action that was denied.
    """

    def __init__(self, action: str):
        super().__init__(f"Permission denied: {action}", code=403)
        self.action = action


class TimeoutError_(AppError):
    """
    Raised when an operation times out.

    Parameters
    ----------
    operation
        The operation that timed out.
    seconds
        Number of seconds before timeout.
    """

    def __init__(self, operation: str, seconds: float):
        super().__init__(f"Timeout: {operation} after {seconds}s", code=408)
        self.operation = operation
        self.seconds = seconds
📄 README.md
# gdtest-exceptions

Tests custom exception hierarchy documentation.
📄 great-docs.yml generated
# Great Docs Configuration
# See https://posit-dev.github.io/great-docs/user-guide/configuration.html

# Module Name (optional)
# ----------------------
# Set this if your importable module name differs from the project name.
# Example: project 'py-yaml12' with module name 'yaml12'
# module: yaml12

# Docstring Parser
# ----------------
# The docstring format used in your package (numpy, google, or sphinx)
parser: numpy

# Dynamic Introspection
# ---------------------
# Use runtime introspection for more accurate documentation (default: true)
# Set to false if your package has cyclic alias issues (e.g., PyO3/Rust bindings)
dynamic: true

# API Discovery Settings
# ----------------------
# Exclude items from auto-documentation
# exclude:
#   - InternalClass
#   - helper_function

# Logo & Favicon
# ---------------
# Point to a single logo file (replaces the text title in the navbar):
# logo: assets/logo.svg
#
# For light/dark variants:
# logo:
#   light: assets/logo-light.svg
#   dark: assets/logo-dark.svg
#
# To show the text title alongside the logo, add: show_title: true

# Funding / Copyright Holder
# --------------------------
# Credit the organization that funds or holds copyright for this package.
# Displays in sidebar and footer. Homepage and ROR provide links.
# funding:
#   name: "Posit Software, PBC"
#   roles:
#     - Copyright holder
#     - funder
#   homepage: https://posit.co
#   ror: https://ror.org/03wc8by49

# API Reference Structure
# -----------------------
# Customize the sections below to organize your API documentation.
# - Reorder items within a section to change their display order
# - Move items between sections or create new sections
# - Use 'members: false' to exclude methods from documentation
# - Add 'desc:' to sections for descriptions

reference:
  - title: Classes
    desc: Main classes provided by the package
    contents:
      - NotFoundError
      - PermissionError_
      - TimeoutError_
      - ValidationError

  - title: Exceptions
    desc: Exception classes
    contents:
      - AppError

# Site URL
# --------
# Canonical address of the deployed documentation site.
# Required for subdirectory deployments, skills page install commands,
# .well-known/ discovery, and sitemaps.
# site_url: "https://your-org.github.io/your-package/"

# Site Settings
# -------------
# site:
#   theme: flatly              # Quarto theme (default: flatly)
#   toc: true                  # Show table of contents (default: true)
#   toc-depth: 2               # TOC heading depth (default: 2)
#   toc-title: On this page    # TOC title (default: "On this page")

# Jupyter Kernel
# --------------
# Jupyter kernel to use for executing code cells in .qmd files.
# This is set at the project level so it applies to all pages, including
# auto-generated API reference pages. Can be overridden in individual .qmd
# file frontmatter if needed for special cases.
jupyter: python3

# CLI Documentation
# -----------------
# cli:
#   enabled: true              # Enable CLI documentation
#   module: my_package.cli     # Module containing Click commands
#   name: cli                  # Name of the Click command object