模板类

Instrument （模板类）是你在数据处理中可能使用的类。对于金融分析，模板类通常指的是股票，债券，或其他证券类型，或者是利率和发行人。

如果在 config.py 文件中，你声明模板类继承自 security，那么模板类会是一个证券类型的模板，位于 RiskQuantLib/Instrument/Security 文件夹下，如果你声明模板类继承自 index 或者 interest 等，模板类就会处于父类的文件夹下。你也可以在声明父类的那一列留空，这样的话一个全新的独立类就会被创建，位于 RiskQuantLib/Instrument 文件夹下。

模板类的实例应该有 code 和 name 这两个属性， code 非常像pandas中的index，set 函数族会默认使用 code 来作为索引元素的根属性。 name 通常作为一个可以显示更多细节信息的属性。

注意：code和name这两个属性不是完全等价的，正如上面所说，code是set函数族的默认属性。

通过使用 from RiskQuantLib.module import *，任何已经注册过的模板类都可以被自动导入，你可以用类名来创建一个类实例。比如如果你的模板类名为pandaBond，你可以这样实例化它：:

firstPandaBondObject = pandaBond('code','name')

任何模板类在实例化时都有一个可选属性，名为type。你可以选择性地传入一个字符串，像这样：:

firstPandaBondObject = pandaBond('code','name','type')

使用模板类的最主要原因是这样做可以将代码封装为一个个独立的模块，使得使用和维护都变得更加方便。当需要团队协作或者数据处理过程非常复杂的时候，实践证明对象化编程是非常有用的手段。

模板类的源文件所处的位置是他们继承的第一个RiskQuantLib父类的位置。比如：你的模板类 pandaBond 继承自 Bond，那么 pandaBond 将位于 RiskQuantLib/Instrument/Security/Bond 文件夹，你应该将相关的代码全部放在这个文件夹下。

如果你更改了 RiskQuantLib/Instrument/Security/Bond/PandaBond/pandaBond.py 的源码，那么你的更改将会被记录，无论你再运行多少次 python build.py，这些更改过的源码都不会受到影响。这使得你发现工程需要修改时，可以对工程进行重复编译。

注意：有一个例外。如果你更改了 RiskQuantLib/Instrument/Security/Bond/PandaBond/pandaBond.py 文件中的代码，你应该确保你更改的代码不在任何的 插入标签 之间， 插入标签 是用来标记文件中可以被插入代码的位置的注释，它看起来像这样：

#<tagName>
#</tagName>

它非常类似于html中的标签，RiskQuantLib可以帮助你生成很多重复的代码，然后自动帮你把他们放在你想要放的位置。但实际上，代码只能被插入到插入标签之间，这意味着插入标签之间的代码是被不停地动态替换的。这就是为什么你应该确保自己的代码不在任何两个插入标签之间。

注意：即使你在下一次编译时声明删除，任何曾经编译生成的模板类的源文件都是不会被自动删除的。这样做是为了安全的考虑，如果确实需要删除源文件，你需要手动删除。

注意：虽然模板类的源文件不会被自动删除，但模板类可以被取消注册。如果你需要取消某个模板类的注册，只需要删除 config.py 文件中对应的那一行，并且重新编译。这样操作后，即使使用 from RiskQuantLib.module import * 你也无法再直接使用那个删除的模板类，它也无法作为父类被其他模板类继承。