Getter con efecto secundario

Question

Creo una clase cuyos objetos se inicializan con un montón de código XML. La clase tiene la capacidad de extraer varios parámetros de ese XML y almacenarlos en caché dentro de las variables de estado del objeto. La cantidad potencial de estos parámetros es grande y, probablemente, el usuario no necesitará la mayoría de ellos. Es por eso que he decidido realizar una inicialización "floja".

En el siguiente caso de prueba, tal parámetro es title. Cuando el usuario intenta acceder a él por primera vez, la función getter analiza el XML, adecuadamente inicializa la variable de estado y devolver su valor:

class MyClass(object):  
    def __init__(self, xml=None): 
     self.xml = xml 
     self.title = None 

    def get_title(self): 
     if self.__title is None: 
      self.__title = self.__title_from_xml() 
     return self.__title 

    def set_title(self, value): 
     self.__title = value 

    title = property(get_title, set_title, None, "Citation title") 

    def __title_from_xml(self): 
     #parse the XML and return the title 
     return title   

Esto se ve bien y funciona bien para mí. Sin embargo, me molesta un poco el hecho de que la función getter es en realidad una "setter" en el sentido de que tiene un efecto secundario muy significativo en el objeto. ¿Es esto una preocupación legítima? Si es así, ¿cómo debería abordarlo?

Answer 1

Si bien el captador ciertamente tiene un efecto secundario, tradicionalmente no es lo que uno consideraría un efecto secundario negativo. Como el captador siempre devuelve lo mismo (salvo que haya cambios intermedios en el estado), no tiene efectos secundarios visibles para el usuario. Este es un uso típico de las propiedades, por lo que no hay nada de qué preocuparse.

Answer 2

Este patrón de diseño se llama Lazy initialization y tiene un uso legítimo.

Answer 3

Algunos años después pero bien: aunque la inicialización lenta es buena en sí misma, definitivamente no pospongo el análisis xml hasta que alguien acceda al objeto title. Se supone que los atributos calculados se comportan como atributos simples, y un acceso de atributo simple nunca raise (suponiendo que el atributo existe, por supuesto).

FWIW Tuve un caso muy similar en algún proyecto que asumí, con errores de análisis XML ocurriendo en los lugares más inesperados, debido a que el desarrollador anterior usó las propiedades de la misma manera que en el ejemplo OP, y tuvo que arreglarlo al poner la parte de análisis y validación en el momento de instanciación.

lo tanto, utilizar las propiedades de inicialización perezosa sólo si y cuando se sabe el primer acceso se nunca aumento. En realidad, nunca use una propiedad para cualquier cosa que pueda aumentar (al menos cuando se obtiene - la configuración es una situación diferente). De lo contrario, no use una propiedad, haga del getter un método explícito y documente claramente que podría plantear esto o aquello.

NB: usar una propiedad para almacenar en caché algo no es el problema aquí, esto solo está bien.