slackapi / slackapi/python-slack-sdk

Export types for the objects returned from making requests

Aperta
#1,543 2 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

auto-triage-skip discussion Version: 3x web-client
Lingua principale
Python
Stelle
4k
Fork
857
Merge medio
22h 21m
PR unite (30g)
16

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia da slack_sdk.web.WebClient, l'unica area client selezionata nell'issue, e leggi le linee guida per i contributi collegate prima di analizzare come sono rappresentate le risposte della Web API. Definisci l'ambito dei tipi di risposta esportati e il modo in cui coprirebbero le richieste sincrone e asincrone; il completamento dovrebbe fornire tipi utilizzabili che supportino il controllo delle chiavi, il completamento nell'IDE, i linter e i type checker statici.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
api, developer-experience
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.