thingsboard / thingsboard/thingsboard-python-client-sdk
Module naming may cause issues & clashes with other python packages
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 130
- Forks
- 86
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par inspecter la structure du package et les références à init.py, sdk_utils.py, tb_device_http.py, tb_device_mqtt.py, tb_gateway_mqtt.py et utils.py, puis vérifiez comment tb-mqtt-client les installe dans site-packages. Le travail est terminé lorsque les fichiers du SDK sont contenus dans un module de niveau supérieur unique ou utilisent des noms uniques, sans casser les imports du package ni l’installation.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- api
- Type d'issue
- Refactorisation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100