¿Es una buena práctica agregar nombres a __all__ utilizando un decorador?

Question

¿Es esta una buena práctica en Python (desde 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 

La idea general sería definir un decorador que toma una función o una clase de y añade su nombre a la __all__ del módulo actual.

Answer 1

Sí, es una buena práctica. Este decorador le permite expresar sus intenciones directamente en la definición de la función o la clase, en lugar de directamente después. Eso hace que tu código sea más legible.

@public 
def foo(): 
    pass 

@public 
class bar(): 
    pass 

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

Nota:helper sigue siendo accesible a un usuario del módulo de modulename.helper. Simplemente no se importa con from modulename import *.

Answer 2

Esto no agrega automáticamente nombres a __all__, simplemente le permite agregar una función a todos decorando con @public. Me parece una buena idea.

Answer 3

Creo que la pregunta es un poco subjetiva, pero me gusta la idea. Usualmente uso __all__ en mis módulos, pero a veces me olvido de agregar una nueva función que pretendía formar parte de la interfaz pública del módulo. Dado que generalmente importo módulos por nombre y no por comodines, no noto el error hasta que alguien más en mi equipo (que usa la sintaxis comodín para importar toda la interfaz pública de un módulo) comienza a quejarse.

Nota: el título de la pregunta es engañoso, ya que otros ya han notado entre las respuestas.

Answer 4

La forma más idiomática para hacer esto en Python es marcar los eventos privados como privada por comenzar su nombre con un guión bajo:

def public(x): 
     ... 


def _private_helper(y): 
    ... 

más personas estarán familiarizados con este estilo (que también es apoyado por el idioma: _private_helper no se exportará aunque no use __all__) que con su decorador public.