B2 SDK docs: inventory and classify the public names exported by b2sdk.v3
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 22/100
- Issue 類型
- 文件
- 描述清晰度
- 基本清楚
- 活躍度
- 冷清
- 技術堆疊
- python
- 領域
- api, documentation
研究方向
Start by running import b2sdk.v3 and listing vars(b2sdk.v3) for non-underscored names, then check which ones appear in the .rst files under doc/source/api. Sample the low-level names the issue lists (B2Session, B2Http, RawSimulator, BucketFactory) to see how they are documented. Done means a reviewed classification of each root export and an interface-policy statement, which needs maintainer decisions on compatibility.
由索引模型根據 Issue 內容生成。
描述
Description
b2sdk.v3 re-exports a large surface from _internal, including high-level APIs, low-level HTTP classes, test simulators, constants, and implementation-oriented helpers. A static inventory at f3ab7b71 found 208 non-underscored names in the v3 root; 137 were not mentioned anywhere in the Sphinx .rst sources. This count is not evidence that all 137 names should be public. It demonstrates that the repository does not currently make the boundary explicit enough to tell intentional public exports from convenient or accidental re-exports.
Steps to reproduce
import b2sdk.v3
exported = sorted(name for name in vars(b2sdk.v3) if not name.startswith('_'))
print(exported)
Compare the result with the public API pages under doc/source/api, then sample low-level names such as B2Session, B2Http, RawSimulator, BucketFactory, and transfer-manager classes to determine whether their compatibility status is documented.
Expected behavior
Produce a reviewed inventory that classifies each root export as public, advanced public, testing support, deprecated compatibility, or internal implementation. Every intentionally public symbol should be discoverable from the API reference. Anything intentionally excluded should be covered by a clear interface-policy statement so users and maintainers understand whether compatibility is promised.
Actual behavior
The versioned root exposes substantially more names than the public API reference explains. This ambiguity affects users choosing imports and maintainers deciding whether a rename or removal requires a compatibility adapter and version-specific tests.
Environment
- Python version: Any supported version
- b2sdk version:
masteratf3ab7b71 - OS: Any
- 主要語言
- Python
- 星號
- 214
- 分支
- 68
- 平均合併
- 51 分鐘
- 30 天內合併 PR
- 6
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
Backblaze/b2-sdk-python 的其他 Issue
-
Download and copy sync actions print remote file names without escape_control_chars可能已有人在做 @dreyfus92 於 15 天前認領。 未關閉
難度 2/5 1-3 小時 新手友好度 72/100
Backblaze/b2-sdk-python#631 ·
維護者通常 1 天內回覆
-
SqliteAccountInfo profile name validation uses "re.match", so only the first character is checked可能已有人在做 @nazarli-shabnam 於 9 天前認領。 未關閉
難度 2/5 1-3 小時 新手友好度 75/100
Backblaze/b2-sdk-python#629 ·
維護者通常 1 天內回覆
-
Adopt the AI-native SDLC and repository policies可能已有人在做 @goanpeca 於 18 天前認領。 未關閉enhancement
難度 5/5 一週以上 新手友好度 20/100
Backblaze/b2-sdk-python#634 ·
維護者通常 1 天內回覆
-
難度 4/5 3-5 天 新手友好度 50/100
Backblaze/b2-sdk-python#630 ·
維護者通常 1 天內回覆
-
ci: cli-compat fails — 4 sse/sync integration tests broken in B2_Command_Line_Tool (all environments)可能重新可做 @ffumero2003 於 37 天前認領，目前沒有進行中的 PR。 未關閉bug testing
Backblaze/b2-sdk-python#627 · 2 則留言 · 已指派 1 人 ·
維護者通常 1 天內回覆
查看 Backblaze/b2-sdk-python 的全部 Issue
相似的 Issue
-
難度 1/5 1 小時以內 新手友好度 72/100
btclib-org/btclib-node#2505 · 1 則留言 ·
維護者通常 1 天內回覆
-
bug
難度 2/5 1-3 小時 新手友好度 78/100
open-webui/open-webui#34462 · 1 則留言 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100
gorakhargosh/watchdog#1462 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 85/100
openwisp/openwisp-monitoring#889 ·
維護者通常 2 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100
IETF-Hackathon/pqc-certificates#351 ·
維護者通常 2 天內回覆