tobgu/pyrsistent

Public introspection API for fields and checked types

Open

#47 建立於 2015年8月11日

在 GitHub 查看
 (4 留言) (0 反應) (0 負責人)Python (1,943 star) (141 fork)batch import
enhancementhelp wanted

描述

We're about to add some code that introspects pyrsistent classes - in particular PRecord/PClass and the checked data structures - in order to detect changes to our pyrsistent-based configuration model. You can see a sketch of this code here: https://github.com/ClusterHQ/flocker/pull/1836/files#diff-c03885f8c4e64651ea9a499e99090a83R28

Unfortunately this currently requires using private pyrsistent APIs. It would be good to have a public API for finding this information. As a first pass it seems that adding this as extra methods to the classes themselves is problematic, insofar as it means subclasses get extra methods they weren't expecting. So maybe there should be a set of public external functions that extract information from the private implementation details.

貢獻者指南

技術棧
python
領域
backend
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Python basicspyrsistent library knowledge
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
Review the linked PR (https://github.com/ClusterHQ/flocker/pull/1836/files) to understand the required introspection. Examine the private APIs currently used, such as ' fields' and ' types', in pyrsistent classes. Propose a set of public functions (e.g., 'get fields(cls)', 'get checked types(cls)') that expose this information without polluting the class interface. Ensure backward compatibility and document the new API.