Iteradores de streaming

Ao chamar GoogleAdsService.search_stream, um iterador de resposta de streaming é retornado. Ao ser usado, esse iterador precisa permanecer no mesmo escopo que o cliente GoogleAdsService para evitar streams corrompidos ou falhas de segmentação. Isso ocorre porque o objeto Channel do gRPC é coletado da lixeira quando o objeto GoogleAdsService aberto sai do escopo. Se o objeto GoogleAdsService não estiver mais no escopo no momento em que a iteração ocorrer no resultado de search_stream, o objeto Channel poderá já ter sido destruído, causando um comportamento indefinido quando o iterador tentar recuperar o próximo valor.

O código a seguir demonstra o uso incorreto de iteradores de streaming:

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

No código acima, o objeto GoogleAdsService é criado em um escopo diferente de onde o iterador é acessado. Como resultado, o objeto Channel pode ser destruído antes que o iterador consuma toda a resposta.

Em vez disso, o iterador de streaming precisará permanecer no mesmo escopo que o cliente GoogleAdsService enquanto estiver sendo usado:

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