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的错误:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
"""
-------------------------------------------------------------------------------
Function:
【整理】Python中:self和init__的含义与使用
Verison: 2017-10-10
-------------------------------------------------------------------------------
"""
#注:此处全局的变量名,写成name,只是为了演示而用
#实际上,好的编程风格,应该写成gName之类的名字,以表示该变量是Global的变量
name = "whole global name" ;
class Person:
def __init__( self , newPersonName):
#self.name = newPersonName;
#1.如果此处不写成self.name
#那么此处的name,只是__init__函数中的局部临时变量name而已
#和全局中的name,没有半毛钱关系
name = newPersonName;#此处的name,只是__init__函数中的局部临时变量name而已
#此处只是为了代码演示,而使用了局部变量name,
#不过需要注意的是,此处很明显,由于接下来的代码也没有利用到此处的局部变量name
#则会导致:此处的name变量,实际上被浪费了,根本没有被使用
def sayYourName( self ):
#此处由于找不到实例中的name变量,所以会报错:
#AttributeError: Person instance has no attribute 'name'
print 'My name is %s' % ( self .name);
def selfAndInitDemo():
personInstance = Person( "crifan" );
personInstance.sayYourName();
###############################################################################
if __name__ = = "__main__" :
selfAndInitDemo();
|
从上述代码可见,由于在类的初始化(实例化)的__init__函数中,没有给self.name设置值,使得实例中,根本没有name这个变量,导致后续再去访问self.name,就会出现AttributeError的错误。
对应的,如果写成self.name就正确了,就是初始化的时候,在实例中新增加并且设置了正确的值newPersionName,所以后续再去通过self.name,就可以访问到当前实例中正确的变量name了。
相应的正确写法的代码如下:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
"""
-------------------------------------------------------------------------------
Function:
【整理】Python中:self和init__的含义与使用
Verison: 2017-10-10
-------------------------------------------------------------------------------
"""
#注:此处全局的变量名,写成name,只是为了演示而用
#实际上,好的编程风格,应该写成gName之类的名字,以表示该变量是Global的变量
name = "whole global name" ;
class Person:
def __init__( self , newPersionName): #相当于java中的Person类的构造方法
#此处正确的,通过访问self.name的形式,实现了:
#1.给实例中,增加了name变量
#2.并且给name赋了初值,为newPersonName
self .name = newPersonName;
def sayYourName( self ):
#此处由于开始正确的初始化了self对象,使得其中有了name变量,所以此处可以正确访问了name值了,可以正确的输出了:
#My name is crifan
print 'My name is %s' % ( self .name);
def selfAndInitDemo():
personInstance = Person( "crifan" );
personInstance.sayYourName();
###############################################################################
if __name__ = = "__main__" :
selfAndInitDemo();
|
有时候,虽然写的代码,可以运行,但是使用到的变量,由于没有加self,实际上用到的不是实例变量,而是其他的变量。此类问题,主要和Python中的变量的作用域有关,但在下面例子中,也和是否使用self有关:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
"""
-------------------------------------------------------------------------------
Function:
【整理】Python中:self和init__的含义与使用
Verison: 2017-10-10
-------------------------------------------------------------------------------
"""
#注:此处全局的变量名,写成name,只是为了演示而用
#实际上,好的编程风格,应该写成gName之类的名字,以表示该变量是Global的变量
name = "whole global name" ;
class Person:
name = "class global name"
def __init__( self , newPersonName):
#self.name = newPersonName;
#此处,没有使用self.name
#而使得此处的name,实际上仍是局部变量name
#虽然此处赋值了,但是后面没有被利用到,属于被浪费了的局部变量name
name = newPersonName;
def sayYourName( 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
def selfAndInitDemo():
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"。
关于Python中变量的作用域的详细解释,可参考:
【整理】Python中变量的作用域(variable scope)
刚开始学习Python的类写法的时候觉得很是麻烦,为什么定义时需要而调用时又不需要,为什么不能内部简化从而减少我们敲击键盘的次数?有疑惑,返过来再深入地去学习,才会有收获。
self代表类的实例,而非类。
实例来说明
1
2
3
4
5
6
7
|
class Test:
def prt(self):
print(self)
print(self.__class__)
t = Test()
t.prt()
|
执行结果如下
1
2
|
<__main__.Testobjectat0x000000000284E080>
<class'__main__.Test'>
|
从上面的例子中可以很明显的看出,self代表的是类的实例。而self.class则指向类。
self不必非写成self
有很多童鞋是先学习别的语言然后学习Python的,所以总觉得self怪怪的,想写成this,可以吗?
当然可以,还是把上面的代码改写一下。
1
2
3
4
5
6
7
|
class Test:
def prt(this):
print(this)
print(this.__class__)
t = Test()
t.prt()
|
改成this后,运行结果完全一样。
当然,最好还是尊重约定俗成的习惯,使用self。
self可以不写吗
在Python的解释器内部,当我们调用t.prt()时,实际上Python解释成Test.prt(t),也就是说把self替换成类的实例。
有兴趣的童鞋可以把上面的t.prt()一行改写一下,运行后的实际结果完全相同。
实际上已经部分说明了self在定义时不可以省略,如果非要试一下,那么请看下面:
1
2
3
4
5
6
|
classTest:
defprt():
print(self)
t=Test()
t.prt()
|
运行时提醒错误如下:prt在定义时没有参数,但是我们运行时强行传了一个参数。
由于上面解释过了t.prt()等同于Test.prt(t),所以程序提醒我们多传了一个参数t。
1
2
3
4
|
Traceback (most recent call last):
File "h.py", line 6, in <module>
t.prt()
TypeError: prt() takes 0 positional arguments but 1 was given
|
当然,如果我们的定义和调用时均不传类实例是可以的,这就是类方法。
1
2
3
4
|
classTest:
defprt():
print(__class__)
Test.prt()
|
运行结果如下
1
|
<class '__main__.Test'>
|
在继承时,传入的是哪个实例,就是那个传入的实例,而不是指定义了self的类的实例。
先看代码
1
2
3
4
5
6
7
8
9
10
11
12
|
classParent:
defpprt(self):
print(self)
classChild(Parent):
defcprt(self):
print(self)
c=Child()
c.cprt()
c.pprt()
p=Parent()
p.pprt()
|
运行结果如下
1
2
3
|
<__main__.Child object at 0x0000000002A47080>
<__main__.Child object at 0x0000000002A47080>
<__main__.Parent object at 0x0000000002A47240>
|
解释:
运行c.cprt()时应该没有理解问题,指的是Child类的实例。
但是在运行c.pprt()时,等同于Child.pprt(c),所以self指的依然是Child类的实例,由于self中没有定义pprt()方法,所以沿着继承树往上找,发现在父类Parent中定义了pprt()方法,所以就会成功调用。
在描述符类中,self指的是描述符类的实例
不太容易理解,先看实例:
1
2
3
4
5
6
7
8
9
10
11
|
classDesc:
def__get__(self,ins,cls):
print('self in Desc: %s '%self)
print(self,ins,cls)
classTest:
x=Desc()
defprt(self):
print('self in Test: %s'%self)
t=Test()
t.prt()
t.x
|
运行结果如下:
1
2
3
|
self in Test: <__main__.Test object at 0x0000000002A570B8>
self in Desc: <__main__.Desc object at 0x000000000283E208>
<__main__.Desc object at 0x000000000283E208> <__main__.Test object at 0x0000000002A570B8> <class '__main__.Test'>
|
大部分童鞋开始有疑问了,为什么在Desc类中定义的self不是应该是调用它的实例t吗?怎么变成了Desc类的实例了呢?
注意:此处需要睁大眼睛看清楚了,这里调用的是t.x,也就是说是Test类的实例t的属性x,由于实例t中并没有定义属性x,所以找到了类属性x,而该属性是描述符属性,为Desc类的实例而已,所以此处并没有顶用Test的任何方法。
那么我们如果直接通过类来调用属性x也可以得到相同的结果。
下面是把t.x改为Test.x运行的结果。
1
2
3
|
selfinTest:<__main__.Testobjectat0x00000000022570B8>
selfinDesc:<__main__.Descobjectat0x000000000223E208>
<__main__.Descobjectat0x000000000223E208>None<class'__main__.Test'>
|
题外话:由于在很多时候描述符类中仍然需要知道调用该描述符的实例是谁,所以在描述符类中存在第二个参数ins,用来表示调用它的类实例,所以t.x时可以看到第三行中的运行结果中第二项为<main.Test object at 0x0000000002A570B8>。而采用Test.x进行调用时,由于没有实例,所以返回None。
总结
- self在定义时需要定义,但是在调用时会自动传入。
- self的名字并不是规定死的,但是最好还是按照约定是用self
- self总是指调用时的类的实例。
Python中的__init__
Python中,常会看到,在很多类中,都有一个__init__函数。该函数有什么作用,又该如何使用呢?下面就来解释一下,__init__的含义。
Python中__init__的含义
首先来看init单词本身,其含义是初始化。而__init__的含义,也如同其单词本意一样,用来初始化。
但是给谁初始化呢?很明显,是给对应的类Class本身初始化。
Python中为何要有__init__
我的理解是,__init__的出现,主要有两方面的作用:
①支持带参数的类的初始化
这个用法,感觉就像,其他语言中的,对于Class初始化时,可以运行传递不同的参数一样(如java中,在构造方法中,通过参数的传递进行初始化);
用代码演示如下:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
"""
-------------------------------------------------------------------------------
Function:
【整理】Python中:self和init__的含义与使用
Verison: 2017-10-10
-------------------------------------------------------------------------------
"""
class
Person:
def
__init__(
self
, newPersonName):
#在开始初始化新的类Class的示例Instance的时候,给对应的,不同的Instance,设置不同的人名(Person name)
self
.name
=
newPersonName;
def
sayYourName(
self
):
#不同的Person的示例,调用同样的方法的时候,说出自己的名字,结果都是对应着自己的,各自不同的名字
print
'My name is %s'
%
(
self
.name);
#My name is crifan
def
initDemo():
persionInstance
=
Person(
"crifan"
);
persionInstance.sayYourName();
###############################################################################
if
__name__
=
=
"__main__"
:
initDemo();
|
其中,针对Person这个类,不同的示例,在初始化的时候,传递一个对应的参数,这样不同的Person,就都有了自己的不同的名字了。这看起来,有点类似于其他语言中,通过传递特定参数去对类进行初始化。
②实现类本身相关内容的初始化
当一个Class,稍微复杂一点的时候,或者内部函数需要用得到的时候,往往都需要在,别人实例化这个类之前,做一些基本的,与自己的类有关的初始化方面的工作。而这部分工作,往往就放到__init__函数中去完成。
从上面的演示代码就可以看出__init__的作用了:不同的人,应该有不同的名字,而给不同的人设置不同的名字,也是需要在调用sayYourName之前,就先初始化好的。
首先明确的是self只有在类的方法中才会有,独立的函数或方法是不必带有self的。self在定义类的方法时是必须有的,虽然在调用时不必传入相应的参数。
self名称不是必须的,在python中self不是关键词,你可以定义成a或b或其它名字都可以,但是约定成俗,不要搞另类,大家会不明白的。下例中将self改为myname一样没有错误:
1 class Person:
2 def __init__(myname,name):
3 myname.name=name
4 def sayhello(myname):
5 print 'My name is:',myname.name
6 p=Person('Bill')
7 print p
self指的是类实例对象本身(注意:不是类本身)。
1 class Person:
2 def __init__(self,name):
3 self.name=name
4 def sayhello(self):
5 print 'My name is:',self.name
6 p=Person('Bill')
7 print p
在上述例子中,
self
指向Person的实例p。 为什么不是指向类本身呢,如下例子:
1 class Person:
2 def __init__(self,name):
3 self.name=name
4 def sayhello(self):
5 print 'My name is:',self.name
6 p=Person('Bill')
7 p1 = Person('Apple')
8 print p
如果self指向类本身,那么当有多个实例对象时,self指向哪一个呢?所以,self代表的是具体的实例化对象,这样当有多个实例化对象时才不至于混淆不知道调用的是哪一个实例的方法或属性。