ó öÀ„\c@sadZddlZer1ddlmZmZndefd„ƒYZdefd„ƒYZdS(sá sphinx.ext.napoleon.iterators ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ A collection of helpful iterators. :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. iÿÿÿÿN(tAnytIterablet peek_itercBsVeZdZd„Zd„Zdd„Zd„Zd„Zdd„Z dd„Z RS( slAn 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()``. cGsPt|Œ|_tjƒ|_t|ƒdkr@|d|_n tƒ|_dS(s__init__(o, sentinel=None)iiN(titert _iterablet collectionstdequet_cachetlentsentineltobject(tselftargs((s<lib/python2.7/site-packages/sphinx/ext/napoleon/iterators.pyt__init__6s cCs|S(N((R ((s<lib/python2.7/site-packages/sphinx/ext/napoleon/iterators.pyt__iter__@scCst|dƒ|ƒS(Ntnext(tgetattr(R tn((s<lib/python2.7/site-packages/sphinx/ext/napoleon/iterators.pyt__next__DscCs|sd}ny9x2t|jƒ|krF|jjt|jƒƒqWWn@tk rŠx0t|jƒ|kr†|jj|jƒq[WnXdS(s<Cache `n` items. If `n` is 0 or None, then 1 item is cached.iN(RRtappendRRt StopIterationR (R R((s<lib/python2.7/site-packages/sphinx/ext/napoleon/iterators.pyt _fillcacheJs ! cCs|jƒ|jkS(sãDetermine if iterator is exhausted. Returns ------- bool True if iterator has more items, False otherwise. Note ---- Will never raise :exc:`StopIteration`. (tpeekR (R ((s<lib/python2.7/site-packages/sphinx/ext/napoleon/iterators.pythas_nextVscCs¨|j|ƒ|sY|jd|jkr2t‚n|dkrP|jjƒ}q¤g}nK|j|d|jkr|t‚ngt|ƒD]}|jjƒ^q‰}|S(sKGet 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. iiN(RRR RtNonetpoplefttrange(R Rtresultti((s<lib/python2.7/site-packages/sphinx/ext/napoleon/iterators.pyRfs     (cCsS|j|ƒ|dkr)|jd}n&gt|ƒD]}|j|^q6}|S(shPreview 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`. iN(RRRR(R RRR((s<lib/python2.7/site-packages/sphinx/ext/napoleon/iterators.pyRŠs   &N( t__name__t __module__t__doc__R RRRRRRR(((s<lib/python2.7/site-packages/sphinx/ext/napoleon/iterators.pyRs     $t modify_itercBs eZdZd„Zd„ZRS(sTAn 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." cOsŒd|kr|d|_n8t|ƒdkrH|d|_|d }n d„|_t|jƒsrtdƒ‚ntt|ƒj|ŒdS(s0__init__(o, sentinel=None, modifier=lambda x: x)tmodifiericSs|S(N((tx((s<lib/python2.7/site-packages/sphinx/ext/napoleon/iterators.pytçss3modify_iter(o, modifier): modifier must be callableN(R!Rtcallablet TypeErrortsuperR R (R R tkwargs((s<lib/python2.7/site-packages/sphinx/ext/napoleon/iterators.pyR Þs    cCs˜|sd}nyBx;t|jƒ|krO|jj|jt|jƒƒƒqWWn@tk r“x0t|jƒ|kr|jj|jƒqdWnXdS(sÉCache `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. iN(RRRR!RRRR (R R((s<lib/python2.7/site-packages/sphinx/ext/napoleon/iterators.pyRís * (RRRR R(((s<lib/python2.7/site-packages/sphinx/ext/napoleon/iterators.pyR §s6 ( RRtFalsettypingRRR RR (((s<lib/python2.7/site-packages/sphinx/ext/napoleon/iterators.pyt s  ’