apache / apache/pulsar-client-python

Document for the pulsar.Result enum

未關閉
#185 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
主要語言
Python
星號
75
分支
53
PR 合併指標
30 天內沒有已合併 PR

描述

The `pulsar.Result` enum is just imported from the C extension. See https://github.com/apache/pulsar-client-python/blob/daabc677e06e867f84beaeb3912d1d450cddf54d/pulsar/__init__.py#L50

Running `help(pulsar.Result)` could only show the underlying C error codes like

```
|
| AlreadyClosed =
|
| AuthenticationError =
|
| AuthorizationError =
|
| BrokerMetadataError =
|
| BrokerPersistenceError =
```

The error code should be well documented. Otherwise users might not know how to handle these error codes.

For now, users can refer https://github.com/apache/pulsar-client-cpp/blob/main/include/pulsar/Result.h for the meaning of error codes.

貢獻指南

開啟貢獻指南

研究方向

從 pulsar/__init__.py 中第 50 行附近的 import 開始,然後將 enum 值與連結的 C++ include/pulsar/Result.h 中的含義進行比較。記錄面向 Python 的 pulsar.Result enum 的錯誤碼含義,讓使用者能夠理解並處理每個結果。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
python
領域
documentation
Issue 類型
文件
難度
2/5
預估耗時
1-3 小時
活躍度
停滯
描述清晰度
基本清楚
新手友好度
52/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。