Coverage for src/kwai/modules/identity/users/user_repository.py: 100%

1"""Module that defines the interface for a user repository.""" 

2 

3from abc import ABC, abstractmethod 

4 

5from kwai.core.domain.value_objects.email_address import EmailAddress 

6from kwai.core.domain.value_objects.unique_id import UniqueId 

7from kwai.modules.identity.users.user import UserEntity, UserIdentifier 

8 

9 

10class UserNotFoundException(Exception): 

11 """Raised when a user could not be found.""" 

12 

13 

14class UserRepository(ABC): 

15 """A user repository interface.""" 

16 

17 @abstractmethod 

18 async def get_user_by_id(self, id_: UserIdentifier) -> UserEntity: 

19 """Get a user using the id.""" 

20 raise NotImplementedError 

21 

22 @abstractmethod 

23 async def get_user_by_uuid(self, uuid: UniqueId) -> UserEntity: 

24 """Get a user using the unique id.""" 

25 raise NotImplementedError 

26 

27 @abstractmethod 

28 async def get_user_by_email(self, email: EmailAddress) -> UserEntity: 

29 """Get a user using his/her email address.""" 

30 raise NotImplementedError 

31 

32 @abstractmethod 

33 async def update(self, user: UserEntity) -> None: 

34 """Update an existing user entity.""" 

35 raise NotImplementedError