matrix-org / matrix-org/matrix-python-sdk

Add canonicaljson to runtime dependencies

Abierto
#324 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Python
Estrellas
266
Forks
118
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Describe the bug
The module crypto/olm_device.py imports the canonicaljson packages which is not listed in the projects runtime dependencies. When creating a MatrixClient object with encryption=True but missing installation of canonicaljson the resulting ImportError is caught. The further handling of this Error makes it look like python-olm package is not installed.

To Reproduce
Steps to reproduce the behavior, with python-olm installed but missing canonicaljson:

  1. Create a MatrixClient object with encryption enabled:
    from matrix_client.client import MatrixClient
    client = MatrixClient("http://localhost:8008", encryption=True)

Expected behavior
These two lines should result in the creation of a MatrixClient object.

Desktop (please complete the following information):

  • OS: Debian 11
  • Version: Python 3.8.8, matrix-client 0.4.0

Additional context
This can be fixed by adding 'canonicaljson' to the list started in line 47 in setup.py. Even if the additional packages is only used when encryption is enabled, installing it always seems to be the preferable option, especially because the import error is masked.
I'd be willing to create a PR to fix this.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza por la lista de dependencias alrededor de la línea 47 de setup.py e inspecciona la importación en crypto/olm_device.py. Reproduce la creación de MatrixClient con el cifrado habilitado y canonicaljson ausente; después, verifica que declarar canonicaljson como dependencia de ejecución permite que el ejemplo documentado cree un cliente sin el manejo engañoso de ImportError.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
build-system
Tipo de issue
Error
Dificultad
1/5
Tiempo estimado
Menos de una hora
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
55/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.