# -*- 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 #
###########################################################################
"""Backend user"""
from __future__ import division
from __future__ import print_function
from __future__ import absolute_import
import abc
import six
from . import backends
__all__ = ('BackendUser', 'BackendUserCollection')
[docs]@six.add_metaclass(abc.ABCMeta)
class BackendUser(backends.BackendEntity):
"""
This is the base class for User information in AiiDA. An implementing
backend needs to provide a concrete version.
"""
# pylint: disable=invalid-name
REQUIRED_FIELDS = ['first_name', 'last_name', 'institution']
@property
def uuid(self):
"""
For now users do not have UUIDs so always return false
:return: None
"""
return None
@abc.abstractproperty
def email(self):
"""
Get the email address of the user
:return: the email address
"""
@abc.abstractmethod
@email.setter
def email(self, val):
"""
Set the email address of the user
:param val: the new email address
"""
[docs] @abc.abstractmethod
def get_password(self):
"""
Get the password for the user
:return: the password
"""
[docs] @abc.abstractmethod
def set_password(self, new_pass):
"""
Set the password of the user
:param new_pass: the new password
"""
@abc.abstractproperty
def first_name(self):
"""
Get the user's first name
:return: the first name
:rtype: str
"""
@abc.abstractmethod
@first_name.setter
def first_name(self, val):
"""
Set the user's first name
:param val: the new first name
"""
@abc.abstractproperty
def last_name(self):
"""
Get the user's last name
:return: the last name
:rtype: str
"""
@abc.abstractmethod
@last_name.setter
def last_name(self, val):
"""
Set the user's last name
:param val: the new last name
:type val: str
"""
@abc.abstractproperty
def institution(self):
"""
Get the user's institution
:return: the institution
:rtype: str
"""
@abc.abstractmethod
@institution.setter
def institution(self, val):
"""
Set the user's institution
:param val: the new institution
"""
@abc.abstractproperty
def is_active(self):
pass
@abc.abstractmethod
@is_active.setter
def is_active(self, val):
pass
@abc.abstractproperty
def last_login(self):
pass
@abc.abstractmethod
@last_login.setter
def last_login(self, val):
pass
@abc.abstractproperty
def date_joined(self):
pass
@abc.abstractmethod
@date_joined.setter
def date_joined(self, val):
pass
[docs]class BackendUserCollection(backends.BackendCollection[BackendUser]):
# pylint: disable=too-few-public-methods
ENTITY_CLASS = BackendUser