Skip to content

API Reference

GFFBase's public surface is intentionally compatible with legacy gffutils. Pages in this section are auto-generated from the live docstrings via mkdocstrings.

Module What's there
FeatureDB The query database. Includes the row-by-row legacy methods and the vectorized children_batched, parents_batched, region_batched for bulk PyArrow extraction.
Feature The user-facing record type. Backwards-compatible with gffutils.Feature.
create_db The ingestion entrypoint.
DataIterator & GFFWriter Streaming I/O.
merge_criteria Predicates consumed by FeatureDB.merge.
Exceptions FeatureNotFoundError, DuplicateIDError, AttributeStringError, EmptyInputError.

If a method name is missing here it lives in the source under python/gffbase/; cross-reference MIGRATION.md for the legacy-equivalence table.