gdtest_context_mgr — Synthetic Package Details

#066 gdtest_context_mgr OK INIT

Context manager classes

Context manager classes with __enter__/__exit__: ManagedResource and Timer. On the Reference page the classes should show their dunder methods and any public methods. Key test: context manager protocols render cleanly.

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 C21 D1 E6 F6 G1 H7

A1Flat layoutlayout

B1Explicit __all__exports

C21Context managersobjects

D1NumPydocstrings

E6No directivesdirectives

F6No user guideuser_guide

G1README.mdlanding

H7No extrasextras

Source Files

📁 gdtest_context_mgr/

📄 __init__.py

"""Package with context manager classes."""

import time
from typing import Optional

__version__ = "0.1.0"
__all__ = ["ManagedResource", "Timer"]


class ManagedResource:
    """
    A resource that must be explicitly acquired and released.

    Parameters
    ----------
    name
        Resource name.
    """

    def __init__(self, name: str):
        self.name = name
        self._acquired = False

    def __enter__(self) -> "ManagedResource":
        """
        Acquire the resource.

        Returns
        -------
        ManagedResource
            Self.
        """
        self._acquired = True
        return self

    def __exit__(self, exc_type, exc_val, exc_tb) -> None:
        """
        Release the resource.

        Parameters
        ----------
        exc_type
            Exception type, if any.
        exc_val
            Exception value, if any.
        exc_tb
            Traceback, if any.
        """
        self._acquired = False

    def is_acquired(self) -> bool:
        """
        Check if resource is currently acquired.

        Returns
        -------
        bool
            True if acquired.
        """
        return self._acquired


class Timer:
    """
    A context manager for timing code blocks.

    Parameters
    ----------
    label
        Optional label for the timer.
    """

    def __init__(self, label: Optional[str] = None):
        self.label = label
        self.start_time: Optional[float] = None
        self.elapsed: Optional[float] = None

    def __enter__(self) -> "Timer":
        """
        Start the timer.

        Returns
        -------
        Timer
            Self.
        """
        self.start_time = time.monotonic()
        return self

    def __exit__(self, exc_type, exc_val, exc_tb) -> None:
        """Stop the timer and record elapsed time."""
        if self.start_time is not None:
            self.elapsed = time.monotonic() - self.start_time

    def report(self) -> str:
        """
        Return a human-readable timing report.

        Returns
        -------
        str
            Report string.
        """
        label = self.label or "Timer"
        elapsed = self.elapsed or 0.0
        return f"{label}: {elapsed:.4f}s"

📄 README.md

# gdtest-context-mgr

Tests context manager classes with __enter__/__exit__.

📄 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:
      - ManagedResource  # 3 method(s)
      - Timer  # 3 method(s)

# 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