Users Api

exception api.users.exceptions.AlreadyFollowingUserAPIException(detail=None, code=None)

Bases: APIException

API Exception to be raised when a user attempts to follow a user that they are already following.

default_code = 'already_following_user'

default_detail = 'You are already following this user.'

status_code = 400

exception api.users.exceptions.NotFollowingUserAPIException(detail=None, code=None)

Bases: APIException

API Exception to be raised when a user attempts to unfollow a user that they are not following.

default_code = 'not_following_user'

default_detail = "You are not following to this user, so you can't unsubscribe from them."

status_code = 400

class api.users.serializers.AccessRefreshTokensDTOSerializer(*args, **kwargs)

Bases: DataclassSerializer

class api.users.serializers.AuthorCommentSerializer(*args, **kwargs)

Bases: ModelSerializer

Author serializer for comment

class api.users.serializers.CategorySerializer(*args, **kwargs)

Bases: ModelSerializer

class api.users.serializers.ConfirmEmailSerializer(*args, **kwargs)

Bases: BaseUserActivationSerializer

to_internal_value(data)

Dict of native values <- Dict of primitive datatypes.

validate(attrs: Dict) → Dict

class api.users.serializers.ConfirmPasswordSerializer(*args, **kwargs)

Bases: ConfirmEmailSerializer, UserChangePasswordSerializer

validate(attrs: Dict) → Dict

class api.users.serializers.CreateTokenDocsBodySerializer(*args, **kwargs)

Bases: Serializer

class api.users.serializers.CreateTokenDocsResponseSerializer(*args, **kwargs)

Bases: Serializer

class api.users.serializers.CustomTokenObtainPairSerializer(*args, **kwargs)

Bases: TokenObtainPairSerializer

class api.users.serializers.CustomTokenRefreshSerializer(*args, **kwargs)

Bases: TokenRefreshSerializer

class api.users.serializers.ExtendedUserSerializer(*args, **kwargs)

Bases: UserSerializer

class api.users.serializers.FollowingAndFollowersUserSerializer(*args, **kwargs)

Bases: UserSerializer

class api.users.serializers.FollowingUserSerializer(*args, **kwargs)

Bases: UserSerializer

class api.users.serializers.ProfileSerializer(*args, **kwargs)

Bases: ModelSerializer

class api.users.serializers.RefreshTokenDocsBodySerializer(*args, **kwargs)

Bases: Serializer

class api.users.serializers.RefreshTokenDocsResponseSerializer(*args, **kwargs)

Bases: Serializer

class api.users.serializers.ResendUserActivationCodeSerializer(*args, **kwargs)

Bases: EmailValidationMixin, Serializer

validate_email(value: str) → str

class api.users.serializers.SenderNotificationSerializer(*args, **kwargs)

Bases: ModelSerializer

Serializer for sender

class api.users.serializers.UserActivationSerializer(*args, **kwargs)

Bases: BaseUserActivationSerializer

to_internal_value(data)

Dict of native values <- Dict of primitive datatypes.

validate(attrs: Dict) → Dict

class api.users.serializers.UserChangePasswordSerializer(*args, **kwargs)

Bases: PasswordMatchValidationMixin, Serializer

validate_password(value)

class api.users.serializers.UserResetPassword(*args, **kwargs)

Bases: EmailValidationMixin, Serializer

class api.users.serializers.UserSerializer(*args, **kwargs)

Bases: PasswordMatchValidationMixin, ModelSerializer

__init__(*args: Any, **kwargs: Any) → None

get_fields()

Return the dict of field names -> field instances that should be used for self.fields when instantiating the serializer.

to_representation(instance)

Object instance -> Dict of primitive datatypes.

update(instance, validated_data)

validate_password(value)

class api.users.views.FollowersAPIViewSet(**kwargs)

Bases: GenericViewSet

basename = None

description = None

detail = None

filter_backends = [<class 'rest_framework.filters.SearchFilter'>]

follow(request, pk=None)

followers_list(request, pk=None)

following_list(request, pk=None)

get_object() → User | None

Returns the object the view is displaying.

You may want to override this if you need to provide non-standard queryset lookups. Eg if objects are referenced using multiple keyword arguments in the url conf.

http_method_names = ['get', 'post']

list(request, return_followers: bool = True, *args, **kwargs)

name = None

permission_classes = [<class 'rest_framework.permissions.IsAuthenticatedOrReadOnly'>]

queryset = NotDeletedQuerySet

search_fields = ['username', 'first_name', 'last_name']

serializer_class

alias of UserSerializer

service

alias of UsersService

subtag = 'followers'

suffix = None

tags = ['Users [authorized]']

unfollow(request, pk=None)

class api.users.views.InterestsListAPIView(**kwargs)

Bases: ListAPIView

View with interests list

get(request, *args, **kwargs)

http_method_names = ['get']

queryset = QuerySet

serializer_class

alias of CategorySerializer

tags = ['Users [unauthorized]']

class api.users.views.TokenViewSet(**kwargs)

Bases: CustomViewSet

handle_token_response(serializer_class)

http_method_names = ['post']

obtain(request)

permission_classes = [<class 'rest_framework.permissions.AllowAny'>]

refresh(request)

tags = ['Token']

class api.users.views.UsersAuthorizedViewSet(**kwargs)

Bases: CustomModelViewSet

basename = None

description = None

detail = None

export_data(request)

filter_backends = [<class 'api.users.filters.UserElasticsearchFilter'>]

get_object() → AbstractBaseUser | AnonymousUser | None

Returns the object the view is displaying.

You may want to override this if you need to provide non-standard queryset lookups. Eg if objects are referenced using multiple keyword arguments in the url conf.

get_queryset() → QuerySet

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

http_method_names = ['post', 'get', 'put', 'patch', 'delete']

list(request: Request, *args: Any, **kwargs: Any) → Response

name = None

pagination_class

alias of SearchPagination

password_change(request: Request)

perform_destroy(instance: User) → None

permission_classes = [<class 'rest_framework.permissions.IsAuthenticatedOrReadOnly'>]

serializer_class

alias of ExtendedUserSerializer

service

alias of UsersService

suffix = None

tags = ['Users [authorized]']

class api.users.views.UsersUnauthorizedViewSet(**kwargs)

Bases: CustomViewSet

ViewSet with actions for unauthorized users

activate(request, *args: Tuple[Any], **kwargs: Dict)

basename = None

confirm_email(request, *args: Tuple[Any], **kwargs: Dict)

confirm_password(request, *args: Tuple[Any], **kwargs: Dict)

description = None

detail = None

http_method_names = ['post']

name = None

permission_classes = [<class 'rest_framework.permissions.AllowAny'>]

resend_activation_code(request, *args: Tuple[Any], **kwargs: Dict)

reset_password(request, *args: Tuple[Any], **kwargs: Dict)

service

alias of UsersService

signup(request: Request, *args: Tuple[Any], **kwargs: Dict) → Response

suffix = None

tags = ['Users [unauthorized]']

class api.users.filters.UserElasticsearchFilter

Bases: BaseFilterBackend

Filter for performing user search using Elasticsearch. Executes search on username, first_name, and last_name with different weights.

construct_query(search_param)

Constructs a combined Elasticsearch query from various parts.

Parameters:

search_param – The search parameter entered by the user.

Returns:

A combined Elasticsearch query.

filter_queryset(request, queryset, view)

Filters a QuerySet based on the search parameters in the request.

Parameters:

• request – HTTP request object.

• queryset – Initial QuerySet.

• view – The view that calls this method.

Returns:

Updated QuerySet.