Diferencia entre método estático y método de clase

3583

¿Cuál es la diferencia entre una función decorada @staticmethody una decorada con @classmethod?

Daryl Spitzer
fuente
11
Los métodos estáticos a veces son mejores como funciones de nivel de módulo en Python por razones de limpieza. Con una función de módulo es más fácil importar solo la función que necesita y evitar "" innecesarios. sintaxis (te estoy mirando Objective-C). Los métodos de clase tienen más uso ya que pueden usarse en combinación con el polimorfismo para crear funciones de "patrón de fábrica". Esto se debe a que los métodos de clase reciben la clase como un parámetro implícito.
FistOfFury
27
tl; dr >> en comparación con los métodos normales, también se puede acceder a los métodos estáticos y a los métodos de clase utilizando la clase, pero a diferencia de los métodos de clase, los métodos estáticos son inmutables por herencia.
imsrgadich
44
Charla relacionada de Raymond Hettinger sobre el tema: youtube.com/watch?v=HTLu2DFOdTg
moooeeeep
youtube.com/watch?v=HTLu2DFOdTg&feature=youtu.be&t=2689 más preciso solo necesita el método de clase para constructores alternativos. De lo contrario, puede usar el método estático y acceder a cualquier atributo de clase (vía. / Dot) mediante el "CLASSNAME" real de alguna manera más informativo en lugar de cls como en classmethod
Robert Nowak

Respuestas:

3138

Tal vez un poco de ejemplo de código ayudará a: Aviso de la diferencia de las firmas de llamadas foo, class_fooy static_foo:

class A(object):
    def foo(self, x):
        print "executing foo(%s, %s)" % (self, x)

    @classmethod
    def class_foo(cls, x):
        print "executing class_foo(%s, %s)" % (cls, x)

    @staticmethod
    def static_foo(x):
        print "executing static_foo(%s)" % x    

a = A()

A continuación se muestra la forma habitual en que una instancia de objeto llama a un método. La instancia del objeto a, se pasa implícitamente como el primer argumento.

a.foo(1)
# executing foo(<__main__.A object at 0xb7dbef0c>,1)

Con classmethods , la clase de la instancia del objeto se pasa implícitamente como el primer argumento en lugar de self.

a.class_foo(1)
# executing class_foo(<class '__main__.A'>,1)

También puedes llamar class_foousando la clase. De hecho, si define algo como un método de clase, probablemente sea porque tiene la intención de llamarlo desde la clase en lugar de desde una instancia de clase. A.foo(1)habría generado un TypeError, pero A.class_foo(1)funciona bien:

A.class_foo(1)
# executing class_foo(<class '__main__.A'>,1)

Un uso que la gente ha encontrado para los métodos de clase es crear constructores alternativos heredables .


Con métodos estáticos , ni self(la instancia del objeto) ni cls(la clase) se pasa implícitamente como primer argumento. Se comportan como funciones simples, excepto que puede llamarlas desde una instancia o la clase:

a.static_foo(1)
# executing static_foo(1)

A.static_foo('hi')
# executing static_foo(hi)

Los métodos estáticos se utilizan para agrupar funciones que tienen alguna conexión lógica con una clase a la clase.


fooes solo una función, pero cuando llama a.foono solo obtiene la función, obtiene una versión "parcialmente aplicada" de la función con la instancia del objeto avinculada como el primer argumento de la función. fooespera 2 argumentos, mientras que a.foosolo espera 1 argumento.

aestá obligado a foo. Eso es lo que se entiende por el término "obligado" a continuación:

print(a.foo)
# <bound method A.foo of <__main__.A object at 0xb7d52f0c>>

Con a.class_foo, ano está obligado a class_foo, más bien Aestá obligado a la clase class_foo.

print(a.class_foo)
# <bound method type.class_foo of <class '__main__.A'>>

Aquí, con un método estático, aunque es un método, a.static_foosimplemente devuelve una buena función 'ole sin argumentos vinculados. static_fooespera 1 argumento, y a.static_fooespera 1 argumento también.

print(a.static_foo)
# <function static_foo at 0xb7d479cc>

Y, por supuesto, sucede lo mismo cuando llamas static_foocon la clase A.

print(A.static_foo)
# <function static_foo at 0xb7d479cc>
unutbu
fuente
182
No entiendo cuál es el truco para usar el método estático. simplemente podemos usar una función simple fuera de clase.
Alcott
372
@Alcott: es posible que desee mover una función a una clase porque lógicamente pertenece a la clase. En el código fuente de Python (por ejemplo, multiprocesamiento, tortuga, paquetes dist), se utiliza para "ocultar" funciones "privadas" de subrayado simple del espacio de nombres del módulo. Sin embargo, su uso está altamente concentrado en solo unos pocos módulos, tal vez una indicación de que es principalmente una cuestión estilística. Aunque no pude encontrar ningún ejemplo de esto, @staticmethodpodría ayudar a organizar su código al ser reemplazable por subclases. Sin él, tendrías variantes de la función flotando en el espacio de nombres del módulo.
unutbu
15
... junto con alguna explicación sobre dónde y por qué usar una instancia, clase o métodos estáticos. No dio una sola palabra al respecto, pero tampoco el OP le preguntó al respecto.
MestreLion
106
@Alcott: como dijo unutbu, los métodos estáticos son una característica de organización / estilística. A veces, un módulo tiene muchas clases, y algunas funciones auxiliares están lógicamente vinculadas a una clase determinada y no a las demás, por lo que tiene sentido no "contaminar" el módulo con muchas "funciones libres", y es mejor usar una estática método que confiar en el pobre estilo de mezclar clases y funciones defs juntas en el código solo para mostrar que están "relacionadas"
MestreLion
44
Un uso más para @staticmethod: puede usarlo para eliminar cruft. Estoy implementando un lenguaje de programación en Python: las funciones definidas por la biblioteca utilizan un executemétodo estático , donde las funciones definidas por el usuario requieren argumentos de instancia (es decir, el cuerpo de la función). Este decorador elimina las advertencias de "parámetro propio no utilizado" en el inspector de PyCharm.
tehwalrus
799

Un método estático es un método que no sabe nada acerca de la clase o instancia en la que fue invocado. Simplemente obtiene los argumentos que se aprobaron, no el primer argumento implícito. Básicamente es inútil en Python: puede usar una función de módulo en lugar de un método estático.

Un método de clase , por otro lado, es un método que pasa la clase a la que se llamó, o la clase de la instancia a la que se llamó, como primer argumento. Esto es útil cuando desea que el método sea una fábrica para la clase: dado que obtiene la clase real a la que se llamó como primer argumento, siempre puede crear una instancia de la clase correcta, incluso cuando están involucradas subclases. Observe, por ejemplo dict.fromkeys(), cómo , un método de clase, devuelve una instancia de la subclase cuando se llama en una subclase:

>>> class DictSubclass(dict):
...     def __repr__(self):
...         return "DictSubclass"
... 
>>> dict.fromkeys("abc")
{'a': None, 'c': None, 'b': None}
>>> DictSubclass.fromkeys("abc")
DictSubclass
>>> 
Thomas Wouters
fuente
715
Un método estático no es inútil: es una forma de poner una función en una clase (porque lógicamente pertenece allí), mientras indica que no requiere acceso a la clase.
Tony Meyer,
136
Por lo tanto, solo 'básicamente' inútil. Dicha organización, así como la inyección de dependencias, son usos válidos de métodos estáticos, pero dado que los módulos, no las clases como en Java, son los elementos básicos de la organización del código en Python, su uso y utilidad son raros.
Thomas Wouters
40
¿Qué tiene de lógico definir un método dentro de una clase, cuando no tiene nada que ver ni con la clase ni con sus instancias?
Ben James
107
Tal vez por el bien de la herencia? Los métodos estáticos se pueden heredar y anular al igual que los métodos de instancia y los métodos de clase, y la búsqueda funciona como se esperaba (a diferencia de Java). Los métodos estáticos no se resuelven estáticamente si se llama a la clase o instancia, por lo que la única diferencia entre la clase y los métodos estáticos es el primer argumento implícito.
haridsv
80
También crean un espacio de nombres más limpio y hace que sea más fácil entender que la función tiene algo que ver con la clase.
Imbrondir
149

Básicamente, @classmethodun método cuyo primer argumento es la clase de la que se llama (en lugar de la instancia de clase), @staticmethodno tiene ningún argumento implícito.

Terence Simpson
fuente
103

Documentos oficiales de Python:

@classmethod

Un método de clase recibe la clase como primer argumento implícito, al igual que un método de instancia recibe la instancia. Para declarar un método de clase, use este modismo:

class C:
    @classmethod
    def f(cls, arg1, arg2, ...): ... 

El @classmethodformulario es un decorador de funciones : consulte la descripción de las definiciones de funciones en Definiciones de funciones para obtener más detalles.

Se puede invocar en la clase (como C.f()) o en una instancia (comoC().f() ). La instancia se ignora a excepción de su clase. Si se llama a un método de clase para una clase derivada, el objeto de clase derivada se pasa como el primer argumento implícito.

Los métodos de clase son diferentes a los métodos estáticos C ++ o Java. Si quieres esos, mira staticmethod()en esta sección.

@staticmethod

Un método estático no recibe un primer argumento implícito. Para declarar un método estático, use este modismo:

class C:
    @staticmethod
    def f(arg1, arg2, ...): ... 

El @staticmethodformulario es un decorador de funciones : consulte la descripción de las definiciones de funciones en Definiciones de funciones para obtener más detalles.

Se puede invocar en la clase (como C.f()) o en una instancia (como C().f()). La instancia se ignora a excepción de su clase.

Los métodos estáticos en Python son similares a los encontrados en Java o C ++. Para un concepto más avanzado, vea classmethod()en esta sección.

Chris B.
fuente
¿No hay un error en los documentos? No debería estar en el método estático: "La instancia y su clase se ignoran". en lugar de "La instancia se ignora a excepción de su clase".
mirek
Puede ser un error de cortar y pegar, pero estrictamente hablando no puede llamar a un método en una clase si ignora la clase.
Aaron Bentley
76

Aquí hay un breve artículo sobre esta pregunta.

La función @staticmethod no es más que una función definida dentro de una clase. Es invocable sin instanciar la clase primero. Su definición es inmutable a través de la herencia.

La función @classmethod también se puede llamar sin crear instancias de la clase, pero su definición sigue a la subclase, no a la clase padre, a través de la herencia. Esto se debe a que el primer argumento para la función @classmethod siempre debe ser cls (clase).

Tom Neyland
fuente
1
Entonces, ¿eso significa que al usar un método estático siempre estoy vinculado a la clase Parent y con el método classy estoy vinculado a la clase en la que declaro el método class (en este caso, la subclase)?
Mohan Gulati el
77
No. Al usar un método estático no estás obligado en absoluto; No hay un primer parámetro implícito. Al usar classmethod, obtiene como primer parámetro implícito la clase a la que llamó el método (si lo llamó directamente a una clase), o la clase de la instancia a la que llamó al método (si lo llamó a una instancia).
Matt Anderson el
66
Podría expandirse un poco para mostrar que, al tener una clase como primer argumento, los métodos de clase tienen acceso directo a otros atributos y métodos de clase, mientras que los métodos estáticos no (tendrían que codificar MyClass.attr para eso)
MestreLion
"Su definición es inmutable a través de la herencia". no tiene ningún sentido en Python, puede anular un método estático muy bien.
cz
68

Para decidir si usar @staticmethod o @classmethod debes mirar dentro de tu método. Si su método accede a otras variables / métodos en su clase, entonces use @classmethod . Por otro lado, si su método no toca ninguna otra parte de la clase, use @staticmethod.

class Apple:

    _counter = 0

    @staticmethod
    def about_apple():
        print('Apple is good for you.')

        # note you can still access other member of the class
        # but you have to use the class instance 
        # which is not very nice, because you have repeat yourself
        # 
        # For example:
        # @staticmethod
        #    print('Number of apples have been juiced: %s' % Apple._counter)
        #
        # @classmethod
        #    print('Number of apples have been juiced: %s' % cls._counter)
        #
        #    @classmethod is especially useful when you move your function to other class,
        #       you don't have to rename the class reference 

    @classmethod
    def make_apple_juice(cls, number_of_apples):
        print('Make juice:')
        for i in range(number_of_apples):
            cls._juice_this(i)

    @classmethod
    def _juice_this(cls, apple):
        print('Juicing %d...' % apple)
        cls._counter += 1
Du D.
fuente
cuál sería la ventaja de classmethod y cls._counter vs. staticmethod y Apple._counter
Robert Nowak
1
cls._counteraún lo sería cls._counterincluso si el código se coloca en una clase diferente o si se cambia el nombre de la clase. Apple._counteres específico para la Appleclase; para una clase diferente, o cuando se cambia el nombre de la clase, necesitaría cambiar la clase referenciada.
kiamlaluno
53

¿Cuál es la diferencia entre @staticmethod y @classmethod en Python?

Es posible que haya visto código Python como este pseudocódigo, que muestra las firmas de los distintos tipos de métodos y proporciona una cadena de documentación para explicar cada uno:

class Foo(object):

    def a_normal_instance_method(self, arg_1, kwarg_2=None):
        '''
        Return a value that is a function of the instance with its
        attributes, and other arguments such as arg_1 and kwarg2
        '''

    @staticmethod
    def a_static_method(arg_0):
        '''
        Return a value that is a function of arg_0. It does not know the 
        instance or class it is called from.
        '''

    @classmethod
    def a_class_method(cls, arg1):
        '''
        Return a value that is a function of the class and other arguments.
        respects subclassing, it is called with the class it is called from.
        '''

El método de instancia normal

Primero te lo explicaré a_normal_instance_method. Esto se llama precisamente un " método de instancia ". Cuando se usa un método de instancia, se usa como una función parcial (en oposición a una función total, definida para todos los valores cuando se ve en el código fuente), es decir, cuando se usa, el primero de los argumentos está predefinido como la instancia de objeto, con todos sus atributos dados. Tiene la instancia del objeto vinculada a él y debe llamarse desde una instancia del objeto. Normalmente, accederá a varios atributos de la instancia.

Por ejemplo, esta es una instancia de una cadena:

', '

si usamos el método de instancia, joinen esta cadena, para unir otro iterable, obviamente es una función de la instancia, además de ser una función de la lista iterable ['a', 'b', 'c']:

>>> ', '.join(['a', 'b', 'c'])
'a, b, c'

Métodos vinculados

Los métodos de instancia se pueden vincular mediante una búsqueda punteada para su uso posterior.

Por ejemplo, esto vincula el str.joinmétodo a la ':'instancia:

>>> join_with_colons = ':'.join 

Y luego podemos usar esto como una función que ya tiene el primer argumento vinculado. De esta manera, funciona como una función parcial en la instancia:

>>> join_with_colons('abcde')
'a:b:c:d:e'
>>> join_with_colons(['FF', 'FF', 'FF', 'FF', 'FF', 'FF'])
'FF:FF:FF:FF:FF:FF'

Método estático

El método estático no toma la instancia como argumento.

Es muy similar a una función de nivel de módulo.

Sin embargo, una función de nivel de módulo debe vivir en el módulo y debe importarse especialmente a otros lugares donde se usa.

Sin embargo, si está adjunto al objeto, seguirá el objeto convenientemente a través de la importación y la herencia también.

Un ejemplo de un método estático es str.maketrans, movido desde el stringmódulo en Python 3. Hace que una tabla de traducción sea adecuada para el consumo de str.translate. Parece bastante tonto cuando se usa desde una instancia de una cadena, como se demuestra a continuación, pero importar la función desde el stringmódulo es bastante torpe, y es bueno poder llamarlo desde la clase, como enstr.maketrans

# demonstrate same function whether called from instance or not:
>>> ', '.maketrans('ABC', 'abc')
{65: 97, 66: 98, 67: 99}
>>> str.maketrans('ABC', 'abc')
{65: 97, 66: 98, 67: 99}

En python 2, debe importar esta función desde el módulo de cadena cada vez menos útil:

>>> import string
>>> 'ABCDEFG'.translate(string.maketrans('ABC', 'abc'))
'abcDEFG'

Método de clase

Un método de clase es similar a un método de instancia en que toma un primer argumento implícito, pero en lugar de tomar la instancia, toma la clase. Con frecuencia, estos se utilizan como constructores alternativos para un mejor uso semántico y admitirá la herencia.

El ejemplo más canónico de un método de clase integrado es dict.fromkeys. Se utiliza como un constructor alternativo de dict (muy adecuado para cuando sepa cuáles son sus claves y desee un valor predeterminado para ellas).

>>> dict.fromkeys(['a', 'b', 'c'])
{'c': None, 'b': None, 'a': None}

Cuando subclasemos dict, podemos usar el mismo constructor, que crea una instancia de la subclase.

>>> class MyDict(dict): 'A dict subclass, use to demo classmethods'
>>> md = MyDict.fromkeys(['a', 'b', 'c'])
>>> md
{'a': None, 'c': None, 'b': None}
>>> type(md)
<class '__main__.MyDict'>

Vea el código fuente de los pandas para otros ejemplos similares de constructores alternativos, y también vea la documentación oficial de Python en classmethody staticmethod.

Aaron Hall
fuente
43

Comencé a aprender lenguaje de programación con C ++ y luego Java y luego Python, por lo que esta pregunta también me molestó mucho, hasta que entendí el uso simple de cada uno.

Método de clase: Python, a diferencia de Java y C ++, no tiene sobrecarga del constructor. Y para lograr esto, podrías usar classmethod. El siguiente ejemplo explicará esto

Vamos a considerar que tenemos una Personclase que toma dos argumentos first_namey last_namey crea la instancia de Person.

class Person(object):

    def __init__(self, first_name, last_name):
        self.first_name = first_name
        self.last_name = last_name

Ahora, si el requisito viene donde necesita crear una clase usando un solo nombre, solo un first_name, no puede hacer algo así en Python.

Esto le dará un error cuando intente crear un objeto (instancia).

class Person(object):

    def __init__(self, first_name, last_name):
        self.first_name = first_name
        self.last_name = last_name

    def __init__(self, first_name):
        self.first_name = first_name

Sin embargo, podría lograr lo mismo usando @classmethodcomo se menciona a continuación

class Person(object):

    def __init__(self, first_name, last_name):
        self.first_name = first_name
        self.last_name = last_name

    @classmethod
    def get_person(cls, first_name):
        return cls(first_name, "")

Método estático: esto es bastante simple, no está vinculado a la instancia o clase y simplemente puede llamarlo usando el nombre de la clase.

Entonces, digamos en el ejemplo anterior que necesita una validación que first_nameno debe exceder los 20 caracteres, simplemente puede hacer esto.

@staticmethod  
def validate_name(name):
    return len(name) <= 20

y simplemente puedes llamar usando class name

Person.validate_name("Gaurang Shah")
Gaurang Shah
fuente
2
Es una publicación antigua, pero se usaría una forma más pitónica de lograr que el constructor acepte uno o dos argumentos en def __init__(self, first_name, last_name="")lugar del método de clase get_person. También el resultado será exactamente el mismo en este caso.
akarilimano
31

Creo que una mejor pregunta es "¿Cuándo usarías @classmethod vs @staticmethod?"

@classmethod le permite un fácil acceso a miembros privados que están asociados a la definición de clase. esta es una excelente manera de hacer singletons o clases de fábrica que controlan la cantidad de instancias de los objetos creados.

@staticmethod proporciona ganancias de rendimiento marginales, pero aún no he visto un uso productivo de un método estático dentro de una clase que no se pueda lograr como una función independiente fuera de la clase.

Nathan Tregillus
fuente
31

@decorators se agregaron en python 2.4 Si está usando python <2.4, puede usar las funciones classmethod () y staticmethod ().

Por ejemplo, si desea crear un método de fábrica (una función que devuelve una instancia de una implementación diferente de una clase según el argumento que obtenga) puede hacer algo como:

class Cluster(object):

    def _is_cluster_for(cls, name):
        """
        see if this class is the cluster with this name
        this is a classmethod
        """ 
        return cls.__name__ == name
    _is_cluster_for = classmethod(_is_cluster_for)

    #static method
    def getCluster(name):
        """
        static factory method, should be in Cluster class
        returns a cluster object for the given name
        """
        for cls in Cluster.__subclasses__():
            if cls._is_cluster_for(name):
                return cls()
    getCluster = staticmethod(getCluster)

Observe también que este es un buen ejemplo para usar un método de clase y un método estático. El método estático pertenece claramente a la clase, ya que utiliza el clúster de clase internamente. El método de clase solo necesita información sobre la clase y ninguna instancia del objeto.

Otro beneficio de hacer que el _is_cluster_formétodo sea un método de clase es que una subclase puede decidir cambiar su implementación, tal vez porque es bastante genérico y puede manejar más de un tipo de clúster, por lo que simplemente verificar el nombre de la clase no sería suficiente.

Jens Timmerman
fuente
28

Métodos Estáticos:

  • Funciones simples sin argumento propio.
  • Trabajar en atributos de clase; no en atributos de instancia.
  • Se puede llamar a través de la clase y la instancia.
  • La función incorporada staticmethod () se usa para crearlos.

Beneficios de los métodos estáticos:

  • Localiza el nombre de la función en el classscope
  • Mueve el código de función más cerca de donde se usa
  • Más conveniente para importar en comparación con funciones de nivel de módulo ya que cada método no tiene que importarse especialmente

    @staticmethod
    def some_static_method(*args, **kwds):
        pass

Métodos de clase:

  • Funciones que tienen primer argumento como nombre de clase.
  • Se puede llamar a través de la clase y la instancia.
  • Estos se crean con la función incorporada classmethod.

     @classmethod
     def some_class_method(cls, *args, **kwds):
         pass
Laxmi
fuente
22

@staticmethodsimplemente deshabilita la función predeterminada como descriptor de método. classmethod envuelve su función en un contenedor invocable que pasa una referencia a la clase propietaria como primer argumento:

>>> class C(object):
...  pass
... 
>>> def f():
...  pass
... 
>>> staticmethod(f).__get__(None, C)
<function f at 0x5c1cf0>
>>> classmethod(f).__get__(None, C)
<bound method type.f of <class '__main__.C'>>

De hecho, classmethodtiene una sobrecarga de tiempo de ejecución pero permite acceder a la clase propietaria. Alternativamente, recomiendo usar una metaclase y poner los métodos de clase en esa metaclase:

>>> class CMeta(type):
...  def foo(cls):
...   print cls
... 
>>> class C(object):
...  __metaclass__ = CMeta
... 
>>> C.foo()
<class '__main__.C'>
Armin Ronacher
fuente
1
Una posible desventaja de una metaclase para esto que se me ocurre de inmediato es que no se puede llamar al método de clase directamente en una instancia. c = C(); c.foo()plantea AttributeError, tendrías que hacer type(c).foo(). Esto también podría considerarse una característica, aunque no puedo pensar por qué querrías hacerlo.
Aaron Hall
20

La guía definitiva sobre cómo usar métodos estáticos, de clase o abstractos en Python es un buen enlace para este tema, y ​​resumirlo de la siguiente manera.

@staticmethodLa función no es más que una función definida dentro de una clase. Es invocable sin instanciar la clase primero. Su definición es inmutable a través de la herencia.

  • Python no tiene que crear una instancia de un método enlazado para el objeto.
  • Facilita la legibilidad del código y no depende del estado del objeto en sí;

@classmethodLa función también se puede llamar sin crear instancias de la clase, pero su definición sigue a la subclase, no a la clase padre, por herencia, puede ser anulada por subclase. Esto se debe a que el primer argumento para la @classmethodfunción siempre debe ser cls (clase).

  • Métodos de fábrica , que se utilizan para crear una instancia para una clase utilizando, por ejemplo, algún tipo de preprocesamiento.
  • Métodos estáticos que llaman a métodos estáticos : si divide un método estático en varios métodos estáticos, no debe codificar el nombre de la clase, sino usar métodos de clase
zangw
fuente
Gracias @zangw: la inmutabilidad heredada de la función estática es la diferencia clave que parece
hard_working_ant
18

Solo el primer argumento difiere :

  • método normal: el objeto actual si se pasa automáticamente como un primer argumento (adicional)
  • método de clase : la clase del objeto actual se pasa automáticamente como un argumento de puño (adicional)
  • método estático: no se pasan argumentos adicionales automáticamente. Lo que pasaste a la función es lo que obtienes.

Con más detalle...

método normal

Cuando se llama al método de un objeto, se le asigna automáticamente un argumento adicional selfcomo primer argumento. Es decir, método

def f(self, x, y)

debe llamarse con 2 argumentos. selfse pasa automáticamente y es el objeto mismo .

método de clase

Cuando el método está decorado

@classmethod
def f(cls, x, y)

el argumento proporcionado automáticamente no es self , sino la clase de self .

método estático

Cuando el método está decorado

@staticmethod
def f(x, y)

el método no recibe ningún argumento automático en absoluto. Solo se le dan los parámetros con los que se llama.

usos

  • classmethod se usa principalmente para constructores alternativos.
  • staticmethodno usa el estado del objeto. Podría ser una función externa a una clase. Solo se coloca dentro de la clase para agrupar funciones con una funcionalidad similar (por ejemplo, como los Mathmétodos estáticos de clase de Java )
class Point
    def __init__(self, x, y):
        self.x = x
        self.y = y

    @classmethod
    def frompolar(cls, radius, angle):
        """The `cls` argument is the `Point` class itself"""
        return cls(radius * cos(angle), radius * sin(angle))

    @staticmethod
    def angle(x, y):
        """this could be outside the class, but we put it here 
just because we think it is logically related to the class."""
        return atan(y, x)


p1 = Point(3, 2)
p2 = Point.frompolar(3, pi/4)

angle = Point.angle(3, 2)
nota azul
fuente
17

Permítanme decir la similitud entre un método decorado con @classmethod vs @staticmethod primero.

Similitud: Ambos se pueden invocar en la Clase en sí, en lugar de solo la instancia de la clase. Entonces, ambos en cierto sentido son los métodos de Class .

Diferencia: un método de clase recibirá la clase en sí como primer argumento, mientras que un método estático no.

Por lo tanto, un método estático, en cierto sentido, no está vinculado a la Clase en sí misma y simplemente está colgando allí solo porque puede tener una funcionalidad relacionada.

>>> class Klaus:
        @classmethod
        def classmthd(*args):
            return args

        @staticmethod
        def staticmthd(*args):
            return args

# 1. Call classmethod without any arg
>>> Klaus.classmthd()  
(__main__.Klaus,)  # the class gets passed as the first argument

# 2. Call classmethod with 1 arg
>>> Klaus.classmthd('chumma')
(__main__.Klaus, 'chumma')

# 3. Call staticmethod without any arg
>>> Klaus.staticmthd()  
()

# 4. Call staticmethod with 1 arg
>>> Klaus.staticmthd('chumma')
('chumma',)
Selva
fuente
11

Otra consideración con respecto al método estático vs método de clase surge con la herencia. Digamos que tienes la siguiente clase:

class Foo(object):
    @staticmethod
    def bar():
        return "In Foo"

Y luego desea anular bar()en una clase secundaria:

class Foo2(Foo):
    @staticmethod
    def bar():
        return "In Foo2"

Esto funciona, pero tenga en cuenta que ahora la bar()implementación en la clase secundaria ( Foo2) ya no puede aprovechar nada específico de esa clase. Por ejemplo, supongamos que Foo2tenía un método llamado magic()que desea utilizar en la Foo2implementación de bar():

class Foo2(Foo):
    @staticmethod
    def bar():
        return "In Foo2"
    @staticmethod
    def magic():
        return "Something useful you'd like to use in bar, but now can't" 

La solución en este caso sería llamar Foo2.magic()en bar(), pero luego te estás repitiendo (si el nombre de Foo2los cambios, tendrá que acordarse de actualizar ese bar()método).

Para mí, esto es una ligera violación del principio abierto / cerrado , ya que una decisión tomada Fooestá afectando su capacidad de refactorizar el código común en una clase derivada (es decir, es menos abierto a la extensión). Si bar()fuera un classmethodestaríamos bien:

class Foo(object):
    @classmethod
    def bar(cls):
        return "In Foo"

class Foo2(Foo):
    @classmethod
    def bar(cls):
        return "In Foo2 " + cls.magic()
    @classmethod
    def magic(cls):
        return "MAGIC"

print Foo2().bar()

Da: In Foo2 MAGIC

Adam Parkin
fuente
7

Trataré de explicar la diferencia básica usando un ejemplo.

class A(object):
    x = 0

    def say_hi(self):
        pass

    @staticmethod
    def say_hi_static():
        pass

    @classmethod
    def say_hi_class(cls):
        pass

    def run_self(self):
        self.x += 1
        print self.x # outputs 1
        self.say_hi()
        self.say_hi_static()
        self.say_hi_class()

    @staticmethod
    def run_static():
        print A.x  # outputs 0
        # A.say_hi() #  wrong
        A.say_hi_static()
        A.say_hi_class()

    @classmethod
    def run_class(cls):
        print cls.x # outputs 0
        # cls.say_hi() #  wrong
        cls.say_hi_static()
        cls.say_hi_class()

1 - podemos llamar directamente a métodos estáticos y de clase sin inicializar

# A.run_self() #  wrong
A.run_static()
A.run_class()

2- El método estático no puede llamar al método propio, pero puede llamar a otro método estático y de clase

3- El método estático pertenece a la clase y no usará ningún objeto.

4- El método de clase no está vinculado a un objeto sino a una clase.

Rizwan Mumtaz
fuente
anuncio 2: ¿Estás seguro? ¿Cómo podría el método estático llamar al método de clase? No tiene referencia a él (a su clase).
mirek
7

@classmethod: se puede usar para crear un acceso global compartido a todas las instancias creadas de esa clase ... como actualizar un registro por varios usuarios ... Particularmente, también encontré que es útil al crear singletons ...: )

Método @static: no tiene nada que ver con la clase o instancia asociada con ... pero para facilitar la lectura puede usar el método estático

vijay
fuente
5

Es posible que desee considerar la diferencia entre:

Class A:
    def foo():  # no self parameter, no decorator
        pass

y

Class B:
    @staticmethod
    def foo():  # no self parameter
        pass

Esto ha cambiado entre python2 y python3:

python2:

>>> A.foo()
TypeError
>>> A().foo()
TypeError
>>> B.foo()
>>> B().foo()

python3:

>>> A.foo()
>>> A().foo()
TypeError
>>> B.foo()
>>> B().foo()

Por lo tanto, el uso @staticmethodde métodos que solo se invocan directamente desde la clase se ha convertido en opcional en python3. Si desea llamarlos desde la clase y la instancia, aún necesita usar el @staticmethoddecorador.

Los otros casos han sido bien cubiertos por la respuesta de unutbus.

David Schumann
fuente
5

Un método de clase recibe la clase como primer argumento implícito, al igual que un método de instancia recibe la instancia. Es un método que está vinculado a la clase y no al objeto de la clase. Tiene acceso al estado de la clase ya que toma un parámetro de clase que apunta a la clase y no a la instancia del objeto. Puede modificar un estado de clase que se aplicaría en todas las instancias de la clase. Por ejemplo, puede modificar una variable de clase que será aplicable a todas las instancias.

Por otro lado, un método estático no recibe un primer argumento implícito, en comparación con los métodos de clase o los métodos de instancia. Y no puede acceder ni modificar el estado de la clase. Solo pertenece a la clase porque desde el punto de vista del diseño esa es la forma correcta. Pero en términos de funcionalidad no está vinculado, en tiempo de ejecución, a la clase.

como guía, use métodos estáticos como utilidades, use métodos de clase, por ejemplo, como fábrica. O tal vez para definir un singleton. Y use métodos de instancia para modelar el estado y el comportamiento de las instancias.

Espero haber sido claro!

Nicolae Petridean
fuente
4

Mi contribución demuestra la diferencia entre @classmethod, @staticmethody los métodos de instancia, incluida la forma en que una instancia puede llamar indirectamente a @staticmethod. Pero en lugar de llamar indirectamente a @staticmethoddesde una instancia, hacerlo privado puede ser más "pitónico". Obtener algo de un método privado no se demuestra aquí, pero es básicamente el mismo concepto.

#!python3

from os import system
system('cls')
# %   %   %   %   %   %   %   %   %   %   %   %   %   %   %   %   %   %   %   %

class DemoClass(object):
    # instance methods need a class instance and
    # can access the instance through 'self'
    def instance_method_1(self):
        return 'called from inside the instance_method_1()'

    def instance_method_2(self):
        # an instance outside the class indirectly calls the static_method
        return self.static_method() + ' via instance_method_2()'

    # class methods don't need a class instance, they can't access the
    # instance (self) but they have access to the class itself via 'cls'
    @classmethod
    def class_method(cls):
        return 'called from inside the class_method()'

    # static methods don't have access to 'cls' or 'self', they work like
    # regular functions but belong to the class' namespace
    @staticmethod
    def static_method():
        return 'called from inside the static_method()'
# %   %   %   %   %   %   %   %   %   %   %   %   %   %   %   %   %   %   %   %

# works even if the class hasn't been instantiated
print(DemoClass.class_method() + '\n')
''' called from inside the class_method() '''

# works even if the class hasn't been instantiated
print(DemoClass.static_method() + '\n')
''' called from inside the static_method() '''
# %   %   %   %   %   %   %   %   %   %   %   %   %   %   %   %   %   %   %   %

# >>>>> all methods types can be called on a class instance <<<<<
# instantiate the class
democlassObj = DemoClass()

# call instance_method_1()
print(democlassObj.instance_method_1() + '\n')
''' called from inside the instance_method_1() '''

# # indirectly call static_method through instance_method_2(), there's really no use
# for this since a @staticmethod can be called whether the class has been
# instantiated or not
print(democlassObj.instance_method_2() + '\n')
''' called from inside the static_method() via instance_method_2() '''

# call class_method()
print(democlassObj.class_method() + '\n')
'''  called from inside the class_method() '''

# call static_method()
print(democlassObj.static_method())
''' called from inside the static_method() '''

"""
# whether the class is instantiated or not, this doesn't work
print(DemoClass.instance_method_1() + '\n')
'''
TypeError: TypeError: unbound method instancemethod() must be called with
DemoClass instance as first argument (got nothing instead)
'''
"""
Michael Swartz
fuente
2

Los métodos de clase, como su nombre indica, se utilizan para realizar cambios en las clases y no en los objetos. Para realizar cambios en las clases, modificarán los atributos de la clase (no los atributos del objeto), ya que así es como se actualizan las clases. Esta es la razón por la cual los métodos de clase toman la clase (convencionalmente denotada por 'cls') como primer argumento.

class A(object):
    m=54

    @classmethod
    def class_method(cls):
        print "m is %d" % cls.m

Los métodos estáticos, por otro lado, se utilizan para realizar funcionalidades que no están vinculadas a la clase, es decir, no leerán ni escribirán variables de clase. Por lo tanto, los métodos estáticos no toman clases como argumentos. Se utilizan para que las clases puedan realizar funcionalidades que no están directamente relacionadas con el propósito de la clase.

class X(object):
    m=54 #will not be referenced

    @staticmethod
    def static_method():
        print "Referencing/calling a variable or function outside this class. E.g. Some global variable/function."
Tushar Vazirani
fuente
2

Analice @staticmethod literalmente proporcionando diferentes ideas.

Un método normal de una clase es un método dinámico implícito que toma la instancia como primer argumento.
Por el contrario, un método estático no toma la instancia como primer argumento, por lo que se llama 'estática' .

Un método estático es, de hecho, una función tan normal como las que están fuera de una definición de clase.
Afortunadamente, se agrupa en la clase solo para estar más cerca de donde se aplica, o puede desplazarse para encontrarlo.

Cálculo
fuente
2

Creo que dar una versión puramente de Python staticmethody classmethodayudaría a comprender la diferencia entre ellos a nivel de lenguaje.

Ambos son descriptores que no son de datos (sería más fácil entenderlos si está familiarizado con los descriptores primero).

class StaticMethod(object):
    "Emulate PyStaticMethod_Type() in Objects/funcobject.c"

    def __init__(self, f):
        self.f = f

    def __get__(self, obj, objtype=None):
        return self.f


class ClassMethod(object):
    "Emulate PyClassMethod_Type() in Objects/funcobject.c"
    def __init__(self, f):
        self.f = f

    def __get__(self, obj, cls=None):
        def inner(*args, **kwargs):
            if cls is None:
                cls = type(obj)
            return self.f(cls, *args, **kwargs)
        return inner
Jacky1205
fuente
1

El método estático no tiene acceso a atributos del objeto, de la clase o de las clases primarias en la jerarquía de herencia. Se puede invocar directamente en la clase (sin crear un objeto).

classmethod no tiene acceso a los atributos del objeto. Sin embargo, puede acceder a los atributos de la clase y de las clases primarias en la jerarquía de herencia. Se puede invocar directamente en la clase (sin crear un objeto). Si se llama al objeto, es el mismo método normal que no accede self.<attribute(s)>y self.__class__.<attribute(s)>solo accede .

Creemos que tenemos una clase b=2, crearemos un objeto y lo restableceremos b=4en él. El método estático no puede acceder a nada de lo anterior. Classmethod .b==2solo puede acceder a través de cls.b. El método normal puede acceder a ambos: .b==4vía self.by .b==2vía self.__class__.b.

Podríamos seguir el estilo KISS (manténgalo simple, estúpido): no use métodos estáticos y métodos de clase, no use clases sin instanciarlos, acceda solo a los atributos del objeto self.attribute(s). Hay idiomas en los que la OOP se implementa de esa manera y creo que no es mala idea. :)

mirek
fuente
Una cosa más importante para los métodos de clase: si modifica un atributo en el método de clase, todos los objetos existentes de esta clase que no establezcan explícitamente este atributo tendrán el valor modificado.
mirek
-4

Un rápido corte de métodos idénticos en iPython revela que @staticmethodproduce ganancias de rendimiento marginal (en nanosegundos), pero de lo contrario parece no tener ninguna función. Además, cualquier aumento de rendimiento probablemente será eliminado por el trabajo adicional de procesar el método staticmethod()durante la compilación (que ocurre antes de la ejecución de cualquier código cuando ejecuta un script).

En aras de la legibilidad del código, evitaría a @staticmethodmenos que su método se utilice para un montón de trabajo, donde los nanosegundos cuentan.

Cathal Garvey
fuente
77
"De lo contrario, parece no cumplir ninguna función": no es estrictamente cierto. Ver la discusión anterior.
Keith Pinson