username_tools package

Submodules

username_tools.admin module

class username_tools.admin.UsernameBlacklistAdmin(model, admin_site)

Bases: django.contrib.admin.options.ModelAdmin

list_display = ('username', 'is_blocked')

list_filter = ('is_blocked',)

media

username_tools.apps module

class username_tools.apps.UsernameToolsConfig(app_name, app_module)

Bases: django.apps.config.AppConfig

name = 'username_tools'

username_tools.blacklist module

username_tools.fields module

class username_tools.fields.UsernameFormField(*args, **kwargs)

Bases: django.forms.fields.CharField

A forms.CharField subclass that comes with validation for blacklisted usernames.

__init__(*args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

to_python(value)

Return a string.

class username_tools.fields.UsernameModelField(*args, **kwargs)

Bases: django.db.models.fields.CharField

A models.CharField subclass that comes with validation for blacklisted usernames.

__init__(*args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

default_error_messages = {'unique': 'A user with that username already exists.'}

default_validators = [<django.contrib.auth.validators.UnicodeUsernameValidator object>]

formfield(**kwargs)

Return a django.forms.Field instance for this field.

username_tools.models module

class username_tools.models.UsernameBlacklist(id, username, is_blocked)

Bases: django.db.models.base.Model

Parameters:

• id (AutoField) – Id
• username (CharField) – Username to black list
• is_blocked (BooleanField) – Set this to False if you need to whitelist this username but don’t want to delete it. This also ensures that a whitelisted username will stay whitelisted when re-populating using the populate manager method.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

id

Model field: ID

is_blocked

Model field: is blocked

objects = <username_tools.models.UsernameBlacklistManager object>

username

Model field: username

class username_tools.models.UsernameBlacklistManager

Bases: django.db.models.manager.Manager

blacklisted(*args, **kwargs)

is_blacklisted(username)

populate()

Populate database from file.

Set reset to True if you want to update those that you have modified.

username_tools.settings module

username_tools.utils module

username_tools.utils.blacklist_model()

username_tools.utils.is_blacklisted(value)

Module contents