Source code for aiida.cmdline.params.types.user

###########################################################################
# 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               #
###########################################################################
"""User param type for click."""
import click

from aiida.cmdline.utils.decorators import with_dbenv

__all__ = ('UserParamType',)


[docs] class UserParamType(click.ParamType): """The user parameter type for click. Can get or create a user.""" name = 'user'
[docs] def __init__(self, create=False): """:param create: If the user does not exist, create a new instance (unstored).""" self._create = create
[docs] @with_dbenv() def convert(self, value, param, ctx): from aiida import orm results = orm.User.collection.find({'email': value}) if not results: if self._create: return orm.User(email=value) self.fail(f"User '{value}' not found", param, ctx) if len(results) > 1: self.fail(f"Multiple users found with email '{value}': {results}") return results[0]
[docs] @with_dbenv() def shell_complete(self, ctx, param, incomplete): """Return possible completions based on an incomplete value :returns: list of tuples of valid entry points (matching incomplete) and a description """ from aiida import orm users = orm.User.collection.find() return [ click.shell_completion.CompletionItem(user.email) for user in users if user.email.startswith(incomplete) ]