first

first(predicate=None)

Returns the first element in an Enumerable collection. If a predicate is given, then it is the first element in the collection that satisfies the condition. If the collection contains no elements then a NoElementsError is raised. This is an executing function.

Parameters

predicate : condition to satisfy as a lambda function. Optional.

Returns

The first element in the Enumerable collection

Example

from py_linq import Enumerable

Enumerable([
    {'value': 1},
    {'value': 2},
    {'value': 3}
]).first()
# {'value': 1}

Enumerable([]).first()
# raises NoElementsError