Add canonicaljson to runtime dependencies
还没有人认领这个 Issue。
评估
- 难度
- 1/5
- 预计耗时
- 1 小时以内
- 新手友好度
- 55/100
- Issue 类型
- 缺陷
- 描述清晰度
- 描述清楚
- 活跃度
- 停滞
- 技术栈
- python
- 领域
- build-system
调研方向
从 setup.py 第 47 行附近的依赖项列表开始，检查 crypto/olm_device.py 中的 import。在启用加密且 canonicaljson 不存在的情况下重现 MatrixClient 的创建，然后验证将 canonicaljson 声明为运行时依赖项后，文档中的示例能够在不采用误导性的 ImportError 处理方式的情况下创建客户端。
由索引模型根据 Issue 内容生成。
描述
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:
- 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.
- 主要语言
- Python
- 星标
- 266
- 派生
- 118
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
matrix-org/matrix-python-sdk 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 25/100
matrix-org/matrix-python-sdk#330 · 3 个 reaction ·
-
难度 5/5 一周以上 新手友好度 25/100
matrix-org/matrix-python-sdk#326 ·
-
难度 2/5 1-3 小时 新手友好度 48/100
matrix-org/matrix-python-sdk#323 ·
-
难度 3/5 1-2 天 新手友好度 35/100
matrix-org/matrix-python-sdk#319 ·
-
难度 4/5 3-5 天 新手友好度 25/100
matrix-org/matrix-python-sdk#318 · 2 条评论 ·
查看 matrix-org/matrix-python-sdk 的全部 Issue
相似的 Issue
-
bug confirmed issue
难度 2/5 1-3 小时 新手友好度 75/100
open-webui/open-webui#30750 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
-
enhancement
难度 2/5 1-3 小时 新手友好度 75/100
OpenwaterHealth/openmotion-bloodflow-app#604 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 70/100
-
good first issue
难度 1/5 1 小时以内 新手友好度 90/100