slackapi / slackapi/python-slack-sdk

Export types for the objects returned from making requests

Offen
#1,543 2 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

auto-triage-skip discussion Version: 3x web-client
Vorherrschende Sprache
Python
Sterne
4k
Forks
857
Ø Merge
22 Std. 21 Min.
Gemergte PRs (30 T.)
16

Beschreibung

The export of types of the objects returned when making requests would be incredibly useful. This would significantly enhance the developer experience by:

  • preventing incorrect key accesses
  • and other invalid operations on the type of an object or value inside the object
  • enhancing IDE intellisense
  • integration with linters and static type checkers

I guess you could implement this manually, though it would be amazing if the Slack API did this for you.

Category (place an x in each of the [ ])
  • slack_sdk.web.WebClient (sync/async) (Web API client)
  • slack_sdk.webhook.WebhookClient (sync/async) (Incoming Webhook, response_url sender)
  • slack_sdk.models (UI component builders)
  • slack_sdk.oauth (OAuth Flow Utilities)
  • slack_sdk.socket_mode (Socket Mode client)
  • slack_sdk.audit_logs (Audit Logs API client)
  • slack_sdk.scim (SCIM API client)
  • slack_sdk.rtm (RTM client)
  • slack_sdk.signature (Request Signature Verifier)
Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit slack_sdk.web.WebClient, dem einzigen im Issue ausgewählten Client-Bereich, und lies die verlinkten Richtlinien für Beiträge, bevor du untersuchst, wie Web-API-Antworten dargestellt werden. Definiere den Umfang der exportierten Antworttypen und wie sie synchrone und asynchrone Anfragen abdecken würden; abgeschlossen ist die Aufgabe, wenn nutzbare Typen bereitstehen, die die Überprüfung von Schlüsseln, die IDE-Vervollständigung, Linter und statische Typprüfer unterstützen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
api, developer-experience
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.