----------------------------------------------------------------------
This is the API documentation for the gdtest_inline_methods library.
----------------------------------------------------------------------


## Classes

Core classes


SmallWidget(name: str)

A widget with few methods (should stay inline with default threshold).

Parameters
----------
name
    The widget name.

BigProcessor(config: dict)

A processor with many methods (should split with default threshold).

Parameters
----------
config
    Configuration dictionary.

Examples
--------
>>> proc = BigProcessor({"verbose": True})
>>> proc.validate()
True


## BigProcessor Methods

Methods for the BigProcessor class


load(self, path: str) -> None

Load data from a file.

Parameters
----------
path
    Path to the data file.

transform(self, func) -> 'BigProcessor'

Apply a transformation.

Parameters
----------
func
    A callable to apply.

Returns
-------
BigProcessor
    Self for chaining.

filter(self, predicate) -> 'BigProcessor'

Filter data by predicate.

Parameters
----------
predicate
    Filter function returning bool.

Returns
-------
BigProcessor
    Self for chaining.

sort(self, key: str) -> 'BigProcessor'

Sort data by key.

Parameters
----------
key
    The sort key.

Returns
-------
BigProcessor
    Self for chaining.

aggregate(self, func, column: str) -> 'BigProcessor'

Aggregate data.

Parameters
----------
func
    Aggregation function.
column
    Column to aggregate.

Returns
-------
BigProcessor
    Self for chaining.

validate(self) -> bool

Validate current state.

Returns
-------
bool
    True if valid.

export(self, path: str, fmt: str = 'csv') -> None

Export data to file.

Parameters
----------
path
    Output path.
fmt
    Output format.

summary(self) -> dict

Get a data summary.

Returns
-------
dict
    Summary statistics.


## Functions

Public functions


helper_func(x: int, y: int) -> int

Add two numbers.

Parameters
----------
x
    First number.
y
    Second number.

Returns
-------
int
    Sum of x and y.