# -*- coding: utf-8 -*- ########################################################################### # Copyright (c), The AiiDA team. All rights reserved. # # This file is part of the AiiDA code. # # # # The code is hosted on GitHub at https://github.com/aiidateam/aiida-core # # For further information on the license, see the LICENSE.txt file # # For further information please visit http://www.aiida.net # ########################################################################### """ .. py:module::conditional :synopsis: Tools for options which are required only if a a set of conditions on the context are fulfilled """ import click [docs]class ConditionalOption(click.Option): """ This cli option takes an additional callable parameter and uses that to determine wether a MissingParam should be raised if the option is not given on the cli. The callable takes the context as an argument and can look up any amount of other parameter values etc. :param required_fn: callable(ctx) -> True | False, returns True if the parameter is required to have a value. This is typically used when the condition depends on other parameters specified on the command line. """ [docs] def __init__(self, param_decls=None, required_fn=None, **kwargs): # note default behaviour for required: False self.required_fn = required_fn # Required_fn overrides 'required', if defined if required_fn is not None: # There is a required_fn self.required = False # So it does not show up as 'required' super().__init__(param_decls=param_decls, **kwargs) [docs] def full_process_value(self, ctx, value): try: value = super().full_process_value(ctx, value) if self.required_fn and self.value_is_missing(value): if self.is_required(ctx): raise click.MissingParameter(ctx=ctx, param=self) except click.MissingParameter: if self.is_required(ctx): raise return value [docs] def is_required(self, ctx): """runs the given check on the context to determine requiredness""" if self.required_fn: return self.required_fn(ctx) return self.required