0
点赞
收藏
分享

微信扫一扫

oslo config

一条咸鱼的干货 2022-11-15 阅读 87
virtualenvpython命令行Linux系统/运维


前段时间开始认真看了一下Ryu的源码，发现oslo是一个非常方便的命令行解析库，可以用于CLI和CONF的解析。oslo是 OpenStack发起的项目，全称为OpenStack Common Libraries，是OpenStack Projects共享的基础库。


​​

oslo config_命令行

​​


oslo

在RYU的目录下可以找到cfg.py文件，这个文件中import了oslo的相关模块，以便调用时减少引用数目。从文件中可以发现 oslo.config.cfg文件是关键文件，其在系统中的文件位置在：/usr/local/lib/python2.7/dist- packages/oslo/config/cfg.py。想查看源码的读者可以自行查看。在该cfg.py文件中 定义了ConfigOpts类，包含了_opts, _groups等成员变量。该类完成了命令行和配置参数的解析。

如果要快速学习某一个知识，最好的办法就是把它用起来。所以首先我会介绍一个入门的教程。如果你没有看懂，可以去看原始的教程。

首先安装python-virtualenv，此python库可以用于创建一个虚拟的，与外界隔离的运行环境，听起来和docker好像有点像。


sudo apt-get install python-virtualenv<br />
virtualenv example-app<br />
cd example-app<br />
source bin/activate<br />
pip install oslo.config<br />
touch app.py<br />
touch app.conf




1



2



3



4



5



6



7



sudo apt - get install python - virtualenv



virtualenv example - app



cd example - app



source bin / activate



pip install oslo .config



touch app .py



touch app .conf



然后修改app.conf。添加了两个group:simple和morestuff。simple组中有一个BoolOpt:enable。morestuff组有StrOpt, ListOpt, DictOpt, IntOpt,和FloatOpt。


[simple]</p>
<p>enable = True</p>
<p>[morestuff]</p>
<p># StrOpt<br />
message = Hello World</p>
<p># ListOpt<br />
usernames = ['Licheng', 'Muzixing', 'Distance']</p>
<p># DictOpt<br />
jobtitles = {'Licheng': 'Manager', 'Muzixing': 'CEO', 'Distance': 'Security Guard'}</p>
<p># IntOpt<br />
payday = 20</p>
<p># FloatOpt<br />
pi = 3.14




1



2



3



4



5



6



7



8



9



10



11



12



13



14



15



16



17



18



19



20



[ simple ]






enable = True






[ morestuff ]






# StrOpt



message = Hello World






# ListOpt



usernames = [ 'Licheng' , 'Muzixing' , 'Distance' ]






# DictOpt



jobtitles = { 'Licheng' : 'Manager' , 'Muzixing' : 'CEO' , 'Distance' : 'Security Guard' }






# IntOpt



payday = 20






# FloatOpt



pi = 3.14



修改app.py文件。首先定义两个group，再对两个group的option进行定义。最后使用registergroup和registeropts函数来完成group和option的注册。


from __future__ import print_function<br />
from oslo.config import cfg</p>
<p>opt_simple_group = cfg.OptGroup(name='simple',<br />
                         title='A Simple Example')</p>
<p>opt_morestuff_group = cfg.OptGroup(name='morestuff',<br />
                         title='A More Complex Example')</p>
<p>simple_opts = [<br />
    cfg.BoolOpt('enable', default=False,<br />
                help=('True enables, False disables'))<br />
]</p>
<p>morestuff_opts = [<br />
    cfg.StrOpt('message', default='No data',<br />
               help=('A message')),<br />
    cfg.ListOpt('usernames', default=None,<br />
                help=('A list of usernames')),<br />
    cfg.DictOpt('jobtitles', default=None,<br />
                help=('A dictionary of usernames and job titles')),<br />
    cfg.IntOpt('payday', default=30,<br />
                help=('Default payday monthly date')),<br />
    cfg.FloatOpt('pi', default=0.0,<br />
                help=('The value of Pi'))<br />
]</p>
<p>CONF = cfg.CONF</p>
<p>CONF.register_group(opt_simple_group)<br />
CONF.register_opts(simple_opts, opt_simple_group)</p>
<p>CONF.register_group(opt_morestuff_group)<br />
CONF.register_opts(morestuff_opts, opt_morestuff_group)</p>
<p>if __name__ == "__main__":<br />
    CONF(default_config_files=['app.conf'])<br />
    print('(simple) enable: {}'.format(CONF.simple.enable))<br />
    print('(morestuff) message :{}'.format(CONF.morestuff.message))<br />
    print('(morestuff) usernames: {}'.format(CONF.morestuff.usernames))<br />
    print('(morestuff) jobtitles: {}'.format(CONF.morestuff.jobtitles))<br />
    print('(morestuff) payday: {}'.format(CONF.morestuff.payday))<br />
    print('(morestuff) pi: {}'.format(CONF.morestuff.pi))




1



2



3



4



5



6



7



8



9



10



11



12



13



14



15



16



17



18



19



20



21



22



23



24



25



26



27



28



29



30



31



32



33



34



35



36



37



38



39



40



41



42



43



44



45



from __future__ import print_function



from oslo . config import cfg









opt_simple_group = cfg . OptGroup ( name = 'simple' ,



                         title = 'A Simple Example' )






opt_morestuff_group = cfg . OptGroup ( name = 'morestuff' ,



                         title = 'A More Complex Example' )






simple_opts = [



     cfg . BoolOpt ( 'enable' , default = False ,



                 help = ( 'True enables, False disables' ) )



]






morestuff_opts = [



     cfg . StrOpt ( 'message' , default = 'No data' ,



               help = ( 'A message' ) ) ,



     cfg . ListOpt ( 'usernames' , default = None ,



                 help = ( 'A list of usernames' ) ) ,



     cfg . DictOpt ( 'jobtitles' , default = None ,



                 help = ( 'A dictionary of usernames and job titles' ) ) ,



     cfg . IntOpt ( 'payday' , default = 30 ,



                 help = ( 'Default payday monthly date' ) ) ,



     cfg . FloatOpt ( 'pi' , default = 0.0 ,



                 help = ( 'The value of Pi' ) )



]






CONF = cfg . CONF






CONF . register_group ( opt_simple_group )



CONF . register_opts ( simple_opts , opt_simple_group )






CONF . register_group ( opt_morestuff_group )



CONF . register_opts ( morestuff_opts , opt_morestuff_group )









if __name__ == "__main__" :



     CONF ( default_config_files = [ 'app.conf' ] )



     print ( '(simple) enable: {}' . format ( CONF . simple . enable ) )



     print ( '(morestuff) message :{}' . format ( CONF . morestuff . message ) )



     print ( '(morestuff) usernames: {}' . format ( CONF . morestuff . usernames ) )



     print ( '(morestuff) jobtitles: {}' . format ( CONF . morestuff . jobtitles ) )



     print ( '(morestuff) payday: {}' . format ( CONF . morestuff . payday ) )



     print ( '(morestuff) pi: {}' . format ( CONF . morestuff . pi ) )



完成之后，运行app.py文件。可以查看到相关输出。

回到RYU中，之前一篇博客介绍了Ryu的main函数。在ryu/ryu/cmd/manager.py文件中我们可以看到如下的代码：


CONF.register_cli_opts([<br />
    cfg.ListOpt('app-lists', default=[],<br />
                help='application module name to run'),<br />
    cfg.MultiStrOpt('app', positional=True, default=[],<br />
                    help='application module name to run'),<br />
    cfg.StrOpt('pid-file', default=None, help='pid file name'),<br />
])




1



2



3



4



5



6



7



CONF . register_cli_opts ( [



     cfg . ListOpt ( 'app-lists' , default = [ ] ,



                 help = 'application module name to run' ) ,



     cfg . MultiStrOpt ( 'app' , positional = True , default = [ ] ,



                     help = 'application module name to run' ) ,



     cfg . StrOpt ( 'pid-file' , default = None , help = 'pid file name' ) ,



] )



以上的注册了三个Option，其中的app-lists和app参数是运行ryu-manager时的参数，即APP的名称。在以下的main函数中，我们可以看到首先获取了输入的参数，若参数为空，则默认开启ofp_handler应用。


def main(args=None, prog=None):<br />
    try:<br />
        CONF(args=args, prog=prog,<br />
             project='ryu', version='ryu-manager %s' % version,<br />
             default_config_files=['/usr/local/etc/ryu/ryu.conf'])<br />
    except cfg.ConfigFilesNotFoundError:<br />
        CONF(args=args, prog=prog,<br />
             project='ryu', version='ryu-manager %s' % version)</p>
<p>    log.init_log()</p>
<p>    if CONF.pid_file:<br />
        import os<br />
        with open(CONF.pid_file, 'w') as pid_file:<br />
            pid_file.write(str(os.getpid()))</p>
<p>    app_lists = CONF.app_lists + CONF.app<br />
    # keep old behaivor, run ofp if no application is specified.<br />
    if not app_lists:<br />
        app_lists = ['ryu.controller.ofp_handler']




1



2



3



4



5



6



7



8



9



10



11



12



13



14



15



16



17



18



19



20



def main ( args = None , prog = None ) :



     try :



         CONF ( args = args , prog = prog ,



             project = 'ryu' , version = 'ryu-manager %s' % version ,



             default_config_files = [ '/usr/local/etc/ryu/ryu.conf' ] )



     except cfg . ConfigFilesNotFoundError :



         CONF ( args = args , prog = prog ,



             project = 'ryu' , version = 'ryu-manager %s' % version )






     log . init_log ( )






     if CONF . pid_file :



         import os



         with open ( CONF . pid_file , 'w' ) as pid_file :



             pid_file . write ( str ( os . getpid ( ) ) )






     app_lists = CONF . app_lists + CONF . app



     # keep old behaivor, run ofp if no application is specified.



     if not app_lists :



         app_lists = [ 'ryu.controller.ofp_handler' ]



oslo模块使用能够使得整个工程的不同模块可以使用同一个配置文件，从而减少了命令冲突的可能，此外，oslo提供的模板，可以让命令解析更方便。oslo模块以此优势被广泛应用与大型项目中，如openstack。

Argparse

oslo模块中使用了argparse。argparse是python标准库中的模块。以下以一个简单例子介绍此模块，更详细的中文教程，可以查看​​《Python中的命令行解析工具介绍》​​。

在argparse模块中定义了ArgumentParser类。我们可以调用该类的add_argument函数添加参数。其函数说明如下：


ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])




1



ArgumentParser . add_argument ( name or flags . . . [ , action ] [ , nargs ] [ , const ] [ , default ] [ , type ] [ , choices ] [ , required ] [ , help ] [ , metavar ] [ , dest ] )



从以上说明可以看出，add_argument函数可以添加action, type, choices，help等重要的属性。具体参数解释，引用自《Python中的命令行解析工具介绍》如下：

  • name or flags - 参数的名字.
  • action - 遇到参数时的动作，默认值是store。storeconst，表示赋值为const；append，将遇到的值存储成列表，也就是如果参数重复则会保存多个值; appendconst，将参数规范中定义的一个值保存到一个列表；
  • count，存储遇到的次数；此外，也可以继承argparse.Action自定义参数解析；
  • nargs - 参数的个数，可以是具体的数字，或者是?号，当不指定值时对于Positional argument使用default，对于Optional argument使用const；或者是*号，表示0或多个参数；或者是+号表示1或多个参数.
  • const - action和nargs所需要的常量值.
  • default - 不指定参数时的默认值.
  • type - 参数的类型.
  • choices - 参数允许的值.
  • required - 可选参数是否可以省略(仅针对optionals).
  • help - 参数的帮助信息，当指定为argparse.SUPPRESS时表示不显示该参数的帮助信息.
  • metavar - 在usage说明中的参数名称，对于必选参数默认就是参数名称，对于可选参数默认是全大写的参数名称.
  • dest - 解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线.

使用案例举例如下：


#filename:prog.py<br />
import argparse<br />
parser = argparse.ArgumentParser()</p>
<p># parser.add_argument("echo", help="Print the arguments.")</p>
<p>parser.add_argument("-v", "--verbosity", default=0,<br />
                    action="count", help="increase output verbosity.")<br />
parser.add_argument("x", type=int, help="the base")<br />
parser.add_argument("y", type=int, help="the exponent")</p>
<p>#parser.add_argument("square", help="Return square of given number.", type=int)</p>
<p>args = parser.parse_args()<br />
answer = args.x**args.y</p>
<p>if args.verbosity >= 2:<br />
    print "{} to the power {} equals {}".format(args.x, args.y, answer)<br />
elif args.verbosity >= 1:<br />
    print "{}^{} =={}".format(args.x, args.y, answer)<br />
else:<br />
    print answer




1



2



3



4



5



6



7



8



9



10



11



12



13



14



15



16



17



18



19



20



21



22



#filename:prog.py



import argparse



parser = argparse . ArgumentParser ( )






# parser.add_argument("echo", help="Print the arguments.")






parser . add_argument ( "-v" , "--verbosity" , default = 0 ,



                     action = "count" , help = "increase output verbosity." )



parser . add_argument ( "x" , type = int , help = "the base" )



parser . add_argument ( "y" , type = int , help = "the exponent" )






#parser.add_argument("square", help="Return square of given number.", type=int)






args = parser . parse_args ( )



answer = args . x * * args . y






if args . verbosity >= 2 :



     print "{} to the power {} equals {}" . format ( args . x , args . y , answer )



elif args . verbosity >= 1 :



     print "{}^{} =={}" . format ( args . x , args . y , answer )



else :



     print answer



可以通过一下命令运行prog.py去查看到相关信息：








Shell



python prog.py -h<br />
python prog.py<br />
python prog.py  2 5 -v<br />
python prog.py  2 5 -vv




1



2



3



4



python prog .py - h



python prog .py



python prog .py    2 5 - v



python prog .py    2 5 - vv



查看原文：​​http://www.zoues.com/index.php/2015/08/25/oslo-config/​​

举报

相关推荐

oslo_messaging学习小结

服务器linux数据库

config命令(config命令汇总)

搜索编程语言

Config

vscodeide编辑器

Machine.Config 和 Web.Config

应用程序配置文件.net编程语言

mongodb config

小程序

config配置

重启配置项XMLJava后端开发

git config

git环境变量当前用户Linux系统/运维

2.2 、spring boot项目配置中心config config 、

CASSOSconfigspringmaven编程语言

SpringCloud: config server

springxmlapache编程语言

config配置中心

spring配置文件服务端编程语言
0 条评论