accounts package

Subpackages

Submodules

accounts.admin module

accounts.apps module

class accounts.apps.AccountsConfig(app_name, app_module)

Bases: AppConfig

default_auto_field = 'django.db.models.BigAutoField'

name = 'accounts'

accounts.models module

class accounts.models.User(id, password, last_login, is_superuser, username, first_name, last_name, is_staff, is_active, date_joined, email, phone_number, gstin, company_name, address, user_role)

Bases: AbstractUser

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

USER_ROLE_CHOICES = [('procurement_officer', 'Procurement Officer'), ('vendor', 'Vendor')]

address

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

company_name

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

date_joined

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

email

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

first_name

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_next_by_date_joined(*, field=<django.db.models.fields.DateTimeField: date_joined>, is_next=True, **kwargs)

get_previous_by_date_joined(*, field=<django.db.models.fields.DateTimeField: date_joined>, is_next=False, **kwargs)

get_user_role_display(*, field=<django.db.models.fields.CharField: user_role>)

groups

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

gstin

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

gstin_validator = <django.core.validators.RegexValidator object>

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

inventory_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

is_active

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_staff

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_superuser

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

last_login

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

last_name

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

logentry_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

outstandingtoken_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

password

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

phone_number

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

phone_number_regex = <django.core.validators.RegexValidator object>

supplierbid_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

user_permissions

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

user_role

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

username

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

vendor

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

class accounts.models.Vendor(id, vendor_certified, vendor_type, contract_expiry_date, vendor_rating, total_ratings, user)

Bases: Model

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

VENDOR_TYPE_CHOICES = [('supplier', 'Supplier'), ('manufacturer', 'Manufacturer'), ('service_provider', 'Service Provider')]

contract_expiry_date

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_next_by_contract_expiry_date(*, field=<django.db.models.fields.DateField: contract_expiry_date>, is_next=True, **kwargs)

get_previous_by_contract_expiry_date(*, field=<django.db.models.fields.DateField: contract_expiry_date>, is_next=False, **kwargs)

get_vendor_type_display(*, field=<django.db.models.fields.CharField: vendor_type>)

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

total_ratings

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

user

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

user_id

vendor_certified

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

vendor_rating

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

vendor_type

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

accounts.permissions module

class accounts.permissions.IsProcurementOfficer

Bases: BasePermission

has_permission(request, view)

Return True if permission is granted, False otherwise.

class accounts.permissions.IsVendor

Bases: BasePermission

has_permission(request, view)

Return True if permission is granted, False otherwise.

accounts.serializers module

class accounts.serializers.ChangePasswordSerializer(*args, **kwargs)

Bases: Serializer

update(instance, validated_data)

validate(attrs)

validate_old_password(value)

class accounts.serializers.MyTokenObtainPairSerializer(*args, **kwargs)

Bases: TokenObtainPairSerializer

classmethod get_token(user)

class accounts.serializers.PasswordResetConfirmSerializer(*args, **kwargs)

Bases: Serializer

validate(value)

class accounts.serializers.PasswordResetSerializer(*args, **kwargs)

Bases: Serializer

validate_email(value)

class accounts.serializers.ProcurementOfficerRegisterSerializer(*args, **kwargs)

Bases: ModelSerializer

class Meta

Bases: object

fields = ('first_name', 'last_name', 'username', 'email', 'phone_number', 'gstin', 'company_name', 'address', 'password1', 'password2')

model

alias of User

create(validated_data)

We have a bit of extra checking around this in order to provide descriptive messages when something goes wrong, but this method is essentially just:

return ExampleModel.objects.create(**validated_data)

If there are many to many fields present on the instance then they cannot be set until the model is instantiated, in which case the implementation is like so:

example_relationship = validated_data.pop(‘example_relationship’) instance = ExampleModel.objects.create(**validated_data) instance.example_relationship = example_relationship return instance

The default implementation also does not handle nested relationships. If you want to support writable nested relationships you’ll need to write an explicit .create() method.

validate(attrs)

class accounts.serializers.ProfileSerializer(*args, **kwargs)

Bases: ModelSerializer

class Meta

Bases: object

fields = ('first_name', 'last_name', 'username', 'email', 'phone_number', 'gstin', 'company_name', 'address', 'vendor')

model

alias of User

to_representation(instance)

Object instance -> Dict of primitive datatypes.

update(instance, validated_data)

class accounts.serializers.VendorInfoSerializer(*args, **kwargs)

Bases: ModelSerializer

class Meta

Bases: object

fields = ('vendor_certified', 'vendor_type')

model

alias of Vendor

class accounts.serializers.VendorRegisterSerializer(*args, **kwargs)

Bases: ModelSerializer

class Meta

Bases: object

fields = ('first_name', 'last_name', 'username', 'email', 'phone_number', 'gstin', 'company_name', 'address', 'password1', 'password2', 'vendor_info')

model

alias of User

create(validated_data)

We have a bit of extra checking around this in order to provide descriptive messages when something goes wrong, but this method is essentially just:

return ExampleModel.objects.create(**validated_data)

If there are many to many fields present on the instance then they cannot be set until the model is instantiated, in which case the implementation is like so:

example_relationship = validated_data.pop(‘example_relationship’) instance = ExampleModel.objects.create(**validated_data) instance.example_relationship = example_relationship return instance

The default implementation also does not handle nested relationships. If you want to support writable nested relationships you’ll need to write an explicit .create() method.

validate(attrs)

class accounts.serializers.VendorSerializer(*args, **kwargs)

Bases: ModelSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of Vendor

accounts.tasks module

accounts.tests module

class accounts.tests.ChangePasswordViewTests(methodName='runTest')

Bases: SetUpUsers, APITestCase

setUp()

Hook method for setting up the test fixture before exercising it.

test_change_password_successfully()

test_change_password_unauthenticated()

test_change_password_with_invalid_http_authorization_header()

test_change_password_with_invalid_http_method()

test_change_password_with_invalid_old_password()

test_change_password_with_invalid_payload()

test_change_password_with_mismatched_passwords()

test_change_password_without_providing_old_password()

class accounts.tests.PasswordResetConfirmViewTests(methodName='runTest')

Bases: APITestCase

setUp()

Hook method for setting up the test fixture before exercising it.

test_password_reset_confirm_successful()

test_password_reset_confirm_with_authenticated_user()

test_password_reset_confirm_with_invalid_http_method()

test_password_reset_confirm_with_invalid_payload()

test_password_reset_confirm_with_invalid_token()

test_password_reset_confirm_with_invalid_user()

test_password_reset_confirm_with_mismatched_passwords()

class accounts.tests.PasswordResetViewTests(methodName='runTest')

Bases: SetUpUsers, APITestCase

setUp()

Hook method for setting up the test fixture before exercising it.

test_password_reset_successful()

test_password_reset_with_authenticated_user()

test_password_reset_with_invalid_email()

test_password_reset_with_invalid_http_method()

test_password_reset_with_invalid_payload()

test_password_reset_with_missing_email()

test_password_reset_with_unregistered_email()

class accounts.tests.ProcurementOfficerRegisterViewTests(methodName='runTest')

Bases: APITestCase

setUp()

Hook method for setting up the test fixture before exercising it.

test_register_procurement_officer_user()

test_register_user_with_authenticated_user()

test_register_user_with_existing_email()

test_register_user_with_existing_gstin()

test_register_user_with_existing_username()

test_register_user_with_invalid_email()

test_register_user_with_invalid_gstin()

test_register_user_with_invalid_http_method()

test_register_user_with_invalid_payload()

test_register_user_with_invalid_phone_number()

test_register_user_with_password_mismatch()

class accounts.tests.SetUpUsers(methodName='runTest')

Bases: APITestCase

setUp()

Hook method for setting up the test fixture before exercising it.

class accounts.tests.TokenViewTests(methodName='runTest')

Bases: SetUpUsers, APITestCase

setUp()

Hook method for setting up the test fixture before exercising it.

test_obtain_token()

test_obtain_token_with_invalid_credentials()

test_obtain_token_with_missing_credentials()

test_refresh_token()

test_refresh_token_which_was_used_previously()

test_refresh_token_with_blacklisted_token()

test_refresh_token_with_expired_token()

test_refresh_token_with_invalid_token()

class accounts.tests.UserProfileViewTests(methodName='runTest')

Bases: SetUpUsers

setUp()

Hook method for setting up the test fixture before exercising it.

test_delete_procurement_officer_profile()

test_delete_user_profile_unauthenticated()

test_delete_vendor_profile()

test_get_procurement_officer_profile()

test_get_user_profile_unauthenticated()

test_get_vendor_profile()

test_update_procurement_officer_profile()

test_update_user_profile_unauthenticated()

test_update_vendor_profile()

class accounts.tests.VendorListViewTests(methodName='runTest')

Bases: APITestCase

setUp()

Hook method for setting up the test fixture before exercising it.

test_insufficient_permissions_vendor()

test_no_vendors()

test_sufficient_permissions_admin()

test_sufficient_permissions_procurement_officer()

test_vendor_list()

class accounts.tests.VendorRegisterViewTests(methodName='runTest')

Bases: APITestCase

setUp()

Hook method for setting up the test fixture before exercising it.

test_register_user_with_authenticated_user()

test_register_user_with_existing_email()

test_register_user_with_existing_gstin()

test_register_user_with_existing_username()

test_register_user_with_invalid_email()

test_register_user_with_invalid_gstin()

test_register_user_with_invalid_http_method()

test_register_user_with_invalid_payload()

test_register_user_with_invalid_phone_number()

test_register_user_with_password_mismatch()

test_register_vendor_user()

accounts.urls module

accounts.views module

class accounts.views.ChangePasswordView(**kwargs)

Bases: UpdateAPIView

get_object()

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.

queryset = <QuerySet [<User: sahil>, <User: admin>]>

serializer_class

alias of ChangePasswordSerializer

update(request, *args, **kwargs)

class accounts.views.DeleteUserProfileView(**kwargs)

Bases: DestroyAPIView

fields = '__all__'

get_object()

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.

model

alias of User

permission_classes = [<rest_framework.permissions.OperandHolder object>]

queryset = <QuerySet [<User: sahil>, <User: admin>]>

serializer_class

alias of ModelSerializer

class accounts.views.MyTokenObtainPairView(**kwargs)

Bases: TokenObtainPairView

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

serializer_class

alias of MyTokenObtainPairSerializer

class accounts.views.MyTokenRefreshView(**kwargs)

Bases: TokenRefreshView

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

class accounts.views.PasswordResetConfirmView(**kwargs)

Bases: UpdateAPIView

get_object()

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.

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

serializer_class

alias of PasswordResetConfirmSerializer

update(request, *args, **kwargs)

class accounts.views.PasswordResetView(**kwargs)

Bases: CreateAPIView

create(request, *args, **kwargs)

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

serializer_class

alias of PasswordResetSerializer

class accounts.views.ProcurementOfficerRegisterView(**kwargs)

Bases: CreateAPIView

perform_create(serializer)

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

queryset = <QuerySet [<User: sahil>, <User: admin>]>

serializer_class

alias of ProcurementOfficerRegisterSerializer

class accounts.views.UpdateUserProfileView(**kwargs)

Bases: UpdateAPIView

get_object()

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.

queryset = <QuerySet [<User: sahil>, <User: admin>]>

serializer_class

alias of ProfileSerializer

update(request, *args, **kwargs)

class accounts.views.UserProfileView(**kwargs)

Bases: RetrieveAPIView

get_object()

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.

queryset = <QuerySet [<User: sahil>, <User: admin>]>

serializer_class

alias of ProfileSerializer

class accounts.views.VendorRegisterView(**kwargs)

Bases: CreateAPIView

perform_create(serializer)

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

queryset = <QuerySet [<User: sahil>, <User: admin>]>

serializer_class

alias of VendorRegisterSerializer

class accounts.views.VendorView(**kwargs)

Bases: ListAPIView

permission_classes = [<class 'rest_framework.permissions.IsAuthenticated'>, <rest_framework.permissions.OperandHolder object>]

queryset = <QuerySet []>

serializer_class

alias of VendorSerializer

accounts.views.getRoutes(request, *args, **kwargs)

Module contents