IDE-Codevervollständigung

IDEs wie VS Code und PyCharm bieten eine integrierte Codevervollständigung für die Sprache Python.

Die google-ads-python-Bibliothek generiert Protobuf-Nachrichtenklassen dynamisch zur Laufzeit mithilfe von Getter-Methoden für die GoogleAdsClient-Klasse. Dies kann die Codevervollständigungsfunktionen der IDE beeinträchtigen, die auf der statischen Analyse des Quellcodes basieren.

Wenn Sie die Kompatibilität mit Tools zur Codevervollständigung verbessern möchten, die auf statischer Analyse basieren, haben Sie folgende Möglichkeiten:

  1. Verwenden Sie Typannotationen mit dynamischen Getter-Methoden (empfohlen).
  2. Importieren Sie Protobuf-Nachrichtenklassen und Dienstclients direkt.

Dynamische Importe mit Typ-Hinweisen

Durch die Verwendung dynamischer Importe bleibt Ihr Code auch bei Bibliotheksupdates stabil. Durch das Hinzufügen von Typannotationen wird die IDE-Codevervollständigung ermöglicht, ohne dass die Vorteile der dynamischen Initialisierung verloren gehen:

from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.v26.resources.types.campaign import (
    Campaign,
)

client = GoogleAdsClient.load_from_storage()

# Type hints allow the IDE to provide code completion suggestions while
# retaining dynamic class generation.
campaign: Campaign = client.get_type("Campaign")

Direkte Importe

Sie können Protobuf-Nachrichtenklassen auch direkt importieren. Dieser Ansatz ermöglicht die automatische Codevervollständigung in der IDE, ohne dass Getter-Methoden verwendet werden müssen:

from google.ads.googleads.v26.resources import Campaign

# The Campaign class is imported directly, enabling the IDE to read the
# class definition and make code completion suggestions.
campaign = Campaign()

Nachteile von Direktimporten

Das direkte Importieren generierter Klassen hilft zwar bei der Codevervollständigung, bringt aber auch einige Nachteile mit sich:

  1. Schwerer zu finden: Es ist nicht immer offensichtlich, in welchem Modul sich eine bestimmte Klasse befindet. Daher kann es schwierig sein, den richtigen Importpfad zu finden.
  2. Anfällig bei Upgrades: Die Verzeichnisstruktur der generierten Klassen kann sich mit neuen Versionen der Clientbibliothek ändern. Wenn Sie Klassen direkt importieren, kann Ihr Code bei einem Upgrade fehlerhaft werden. Code, der Getter-Methoden verwendet, ist von solchen Änderungen nicht betroffen.
  3. Manuelle Initialisierung erforderlich: Die Methode get_service initialisiert Dienste mit Authentifizierung, Transporteinstellungen und gRPC-Interceptors (die Header wie login-customer-id und linked-customer-id anhängen, Logging verarbeiten und Fehler in GoogleAdsException verpacken), bevor sie zurückgegeben werden. Wenn Sie Dienste direkt importieren und instanziieren, werden diese Interceptoren umgangen und Sie müssen Anmeldedaten und Transportkanäle manuell konfigurieren:

    from google.ads.googleads.v26.services.services import (
        campaign_service as campaign_service_module,
    )
    
    # Dynamic service getter (initializes credentials, transport, and gRPC
    # interceptors automatically).
    campaign_service = client.get_service("CampaignService")
    
    # Direct service client import (requires manual credential and interceptor
    # configuration).
    campaign_service_client = campaign_service_module.CampaignServiceClient(
        credentials=client.credentials,
    )