Aby zrozumieć, co yield
robi, musisz zrozumieć, czym są generatory . I zanim zrozumiesz generatory, musisz zrozumieć iterowalne .
Iterables
Kiedy tworzysz listę, możesz odczytywać jej elementy jeden po drugim. Czytanie poszczególnych pozycji jeden po drugim nazywa się iteracją:
>>> mylist = [1, 2, 3]
>>> for i in mylist:
... print(i)
1
2
3
mylist
jest iterowalny . Kiedy używasz rozumienia listy, tworzysz listę, a więc iterowalną:
>>> mylist = [x*x for x in range(3)]
>>> for i in mylist:
... print(i)
0
1
4
Wszystko, czego możesz użyć na „ for... in...
”, jest iterowalne; lists
, strings
, Pliki ...
Te iteracje są przydatne, ponieważ możesz je odczytać tyle, ile chcesz, ale wszystkie wartości przechowujesz w pamięci i nie zawsze jest to potrzebne, gdy masz wiele wartości.
Generatory
Generatory są iteratorami, rodzajem iteracji, które można iterować tylko raz . Generatory nie przechowują wszystkich wartości w pamięci, generują je w locie :
>>> mygenerator = (x*x for x in range(3))
>>> for i in mygenerator:
... print(i)
0
1
4
Jest tak samo, z wyjątkiem tego, że użyłeś ()
zamiast []
. ALE nie możesz wykonać for i in mygenerator
drugiego razu, ponieważ generatory mogą być używane tylko raz: obliczają 0, następnie zapominają o tym i obliczają 1, i kończą obliczanie 4, jeden po drugim.
Wydajność
yield
jest słowem kluczowym, które jest używane podobnie return
, ale funkcja zwróci generator.
>>> def createGenerator():
... mylist = range(3)
... for i in mylist:
... yield i*i
...
>>> mygenerator = createGenerator() # create a generator
>>> print(mygenerator) # mygenerator is an object!
<generator object createGenerator at 0xb7555c34>
>>> for i in mygenerator:
... print(i)
0
1
4
Oto bezużyteczny przykład, ale jest przydatny, gdy wiesz, że twoja funkcja zwróci ogromny zestaw wartości, które będziesz musiał odczytać tylko raz.
Aby opanować yield
, musisz zrozumieć, że po wywołaniu funkcji kod napisany w treści funkcji nie jest uruchamiany. Funkcja zwraca tylko obiekt generatora, jest to nieco trudne :-)
Następnie kod będzie kontynuowany od miejsca, w którym został przerwany za każdym razem, gdy for
używa generatora.
Teraz najtrudniejsza część:
Przy pierwszym for
wywołaniu obiektu generatora utworzonego z twojej funkcji, uruchomi on kod w twojej funkcji od początku aż do trafienia yield
, a następnie zwróci pierwszą wartość pętli. Następnie każde kolejne wywołanie uruchomi kolejną iterację pętli zapisanej w funkcji i zwróci następną wartość. Będzie to trwało, dopóki generator nie zostanie uznany za pusty, co dzieje się, gdy funkcja działa bez uderzenia yield
. Może to być spowodowane tym, że pętla dobiegła końca lub dlatego, że nie spełniasz już warunku "if/else"
.
Twój kod został wyjaśniony
Generator:
# Here you create the method of the node object that will return the generator
def _get_child_candidates(self, distance, min_dist, max_dist):
# Here is the code that will be called each time you use the generator object:
# If there is still a child of the node object on its left
# AND if the distance is ok, return the next child
if self._leftchild and distance - max_dist < self._median:
yield self._leftchild
# If there is still a child of the node object on its right
# AND if the distance is ok, return the next child
if self._rightchild and distance + max_dist >= self._median:
yield self._rightchild
# If the function arrives here, the generator will be considered empty
# there is no more than two values: the left and the right children
Gość:
# Create an empty list and a list with the current object reference
result, candidates = list(), [self]
# Loop on candidates (they contain only one element at the beginning)
while candidates:
# Get the last candidate and remove it from the list
node = candidates.pop()
# Get the distance between obj and the candidate
distance = node._get_dist(obj)
# If distance is ok, then you can fill the result
if distance <= max_dist and distance >= min_dist:
result.extend(node._values)
# Add the children of the candidate in the candidate's list
# so the loop will keep running until it will have looked
# at all the children of the children of the children, etc. of the candidate
candidates.extend(node._get_child_candidates(distance, min_dist, max_dist))
return result
Ten kod zawiera kilka inteligentnych części:
Pętla iteruje się na liście, ale lista rozszerza się podczas iteracji :-) Jest to zwięzły sposób na przejrzenie wszystkich tych zagnieżdżonych danych, nawet jeśli jest to trochę niebezpieczne, ponieważ możesz skończyć z nieskończoną pętlą. W takim przypadku candidates.extend(node._get_child_candidates(distance, min_dist, max_dist))
wyczerp wszystkie wartości generatora, ale while
nadal tworzy nowe obiekty generatora, które będą generować inne wartości niż poprzednie, ponieważ nie są one stosowane w tym samym węźle.
extend()
Metoda jest lista metoda obiekt, który oczekuje iterable i dodaje swoje wartości do listy.
Zwykle podajemy do niej listę:
>>> a = [1, 2]
>>> b = [3, 4]
>>> a.extend(b)
>>> print(a)
[1, 2, 3, 4]
Ale w kodzie dostaje generator, co jest dobre, ponieważ:
- Nie musisz czytać wartości dwa razy.
- Możesz mieć dużo dzieci i nie chcesz, aby wszystkie były przechowywane w pamięci.
I działa, ponieważ Python nie dba o to, czy argumentem metody jest lista, czy nie. Python oczekuje iterable, więc będzie działał z ciągami, listami, krotkami i generatorami! Nazywa się to pisaniem kaczek i jest jednym z powodów, dla których Python jest taki fajny. Ale to już inna historia, na inne pytanie ...
Możesz się tu zatrzymać lub poczytać, aby zobaczyć zaawansowane zastosowanie generatora:
Kontrolowanie wyczerpania generatora
>>> class Bank(): # Let's create a bank, building ATMs
... crisis = False
... def create_atm(self):
... while not self.crisis:
... yield "$100"
>>> hsbc = Bank() # When everything's ok the ATM gives you as much as you want
>>> corner_street_atm = hsbc.create_atm()
>>> print(corner_street_atm.next())
$100
>>> print(corner_street_atm.next())
$100
>>> print([corner_street_atm.next() for cash in range(5)])
['$100', '$100', '$100', '$100', '$100']
>>> hsbc.crisis = True # Crisis is coming, no more money!
>>> print(corner_street_atm.next())
<type 'exceptions.StopIteration'>
>>> wall_street_atm = hsbc.create_atm() # It's even true for new ATMs
>>> print(wall_street_atm.next())
<type 'exceptions.StopIteration'>
>>> hsbc.crisis = False # The trouble is, even post-crisis the ATM remains empty
>>> print(corner_street_atm.next())
<type 'exceptions.StopIteration'>
>>> brand_new_atm = hsbc.create_atm() # Build a new one to get back in business
>>> for cash in brand_new_atm:
... print cash
$100
$100
$100
$100
$100
$100
$100
$100
$100
...
Uwaga: W przypadku Python 3 użyj print(corner_street_atm.__next__())
lubprint(next(corner_street_atm))
Może to być przydatne do różnych rzeczy, takich jak kontrolowanie dostępu do zasobu.
Itertools, twój najlepszy przyjaciel
Moduł itertools zawiera specjalne funkcje do manipulowania iteracjami. Czy kiedykolwiek chciałeś zduplikować generator? Łańcuch dwóch generatorów? Czy grupować wartości na zagnieżdżonej liście za pomocą jednego wiersza? Map / Zip
bez tworzenia kolejnej listy?
Więc po prostu import itertools
.
Przykład? Zobaczmy możliwe rozkazy przylotów dla wyścigu czterech koni:
>>> horses = [1, 2, 3, 4]
>>> races = itertools.permutations(horses)
>>> print(races)
<itertools.permutations object at 0xb754f1dc>
>>> print(list(itertools.permutations(horses)))
[(1, 2, 3, 4),
(1, 2, 4, 3),
(1, 3, 2, 4),
(1, 3, 4, 2),
(1, 4, 2, 3),
(1, 4, 3, 2),
(2, 1, 3, 4),
(2, 1, 4, 3),
(2, 3, 1, 4),
(2, 3, 4, 1),
(2, 4, 1, 3),
(2, 4, 3, 1),
(3, 1, 2, 4),
(3, 1, 4, 2),
(3, 2, 1, 4),
(3, 2, 4, 1),
(3, 4, 1, 2),
(3, 4, 2, 1),
(4, 1, 2, 3),
(4, 1, 3, 2),
(4, 2, 1, 3),
(4, 2, 3, 1),
(4, 3, 1, 2),
(4, 3, 2, 1)]
Zrozumienie wewnętrznych mechanizmów iteracji
Iteracja jest procesem polegającym na iteracjach (implementacja __iter__()
metody) i iteratorach (implementacja __next__()
metody). Iterabile to dowolne obiekty, z których można uzyskać iterator. Iteratory to obiekty, które pozwalają iterować na iterowalnych.
Więcej informacji na ten temat można znaleźć w tym artykule na temat działania for
pętli .
yield
ta odpowiedź nie jest tak magiczna. Kiedy wywołujesz funkcję, która zawierayield
instrukcję w dowolnym miejscu, otrzymujesz obiekt generatora, ale nie działa żaden kod. Następnie za każdym razem, gdy wyodrębniasz obiekt z generatora, Python wykonuje kod w funkcji, aż dojdzie doyield
instrukcji, a następnie zatrzymuje się i dostarcza obiekt. Kiedy wyodrębniasz inny obiekt, Python wznawia się zaraz po nimyield
i kontynuuje, aż osiągnie innyyield
(często ten sam, ale jedna iteracja później). Trwa to do momentu, gdy funkcja przestanie działać, w tym momencie generator zostanie uznany za wyczerpany.