O&idZddlZddlZddlmZmZmZddlmZej deGddZ Gdd e Z dS) z"A collection of helpful iterators.N)AnyIterableOptional)RemovedInSphinx70Warningz,sphinx.ext.napoleon.iterators is deprecated.ceZdZdZdeddfdZd dZddeedefdZ deeddfd Z de fd Z ddeedefd Z ddeedefd ZdS) peek_iteralAn iterator object that supports peeking ahead. Parameters ---------- o : iterable or callable `o` is interpreted very differently depending on the presence of `sentinel`. If `sentinel` is not given, then `o` must be a collection object which supports either the iteration protocol or the sequence protocol. If `sentinel` is given, then `o` must be a callable object. sentinel : any value, optional If given, the iterator will call `o` with no arguments for each call to its `next` method; if the value returned is equal to `sentinel`, :exc:`StopIteration` will be raised, otherwise the value will be returned. See Also -------- `peek_iter` can operate as a drop in replacement for the built-in `iter `_ function. Attributes ---------- sentinel The value used to indicate the iterator is exhausted. If `sentinel` was not given when the `peek_iter` was instantiated, then it will be set to a new object instance: ``object()``. argsreturnNct||_tj|_t |dkr|d|_dSt|_dS)z__init__(o, sentinel=None)N)iter _iterable collectionsdeque_cachelensentinelobject)selfr s j/home/geonatureadmin/si_en_reseau/tutos/venv/lib/python3.11/site-packages/sphinx/ext/napoleon/iterators.py__init__zpeek_iter.__init__.sJ#';)4):)<)< t99>> GDMMM"HHDMMMc|SNrs r__iter__zpeek_iter.__iter__7s rnc,||Sr)nextrrs r__next__zpeek_iter.__next__:syy||rc|sd} t|j|krF|jt|jt|j|kDdSdS#t $rVt|j|kr:|j|jt|j|k7YdSYdSwxYw)zg}n;j|dz jkrtfdt |D}|S)aKGet the next item or `n` items of the iterator. Parameters ---------- n : int or None The number of items to retrieve. Defaults to None. Returns ------- item or list of items The next item or `n` items of the iterator. If `n` is None, the item itself is returned. If `n` is an int, the items will be returned in a list. If `n` is 0, an empty list is returned. Raises ------ StopIteration Raised if the iterator is exhausted, even if `n` is 0. rNr cBg|]}jSr)rpopleft.0irs r z"peek_iter.next..ws'>>>dk))++>>>r)r'rrr&r-rangerrresults` rr!zpeek_iter.nextWs*  ?{1~..##y,,..{1q5!T]22##>>>>U1XX>>>F rc||jd}nfdt|D}|S)ahPreview the next item or `n` items of the iterator. The iterator is not advanced when peek is called. Returns ------- item or list of items The next item or `n` items of the iterator. If `n` is None, the item itself is returned. If `n` is an int, the items will be returned in a list. If `n` is 0, an empty list is returned. If the iterator is exhausted, `peek_iter.sentinel` is returned, or placed as the last item in the returned list. Note ---- Will never raise :exc:`StopIteration`. Nrc*g|]}j|Sr)rr.s rr1z"peek_iter.peek..s777dk!n777r)r'rr2r3s` rr)zpeek_iter.peekzsM(  9[^FF7777eAhh777F r)r rr)__name__ __module__ __qualname____doc__rrrrintr#r'boolr*r!r)rrrrr s@%c%d%%%%(3-3 2HSM 2d 2 2 2 2 ,$ , , , ,!!hsm!s!!!!FhsmsrrcLeZdZdZdededdffd ZdeeddfdZxZ S) modify_iteraTAn iterator object that supports modifying items as they are returned. Parameters ---------- o : iterable or callable `o` is interpreted very differently depending on the presence of `sentinel`. If `sentinel` is not given, then `o` must be a collection object which supports either the iteration protocol or the sequence protocol. If `sentinel` is given, then `o` must be a callable object. sentinel : any value, optional If given, the iterator will call `o` with no arguments for each call to its `next` method; if the value returned is equal to `sentinel`, :exc:`StopIteration` will be raised, otherwise the value will be returned. modifier : callable, optional The function that will be used to modify each item returned by the iterator. `modifier` should take a single argument and return a single value. Defaults to ``lambda x: x``. If `sentinel` is not given, `modifier` must be passed as a keyword argument. Attributes ---------- modifier : callable `modifier` is called with each item in `o` as it is iterated. The return value of `modifier` is returned in lieu of the item. Values returned by `peek` as well as `next` are affected by `modifier`. However, `modify_iter.sentinel` is never passed through `modifier`; it will always be returned from `peek` unmodified. Example ------- >>> a = [" A list ", ... " of strings ", ... " with ", ... " extra ", ... " whitespace. "] >>> modifier = lambda s: s.strip().replace('with', 'without') >>> for s in modify_iter(a, modifier=modifier): ... print('"%s"' % s) "A list" "of strings" "without" "extra" "whitespace." r kwargsr Ncd|vr|d|_n3t|dkr|d|_|dd}nd|_t|jstdt j|dS)z0__init__(o, sentinel=None, modifier=lambda x: x)modifierr Nc|Srr)xs rz&modify_iter.__init__..sarz3modify_iter(o, modifier): modifier must be callable)rArcallable TypeErrorsuperr)rr r? __class__s rrzmodify_iter.__init__s   ":.DMM YY]] GDM8DD'KDM && 9899 9$rrc|sd} t|j|krY|j|t |jt|j|kWdSdS#t $rVt|j|kr:|j|jt|j|k7YdSYdSwxYw)zCache `n` modified items. If `n` is 0 or None, 1 item is cached. Each item returned by the iterator is passed through the `modify_iter.modified` function before being cached. r N)rrr%rAr!rr&rr"s rr'zmodify_iter._fillcaches A 2dk""Q&& ""4==dn1E1E#F#FGGGdk""Q&&&&&& 2 2 2dk""Q&& ""4=111dk""Q&&&&&&&& 2sA/A99ACC) r7r8r9r:rrrr;r' __classcell__)rHs@rr>r>s55l  c  S  T       2HSM2d22222222rr>) r:rwarningstypingrrrsphinx.deprecationrwarnrr>rrrrOs((**********777777  <&(((FFFFFFFFRS2S2S2S2S2)S2S2S2S2S2r