NexusIterator & DataframableList

class qnexus.client.nexus_iterator.NexusIterator(
resource_type: str,
nexus_url: str,
params: Dict[str, Any],
wrapper_method: Callable[[dict[str, Any]], List[T]],
nexus_client: Client,
)[source]

Bases: Generic[T], Iterator[T]

An object that can be used to summarize or iterate through a filter query made to the Nexus database.

count() int[source]

Count the items that match the filter.

df() DataFrame[source]

List and present in a pandas DataFrame.

list() DataframableList[T][source]

Collapse into RefList.

summarize() DataFrame[source]

Present in a pandas DataFrame.

try_unique_match() T[source]

Utility function for expecting a single match on the filter.

class qnexus.models.references.DataframableList(
iterable: Iterable[T],
)[source]

Bases: list[T]

A Python list that implements the Dataframable protocol.

df() DataFrame[source]

Present in a pandas DataFrame.