Fortschritte bei der Open-Source-Zusammenarbeit

Überblick

Kürzlich stand ich vor einer interessanten Herausforderung, als ich an einem Projekt arbeitete, bei dem Slack Bolt mit Sanic integriert wurde – ein Framework, mit dem ich bisher nicht vertraut war, was zu einigen unerwarteten veralteten Warnungen und typbezogenen Problemen führte. Ich erläutere Ihnen, wie ich das Problem angegangen bin, welche Lektionen ich gelernt habe und welche genauen Codeänderungen das Problem gelöst haben.

Was sind Sanic und Slack Bolt?

Sanic

Sanic ist ein leistungsstarkes, asynchrones Webframework in Python. Es ist auf Schnelligkeit ausgelegt und nutzt die Asyncio-Funktionen von Python, um große Mengen an Anfragen effizient zu bearbeiten. Durch sein minimalistisches Design eignet es sich für leichte Webanwendungen, Microservices und API-Ebenen.

Lockerer Bolzen

Slack Bolt ist ein Framework zum Erstellen von Slack-Apps. Es abstrahiert die Komplexität der Slack-APIs und ermöglicht es Entwicklern, sich auf die Erstellung interaktiver und ereignisgesteuerter Slack-Anwendungen zu konzentrieren. Mit Bolt können Sie Befehle, Verknüpfungen, Ereignisse und mehr ganz einfach verwalten.

Die Herausforderung

Während der Implementierung der Integration bin ich auf mehrere Warnungen im Zusammenhang mit der Cookie-Verarbeitung von Sanic beim Ausführen von Tests und beim Bearbeiten von Anfragen gestoßen. Hier ist ein Beispiel für die Warnungen, die ich gesehen habe:

DeprecationWarning: [DEPRECATION] Setting cookie values using the dict pattern has been deprecated.
DeprecationWarning: [DEPRECATION] Accessing cookies from the CookieJar by dict key is deprecated.
TypeError: Argument "path" to "add_cookie" of "BaseHTTPResponse" has incompatible type "Optional[Any]"; expected "str"

Die Hauptursache war die Verwendung der alten dict-basierten Cookie-Verarbeitungssyntax von Sanic, die ab Sanic v23.3 nicht mehr empfohlen wird. Stattdessen muss die neue Methode add_cookie verwendet werden, um die Kompatibilität sicherzustellen und diese Warnungen zu beseitigen.

Die Lösung

Die wichtigste Änderung bestand darin, die dict-basierte Cookie-Verarbeitung durch die Methode add_cookie zu ersetzen und sicherzustellen, dass alle übergebenen Cookie-Parameter vom richtigen Typ waren.

Hier ist das aktualisierte Code-Snippet:

# Iterate over cookies and add them using Sanic's add_cookie method
for cookie in bolt_resp.cookies():
    for key, c in cookie.items():
        # Convert "expires" field if provided
        expire_value = c.get("expires")
        expires = datetime.strptime(expire_value, "%a, %d %b %Y %H:%M:%S %Z") if expire_value else None

        # Convert "max-age" if provided
        max_age = int(c["max-age"]) if c.get("max-age") else None

        # Ensure values are of the correct type before passing to add_cookie
        path = str(c.get("path")) if c.get("path") else "/"
        domain = str(c.get("domain")) if c.get("domain") else None

        # Add cookie with Sanic's add_cookie method
        resp.add_cookie(
            key=key,
            value=c.value,
            expires=expires,
            path=path,
            domain=domain,
            max_age=max_age,
            secure=True,
            httponly=True,
        )

Ersetzte Dict-basierte Syntax: Der alte Ansatz basierte auf der direkten Manipulation von resp.cookies mithilfe der Dict-Syntax, die veraltet ist. Stattdessen haben wir resp.add_cookie() verwendet, um Cookies vorwärtskompatibel zu setzen.

Sorgt für die richtigen Datentypen: Parameter wie Pfad und Domäne waren manchmal „Keine“ oder keine Zeichenfolgen. Wir haben diese Werte explizit in Zeichenfolgen konvertiert oder Standardwerte festgelegt („/“ für Pfad, Keine für Domäne), bevor wir sie an add_cookie übergeben.

Behandelte optionale Cookie-Felder: läuft ab, wurde in ein Datetime-Objekt analysiert, sofern angegeben, unter Verwendung des Formats „%a, %d %b %Y %H:%M:%S %Z“.
max-age wurde in eine Ganzzahl konvertiert, sofern verfügbar.

Durch diese Änderungen wurden alle Warnungen und Fehler behoben und sichergestellt, dass die Integration den modernen Praktiken von Sanic entsprach.

Letzte Gedanken

Da ich noch keine Erfahrung mit Sanic hatte, war es von entscheidender Bedeutung, die Dokumentation zu verstehen. Als ich lernte, wie Sanic mit Cookies und Anfragen umgeht, wurde mir klar, warum die alte Syntax problematisch war und wie die neue Methode add_cookie funktioniert.

Die Integration von Slack Bolt mit Sanic erwies sich als lohnende Herausforderung. Es hat nicht nur mein Verständnis von Sanic verbessert, sondern auch betont, wie wichtig es ist, über die Best Practices des Frameworks auf dem Laufenden zu bleiben. Wenn Sie mit ähnlichen Problemen konfrontiert sind, hoffe ich, dass dieser Blogbeitrag Klarheit schafft und Ihnen hilft, Ihr Problem effizienter zu lösen.

Das obige ist der detaillierte Inhalt vonFortschritte bei der Open-Source-Zusammenarbeit. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!