#211
gdtest_pdm_big_class
OK
INIT
PDM layout + big class (>5 methods) + NumPy docstrings. Tests PDM build backend with complex class documentation.
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
A11 C3 D1
A11PDM buildlayout
C3Big class (>5)objects
D1NumPydocstrings
Source Files
src/
gdtest_pdm_big_class/
__init__.py
"""Package with PDM layout and a big class.""" from gdtest_pdm_big_class.pipeline import Pipeline __version__ = "0.1.0" __all__ = ["Pipeline"]
pipeline.py
"""Data processing pipeline with many methods."""
class Pipeline:
"""
A multi-step data processing pipeline.
Provides methods for loading, cleaning, transforming,
validating, aggregating, and exporting data.
Parameters
----------
name : str
The pipeline name.
verbose : bool
Whether to print progress messages.
Examples
--------
>>> p = Pipeline("etl")
>>> p.load({"items": [1, 2, 3]})
"""
def __init__(self, name: str, verbose: bool = False):
self.name = name
self.verbose = verbose
self._data = None
def load(self, source: dict) -> "Pipeline":
"""
Load data from a source dictionary.
Parameters
----------
source : dict
The data source.
Returns
-------
Pipeline
Self for method chaining.
"""
self._data = source
return self
def clean(self, drop_nulls: bool = True) -> "Pipeline":
"""
Clean the loaded data.
Parameters
----------
drop_nulls : bool
Whether to drop null values.
Returns
-------
Pipeline
Self for method chaining.
"""
return self
def transform(self, func: callable) -> "Pipeline":
"""
Apply a transformation function to the data.
Parameters
----------
func : callable
A function to apply to each data item.
Returns
-------
Pipeline
Self for method chaining.
"""
return self
def validate(self, schema: dict | None = None) -> bool:
"""
Validate the data against an optional schema.
Parameters
----------
schema : dict or None
Validation schema. If None, performs basic checks.
Returns
-------
bool
True if the data passes validation.
"""
return True
def aggregate(self, group_by: str, agg_func: str = "sum") -> dict:
"""
Aggregate data by a given key.
Parameters
----------
group_by : str
The field to group by.
agg_func : str
Aggregation function: 'sum', 'mean', 'count'.
Returns
-------
dict
Aggregated results.
"""
return {}
def export(self, fmt: str = "json") -> str:
"""
Export the pipeline results.
Parameters
----------
fmt : str
Output format: 'json', 'csv', or 'parquet'.
Returns
-------
str
The serialized output.
"""
return ""
def status(self) -> dict:
"""
Get the current pipeline status.
Returns
-------
dict
Status info including name, data loaded, and step count.
"""
return {"name": self.name, "loaded": self._data is not None}README.md
# gdtest-pdm-big-class Test package with PDM build backend and a big class with many methods.
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:
- name: Pipeline
members: false # 7 methods listed below
- title: Pipeline Methods
desc: Methods for the Pipeline class
contents:
- Pipeline.load
- Pipeline.clean
- Pipeline.transform
- Pipeline.validate
- Pipeline.aggregate
- Pipeline.export
- Pipeline.status
# 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