thingsboard / thingsboard/thingsboard-python-client-sdk
Module naming may cause issues & clashes with other python packages
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 130
- Forks
- 86
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der Untersuchung des Paketlayouts und der Verweise auf init.py, sdk_utils.py, tb_device_http.py, tb_device_mqtt.py, tb_gateway_mqtt.py und utils.py. Überprüfe anschließend, wie tb-mqtt-client diese in site-packages installiert. Als erledigt gilt die Aufgabe, wenn die SDK-Dateien unter einem eindeutigen Top-Level-Modul enthalten sind oder eindeutige Namen verwenden, ohne Paketimporte oder die Installation zu beeinträchtigen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- api
- Issue-Typ
- Refactoring
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100