properly define what "canonical" means in `os.path.realpath`
還沒有人認領這個 Issue。
- 主要語言
- Python
- 星號
- 77.2k
- 分支
- 36k
- PR 合併指標
- PR 指標待擷取
描述
Documentation
The documentation says:
https://github.com/python/cpython/blob/2fd09b011031f3c00c342b44e02e2817010e507c/Doc/library/os.path.rst?plain=1#L406-L409
So it merely mentions symlink resolution, but not what else it means (if anything).
It does however mention that whatever it does is OS dependent:
https://github.com/python/cpython/blob/2fd09b011031f3c00c342b44e02e2817010e507c/Doc/library/os.path.rst?plain=1#L416-L418
IMO, it should be clearly documented what it does or at least:
- what it guarantees to the least (For example will the pathname be absolute? Will it be normalised?)
and/or: - which OS function it’s identical to, like on POSIX where that would probably realpath(), and whether there are differences to that
Especially since IMO "canonical" pathname (though I think it has no formal definition, or is there anything in POSIX?) means rather just that there are no symlinks left, i.e. that the file is "reached" by its true (=canonical) name.
But that could still be a relative pathname, and perhaps even one that is not normalised.
Cheers,
Chris.
Linked PRs
- gh-134755
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
從 Doc/library/os.path.rst 中引用的第 406-409 行和第 416-418 行開始,然後與 issue 中連結的 POSIX realpath() 參考文件進行比較。記錄 os.path.realpath 的最低保證,以及任何特定於作業系統的行為或差異,並確保措辭明確說明「canonical」的含義。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 2/5
- 預估耗時
- 1-3 小時
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100