influxdata / influxdata/influxdb-client-python
Public symbols not properly exported with `py.typed` present — triggers Pylance/Pyright errors
- Lenguaje dominante
- Python
- Estrellas
- 793
- Forks
- 186
- Merge medio
- 3 h 2 min
- PR fusionados (30 d)
- 1
Descripción
Hi team,
Thanks for maintaining this package — it's a great tool for working with InfluxDB.
I'm opening this issue to report a problem that affects type checkers and IDEs (like Pyright, Pylance, and mypy) due to the presence of the `py.typed` file in the `influxdb-client-python` package.
Since the package declares itself as typed (via `py.typed`, per [[PEP 561](https://peps.python.org/pep-0561/)](https://peps.python.org/pep-0561/)), tools like **Pyright** and **Pylance** apply stricter rules around public API exposure. Specifically, **public symbols must be explicitly exported** using either:
* a `__all__` list in `__init__.py`, or
* `.pyi` stub files.
Currently, this is not the case for the main client class. When importing `InfluxDBClient` from the top-level module as documented:
```python
from influxdb_client import InfluxDBClient
```
Pylance (and Pyright) raises the following error:
```
"InfluxDBClient" is not exported from module "influxdb_client"
Import from "influxdb_client.client.influxdb_client" instead
Pylance: reportPrivateImportUsage
```
This is confusing to users and suggests that the public API is not properly defined.
### Suggested solutions
To resolve this and ensure compatibility with type checkers, here are a few possible approaches:
1. **Add `__all__` to `influxdb_client/__init__.py`** to explicitly define the intended public interface.
2. **Provide proper `.pyi` stub files** that describe the public API.
3. If full typing support is not maintained, **consider removing the `py.typed` file** to avoid stricter validation.
Improving this would help developers relying on static analysis and IDE support, and reduce confusion about which imports are officially supported.
Thanks again for your work and for considering this issue!
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Línea de trabajo
Comienza inspeccionando influxdb_client/__init__.py y el marcador py.typed del paquete; después, reproduce la importación documentada `from influxdb_client import InfluxDBClient` con Pyright o Pylance. Determina cuáles son las exportaciones públicas previstas y verifica que la importación de nivel superior ya no produzca el diagnóstico de importación privada indicado.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- api
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100