क्या सजावट का उपयोग कर __all__ में नाम जोड़ने का अच्छा अभ्यास है?

Question

क्या यह पाइथन में एक अच्छा अभ्यास है (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 * के साथ आयात नहीं किया गया है। (

def public(x): 
     ... 


def _private_helper(y): 
    ... 

अधिक लोग इस शैली से परिचित हो जाएगा जो भी द्वारा समर्थित है:

Answer 2

यह स्वचालित रूप से __all__ पर नाम नहीं जोड़ता है, यह आपको @public के साथ सजाने के लिए सभी को एक फ़ंक्शन जोड़ने की अनुमति देता है। मुझे एक अच्छा विचार लगता है।

Answer 3

मुझे लगता है कि प्रश्न थोड़ा व्यक्तिपरक है, लेकिन मैं इस विचार की तरह। मैं आमतौर पर अपने मॉड्यूल में __all__ का उपयोग करता हूं लेकिन मैं कभी-कभी एक नया फ़ंक्शन जोड़ना भूल जाता हूं जिसका उद्देश्य मैं मॉड्यूल के सार्वजनिक इंटरफ़ेस का हिस्सा बनना चाहता हूं। चूंकि मैं आमतौर पर नाम से मॉड्यूल आयात करता हूं, न कि वाइल्डकार्ड द्वारा, मुझे तब तक त्रुटि दिखाई नहीं देती जब तक कि मेरी टीम में कोई और (जो मॉड्यूल के पूरे सार्वजनिक इंटरफ़ेस को आयात करने के लिए वाइल्डकार्ड वाक्यविन्यास का उपयोग नहीं करता) शिकायत करना शुरू कर देता है।

नोट: प्रश्न के शीर्षक भ्रामक है के रूप में दूसरों को पहले से ही जवाब के बीच में देखा है।

Answer 4

अजगर में यह करने के लिए अधिक मुहावरेदार तरह से एक अंडरस्कोर से उनके नाम शुरू करने से निजी रूप में निजी कार्यों को चिह्नित करने के लिए है भाषा: आपके public सजावट के मुकाबले __all__ का उपयोग नहीं करते हैं, भले ही निर्यात नहीं किया जाएगा।