#067
gdtest_decorators
OK
INIT
Decorator functions
Module of decorator functions: retry, cache, validate_args, log_calls. Each returns a wrapper function. On the Reference page you should see these in the Functions section with their signatures showing the decorator parameters like max_retries, ttl, etc. They render as regular functions, which is correct.
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 C22 D1 E6 F6 G1 H7
A1Flat layoutlayout
B1Explicit __all__exports
C22Decorator functionsobjects
D1NumPydocstrings
E6No directivesdirectives
F6No user guideuser_guide
G1README.mdlanding
H7No extrasextras
Source Files
gdtest_decorators/
__init__.py
"""Package with decorator functions."""
import functools
from typing import Callable, Any
__version__ = "0.1.0"
__all__ = ["retry", "cache", "validate_args", "log_calls"]
def retry(max_retries: int = 3, delay: float = 1.0) -> Callable:
"""
Decorator that retries a function on failure.
Parameters
----------
max_retries
Maximum number of retries.
delay
Delay between retries in seconds.
Returns
-------
Callable
Decorator function.
"""
def decorator(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
for i in range(max_retries):
try:
return func(*args, **kwargs)
except Exception:
if i == max_retries - 1:
raise
return wrapper
return decorator
def cache(ttl: int = 300) -> Callable:
"""
Decorator that caches function results.
Parameters
----------
ttl
Time-to-live in seconds.
Returns
-------
Callable
Decorator function.
"""
def decorator(func):
_cache: dict = {}
@functools.wraps(func)
def wrapper(*args, **kwargs):
key = (args, tuple(sorted(kwargs.items())))
if key in _cache:
return _cache[key]
result = func(*args, **kwargs)
_cache[key] = result
return result
return wrapper
return decorator
def validate_args(*types) -> Callable:
"""
Decorator that validates argument types.
Parameters
----------
*types
Expected types for each positional argument.
Returns
-------
Callable
Decorator function.
"""
def decorator(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
for arg, expected in zip(args, types):
if not isinstance(arg, expected):
raise TypeError(
f"Expected {expected.__name__}, got {type(arg).__name__}"
)
return func(*args, **kwargs)
return wrapper
return decorator
def log_calls(func: Callable) -> Callable:
"""
Decorator that logs function calls.
Parameters
----------
func
The function to wrap.
Returns
-------
Callable
Wrapped function with logging.
"""
@functools.wraps(func)
def wrapper(*args, **kwargs):
print(f"Calling {func.__name__}")
result = func(*args, **kwargs)
print(f"{func.__name__} returned {result}")
return result
return wrapperREADME.md
# gdtest-decorators Tests documentation of decorator functions.
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: Functions
desc: Utility functions
contents:
- cache
- log_calls
- retry
- validate_args
# 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