Dashboard
PHP:
8.2.30
OS:
Linux
User:
dh_nv8b2m
/
/
usr
/
lib
/
python3
/
dist-packages
/
sphinx
/
ext
/
napoleon
/
__pycache__
📤 Upload
📝 New File
📁 New Folder
Close
Editing: iterators.cpython-310.pyc
o �$�a� � @ sB d Z ddlZddlmZmZmZ G dd� d�ZG dd� de�ZdS )z� sphinx.ext.napoleon.iterators ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ A collection of helpful iterators. :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. � N)�Any�Iterable�Optionalc @ s� e Zd ZdZdeddfdd�Zddd�Zdd edefd d �Zd e e ddfd d �Z de fdd�Z dd edefdd�Z dd e e defdd�ZdS )� peek_iteral An 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 <https://docs.python.org/3/library/functions.html#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()``. �args�returnNc G s: t |� | _t�� | _t|�dkr|d | _dS t� | _dS )z__init__(o, sentinel=None)� � N)�iter� _iterable� collections�deque�_cache�len�sentinel�object)�selfr � r �?/usr/lib/python3/dist-packages/sphinx/ext/napoleon/iterators.py�__init__2 s zpeek_iter.__init__c C � | S �Nr �r r r r �__iter__; s zpeek_iter.__iter__�nc C s | � |�S r )�next�r r r r r �__next__> s zpeek_iter.__next__c C s� |sd}z t | j�|k r | j�t| j�� t | j�|k s W dS W dS tyC t | j�|k r@| j�| j� t | j�|k s/Y dS Y dS w )z<Cache `n` items. If `n` is 0 or None, then 1 item is cached.r N)r r �appendr r � StopIterationr r r r r � _fillcacheA s � ��zpeek_iter._fillcachec C s | � � | jkS )z�Determine if iterator is exhausted. Returns ------- bool True if iterator has more items, False otherwise. Note ---- Will never raise :exc:`StopIteration`. )�peekr r r r r �has_nextL s zpeek_iter.has_nextc sr � � |� |s � jd � jkrt�|du r � j�� }|S g }|S � j|d � jkr,t�� fdd�t|�D �}|S )aK Get 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. r Nr c s g | ]}� j �� �qS r )r �popleft��.0�ir r r � <listcomp>{ � z"peek_iter.next.<locals>.<listcomp>)r r r r r# �range�r r �resultr r r r [ s ��zpeek_iter.nextc s: � � |� |du r� jd }|S � fdd�t|�D �}|S )ah Preview 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`. Nr c s g | ]}� j | �qS r )r r$ r r r r' � r( z"peek_iter.peek.<locals>.<listcomp>)r r r) r* r r r r! ~ s �zpeek_iter.peek)r r r )�__name__� __module__� __qualname__�__doc__r r r �intr r r �boolr" r r! r r r r r s #r c sD e Zd ZdZdededdf� fdd� Zdee ddfd d �Z� Z S ) � modify_iteraT An 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 Nc sd d|v r |d | _ nt|�dkr |d | _ |dd� }ndd� | _ t| j �s*td��t� j|� dS )z0__init__(o, sentinel=None, modifier=lambda x: x)�modifierr Nc S r r r )�xr r r �<lambda>� s z&modify_iter.__init__.<locals>.<lambda>z3modify_iter(o, modifier): modifier must be callable)r4 r �callable� TypeError�superr )r r r3 �� __class__r r r � s zmodify_iter.__init__r c C s� |sd}z t | j�|k r"| j�| �t| j��� t | j�|k s W dS W dS tyF t | j�|k rC| j�| j� t | j�|k s2Y dS Y dS w )z�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. r N)r r r r4 r r r r r r r r r � s � ��zmodify_iter._fillcache) r, r- r. r/ r r r r0 r � __classcell__r r r: r r2 � s 6 r2 )r/ r �typingr r r r r2 r r r r �<module> s
Save
Cancel