Iteratory strumieniowania

Podczas wywoływania funkcji GoogleAdsService.search_stream zwracany jest iterator odpowiedzi przesyłanej strumieniowo. Ten iterator powinien pozostawać w tym samym zakresie co klient GoogleAdsService podczas używania, aby uniknąć uszkodzonych strumieni lub błędów segmentacji. Dzieje się tak, ponieważ obiekt gRPC Channel jest usuwany z pamięci, gdy otwarty obiekt GoogleAdsService wychodzi poza zakres. Jeśli obiekt GoogleAdsService nie jest już w zakresie w momencie iteracji wyniku search_stream, obiekt Channel może być już zniszczony, co powoduje nieokreślone zachowanie, gdy iterator próbuje pobrać następną wartość.

Poniższy kod pokazuje nieprawidłowe użycie iteratorów przesyłania strumieniowego:

def stream_response(client, customer_id, query):
    return client.get_service("GoogleAdsService", version="v20").search_stream(customer_id, query=query)

def main(client, customer_id):
    query = "SELECT campaign.name FROM campaign LIMIT 10"
    response = stream_response(client, customer_id, query=query)
    # Access the iterator in a different scope from where the service object was created.
    try:
        for batch in response:
            # Iterate through response, expect undefined behavior.

W powyższym kodzie obiekt GoogleAdsService jest tworzony w innym zakresie niż ten, w którym uzyskuje się dostęp do iteratora. W rezultacie obiekt Channel może zostać zniszczony, zanim iterator przetworzy całą odpowiedź.

Zamiast tego iterator strumieniowania powinien pozostawać w tym samym zakresie co klient GoogleAdsService tak długo, jak jest używany:

def main(client, customer_id):
    ga_service = client.get_service("GoogleAdsService", version="v20")
    query = "SELECT campaign.name FROM campaign LIMIT 10"
    response = ga_service.search_stream(customer_id=customer_id, query=query)
    # Access the iterator in the same scope as where the service object was created.
    try:
        for batch in response:
            # Successfully iterate through response.