當一個專案的程式碼不斷增加，其中很多的內容諸如全域性變數、提示語言等等都有必要放在一個獨立的檔案，方便變更。這個獨立的檔案有很多種，可以是init檔案、conf檔案、xml檔案，為了通用性，我選擇了xml檔案作為自己的配置檔案。對於《字元級的CNN文字分類器》一文中，我的xml檔案是這樣的：

<?xml version="1.0" encoding="UTF-8" ?>
<config>
    <directories>
        <directory name="train_text_home">TrainText</directory>
 
        <directory name="test_text_home">TestText</directory>
        <directory name="checkpoint_home">CheckPoints</directory>
        <directory name="summary_home">Summaries</directory>
        <directory name="log_home">Logs</directory>
    </directories>
 
    <files>
        <file name="model_file">ENCharCNNTextClassification_%s</file>
        <file name="summary_file">ENCharCNNTextClassification_%s</file>
        <file name="log_file">Logs_of_%s.log</file>
    </files>
    <messages>
        <module 
 
name="pre_train.py">
            <message name="encode_success">One-Hot encoding done! Totally %d words have been skipped.</message>
            <message name="start_train_file">Start to train from file: %s.</message>
            <message name="done_train_file">Finish to train from file: %s.</message>
            <message name="open_dir">Open directory: %s.</message>
        </module>
        <module name="char_cnn.py">
            <message name="checkpoint_restore">Checkpoint: %s has been restored.</message>
            <message name="checkpoint_restore_fail">No checkpoints being restored.</message>
            <message name="display_steps">Total steps: %d, batch cost: %.4f, batch accuracy: %.2f%%, time to use: %d seconds.</message>
            <message name="display_test">Accuracy: %.2f%%.</message>
        </module>
        <module name="main.py">
            <message name="done_train">The train has been done!</message>
            <message name="done_validation">The validation has been done!</message>
        </module>
    </messages>
    <options>
        <option name="train_name" type="str">ag_news</option>
        <option name="max_to_keep" type="int">10</option>
        <option name="epochs" type="int">55</option>
        <option name="display_steps" type="int">2000</option>
        <option name="save_steps" type="int">2000</option>
    </options>
    <hyperparameters>
        <hyperparameter name="length0" type="int">1014</hyperparameter>
        <hyperparameter name="n_class" type="int">4</hyperparameter>
        <hyperparameter name="batch_size" type="int">128</hyperparameter>
        <hyperparameter name="learning_rate" type="float">0.01</hyperparameter>
        <hyperparameter name="decay_steps" type="int">1000</hyperparameter>
        <hyperparameter name="decay_rate" type="float">0.8</hyperparameter>
        <hyperparameter name="keep_prob" type="float">0.5</hyperparameter>
        <hyperparameter name="grad_clip" type="int">5</hyperparameter>
    </hyperparameters>
</config>

xml是一種非常開放的語言，所有的標籤、屬性命名都沒有相關的規定，什麼時候使用子標籤，什麼時候使用屬性全憑作者的習慣，這裡我給出一種判斷的標準：對於資料的儲存，儘量使用子標籤，例如上述中hyperparameter（超參）屬於我要存的資料，所以我用標籤來存。但name和type屬於這個資料的一些屬性，我使用屬性去儲存。但其實這樣的分類法有時候並不會很清晰。例如電影，一部電影有標題、簡介、演員等內容，這些屬於這部電影的屬性，但從另外一個角度來說，這些又是屬於我們要存起來的資料。所以有另外一種標準，我們可以把需要直接使用的內容看成資料，例如這個超參直接賦給程式，電影的標題、簡介和演員直接輸出到前端頁面，而name和type屬於對這些資料的描述，我們不會直接使用它們，所以作為屬性。在上述檔案中，大家還可以看到我在部分內容裡面使用了格式字串“%s%d%f”等，關於這點的意義之一，我在另一篇文章中提到，就是為了可以儲存整條文字，方便語言包的製作。具體怎樣指定相關的變數，後面會介紹。

有了xml檔案，就需要有程式碼去讀，同樣為了全域性性考慮，我專門寫了一個類來讀取配置檔案，做我程式的初始化工作：

import os
import logging
import xml.etree.ElementTree


class ProjectInitializer:
    config = None
work_dir = os.getcwd()

    @classmethod
def init_my_project(cls, config_file='config.xml'):
        assert os.path.isfile(config_file)
        assert (os.path.splitext(config_file)[-1]) == '.xml'
cls.config = xml.etree.ElementTree.parse(config_file).getroot()
        cls._check_dirs()
        cls._init_logging()

    @classmethod
def get_dir_path(cls, home_name):
        path = cls.config.find("./directories/directory[@name=\'%s\']" % home_name).text
        if os.path.isabs(path):
            return path
        else:
            return os.path.join(cls.work_dir, path)

    @classmethod
def get_file_path(cls, home_name, file_name, *args):
        real_file_name = cls.config.find("./files/file[@name=\'%s\']" % file_name).text
        if len(args) > 0:
            real_file_name = real_file_name % args
        return os.path.join(cls.get_dir_path(home_name), real_file_name)

    @classmethod
def message_about(cls, module_file_path, event_name, *args):
        module_name = os.path.basename(module_file_path)
        mess_module = cls.config.find("./messages/module[@name=\'%s\']" % module_name)
        assert mess_module is not None
message = mess_module.find("./message[@name=\'%s\']" % event_name).text
        if len(args) > 0:
            message = message % args
        return message

    @classmethod
def option(cls, opt_name):
        tag = cls.config.find("./options/option[@name=\'%s\']" % opt_name)
        value = eval(tag.get('type'))(tag.text)
        return value

    @classmethod
def hyper_para(cls, para_name):
        tag = cls.config.find("./hyperparameters/hyperparameter[@name=\'%s\']" % para_name)
        value = eval(tag.get('type'))(tag.text)
        return value

    @classmethod
def _check_dirs(cls):
        for directory in cls.config.findall("./directories/directory"):
            path = cls.get_dir_path(directory.get('name'))
            if not os.path.isdir(path):
                os.mkdir(path)

    @classmethod
def _init_logging(cls):
        formatter = logging.Formatter('%(asctime)s %(name)s %(levelname)s - %(message)s', '%Y %b %d %H:%M:%S')

        handlers = [
            logging.FileHandler(cls.get_file_path('log_home', 'log_file', cls.option('train_name'))),
logging.StreamHandler()
        ]
        logging.getLogger().setLevel(logging.INFO)
        for handler in handlers:
            handler.setFormatter(formatter)
            logging.getLogger().addHandler(handler)

且看我逐行解析：

class ProjectInitializer:
    config = None
work_dir = os.getcwd()

類變數config是儲存xml解析樹的，在import類的時候，因為配置檔案的路徑不確定，所以先初始化為None，而work_dir則是要獲取當前的工作目錄作為全域性變數，這樣的好處是，無論後面我們是否改變了工作目錄，我們配置檔案指定的路徑都可以跟這個路徑組合成絕對路徑，固定儲存的位置。

xml獲取相關標籤的公式如下：

20.5.2.2. Supported XPath syntax

Syntax	Meaning
tag	Selects all child elements with the given tag. For example, spam selects all child elements named spam, and spam/egg selects all grandchildren named egg in all children named spam.
*	Selects all child elements. For example, */egg selects all grandchildren named egg.
.	Selects the current node. This is mostly useful at the beginning of the path, to indicate that it’s a relative path.
//	Selects all subelements, on all levels beneath the current element. For example, .//egg selects all egg elements in the entire tree.
..	Selects the parent element. Returns None if the path attempts to reach the ancestors of the start element (the element findwas called on).
[@attrib]	Selects all elements that have the given attribute.
[@attrib='value']	Selects all elements for which the given attribute has the given value. The value cannot contain quotes.
[tag]	Selects all elements that have a child named tag. Only immediate children are supported.
[tag='text']	Selects all elements that have a child named tag whose complete text content, including descendants, equals the given text.
[position]	Selects all elements that are located at the given position. The position can be either an integer (1 is the first position), the expression last() (for the last position), or a position relative to the last position (e.g. last()-1).

Predicates (expressions within square brackets) must be preceded by a tag name, an asterisk, or another predicate. position predicates must be preceded by a tag name.

@classmethod
def init_my_project(cls, config_file='config.xml'):
    assert os.path.isfile(config_file)
    assert (os.path.splitext(config_file)[-1]) == '.xml'
cls.config = xml.etree.ElementTree.parse(config_file).getroot()
    cls._check_dirs()
    cls._init_logging()

第一個靜態方法是用來初始化專案的，會在main函式的第一句被呼叫。從程式碼我們可以清楚看到，主要工作就是讀取指定的xml檔案，檢查需要的目錄是否存在，以及初始化logging的相關資訊。

@classmethod
def get_dir_path(cls, home_name):
    path = cls.config.find("./directories/directory[@name=\'%s\']" % home_name).text
    if os.path.isabs(path):
        return path
    else:
        return os.path.join(cls.work_dir, path)

@classmethod
def get_file_path(cls, home_name, file_name, *args):
    real_file_name = cls.config.find("./files/file[@name=\'%s\']" % file_name).text
    if len(args) > 0:
        real_file_name = real_file_name % args
    return os.path.join(cls.get_dir_path(home_name), real_file_name)

這兩個方法是用來獲取相關的目錄和檔案路徑的，為了便於在win和Linux之間遷移，我配置檔案一般不會存路徑分割符，而像程式碼中的使用os.path中的join方法來連線，這樣就保證了可遷移性。同時在第二個方法中我們可以看到，函式使用了Python的一個可變引數的特性*args，這個特性允許使用著動態輸入若干個引數，例如引數檔案中的log檔案我們會允許輸入一個字串來區分不同的日誌，這樣呼叫者獲取log檔案路徑的時候，只需要把這個字串按順序放在函式裡面，程式碼便會替換相應的內容，生成真正的檔名，再組合目錄的路徑成為絕對路徑返回。由於這個引數的個數是可變的，也滿足了字串中替代符個數不定的需要。

@classmethod
def message_about(cls, module_file_path, event_name, *args):
    module_name = os.path.basename(module_file_path)
    mess_module = cls.config.find("./messages/module[@name=\'%s\']" % module_name)
    assert mess_module is not None
message = mess_module.find("./message[@name=\'%s\']" % event_name).text
    if len(args) > 0:
        message = message % args
    return message

這個方法是用來獲取提示資訊的，由於提示資訊非常多，而且一般每個模組有固定的提示資訊，很少是各個模組共用的，所以在提示資訊儲存的xml裡面，我增加了一個父標籤<module>，標籤的內容是這個檔案的檔名。然後在呼叫函式的時候我們有一個取巧的方法：

(MyInit.message_about(__file__, 'done_train')

__file__這個變數儲存了當前模組的檔名，這樣在不同的模組裡面，我們便可以統一使用這樣的程式碼來進行呼叫，減少了錯誤的發生：

MyInit.message_about(__file__, 'start_train_file', file_path)

上面是帶引數的呼叫。

@classmethod
def option(cls, opt_name):
    tag = cls.config.find("./options/option[@name=\'%s\']" % opt_name)
    value = eval(tag.get('type'))(tag.text)
    return value

@classmethod
def hyper_para(cls, para_name):
    tag = cls.config.find("./hyperparameters/hyperparameter[@name=\'%s\']" % para_name)
    value = eval(tag.get('type'))(tag.text)
    return value

這兩個都是獲取全域性變數的方法，其中option和hyperparameter並沒有太嚴格的區分，我憑我個人感覺認為後者對神經網路的定義相關性更大。方法中值得一提的是，tag.text存的都是str變數，這樣我們在使用的時候可能會面臨變數型別的報錯，所以我特意增加了一個type屬性，然後使用Python的特殊方法eval執行，例如是int的變數，eval('int)('4')的效果就等同於int('4')，這樣返回的全域性變數變可以通過xml檔案動態設定屬性了。

@classmethod
def _check_dirs(cls):
    for directory in cls.config.findall("./directories/directory"):
        path = cls.get_dir_path(directory.get('name'))
        if not os.path.isdir(path):
            os.mkdir(path)

該方法是檢查相關的目錄是否存在，沒有就建立，程式碼比較簡單。

@classmethod
def _init_logging(cls):
    formatter = logging.Formatter('%(asctime)s %(name)s %(levelname)s - %(message)s', '%Y %b %d %H:%M:%S')

    handlers = [
        logging.FileHandler(cls.get_file_path('log_home', 'log_file', cls.option('train_name'))),
logging.StreamHandler()
    ]
    logging.getLogger().setLevel(logging.INFO)
    for handler in handlers:
        handler.setFormatter(formatter)
        logging.getLogger().addHandler(handler)

最後一個方法是logging的初始化，由於本文主要講的是xml讀取，這部分程式碼只是簡單介紹一下。formatter是用來定義格式的，handlers裡面存了需要輸出的地方，本程式碼裡面是logfile和螢幕，把它設定到getLogger()獲取的root logger裡面，就可以對所有的log執行了。

上述類就是用來初始化我的程式碼的，我做人工智慧的程式設計基本上都是照搬這兩個檔案，然後修改一下xml配置檔案的內容，非常方便。