Streaming-Validatoren

Beim Aufruf von GoogleAdsService.search_stream wird ein Streaming-Antwort-Iterator zurückgegeben. Dieser Iterator sollte sich während der Verwendung im selben Gültigkeitsbereich wie der GoogleAdsService-Client befinden, um unterbrochene Streams oder Segmentierungsfehler zu vermeiden. Das liegt daran, dass das gRPC-Objekt Channel durch die Garbage Collection gelöscht wird, sobald das offene GoogleAdsService-Objekt außerhalb des Gültigkeitsbereichs liegt. Wenn das GoogleAdsService-Objekt zum Zeitpunkt der Iteration des Ergebnisses von search_stream nicht mehr im Gültigkeitsbereich ist, wurde das Channel-Objekt möglicherweise bereits zerstört. Dies führt zu einem undefinierten Verhalten, wenn der Iterator versucht, den nächsten Wert abzurufen.

Im folgenden Code wird die falsche Verwendung von Streaming-Iteratoren veranschaulicht:

def stream_response(client, customer_id, query):
    return client.get_service("GoogleAdsService", version="v18").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.

Im obigen Code wird das GoogleAdsService-Objekt in einem anderen Gültigkeitsbereich erstellt, als über den der Iterator darauf zugreift. Daher wird das Channel-Objekt möglicherweise zerstört, bevor der Iterator die gesamte Antwort verarbeitet hat.

Stattdessen sollte der Streaming-Iterator so lange im selben Gültigkeitsbereich wie der GoogleAdsService-Client bleiben, wie er verwendet wird:

def main(client, customer_id):
    ga_service = client.get_service("GoogleAdsService", version="v18")
    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.