Skip to content

Extractor

Bases: Generic[T]

Extraction interface for mining a set of Git objects.

Supports data streaming and converting results into various formats, including native Python representations and data analysis interfaces.

__iter__

__iter__() -> Iterator[T]

Extract and iterate over Git objects.

Items are processed on demand for memory efficiency.

Yields:

Type Description
T

Extracted Git objects.

iter_dicts

iter_dicts() -> Iterator[dict]

Extract and iterate over Git objects as dictionaries.

Items are processed on demand for memory efficiency.

Yields:

Type Description
dict

Dictionary representations of Git objects.

to_pandas

to_pandas() -> DataFrame

Extract data into a pandas DataFrame.

Returns:

Type Description
DataFrame

A pandas DataFrame containing the results.

Raises:

Type Description
ImportError

If pandas is not installed.

pd

pd() -> DataFrame

Shorthand for to_pandas().

to_polars

to_polars() -> DataFrame

Extract data into a Polars DataFrame.

Returns:

Type Description
DataFrame

A Polars DataFrame containing the results.

Raises:

Type Description
ImportError

If Polars is not installed.

pl

pl() -> DataFrame

Shorthand for to_polars().

to_list

to_list() -> list[T]

Extract data into a list.

Returns:

Type Description
list[T]

A list containing the extracted Git objects.

to_dicts

to_dicts() -> list[dict]

Extract data into a list of dictionaries.

Returns:

Type Description
list[dict]

A list of dictionaries representing the extracted Git objects.