python - 从选项卡完成中隐藏不推荐使用的方法

Question

我想控制当用户在 ipython 中的自定义对象上使用 tab 完成时出现哪些方法 - 特别是，我想隐藏我已弃用的​​功能。我仍然希望这些方法是可调用的，但我不希望用户在检查对象时看到它们并开始使用它们。这是可能的吗？

Answer 1

为您提供部分答案。我将发布示例代码，然后解释为什么它只是部分答案。
代码:

class hidden(object): # or whatever its parent class is
    def __init__(self):
        self.value = 4
    def show(self):
        return self.value
    def change(self,n):
        self.value = n
    def __getattr__(self, attrname):
        # put the dep'd method/attribute names here
        deprecateds = ['dep_show','dep_change']
        if attrname in deprecateds:
            print("These aren't the methods you're looking for.")
            def dep_change(n):
                self.value = n
            def dep_show():
                return self.value
            return eval(attrname)
        else:
            raise AttributeError, attrname

所以现在要注意:它们不是方法(请注意缺少 self 作为第一个变量)。如果您需要您的用户(或您的代码)能够在任何已弃用的方法上调用 im_class、im_func 或 im_self，那么此 hack 将不起作用。另外，我很确定性能会受到影响，因为您在 __getattr__ 中定义了每个 dep'd 函数。这不会影响您的其他属性查找(如果我将它们放在 __getattribute__ 中，那将是另一回事)，但它会减慢对那些已弃用方法的访问速度。通过将每个函数定义放在其自己的 if block 中，而不是进行列表成员检查，可以(很大程度上但不是完全)否定这一点，但是，根据您的函数有多大，维护起来可能真的很烦人。

更新:

1) 如果你想制作已弃用的函数方法(你也这样做了)，只需使用

import types
return types.MethodType(eval(attrname), self)

代替

return eval(attrname)

在上面的代码片段中，将 self 添加为函数 defs 的第一个参数。它将它们变成实例方法(因此您可以随心所欲地使用 im_class、im_func 和 im_self)。

2) 如果 __getattr__ 钩子(Hook)没有让您兴奋，还有另一种选择(据我所知)(尽管有其自身的注意事项，我们将讨论这些):将在 __init__ 中弃用函数定义，并使用自定义 __dir__ 隐藏它们。以下是上述代码以这种方式完成后的样子:

class hidden(object):
    def __init__(self):
        self.value = 4
        from types import MethodType
        def dep_show(self):
            return self.value
        self.__setattr__('dep_show', MethodType(dep_show, self))
        def dep_change(self, n):
            self.value = n
        self.__setattr__('dep_change', MethodType(dep_change, self))
    def show(self):
        return self.value
    def change(self, n):
        self.value = n
    def __dir__(self):
        heritage = dir(super(self.__class__, self)) # inherited attributes
        hide = ['dep_show', 'dep_change']
        show = [k for k in self.__class__.__dict__.keys() + self.__dict__.keys() if not k in heritage + private]
        return sorted(heritage + show)

这里的优点是您不必在每次查找时都重新定义函数，这样可以提高速度。这里的缺点是因为您没有在每次查找时重新定义函数，所以它们必须“持久化”(如果您愿意的话)。因此，虽然自定义 __dir__ 方法从 dir(hiddenObj) 中隐藏了您的弃用项，因此，IPython 的制表符完成，它们仍然存在于实例的 __dict__ 属性，用户可以在其中发现它们。