thingsboard / thingsboard/thingsboard-python-client-sdk
Module naming may cause issues & clashes with other python packages
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 130
- Fork
- 86
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
Installing tb-mqtt-client results in the following files in python's site-packages directory:
__init__.py
sdk_utils.py
tb_device_http.py
tb_device_mqtt.py
tb_gateway_mqtt.py
utils.py
This gives me a few concerns:
- The
__init__.pyfile at the top-level of site-packages may be imported automatically when anything else from that directory is imported. This could lead to issues if any content is added to this file. - The names
__init__.py,sdk_utils.pyandutils.pyare not very unique and may easily clash with modules from other Python packages.
I recommend moving these files into a single top-level module or prefixing the file names with something unique to prevent issues.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
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 ispezionando la struttura del package e i riferimenti a init.py, sdk_utils.py, tb_device_http.py, tb_device_mqtt.py, tb_gateway_mqtt.py e utils.py, quindi verifica come tb-mqtt-client li installa in site-packages. Il lavoro è completato quando i file dell’SDK sono contenuti in un modulo di primo livello univoco oppure usano nomi univoci, senza compromettere gli import del package o l’installazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- api
- Tipo di issue
- Refactoring
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100