在python中有些方法名比较特别,在名称的前后各有两个下划线,这样的方法往往具有特殊的意义,一般情况下我们不会直接用到所以称之为“隐藏方法”也有一些人称之为“魔法方法”。下面划分这些隐藏方法,分类解析。

模块属性

  1. __ name__
    当python文件被直接运行时,__ name__的值为__main__,而当python文件以模块的形式被导入时,__name__的值为模块名
  2. __ file__
    在python模块中使用__file__来获取脚本所在的路径,但得到的是相对路径,若希望得到绝对路径可使用
os.path.realpath(__file__)
  1. __ all__
    __all__指定的是当包被import * 的时候, 哪些模块会被import进来(不建议使用import *的方式)
    eg.
#test1.py
import os, sys
__all__ = [os]

#test2.py
from test1 import *
sys.path
  1. __ path__
    __ path__用于指定包的搜索路径,默认情况下只有一个元素, 就是当前包的路径, 修改__ path__, 可以修改此包内的搜索路径,修改该属性类似于修改sys.path
  2. __ module__
    __ module__ 表示当前操作的对象在属于哪个模块

类和实例属性

  1. __ doc__
    说明性文档和信息,Python自建,无需自定义。
""" 描述类信息,可被自动收集 """

def func(self):
    pass

# 打印类的说明文档 
print(Foo.__doc__)
  1. __ class__
    __ class__属于实例的属性,直接指向该实例的类对象
class A(object):
	pass

a = A()
a.__class__等同于A
  1. __ dict__
    对象的属性字典,key为属性名,value为该属性的值
    注:__ dict__若被实例对象引用则列出实例对象的属性,若被类引用则列出类属性
    eg.
class A():  
    def __init__(self):  
        self.x=1   #定义一个实例属性  
    y = 2          #定义一个类属性  


a = A()
a.__dict__
{'x': 1}
A.__dict__
{'__doc__': None,
 '__init__': function __main__.__init__
 '__module__': '__main__',
 'y': 2}
  1. __ init__and __ new__
    继承自object的新式类拥有__ new__隐藏方法
    __ new__在实例被创建时调用,__ init__在实例创建后的初始化时调用,所以先调用__ new__,然后调用__ init__
class A(object):    
    def __init__(self):
        print init
    def __new__(cls,*args, **kwargs):
        print new %s%cls
        return object.__new__(cls, *args, **kwargs)
 
A()

# 输出
new class '__main__.A'
init

__ new__方法返回一个实例对象
5. __ slots__
Python作为一种动态语言,可以在类定义完成和实例化后,给类或者对象继续添加随意个数或者任意类型的变量或方法,这是动态语言的特性。例如:

def print_doc(self):
    print("haha")
    
class Foo:
    pass

obj1 = Foo()
obj2 = Foo()
# 动态添加实例变量
obj1.name = "jack"
obj2.age = 18
# 动态的给类添加实例方法
Foo.show = print_doc
obj1.show()
obj2.show()

果我想限制实例可以添加的变量怎么办?可以使用__ slots__
__ slots__限制类中只能定义某些属性
例如:

print("haha")

class Foo:
    __slots__ = ("name", "age")
    pass


obj1 = Foo()
obj2 = Foo()
# 动态添加实例变量
obj1.name = "jack"
obj2.age = 18
obj1.sex = "male"       # 这一句会弹出错误
# 但是无法限制给类添加方法
Foo.show = print_doc
obj1.show()
obj2.show()

由于’sex’不在__ slots__的列表中,所以不能绑定sex属性,试图绑定sex将得到AttributeError的错误
obj1.sex = “male”, AttributeError: ‘Foo’ object has no attribute ‘sex’
注意: __ slots__定义的属性仅对当前类的实例起作用,对继承了它的子类是不起作用的,如果子类也被限制,可以在子类中也定义__ slots__

  1. __ del__
    析构方法,当对象在内存中被释放时,自动触发此方法。
    此方法一般无须自定义,因为Python自带内存分配和释放机制,除非你需要在释放的时候指定做一些动作。析构函数的调用是由解释器在进行垃圾回收时自动触发执行的。
  2. __ call__
    如果一个类编写了该方法,那么在该类的实例后面加括号,可会调用这个方法。
    注:构造方法的执行是由类加括号执行的,即:对象 = 类名(),而对于__call__() 方法,是由对象后加括号触发的,即:对象() 或者 类()()
    eg.
class Foo:

    def __init__(self):
        pass

    def __call__(self, *args, **kwargs):

        print('__call__')


obj = Foo()     # 执行 __init__
obj()       # 执行 __call__

怎么判断一个对象是否可以被执行呢?能被执行的对象就是一个Callable对象,可以用Python内建的callable()函数进行测试。
eg.

>>> callable(max)
True

操作符类属性

  1. __ str__
    当将一个对象进行格式化字符串时,调用的是对象的__ str__方法,如果一个类中定义了__ str__()方法,那么在打印对象时,默认输出该方法的返回值。
    下面的类,没有定义__ str__()方法,打印结果是:<__ main__.Foo object at 0x000000000210A358>
class Foo:
    pass

obj = Foo()
print(obj)

定义了__ str__()方法后,打印结果是:jack

class Foo:

    def __str__(self):
        return 'jack'

obj = Foo()
print(obj)
  1. __ repr__
    这个方法的作用和__str__()很像,两者的区别是__str__()返回用户看到的字符串,而__repr__()返回程序开发者看到的字符串,也就是说,repr()是为调试服务的。通常两者代码一样。
  2. __ len__
    在Python中,调用内置的len()函数获取一个对象的长度,在后台其实是去调用该对象的__len__()方法,所以下面的代码是等价的:
    Python的list、dict、str等内置数据类型都实现了该方法,但是你自定义的类要实现len方法需要自己设计。
class Foo:
    def __init__(self):
        pass

    def __iter__(self):
        yield 1
        yield 2
        yield 3

obj = Foo()
for i in obj:
    print(i)

>>> 1
>>> 2
>>> 3
  1. __ iter__
    列表、字典、元组之所以可以进行for循环,是因为其内部定义了 __ iter__()这个方法。用户也可以在自定类中定义这个方法,在利用for循环遍历对象时就可以调用这个__ iter__()方法。
    eg.
class Foo:
    def __init__(self):
        pass

    def __iter__(self):
        yield 1
        yield 2
        yield 3

obj = Foo()
for i in obj:
    print(i)

>>> 1
>>> 2
>>> 3
  1. __ getitem__, __ setitem__, __ delitem__
    Python设计了__ getitem__()、__ setitem__()、__ delitem__()这三个特殊成员,用于执行与中括号有关的动作。它们分别表示取值、赋值、删除数据。
a = 标识符[] :   执行__getitem__方法
标识符[] = a  :   执行__setitem__方法
del 标识符[] :   执行__delitem__方法

eg.

class Foo:

    def __getitem__(self, key):
        print('__getitem__',key)

    def __setitem__(self, key, value):
        print('__setitem__',key,value)

    def __delitem__(self, key):
        print('__delitem__',key)


obj = Foo()

result = obj['k1']      # 自动触发执行 __getitem__
obj['k2'] = 'jack'      # 自动触发执行 __setitem__
del obj['k1']             # 自动触发执行 __delitem__