Deep Learning学习笔记（六）详解tf.app.flags()和tf.app.run()的源码

经常在程序中看到有tf.app.flags和tf.app.run字样的代码，这两段代码究竟是什么作用，就让我们从分析源码的角度来加深理解！

tf.app.flags

tf.app.flags主要用于处理命令行参数的解析工作，其实可以理解为一个封装好了的argparse包（argparse是一种结构化的数据存储格式，类似于Json、XML）。现在我们就从源码来分析它究竟是怎么解析命令行参数的，应该怎么使用它！

源码如下：

不出意外的首先导入了argparse包

导入argparse.png

使用argparse的第一步就是创建一个解析器对象，告诉它将会有些什么参数。当程序运行时，该解析器可以用于处理命令行参数（只能解析参数、获取参数、设置已有参数的默认值等操作）。argparse中的解析器类是ArgumentParser。

创建解析器对象.png

定义了_FlagValues类，如我们前面所说，要处理命令行参数，就要用解析器类_global_parser里的方法来解析，这里使用了parse_known_args()这个函数，其实同parse_args函数差不多（注：这里说的parse_args()函数和此处_FlagValues类中定义的_parse_args()函数不一样，前者也是argparse中一种解析参数的函数），只是这个函数在接受到多余的命令行参数时不会报错，会原封不动的以一个list形式将其返回。所以此函数返回的”result“是参数解析完的数据，而”unparsed“是那些未被解析的参数list。将命令行传入的命令和数据解析出来以字典的形式放到__dict__的['_flags']这个字典中，这么做也是为了方便我们后续直接访问命令行输入的命令，因为可以直接通过字典调用（在tensorflow中其实是通过tf.app.flag.Flags来实现实例化这个类，然后再调用里面解析得到的参数即可）。

定义_FlagValue类.png

初始化完了之后，可以看到源码里是一些setattr/getattr的方法，也就是一些设置和获得解析的命令行参数的方法。要注意的是，在获得参数的时候（getattr），首先要通过解析字典中的’parsed’来检验参数是否已经被解析过，因为在_parse_flags方法中，只要解析过参数（也即是运行过该函数），那么self.__dict__[‘__parsed’]就会为True（表明解析过参数）。因为这里是获取参数，所以出了要判断参数是否在字典里的基本要求外，还要判断有没有解析过参数，没有就运行_parse_flags解析参数。其它就比较简单，这里就不介绍了！

getattr/setattr.png

后面将上述整个_FlagValues类的实例化，这样就方便了我们的访问操作。因为我们要访问命令行输入的命令时，就可以直接从这个实例里操作。

实例化_FlagValue类.png

注意从这里开始都是在类外定义的方法，所以要调用就只能通过tf.app.flags.XXX来实现了。

下面的_define_helper函数中调用了_global_parser.add_argument完成对命令行参数的添加（传入flag_name，default_value，docstring，flagtype参数），可以看到添加参数使用的是解析器类_global_parser的方法。仔细看这个函数的参数，第一个参数是‘--’+flag_name这个表示我们定义的命令行参数使用时必须以‘--’开头，比如--flag_int9(具体看后面例子)，而第二个参数default_value是参数的默认值，第三个参数docstring保存帮助信息（命令行中输入 -h激活该参数），第四个参数表示限定了赋予命令行参数数据的类型。

_deine_helper方法.png

上面我们已经看到了使用_define_helper参数即可以添加命令行参数，这里源码中又将其封装为针对string/int/float/bool类型参数的特定添加方法**。
看DEFINE_string()，这里则由于_define_helper()最后一个type参数是str，上面我们关于_define_helper参数的解释，说明DEFINE_string()限定了可选参数输入必须是string，这也就是为什么这个函数定义为DEFINE_string()，同理，DEFINE_interger()限定可选参数必须是int，DEFINE_float()限定可选参数必须是float，DEFINE_boolean()限定可选参数必须是bool。

DEFINE_string方法.png

DEFINE_int方法.png

DEFINE_float方法.png

DEFINE_boolean方法.png

源码中最后介绍的方法是在程序运行前先将某些命令行参数加入到”必备参数“（__required_flags）的字典中，以判断解析完的参数是否满足这些必备要求！因为mark_flags_as_required方法会调用mark_flag_as_required方法，来将当前传入的参数加入到__required_flags字典中（_add_required_flag方法），在最上面解析参数的方法_parse_flags中，解析完参数会通过_assert_all_required方法判断解析到的参数是否都在_required_flags字典中。

required_flags.png

讲了这么多，具体在tensorflow中我们该怎么使用呢？
首先我们通过tf.app.flags来调用这个flags.py文件，这样我们就可以用flags.DEFINE_interger/float()来添加命令行参数，而FLAGS=flags.FLAGS可以实例化这个解析参数的类从对应的命令行参数取出参数。
新建test.py文件，并输入如下代码，代码的功能是创建几个命令行参数，然后把命令行参数输出显示

import tensorflow as tf  

flags = tf.app.flags
flags.DEFINE_string('data_dir', '/tmp/mnist', 'Directory with the MNIST data.')
flags.DEFINE_integer('batch_size', 5, 'Batch size.')
flags.DEFINE_integer('num_evals', 1000, 'Number of batches to evaluate.')
FLAGS = flags.FLAGS

print(FLAGS.data_dir, FLAGS.batch_size, FLAGS.num_evals)

在命令行中输入test.py -h就可以查看帮助信息，也就是Directory with the MNIST data.，Batch size和Number of batches to evaluate这样的消息。
在命令行中输入test.py --batchsize 10就可以将batch_size的值修改为10！

tf.app.run()

该函数一般都是出现在这种代码中：

if __name__ == '__main__':
    tf.app.run()

上述第一行代码表示如果当前是从其它模块调用的该模块程序，则不会运行main函数！而如果就是直接运行的该模块程序，则会运行main函数。

具体第二行的功能从源码开始分析，源码如下：

run函数.png

flags_passthrough=f._parse_flags(args=args)这里的parse_flags就是我们tf.app.flags源码中用来解析命令行参数的函数。所以这一行就是解析参数的功能；

下面两行代码也就是tf.app.run的核心意思：执行程序中main函数，并解析命令行参数！