使用裝飾器向__all__添加名稱是一種好的做法嗎？

Question

這是Python中的一個很好的練習（從Active State Recipes -- Public Decorator）？

import sys 

def public(f): 
    """Use a decorator to avoid retyping function/class names. 

    * Based on an idea by Duncan Booth: 
    http://groups.google.com/group/comp.lang.python/msg/11cbb03e09611b8a 
    * Improved via a suggestion by Dave Angel: 
    http://groups.google.com/group/comp.lang.python/msg/3d400fb22d8a42e1 
    """ 
    all = sys.modules[f.__module__].__dict__.setdefault('__all__', []) 
    if f.__name__ not in all: # Prevent duplicates if run from an IDE. 
     all.append(f.__name__) 
    return f 

public(public) # Emulate decorating ourself 

總的想法是定義一個裝飾，需要一個功能或 類，並增加了它的名字到當前模塊的__all__。

Answer 1

是的，這是一個很好的做法。這個裝飾器允許你在函數或類定義中表達你的意圖，而不是直接在之後。這使您的代碼更具可讀性。

@public 
def foo(): 
    pass 

@public 
class bar(): 
    pass 

class helper(): # not part of the modules public interface! 
    pass 

注：helper仍然是由modulename.helper一個模塊的用戶訪問。它只是沒有與from modulename import *進口。

Answer 2

這不會自動將名稱添加到__all__，它只是允許您通過用@public裝飾它來爲所有人添加功能。對我來說似乎是一個不錯的主意。

Answer 3

我認爲這個問題有點主觀，但我喜歡這個主意。我通常在我的模塊中使用__all__，但我有時會忘記添加一個新功能，我打算將其作爲模塊公共接口的一部分。由於我通常通過名稱而不是通配符導入模塊，因此直到我的團隊中的其他人（使用通配符語法導入模塊的整個公共接口）開始抱怨爲止，我才注意到錯誤。

注意：問題的標題是誤導的，因爲其他人已經注意到了答案。

Answer 4

更習慣的方法在Python做，這是通過用下劃線開始他們的名字，以紀念私有函數私有：

def public(x): 
     ... 


def _private_helper(y): 
    ... 

更多的人會熟悉這種風格（也由支持語言：_private_helper即使不使用__all__也不會被導出），而不是使用您的public修飾器。