python中代码复用的示例分析

这篇文章给大家分享的是有关python中代码复用的示例分析的内容。小编觉得挺实用的，因此分享给大家做个参考，一起跟随小编过来看看吧。

最初代码

3种动物牛Cow、羊Sheep、马Horse发出的声音各不相同，于是在同一个目录下建立三个模块文件：

$ tree .
.
|-- cow.py
|-- horse.py
`-- sheep.py

三个模块文件的内容都只定义了各自的speak()函数：

# cow.py
def speak():
 print("a cow goes moooo!")

# sheep.py
def speak():
 print("a sheep goes baaaah!")

# horse.py
def speak():
 print("a horse goes neigh!")

然后当前目录下在创建一个程序文件main.py，导入这三个模块文件，分别调用这三种动物的speak()函数，它们将发出不同声音：

# main.py
import cow,sheep,horse

cow.speak()
sheep.speak()
horse.speak()

让代码更具共性的两种基本方法

上面的cow.py、sheep.py和horse.py中，都是speak()函数，不同的是函数内容，确切地说是函数内容中print()输出的部分不同，它们输出的结构是a 动物名 goes 叫声!。于是为了让代码更具共性，或者说复用性更高，可以将各模块文件中的动物名和叫声都变得通用化。

目前来说，有两种最基本的方式可以让一段代码变得更共性、共通用化：使用参数或变量、使用额外的辅助函数。当然，除此之外还有更多的方法，但目前来说这两种是最基本的，也是最容易理解的。

使用参数(变量)让代码更具共性

首先让动物名变得共性化。可以让speak()中的动物名使用一个参数来替代。例如名为self的参数变量(之所以使用self，是因为在面向对象中它有特殊含义，后文解释)，于是修改这三个模块文件：

# cow.py
def speak(self):
 print("a %s goes moooo!" % (self))

# sheep.py
def speak(self):
 print("a %s goes baaaah!" % (self))

# horse.py
def speak(self):
 print("a %s goes neigh!" %(self))

它们现在在动物名上和参数名上已经完全相同，需要调用它们时，只需在函数调用处为他们传递不同的动物名即可。例如，在main.py中：

import cow,sheep,horse

cow.speak("cow")
sheep.speak("sheep")
horse.speak("horse")

使用辅助函数让代码更具共性

除了参数(变量)，还可以定义额外的函数来上面的代码变得更具共性。例如，这三种动物的叫声，可以额外定义一个sound()函数描述它们。于是在前面的基础上继续修改这三个模块文件：

# cow.py
def speak(self):
 print("a %s goes %s!" % (self,sound()))

def sound():
 return "moooo"

# sheep.py
def speak(self):
 print("a %s goes %s!" % (self,sound()))

def sound():
 return "baaaah"

# horse.py
def speak(self):
 print("a %s goes %s!" % (self,sound()))

def sound():
 return "neigh"

在main.py中，仍然可以使用之前的方式对这3个speak()进行调用：

import cow,sheep,horse

cow.speak("cow")
sheep.speak("sheep")
horse.speak("horse")

现在，这3个模块文件的speak()已经完完全全地共性化了。

初步理解类和对象

所谓的类，就像是一个模板；所谓对象，就像是通过模板生成的具体的事物。类一般具有比较大的共性，对象一般是具体的，带有自己的特性。

类与对象的关系，例如人类和人，鸟类和麻雀，交通工具和自行车。其中人类、鸟类、交通工具类都是一种类型称呼，它们中的任何一种都具有像模板一样的共性。例如人类的共性是能说话、有感情、双脚走路、能思考等等，而根据这个人类模板生成一个人，这个具体的人是人类的实例，是一个人类对象，每一个具体的人都有自己的说话方式、感情模式、性格、走路方式、思考能力等等。

类与类的关系。有的类的范畴太大，模板太抽象，它们可以稍微细化一点，例如人类可以划分为男性人类和女性人类，交通工具类可以划分为烧油的、电动的、脚踏的。一个大类按照不同的种类划分，可以得到不同标准的小类。无论如何划分，小类总是根据大类的模板生成的，具有大类的共性，又具有自己的个性。

在面向对象中，小类和大类之间的关系称之为继承，小类称之为子类，大类称之为父类。

类具有属性，属性一般包括两类：像名词一样的属性，像动词一样的行为。例如，人类有父母(parent)，parent就是名词，人类能吃饭(eat)，eat这种行为就是动词。鸟类能飞(fly)，fly的行为就是动词，鸟类有翅膀(wing)，wing就是名词。对于面向对象来说，名词就是变量，动词行为就是方法(也就是子程序)。通常，变量和方法都成为类的属性。

当子类继承了父类之后，父类有的属性，子类可以直接拥有。因为子类一般具有自己的个性，所以子类可以定义自己的属性，甚至修改从父类那里继承来的属性。例如，人类中定义的eat属性是一种非常抽象的、共性非常强的动词行为，如果女性人类继承人类，那么女性人类的eat()可以直接使用人类中的eat，也可以定义自己的eat(比如淑女地吃)覆盖从人类那里继承来的eat(没有形容词的吃)，女性人类还可以定义人类中没有定义的跳舞(dance)行为，这是女性人类的特性。子类方法覆盖父类方法，称之为方法的重写(override)，子类定义父类中没有的方法，称为方法的扩展(extend)。

当通过类构造出对象后，对象是类的实例，是类的具体化，对象将也具备类的属性，且对象的属性都有各自的值。例如，student类具有成绩、班级等属性，对于一个实际的学生A对象来说，他有成绩属性，且这个成绩具有值，比如89分，班级也一样，比如2班，此外，学生B也有自己的成绩和班级以及对应的值。也就是说，根据类模板生成对象后，对象的各个属性都属于自己，不同对象的属性互不影响。

无论是对象与类还是子类与父类，它们的关系都可以用一种"is a"来描述，例如"自行车 is a 交通工具"(对象与类的关系)、"笔记本 is a 计算机"(子类与父类的关系)。

继承

回到上面的3个模块文件。它们具有共性的speak()和sound()，尽管sound()的返回内容各不相同，但至少函数名sound是相同的。

可以将这3个文件中共性的内容抽取到同一个模块文件中，假设放进animal.py的文件中。animal.py文件的内容为(但这是错误的代码，稍后修改)：

def speak(self):
 print("a %s goes %s!" % (self,sound()))

def sound(): pass

然后修改cow.py、sheep.py和horse.py，使它们"继承"animal.py。

# cow.py
import animal

def sound(): return "moooo"

# sheep.py
import animal

def sound(): return "baaaah"

# horse.py
import animal

def sound(): return "neigh"

现在，这三个模块文件都没有了speak()，因为它们都借用它们的"父类"animal中的speak()。

这表示horse、cow和sheep"继承"了animal，前三者为"子类"，后者为"父类"。

但注意，这里不是真正的继承，因为python不支持非class对象的继承，所以没法通过非面向对象语法演示继承。但至少从代码复用的角度上来说，它和继承的功能是类似的。

另外注意，前面animal.py文件是错误的，因为它的speak()函数中调用了sound()函数，但sound()函数在animal.py中是一个没任何用处的函数，仅仅只是代表这个animal具有sound()功能(表示类的一个属性)。而我们真正需要的sound()是可以调用cow、horse、sheep中的sound()，而不是animal自身的sound()。

所以，在没有使用面向对象语法的情况下，改写一下animal.py文件，导入cow、horse、sheep，使得可以在"父类"的speak()中调用各个"子类"的sound()。再次说明，这里只是为了演示，这种编程方式是不规范的，在真正的面向对象语法中根本无需这些操作。

以下是修改后的animal.py文件：

import cow,horse,sheep

def speak(self):
 print( "a %s goes %s!" % (self, eval(self + ".sound()")) )

def sound(): 
 pass

上面使用eval函数，因为python不支持普通的变量名作为模块名来调用模块的属性sound()，所以使用eval先解析成cow或horse或sheep，再调用各自的sound()函数。如果不懂eval()的功能，可无视它。只需知道这是为了实现self.sound()来调用self所对应变量的sound()函数。

现在，在main.py中，使用下面的代码来调用speak()，得到的结果和前面是一样的。

import cow,sheep,horse

cow.animal.speak("cow")
sheep.animal.speak("sheep")
horse.animal.speak("horse")

由于不是真正的"继承"，所以这里只能通过模块的方式添加一层animal.来调用speak()。

虽然上面的代码变得"人不人鬼不鬼"(因为没有使用面向对象的语法)，但面向对象的基本目标达到了：共性的代码全部抽取出去，实现最大程度的代码复用。

self是什么

在python的面向对象语法中，将会经常看见self这个字眼。其实不仅python，各种动态类型的、支持面向对象的语言都使用self，例如perl、ruby也是如此。但是，self是约定俗成的词，并非是强制的，可以将self换成其它任何字符，这并不会出现语法错误。

实际上，对于静态面向对象语言来说，用的更多的可能是this，比如java、c#、c++都使用this来表示实例对象自身。

那么self到底是什么东西？

在前文，为了将cow、sheep和horse模块中speak()函数中的动物名称变得共性，添加了一个self参数。之前的那段代码如下：

# cow.py
def speak(self):
 print("a %s goes moooo!" % (self))

# sheep.py
def speak(self):
 print("a %s goes baaaah!" % (self))

# horse.py
def speak(self):
 print("a %s goes neigh!" %(self))

当调用这三个函数时，分别传递各自的动物名作为参数：

import cow,sheep,horse

cow.speak("cow")
sheep.speak("sheep")
horse.speak("horse")

所以，对于cow来说，self是名为"cow"的动物，对于sheep来说，self是名为"sheep"的动物，对于horse来说，self是名为"horse"的动物。

也就是说，self是各种动物对象，cow.speak()时是cow，sheep.speak()时是sheep，horse.speak()时是horse。这里的模块名变量和speak()的参数是一致的，这是我故意设计成这样的，因为面向对象语法中默认的行为和这是完全一样的，仅仅只是因为语法不同而写法不同。

简而言之，self是各个动物对象自身。

后来将cow、sheep和horse的speak()函数抽取到了animal中，仍然使用self作为speak()的参数。

以下是animal.py文件中的speak()函数：

def speak(self):
 print( "a %s goes %s!" % (self, eval(self + ".sound()")) )

当使用下面的方式去调用它时：

cow.animal.speak("cow")
sheep.animal.speak("sheep")
horse.animal.speak("horse")

self是cow、是sheep、是horse，而不是animal。前面说了，在真正的面向对象语法中，中间的这一层animal是被省略的，这里之所以加上一层animal，完全是因为python的非面向对象语法中没办法实现继承。

当真正使用面向对象语法的时候，self将表示实例对象自身。例如student类有name属性，当根据此类创建一个stuA对象，并使用self.name时，表示stuA.name，换句话说，self是stuA这个对象自身，self.name是stuA对象自身的属性name，和另一个学生对象的stuB.name无关。

重写父类方法

前面的animal.py中定义了一个空代码体的sound()函数，在cow、sheep和horse中定义了属于自己叫声的sound()函数。这其实就是方法的重写(方法就是函数，只是在面向对象中称为方法)：父类定义了某个方法，子类修改和父类同名的方法。

例如，新添加一个类mouse，重写animal的speak()方法，mouse的speak()方法中会叫两声，而不是其它动物一样只有一声。假设mouse类定义在mouse.py文件中，代码如下：

import animal

def speak(self):
 animal.speak(self)
 print(sound())

def sound():
 return "jijiji"

这里重写了父类animal的speak()，并在mouse.speak()中调用了父类animal.speak()，再次基础上还叫了一声。

为了让这段代码运行，需要在animal.py中导入mouse，但在真正面向对象语法中是不需要的，原因前面说了。

# animal.py
import cow,horse,sheep,mouse

def speak(self):
 print( "a %s goes %s!" % (self, eval(self + ".sound()")) )

def sound(): 
 pass

然后在main.py中调用mouse.speak()即可：

import cow,sheep,horse,mouse

cow.animal.speak("cow")
sheep.animal.speak("sheep")
horse.animal.speak("horse")
mouse.speak("mouse")

按照"里氏替换原则"：子类重写父类方法时，应该扩展父类的方法行为，而不是直接否定父类的方法代码并修改父类方法的代码。这是一种编程原则，并非强制，但是经验所在，我们应当参考甚至尽量遵循这些伟人提出的原则。

正如上面的mouse，speak()是在父类的speak()上扩展的。如果将mouse.speak()改为如下代码，则不符合里氏替换原则：

import animal

def speak(self):
 print(sound())
 print(sound())

def sound():
 return "jijiji"

并非一定要遵循里氏替换原则，应该根据实际场景去考虑。比如上面的sound()方法，父类的sound()是一个空方法，仅仅只是声明为类的属性而存在。子类可以随意根据自己的类特性去定制sound()。

再举一个扩展父类方法的例子。在父类中定义了一个clean()方法，用于清理、回收父类的一些信息。子类中也重写一个clean()方法，但这时应当确保子类的clean()中包含了调用父类的clean()方法，再定义属于子类独有的应当清理的一些信息。这就是父类方法的扩展，而不是父类方法的直接否定。因为子类并不知道父类的clean()会清理哪些信息，如果完全略过父类clean()，很可能本该被父类clean()清理的东西，子类没有去清理。

真正面向对象的语法

前面的所有内容都只是为了从代码复用的角度去演示如何从普通编程方式演变成面向对象编程。现在，简单介绍python面向对象编程的语法，实现前文的animal、horse、cow和sheep，由此来和前文的推演做个比较。关于面向对象，更多内容在后面的文章会介绍。

使用class关键字定义类，就像定义函数一样。这里定义4个类，父类animal，子类cow、sheep、horse，子类继承父类。它们分别保存到animal.py、cow.py、sheep.py和horse.py文件中。

animal.py文件：

# 定义Animal类
class Animal():
 def speak(self):
  print( "a %s goes %s!" % (self, self.sound()) )
 def sound(self):
  pass

cow.py文件：

import animal

# 定义Cow类，继承自Animal
class Cow(animal.Animal):
 def sound(self):
  return "moooo"

sheep.py文件：

import animal

# 定义Sheep类，继承自Animal
class Sheep(animal.Animal):
 def sound(self):
  return "baaaah"

horse.py文件：

import animal

# 定义Horse类，继承自Animal
class Horse(animal.Animal):
 def sound(self):
  return "neigh"

在main.py文件中生成这3个子类的实例，并通过实例对象去调用定义在父类的speak()方法：

import cow,horse,sheep

# 生成这3个子类的实例对象
cowA = cow.Cow()
sheepA = sheep.Sheep()
horseA = horse.Horse()

# 通过实例对象去调用speak()方法
cowA.speak()
sheepA.speak()
horseA.speak()

输出结果：

a <cow.Cow object at 0x03341BD0> goes moooo!
a <sheep.Sheep object at 0x03341BF0> goes baaaah!
a <horse.Horse object at 0x03341F50> goes neigh!

输出结果和想象中不一样，先别管结果。至少如果把<xxx>换成对应的实例对象名称，就和前文的效果一样了。这个稍后再改。

先看语法。

使用class关键字声明类，类名一般首字母大写。如果要继承某个类，在类名的括号中指定即可，例如class Cow(Animal)。

因为Cow、Horse、Sheep类继承了Animal类，所以即使这3个子类没有定义speak()方法，也将拥有(继承)父类Animal的speak()方法。

通过调用类，可以创建这个类的实例对象。例如上面cowA=cow.Cow()，表示创建一个Cow()的对象，这个对象在内存中，赋值给了cowA变量。也即是说cowA引用了这个对象，是这个对象的唯一标识符。注意，cowA是变量，因为引用对象，所以可以称为对象变量。

当调用cowA.speak()时，首先查找speak()方法，因为没有定义在Cow类中，于是查找父类Animal，发现有speak()方法，于是调用父类的speak()方法。调用时，python会自动将cowA这个对象作为speak()的第一个参数，它将传递给Animal类中speak()的self参数，所以此时self表示cowA这个对象，self.sound()表示cowA.sound()，由于Cow类中定义了sound()，所以直接调用Cow类的sound()，而不会调用Animal中的sound()。

和前面的推演代码复用的过程比较一下，不难发现面向对象的语法要轻便很多，它将很多过程自动化了。

现在还有一个问题，上面的代码输出结果不是我们想要的。见下文。

类的属性

为了让speak()输出对象名(如对象变量名cowA)，这并非一件简单的事。

在python中，变量都是保存对象的，变量和数据对象之间是相互映射的，只要引用变量就会得到它的映射目标。如果这个对象具有__name__属性，则直接引用该属性即可获取该变量的名称，很简单。

但是很多对象并没有__name__属性，比如自定义的类的对象实例，这时想要获取类的对象变量名，实非易事。有两个内置函数可以考虑：globals()函数和locals()函数，它们返回当前的全局变量和本地变量的字典。遍历它们并对字典的value和给定变量进行比较，即可获取想要的变量名key。

但如果跨文件了，例如Animal类在一个文件，Cow类在一个文件，创建对象的代码又在另一个文件，它们的作用域都是各自独立的，想要在Animal类的方法speak()中获取Cow类的对象变量名cowA，python应该是没办法实现的(perl支持，且实现非常简单)。

所以，只能使用另一种标识对象的方法：为类添加属性，例如name属性，然后在speak()中引用对象的这个name属性即可。

修改animal.py文件如下：

class Animal():
 def speak(self,name):
  self.name = name
  print( "a %s goes %s!" % (self.name, self.sound()) )
 def sound(self):
  pass

然后，在main.py中调用speak()的时候，传递name参数即可：

import cow,horse,sheep

# 生成这3个子类的实例对象
cowA = cow.Cow()
sheepA = sheep.Sheep()
horseA = horse.Horse()

# 通过实例对象去调用speak()方法
cowA.speak("cowA")
sheepA.speak("sheepA")
horseA.speak("horseA")

输出结果：

a cowA goes moooo!
a sheepA goes baaaah!
a horseA goes neigh!

这正是期待的结果。

构造方法__init__()

上面是在speak()方法中通过self.name = name的方式设置对象horseA的name属性。一般来说，对于那些对象刚创建就需要具备的属性，应当放在构造方法中进行设置。

构造方法是指从类构造对象时自动调用的方法，是对象的初始化方法。python的构造方法名为__init__()。以下是在构造方法中设置name属性的代码：

class Animal():
 def __init__(self,name):
  self.name = name

 def speak(self):
  print( "a %s goes %s!" % (self.name, self.sound()) )

 def sound(self):
  pass

然后构造horseA对象的时候，传递name参数的值即可构造带有name属性的对象：

horseA = Horse("baima")
horseA.speak()

__init__()是在调用Horse()的时候自动被调用的，由于Horse类中没有定义构造方法，所以将搜索继承自父类的构造方法__init__()，发现定义了，于是调用父类的构造方法，并将对象名horseA传递给self参数，然后设置该对象的name属性为"baima"。

python设置或添加对象的属性和其它语言非常不同，python可以在任意地方设置对象的属性，而不必先在构造方法中声明好具有哪些属性。比如前面在speak()方法中通过self.name = name设置，此外还可以在main.py文件中添加对象的属性。例如添加一个color属性：

horseA = Horse("baima")
horseA.color = "white"

只要通过self.xxx或者obj_name.xxx的方式设置属性，无论在何处设置都无所谓，都会是该对象独有的属性，都会被代表名称空间的__dict__属性收集到。

horseA.__dict__

感谢各位的阅读！关于“python中代码复用的示例分析”这篇文章就分享到这里了，希望以上内容可以对大家有一定的帮助，让大家可以学到更多知识，如果觉得文章不错，可以把它分享出去让更多的人看到吧！