API Reference¶
Interface function signatures in the namedzip.namedzip
module.
namedzip
¶
-
namedzip.
namedzip
(named_tuple, *iterables)[source]¶ Extends
zip()
to generate named tuples.Returns a generator if
*iterables
are supplied, otherwise returns a function for creating generators.Parameters: - named_tuple : tuple subclass
tuple subclass from
collections.namedtuple
factory function, or subclass oftyping.NamedTuple
.- *iterables : iterable, optional
Iterable objects to zip.
Returns: - generator object
If
*iterables
are supplied.- function object
If
*iterables
are not supplied.
namedzip_longest
¶
-
namedzip.
namedzip_longest
(named_tuple, *iterables, fillvalue=None, defaults=None)[source]¶ Extends
itertools.zip_longest()
to generate named tuples.Returns a generator if
*iterables
are supplied, otherwise returns a function for creating generators.Parameters: - named_tuple : tuple subclass
tuple subclass from
collections.namedtuple
factory function, or subclass oftyping.NamedTuple
.- *iterables : iterable, optional
Iterable objects to zip.
- fillvalue : optional
Use for setting all missing values to the same default value. (default is None).
- defaults : iterable, optional
Individual default values for each iterable to zip. Overrides
fillvalue
for last n iterables, and any defaults specified innamed_tuple
. Length can be less than or equal to the number of named tuple field names.
Returns: - generator object
If
*iterables
are supplied.- function object
If
*iterables
are not supplied.