类(5)

在前面几节讨论类的时候，经常要将类实例化，然后通过实例来调用类的方法（函数）。在此，把前面经常做的这类事情概括一下：

  • 方法是类内部定义函数，只不过这个函数的第一个参数是 self。（可以认为方法是类属性，但不是实例属性）
  • 必须将类实例化之后，才能通过实例调用该类的方法。调用的时候在方法后面要跟括号（括号中默认有 self 参数，但是不写出来。）

通过实例调用方法（在前面曾用了一个不严谨的词语：实例方法），我们称这个方法绑定在实例上。

调用绑定方法

前面一直在这样做。比如：

  1. class Person(object):
  2.     def foo(self):
  3.         pass

如果要调用 Person.foo() 方法，必须：

  1. pp = Person()    #实例化
  2. pp.foo()

这样就实现了方法和实例的绑定，于是通过 pp.foo() 即可调用该方法。

调用非绑定方法

在《类(4)》中，介绍了一个函数 super。为了描述方便，把代码复制过来：

  1. #!/usr/bin/env python
  2. # coding=utf-8
  4. __metaclass__ = type
  6. class Person:
  7.     def __init__(self):
  8.         self.height = 160
  10.     def about(self, name):
  11.         print "{} is about {}".format(name, self.height)
  13. class Girl(Person):
  14.     def __init__(self):
  15.         super(Girl, self).__init__()
  16.         self.breast = 90
  18.     def about(self, name):
  19.         print "{} is a hot girl, she is about {}, and her breast is {}".format(name, self.height, self.breast)
  20.         super(Girl, self).about(name)
  22. if __name__ == "__main__":
  23.     cang = Girl()
  24.     cang.about("wangguniang")

在子类 Girl 中，因为重写了父类的__init__方法，如果要调用父类该方法，在上节中不得不使用 super(Girl, self).__init__()调用父类中因为子类方法重写而被遮蔽的同名方法。

其实，在子类中，父类的方法就是非绑定方法，因为在子类中，没有建立父类的实例，却要是用父类的方法。对于这种非绑定方法的调用，还有一种方式。不过这种方式现在已经较少是用了，因为有了 super 函数。为了方便读者看其它有关代码，还是要简要说明。

例如在上面代码中，在类 Girl 中想调用父类 Person 的初始化函数，则需要在子类中，写上这么一行：

  1. Person.__init__(self)

这不是通过实例调用的，而是通过类 Person 实现了对__init__(self)的调用。这就是调用非绑定方法的用途。但是，这种方法已经被 super 函数取代，所以，如果读者在编程中遇到类似情况，推荐使用 super 函数。

静态方法和类方法

已知，类的方法第一个参数必须是 self，并且如果要调用类的方法，必须将通过类的实例，即方法绑定实例后才能由实例调用。如果不绑定，一般在继承关系的类之间，可以用 super 函数等方法调用。

这里再介绍一种方法，这种方法的调用方式跟上述的都不同，这就是：静态方法和类方法。看代码：

  1. #!/usr/bin/env Python
  2. # coding=utf-8
  4. __metaclass__ = type
  6. class StaticMethod:
  7.     @staticmethod
  8.     def foo():
  9.         print "This is static method foo()."
  11. class ClassMethod:
  12.     @classmethod
  13.     def bar(cls):
  14.         print "This is class method bar()."
  15.         print "bar() is part of class:", cls.__name__
  17. if __name__ == "__main__":
  18.     static_foo = StaticMethod()    #实例化
  19.     static_foo.foo()               #实例调用静态方法
  20.     StaticMethod.foo()             #通过类来调用静态方法
  21.     print "********"
  22.     class_bar = ClassMethod()
  23.     class_bar.bar()
  24.     ClassMethod.bar()

对于这部分代码，有一处非常特别，那就是包含了“@”符号。在 Python 中：

  • @staticmethod表示下面的方法是静态方法
  • @classmethod表示下面的方法是类方法

一个一个来看。

先看静态方法，虽然名为静态方法，但也是方法，所以，依然用 def 语句来定义。需要注意的是文件名后面的括号内，没有 self，这和前面定义的类中的方法是不同的，也正是因着这个不同，才给它另外取了一个名字叫做静态方法，否则不就“泯然众人矣”。如果没有 self，那么也就无法访问实例变量、类和实例的属性了，因为它们都是借助 self 来传递数据的。

在看类方法，同样也具有一般方法的特点，区别也在参数上。类方法的参数也没有 self，但是必须有 cls 这个参数。在类方法中，能够方法类属性，但是不能访问实例属性（读者可以自行设计代码检验之）。

简要明确两种方法。下面看调用方法。两种方法都可以通过实例调用，即绑定实例。也可以通过类来调用，即 StaticMethod.foo() 这样的形式，这也是区别一般方法的地方，一般方法必须用通过绑定实例调用。

上述代码运行结果：

  1. $ python 21001.py 
  2. This is static method foo().
  3. This is static method foo().
  4. ********
  5. This is class method bar().
  6. bar() is part of class: ClassMethod
  7. This is class method bar().
  8. bar() is part of class: ClassMethod

这是关于静态方法和类方法的简要介绍。

正当我思考如何讲解的更深入一点的时候，我想起了以往看过的一篇文章，觉得人家讲的非常到位。所以，不敢吝啬，更不敢班门弄斧，所以干醋把那篇文章恭恭敬敬的抄录于此。同时，读者从下面的文章中，也能对前面的知识复习一下。文章标题是：Python 中的 staticmethod 和 classmethod 的差异。原载：www.pythoncentral.io/difference-between-staticmethod-and-classmethod-in-Python/。此地址需要你准备梯子才能浏览。后经国人翻译，地址是：http://www.wklken.me/posts/2013/12/22/difference-between-staticmethod-and-classmethod-in-Python.html

以下是翻译文章：

Class vs static methods in Python

这篇文章试图解释：什么事 staticmethod/classmethod,并且这两者之间的差异.

staticmethod 和 classmethod 均被作为装饰器，用作定义一个函数为"staticmethod"还是"classmethod"

如果想要了解 Python 装饰器的基础，可以看这篇文章

Simple, static and class methods

类中最常用到的方法是 实例方法(instance methods), 即，实例对象作为第一个参数传递给函数

例如，下面是一个基本的实例方法

  1. class Kls(object):
  2.     def __init__(self, data):
  3.         self.data = data
  5.     def printd(self):
  6.         print(self.data)
  8. ik1 = Kls('arun')
  9. ik2 = Kls('seema')
  11. ik1.printd()
  12. ik2.printd()

得到的输出:

  1. arun
  2. seema

调用关系图:

类(5) - 图1

查看代码和图解:

1/2 参数传递给函数

3 self 参数指向实例本身

4 我们不需要显式提供实例，解释器本身会处理

假如我们想仅实现类之间交互而不是通过实例？我们可以在类之外建立一个简单的函数来实现这个功能，但是将会使代码扩散到类之外，这个可能对未来代码维护带来问题。

例如：

  1. def get_no_of_instances(cls_obj):
  2.     return cls_obj.no_inst
  4. class Kls(object):
  5.     no_inst = 0
  7.     def __init__(self):
  8.         Kls.no_inst = Kls.no_inst + 1
  10. ik1 = Kls()
  11. ik2 = Kls()
  13. print(get_no_of_instances(Kls))

结果：

  1. 2

The Python @classmethod

现在我们要做的是在类里创建一个函数，这个函数参数是类对象而不是实例对象.

在上面那个实现中，如果要实现不获取实例,需要修改如下:

  1. def iget_no_of_instance(ins_obj):
  2.     return ins_obj.__class__.no_inst
  4. class Kls(object):
  5.     no_inst = 0
  7.     def __init__(self):
  8.         Kls.no_inst = Kls.no_inst + 1
  10. ik1 = Kls()
  11. ik2 = Kls()
  12. print iget_no_of_instance(ik1)

结果

  1. 2

可以使用 Python2.2 引入的新特性，使用 @classmethod 在类代码中创建一个函数

  1. class Kls(object):
  2.     no_inst = 0
  4.     def __init__(self):
  5.         Kls.no_inst = Kls.no_inst + 1
  7.     @classmethod
  8.     def get_no_of_instance(cls_obj):
  9.         return cls_obj.no_inst
  11. ik1 = Kls()
  12. ik2 = Kls()
  14. print ik1.get_no_of_instance()
  15. print Kls.get_no_of_instance()

We get the following output:

  1. 2
  2. 2

The Python @staticmethod

通常，有很多情况下一些函数与类相关，但不需要任何类或实例变量就可以实现一些功能.

比如设置环境变量，修改另一个类的属性等等.这种情况下，我们也可以使用一个函数，一样会将代码扩散到类之外（难以维护）

下面是一个例子:

  1. IND = 'ON'
  3. def checkind():
  4.     return (IND == 'ON')
  6. class Kls(object):
  7.     def __init__(self,data):
  8.         self.data = data
  10.     def do_reset(self):
  11.         if checkind():
  12.             print('Reset done for:', self.data)
  14.     def set_db(self):
  15.         if checkind():
  16.             self.db = 'new db connection'
  17.             print('DB connection made for:',self.data)
  19. ik1 = Kls(12)
  20. ik1.do_reset()
  21. ik1.set_db()

结果:

  1. Reset done for: 12
  2. DB connection made for: 12

现在我们使用 @staticmethod, 我们可以将所有代码放到类中

  1. IND = 'ON'
  3. class Kls(object):
  4.     def __init__(self, data):
  5.         self.data = data
  7.     @staticmethod
  8.     def checkind():
  9.         return (IND == 'ON')
  11.     def do_reset(self):
  12.         if self.checkind():
  13.             print('Reset done for:', self.data)
  15.     def set_db(self):
  16.         if self.checkind():
  17.             self.db = 'New db connection'
  18.         print('DB connection made for: ', self.data)
  20. ik1 = Kls(12)
  21. ik1.do_reset()
  22. ik1.set_db()

得到的结果:

  1. Reset done for: 12
  2. DB connection made for: 12

How @staticmethod and @classmethod are different

  1. class Kls(object):
  2.     def __init__(self, data):
  3.         self.data = data
  5.     def printd(self):
  6.         print(self.data)
  8.     @staticmethod
  9.     def smethod(*arg):
  10.         print('Static:', arg)
  12.     @classmethod
  13.     def cmethod(*arg):
  14.         print('Class:', arg)

调用

  1. >>> ik = Kls(23)
  2. >>> ik.printd()
  3. 23
  4. >>> ik.smethod()
  5. Static: ()
  6. >>> ik.cmethod()
  7. Class: (<class '__main__.Kls'>,)
  8. >>> Kls.printd()
  9. TypeError: unbound method printd() must be called with Kls instance as first argument (got nothing instead)
  10. >>> Kls.smethod()
  11. Static: ()
  12. >>> Kls.cmethod()
  13. Class: (<class '__main__.Kls'>,)

图解

类(5) - 图2

文档字符串

在写程序的时候，必须要写必要的文字说明，没别的原因，除非你的代码写的非常容易理解，特别是各种变量、函数和类等的命名任何人都能够很容易理解，否则，文字说明是不可缺少的。

在函数、类或者文件开头的部分写文档字符串说明，一般采用三重引号。这样写的最大好处是能够用 help() 函数看。

  1. """This is python lesson"""
  3. def start_func(arg):
  4.     """This is a function."""
  5.     pass
  7. class MyClass:
  8.     """Thi is my class."""
  9.     def my_method(self,arg):
  10.         """This is my method."""
  11.         pass

这样的文档是必须的。

当然，在编程中，有不少地方要用“#”符号来做注释。一般用这个来注释局部。

总目录

如果你认为有必要打赏我，请通过支付宝：qiwsir@126.com,不胜感激。