协慌网

登录 贡献 社区

Python 中的静态方法?

是否有可能在 Python 中使用静态方法,因此我可以在不初始化类的情况下调用它们,例如:

ClassName.StaticMethod ( )

答案

是的,使用staticmethod装饰器

class MyClass(object):
    @staticmethod
    def the_static_method(x):
        print x

MyClass.the_static_method(2) # outputs 2

请注意,某些代码可能使用定义静态方法的旧方法,使用staticmethod作为函数而不是装饰器。只有在你必须支持古老版本的 Python(2.2 和 2.3)时才应该使用它

class MyClass(object):
    def the_static_method(x):
        print x
    the_static_method = staticmethod(the_static_method)

MyClass.the_static_method(2) # outputs 2

这与第一个示例(使用@staticmethod )完全相同,只是没有使用漂亮的装饰器语法

最后,谨慎使用staticmethod() !在 Python 中很少需要使用静态方法,并且我已经看到它们多次使用,其中单独的 “顶级” 函数会更清晰。


以下是文档中的逐字

静态方法不会接收隐式的第一个参数。要声明静态方法,请使用此惯用法:

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

@staticmethod 表单是一个函数装饰器 - 有关详细信息,请参阅函数定义中的函数定义说明。

它可以在类(例如Cf() )或实例(例如C().f() )上调用。除了类之外,该实例被忽略。

Python 中的静态方法与 Java 或 C ++ 中的静态方法类似。有关更高级的概念,请参阅classmethod()

有关静态方法的详细信息,请参阅标准类型层次结构中标准类型层次结构的文档。

2.2 版中的新功能。

在版本 2.4 中更改:添加了函数装饰器语法。

我认为史蒂文实际上是对的 。要回答原始问题,那么,为了设置一个类方法,只需假设第一个参数不是一个调用实例,然后确保只从类中调用该方法。

(注意,这个答案是指 Python 3.x. 在 Python 2.x 中,你会得到一个TypeError来调用类本身的方法。)

例如:

class Dog:
    count = 0 # this is a class variable
    dogs = [] # this is a class variable

    def __init__(self, name):
        self.name = name #self.name is an instance variable
        Dog.count += 1
        Dog.dogs.append(name)

    def bark(self, n): # this is an instance method
        print("{} says: {}".format(self.name, "woof! " * n))

    def rollCall(n): #this is implicitly a class method (see comments below)
        print("There are {} dogs.".format(Dog.count))
        if n >= len(Dog.dogs) or n < 0:
            print("They are:")
            for dog in Dog.dogs:
                print("  {}".format(dog))
        else:
            print("The dog indexed at {} is {}.".format(n, Dog.dogs[n]))

fido = Dog("Fido")
fido.bark(3)
Dog.rollCall(-1)
rex = Dog("Rex")
Dog.rollCall(0)

在此代码中,“rollCall” 方法假定第一个参数不是实例(如果它是由实例而不是类调用的话)。只要从类而不是实例调用 “rollCall”,代码就可以正常工作。如果我们尝试从一个实例调用 “rollCall”,例如:

rex.rollCall(-1)

但是,它会引发异常,因为它会发送两个参数:本身和 - 1,而 “rollCall” 只定义为接受一个参数。

顺便说一下,rex.rollCall()会发送正确数量的参数,但也会引发异常,因为当函数期望 n 为数字时,n 表示一个 Dog 实例(即 rex)。

这就是装饰的用武之地:如果我们在 “rollCall” 方法之前使用

@staticmethod

然后,通过明确声明该方法是静态的,我们甚至可以从实例中调用它。现在,

rex.rollCall(-1)

会工作。然后,在方法定义之前插入 @staticmethod 会阻止实例将自身作为参数发送。

您可以通过在注释掉 @staticmethod 行的情况下尝试以下代码来验证这一点。

class Dog:
    count = 0 # this is a class variable
    dogs = [] # this is a class variable

    def __init__(self, name):
        self.name = name #self.name is an instance variable
        Dog.count += 1
        Dog.dogs.append(name)

    def bark(self, n): # this is an instance method
        print("{} says: {}".format(self.name, "woof! " * n))

    @staticmethod
    def rollCall(n):
        print("There are {} dogs.".format(Dog.count))
        if n >= len(Dog.dogs) or n < 0:
            print("They are:")
            for dog in Dog.dogs:
                print("  {}".format(dog))
        else:
            print("The dog indexed at {} is {}.".format(n, Dog.dogs[n]))


fido = Dog("Fido")
fido.bark(3)
Dog.rollCall(-1)
rex = Dog("Rex")
Dog.rollCall(0)
rex.rollCall(-1)

是的,请查看staticmethod装饰器:

>>> class C:
...     @staticmethod
...     def hello():
...             print "Hello World"
...
>>> C.hello()
Hello World