代码之家  ›  专栏  ›  技术社区  ›  Christian

如何在单击选项中使用python单击参数(检查文件中是否存在变量)?

  •  3
  • Christian  · 技术社区  · 9 年前

    我想我需要一个自定义回调来评估这个或这些变量是否包含在文件中。然而,我一直在思考如何从回调方法中访问参数。

    import click
    import xarray as xr
    
    def validate_variable(ctx, param, value):
        """Check that requested variable(s) are in netCDF file """
    
        # HOW TO ACCESS ARGUMENT 'tile' ???
    
        with xr.open_dataset(ctx.tile) as ds:
            for v in value:
                if v not in ds.data_vars:
                    raise click.BadParameter('Var %s not in file %s.' % (v, ctx.tile))
    
    EPILOG = 'my script ...'
    
    CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
    
    @click.command(context_settings=CONTEXT_SETTINGS, epilog=EPILOG)
    
    @click.pass_context
    @click.option('--variable', '-v', multiple=True, metavar='VAR', 
                    callback=validate_variable,
                    help='variable to render')
    @click.argument('tile', type=click.File())
    def cli(tile, variable):
        main(tile, variable)
    
    1 回复  |  直到 7 年前
        1
  •  2
  •   Stephen Rauch Afsar Ali    9 年前

    在回调中执行此操作时会遇到问题,因为调用回调的顺序并不保证在调用回调时会计算您需要的所有参数。

    click.Command.make_context() ,并在上下文构建完成后进行验证。

    该函数被传递给一个验证器函数并返回一个自定义 click.Command 班

    def command_validate(validator):
    
        class CustomClass(click.Command):
    
            def make_context(self, *args, **kwargs):
                ctx = super(CustomClass, self).make_context(*args, **kwargs)
                validator(ctx)
                return ctx
    
        return CustomClass
    

    验证器功能

    验证器函数被传递一个上下文,并可以引发一个 click.BadParameter

    def validate_variables(ctx):
        """Check that requested variable(s) are in netCDF file """
    
        value = ctx.params['variable']
        tile = ctx.params['tile']
        with xr.open_dataset(tile) as ds:
            for v in value:
                if v not in ds.data_vars:
                    raise click.BadParameter(
                        'Var %s not in file %s.' % (v, tile), ctx)
    

    使用自定义类:

    要使用自定义类,请传递 command_validate cls 对于命令装饰器,例如:

    @click.command(cls=command_validate(validate_variables), ...OtherOptions...)
    ...Other config...
    
    推荐文章