User

User views for smarter api.

smarter.apps.account.api.v1.views.user.USER_CREATE_FIELDS = ('username', 'password', 'email', 'first_name', 'last_name')

The fields of a new user that the request body may set.

('username', 'password', 'email', 'first_name', 'last_name')

smarter.apps.account.api.v1.views.user.USER_UPDATE_FIELDS = ('username', 'email', 'first_name', 'last_name', 'is_active')

The fields of a user that the request body may update.

('username', 'email', 'first_name', 'last_name', 'is_active')

class smarter.apps.account.api.v1.views.user.UserListView(*args, **kwargs)

Bases: AccountListViewBase

User list view for smarter api.

get(request, *args, **kwargs)

Handle GET requests to retrieve the list of users.

get_list(request)

Get a list of all users the requesting user has access to, as AccountApiUserDetail models.

get_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)

post(request, *args, **kwargs)

Handle POST requests to create a new user.

serializer_class

alias of UserSerializer

setup(request, *args, **kwargs)

Setup the view.

This is called by Django before dispatch() and is used to initialize attributes that require the request object.

class smarter.apps.account.api.v1.views.user.UserView(*args, **kwargs)

Bases: AccountViewBase

User view for smarter api.

delete(request, user_id)

get(request, user_id)

handle_exception(exc)

Handle any exception that occurs, by returning an appropriate response, or re-raising the error.

patch(request, user_id)

post(request, user_id=None)

smarter.apps.account.api.v1.views.user.create_user(request)

Create an account from a json representation in the body of the request.

smarter.apps.account.api.v1.views.user.delete_user(request, user_id=None)

Delete a user by id.

smarter.apps.account.api.v1.views.user.eval_permissions(request, user_to_update, user_to_update_profile=None)

smarter.apps.account.api.v1.views.user.get_user(request, user_id=None)

Get a user’s json representation, an AccountApiUserDetail, by id.

smarter.apps.account.api.v1.views.user.get_user_for_operation(request, user_id)

Return type:

tuple[User, UserProfile] | JsonResponse

smarter.apps.account.api.v1.views.user.update_user(request, user_id)

Update an account from a json representation in the body of the request.

smarter.apps.account.api.v1.views.user.user_response(user)

The response of a user: its AccountApiUserDetail.

Parameters:

user (django.contrib.auth.models.User) – The user.

Returns:

The response.

Return type:

Response

smarter.apps.account.api.v1.views.user.validate_request_body(request)