cloudevents / cloudevents/sdk-python
Consider exposing public APIs
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 342
- Fork
- 65
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
We should consider exposing public APIs explicitly using __init__.py. This not only makes the usage easier but also allows evolving non-public APIs without breaking outside usage and providing better backward-compatibility.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando i file init.py dei package e verificando come l'SDK espone attualmente le proprie API. Determina quali interfacce dovrebbero essere pubbliche e in che modo le esportazioni esplicite supporterebbero la compatibilità all'indietro. Il lavoro è completato quando le API pubbliche previste sono esposte chiaramente senza rendere le API non pubbliche parte della superficie supportata.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- api, backend
- Tipo di issue
- Refactoring
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100