xiaobing jiang added the comment: when I read the memory_profiler source code, I find it using inspect.getblock(). so I check the doc, but can't find the function's doc. these functions are found not in doc. I want to known which function should in doc or not? in inspect module has no __all__ variable. sorry for poor english! ---------- _______________________________________ Python tracker http://bugs.python.org/issue17972 _______________________________________

Change by Martin Panter : ---------- dependencies: +Online doc does not include inspect.classify_class_attrs _______________________________________ Python tracker https://bugs.python.org/issue17972 _______________________________________

Change by Anand Reddy Pandikunta : ---------- nosy: +chillaranand _______________________________________ Python tracker https://bugs.python.org/issue17972 _______________________________________

Paul Rudin added the comment: If some are to be considered private then the questions are: which ones and how to fix. Presumably renaming to start with "_" might break existing code, so maybe adding an __all__, and just including the public objects is better? That could break code existing relying on * imports I suppose. Deprecation is another possibility, although feels a little odd for things never documented. formatannotation and formatannotationrelativeto look like a helper functions for formatargspec and are probably not intended as part of the public interface. Similarly walktree looks like a helper for getclasstree (and its docstring describes it as such). ---------- nosy: +PaulRudin _______________________________________ Python tracker https://bugs.python.org/issue17972 _______________________________________

Paul Rudin added the comment: Documenting and generating a deprecation warning also makes them part of the documented public api. Or are you suggesting just the warning without including in the documentation? Incidentally, there are also the classes BlockFinder and EndOfBlock, which are helpers for getblock and presumably not intended for public consumption. ---------- _______________________________________ Python tracker https://bugs.python.org/issue17972 _______________________________________

Paul Rudin added the comment: Although formatannotation is undocumented, its actually documented as a default value for one of the parameters of formatargspec, so it does form part of the module's public interface. However formatargspec is deprecated, so it's still OK to deprecate formatannotation. formatannotation is also used as a helper within Parameter, which isn't deprecated, but the public interface or docs of Parameter don't mention formatannotation, so using _formatannotation instead is fine. Since I've looked through this and, as far as I can tell, nobody is working on it, I'll make the changes and make a PR. ---------- _______________________________________ Python tracker https://bugs.python.org/issue17972 _______________________________________

Change by Matthias Bussonnier : ---------- keywords: +patch pull_requests: +6644 stage: needs patch -> patch review _______________________________________ Python tracker https://bugs.python.org/issue17972 _______________________________________

Lysandros Nikolaou added the comment: I think this issue should be discussed once more. I am not sure it's worth defining __all__, but then we would have to include them in the docs. If you think __all__ should be defined instead, then I could go through the trouble of doing so. Could a core developer maybe offer their opinion here? ---------- nosy: +lys.nikolaou _______________________________________ Python tracker https://bugs.python.org/issue17972 _______________________________________

Cheryl Sabella added the comment: issue12317 discusses inspect.getabsfile() ---------- nosy: +cheryl.sabella _______________________________________ Python tracker https://bugs.python.org/issue17972 _______________________________________