Python中的self

 

在Python中的类Class的代码中，常看到函数中的第一个参数，都是self；同时Class中的函数里面，访问对应的变量（读取或者写入），以及调用对应的函数时，都是self.valueName，self.function()的形式。不适用类Class直接编写函数时倒没有主意，一旦编写类，调用其中的函数是老是出现参数或多或少的情况，这时候才回过头来深入看了看self的含义和具体的使用。

Python中self的含义

self，英文单词意思很明显，表示自己，本身。此处有几种潜在含义：1.这里的自己，指的是，实例Instance本身。2.同时， 由于说到“自己”这个词，都是和相对的“其他”而说的。此处的其他，指的是，类Class，和其他变量，比如局部变量，全局变量等。此处的self，是个对象，Object。是当前类的实例。因此，对应的self.valueName，self.function()中的valueName和function()具体含义如下：valueName：表示self对象，即实例的变量。与其他的，Class的变量，全局的变量，局部的变量，是相对应的。function：表示是调用的是self对象，即实例的函数。与其他的全局的函数，是相对应的。

Python中为何要有self

在类的代码（函数）中，需要访问当前的实例中的变量和函数的，即，访问Instance中的：

  • 对应的变量（property)：Instance.ProperyNam，去读取之前的值和写入新的值；
  • 调用对应函数（function）：Instance.function()，即执行对应的动作。

在需要访问实例的变量和调用实例的函数，当然需要对应的实例Instance对象本身去完成调用了。

在Python类中规定，函数的第一个参数是实例对象本身，并且约定俗成，把其名字写为self。其左右相当于java中的this，表示当前类的对象，可以调用当前类中的属性和方法。

而如果没有用到self，即代码中，去掉self后，那种写法所使用到的变量，实际上不是你所希望的，不是真正的实例中的变量和函数，而是访问到了其他部分的变量和函数了。甚至会由于没有合适的初始化实例变量，而导致后续无法访问的错误。

下面，通过代码来演示，如果去掉self，或者没有合理的使用self，会出现哪些错误。

如果没有在__init__中初始化对应的实例变量的话，导致后续引用实例变量会出错

如下代码，完整的演示了，如果没有在类Class的最初的__init__函数中，正确的初始化实例变量，则会导致后续没有变量可用，因而出现AttributeError的错误：

#!/usr/bin/python

# -*- coding: utf-8 -*-

"""

-------------------------------------------------------------------------------

Function:

【整理】Python中：self和init__的含义与使用

  

Verison:    2017-10-10

-------------------------------------------------------------------------------

"""

  

#注：此处全局的变量名，写成name，只是为了演示而用

#实际上，好的编程风格，应该写成gName之类的名字，以表示该变量是Global的变量

name ="whole global name";

  

classPerson:

    def__init__(self, newPersonName):

        #self.name = newPersonName;

          

        #1.如果此处不写成self.name

        #那么此处的name，只是__init__函数中的局部临时变量name而已

        #和全局中的name，没有半毛钱关系

        name =newPersonName;#此处的name，只是__init__函数中的局部临时变量name而已

          

        #此处只是为了代码演示，而使用了局部变量name，

        #不过需要注意的是，此处很明显，由于接下来的代码也没有利用到此处的局部变量name

        #则会导致：此处的name变量，实际上被浪费了，根本没有被使用

  

    defsayYourName(self):

        #此处由于找不到实例中的name变量，所以会报错：

        #AttributeError: Person instance has no attribute 'name'

        print'My name is %s'%(self.name);

  

defselfAndInitDemo():

    personInstance =Person("crifan");

    personInstance.sayYourName();

      

###############################################################################

if__name__=="__main__":

    selfAndInitDemo();

从上述代码可见，由于在类的初始化（实例化）的__init__函数中，没有给self.name设置值，使得实例中，根本没有name这个变量，导致后续再去访问self.name，就会出现AttributeError的错误。

对应的，如果写成self.name就正确了，就是初始化的时候，在实例中新增加并且设置了正确的值newPersionName，所以后续再去通过self.name，就可以访问到当前实例中正确的变量name了。

相应的正确写法的代码如下：

#!/usr/bin/python

# -*- coding: utf-8 -*-

"""

-------------------------------------------------------------------------------


Function:

【整理】Python中：self和init__的含义与使用

  

Verison:    2017-10-10


-------------------------------------------------------------------------------

"""

  

#注：此处全局的变量名，写成name，只是为了演示而用

#实际上，好的编程风格，应该写成gName之类的名字，以表示该变量是Global的变量

name ="whole global name";

  

classPerson:

    def__init__(self, newPersionName): #相当于java中的Person类的构造方法

        #此处正确的，通过访问self.name的形式，实现了：

        #1.给实例中，增加了name变量

        #2.并且给name赋了初值，为newPersonName

        self.name =newPersonName;

  

    defsayYourName(self):

        #此处由于开始正确的初始化了self对象，使得其中有了name变量，所以此处可以正确访问了name值了，可以正确的输出了：

        #My name is crifan

        print'My name is %s'%(self.name);

  

defselfAndInitDemo():

    personInstance =Person("crifan");

    personInstance.sayYourName();

      

###############################################################################

if__name__=="__main__":

    selfAndInitDemo();

有时候，虽然写的代码，可以运行，但是使用到的变量，由于没有加self，实际上用到的不是实例变量，而是其他的变量。此类问题，主要和Python中的变量的作用域有关，但在下面例子中，也和是否使用self有关：

#!/usr/bin/python

# -*- coding: utf-8 -*-

"""

-------------------------------------------------------------------------------


Function:

【整理】Python中：self和init__的含义与使用

  

Verison:    2017-10-10


-------------------------------------------------------------------------------

"""

  

#注：此处全局的变量名，写成name，只是为了演示而用

#实际上，好的编程风格，应该写成gName之类的名字，以表示该变量是Global的变量

name ="whole global name";

  

classPerson:

    name ="class global name"

  

    def__init__(self, newPersonName):

        #self.name = newPersonName;

          

        #此处，没有使用self.name

        #而使得此处的name，实际上仍是局部变量name

        #虽然此处赋值了，但是后面没有被利用到，属于被浪费了的局部变量name

        name =newPersonName;

  

    defsayYourName(self):

        #此处，之所以没有像之前一样出现：

        #AttributeError: Person instance has no attribute 'name'

        #那是因为，虽然当前的实例self中，没有在__init__中初始化对应的name变量，实例self中没有对应的name变量

        #但是由于实例所对应的类Person，有对应的name变量,所以也是可以正常执行代码的

        #对应的，此处的self.name，实际上是Person.name

        print'My name is %s'%(self.name); # -> class global name

        print'name within class Person is actually the global name: %s'%(name); #-> whole global name

        print"only access Person's name via Person.name=%s"%(Person.name); # -> class global name

  

defselfAndInitDemo():

    personInstance =Person("crifan");

    personInstance.sayYourName();

    print"whole global name is %s"%(name); # -> whole global name

      

###############################################################################

if__name__=="__main__":

    selfAndInitDemo();

可见，此处__init__中，没有给self实例初始化对应的name，而在后面的函数sayYourName中，虽然可以调用到self.name但并没有出现AttributeError错误。然而，实际上此处的值，不是所期望传入的name，即"crifan"，而是类中的name的值，即"class global name"。

 

总结

  • self在定义时需要定义，但是在调用时会自动传入。
  • self的名字并不是规定死的，但是最好还是按照约定是用self
  • self总是指调用时的类的实例。