core package

Subpackages

• core.migrations package
  • Submodules
  • core.migrations.0001_initial module
    • Migration
      • Migration.dependencies
      • Migration.initial
      • Migration.operations
  • Module contents

Submodules

core.admin module

Конфигурация административной панели Django для моделей приложения core. Определяет правила отображения, фильтрации и поиска в панели администратора для документов, комментариев, профилей и системы наказаний.

class core.admin.CommentAdmin(model, admin_site)

Базовые классы: ModelAdmin

Настройка админ-панели для управления комментариями.

list_display = ('id', 'sender', 'receiver', 'document', 'created_at', 'is_read')

list_filter = ('created_at', 'is_read')

property media

search_fields = ('text', 'sender__username', 'receiver__username')

class core.admin.ComplaintAdmin(model, admin_site)

Базовые классы: ModelAdmin

Настройка админ-панели для просмотра и обработки жалоб.

list_display = ('id', 'reported_user', 'reporter', 'reason', 'created_at')

list_filter = ('created_at',)

property media

search_fields = ('reported_user__username', 'reporter__username', 'reason')

class core.admin.DocumentAdmin(model, admin_site)

Базовые классы: ModelAdmin

Настройка админ-панели для управления документами.

list_display = ('id', 'title', 'doc_type', 'owner', 'created_at', 'updated_at')

list_filter = ('doc_type', 'created_at')

property media

search_fields = ('title', 'owner__username')

class core.admin.PasswordResetCodeAdmin(model, admin_site)

Базовые классы: ModelAdmin

Настройка админ-панели для отслеживания кодов восстановления паролей.

list_display = ('id', 'user', 'code', 'created_at')

property media

search_fields = ('user__username', 'code')

class core.admin.ProfileAdmin(model, admin_site)

Базовые классы: ModelAdmin

Настройка админ-панели для управления профилями и аватарами пользователей.

list_display = ('id', 'user', 'avatar')

property media

search_fields = ('user__username',)

class core.admin.UserPunishmentAdmin(model, admin_site)

Базовые классы: ModelAdmin

Настройка админ-панели для управления банами и мутами пользователей.

list_display = ('id', 'user', 'reports_count', 'is_banned', 'muted_until')

list_filter = ('is_banned',)

property media

search_fields = ('user__username',)

core.apps module

Модуль конфигурации приложения core (apps.py). Используется Django для инициализации и настройки системных параметров приложения.

class core.apps.CoreConfig(app_name, app_module)

Базовые классы: AppConfig

Класс конфигурации приложения Django Core.

name = 'core'

core.forms module

Формы аутентификации и регистрации пользователей (forms.py). Содержат кастомную валидацию безопасности, включая проверку паролей и алгоритм оценки схожести юзернеймов для защиты от фишинга.

class core.forms.LoginForm(request=None, *args, **kwargs)

Базовые классы: AuthenticationForm

Форма авторизации пользователей с применением стилей Bootstrap классов.

base_fields = {'password': <django.forms.fields.CharField object>, 'username': <django.forms.fields.CharField object>}

declared_fields = {'password': <django.forms.fields.CharField object>, 'username': <django.forms.fields.CharField object>}

property media

Return all media required to render the widgets on this form.

class core.forms.RegisterForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None, renderer=None, bound_field_class=None)

Базовые классы: Form

Форма регистрации нового аккаунта с продвинутыми проверками безопасности.

base_fields = {'email': <django.forms.fields.EmailField object>, 'password': <django.forms.fields.CharField object>, 'password2': <django.forms.fields.CharField object>, 'username': <django.forms.fields.CharField object>}

clean()

Общая проверка формы. Убеждается, что основной и повторный пароли совпадают.

clean_username()

Кастомная валидация юзернейма. Запрещает регистрацию имён, которые похожи на уже существующие более чем на 80% (дистанция Левенштейна / SequenceMatcher).

declared_fields = {'email': <django.forms.fields.EmailField object>, 'password': <django.forms.fields.CharField object>, 'password2': <django.forms.fields.CharField object>, 'username': <django.forms.fields.CharField object>}

property media

Return all media required to render the widgets on this form.

core.models module

Модуль моделей базы данных приложения core. Содержит описание таблиц для пользователей, документов, комментариев и системы жалоб.

class core.models.Comment(*args, **kwargs)

Базовые классы: Model

Модель комментария, привязанного к документу.

Параметры:

• document (Document) – Документ, к которому относится комментарий.

• sender (django.contrib.auth.models.User) – Отправитель комментария.

• receiver (django.contrib.auth.models.User) – Получатель (владелец документа).

exception DoesNotExist

Базовые классы: ObjectDoesNotExist

exception MultipleObjectsReturned

Базовые классы: MultipleObjectsReturned

exception NotUpdated

Базовые классы: ObjectNotUpdated, DatabaseError

complaint_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_reverse_many_to_one_manager() defined below.

created_at

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

document

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

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

Child.parent is a ForwardManyToOneDescriptor instance.

document_id

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

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

id

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

is_read

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>

receiver

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

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

Child.parent is a ForwardManyToOneDescriptor instance.

receiver_id

sender

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

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

Child.parent is a ForwardManyToOneDescriptor instance.

sender_id

text

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

class core.models.Complaint(*args, **kwargs)

Базовые классы: Model

Модель жалобы на комментарий в системе.

exception DoesNotExist

Базовые классы: ObjectDoesNotExist

exception MultipleObjectsReturned

Базовые классы: MultipleObjectsReturned

exception NotUpdated

Базовые классы: ObjectNotUpdated, DatabaseError

comment

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

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

Child.parent is a ForwardManyToOneDescriptor instance.

comment_id

created_at

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_created_at(*, field=<django.db.models.fields.DateTimeField: created_at>, is_next=True, **kwargs)

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

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>

reason

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

reported_user

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

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

Child.parent is a ForwardManyToOneDescriptor instance.

reported_user_id

reporter

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

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

Child.parent is a ForwardManyToOneDescriptor instance.

reporter_id

class core.models.Document(*args, **kwargs)

Базовые классы: Model

Модель документа или онлайн-доски.

Параметры:

• title (str) – Название документа.

• content (str) – Содержимое документа (текст или JSON доски).

• doc_type (str) – Тип документа („text“ или „paint“).

• owner (django.contrib.auth.models.User) – Владелец документа.

DOC_TYPES = [('text', 'Текстовый документ'), ('paint', 'Онлайн доска')]

exception DoesNotExist

Базовые классы: ObjectDoesNotExist

exception MultipleObjectsReturned

Базовые классы: MultipleObjectsReturned

exception NotUpdated

Базовые классы: ObjectNotUpdated, DatabaseError

can_edit_doc(user)

Проверяет, есть ли у пользователя права на редактирование документа.

Параметры:

user (django.contrib.auth.models.User) – Пользователь для проверки.

Результат:

True, если пользователь может редактировать документ, иначе False.

Тип результата:

bool

comments

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_reverse_many_to_one_manager() defined below.

content

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

created_at

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

doc_type

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

editors

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.

get_content()

Возвращает исходный контент документа в виде строки.

Результат:

Распакованное содержимое документа.

Тип результата:

str

get_doc_type_display(*, field=<django.db.models.fields.CharField: doc_type>)

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

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

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

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

id

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

invite_token

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>

owner

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

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

Child.parent is a ForwardManyToOneDescriptor instance.

owner_id

save(*args, **kwargs)

Переопределенный метод сохранения документа. Генерирует уникальный токен приглашения при первом создании и обрабатывает сериализацию сжатого контента.

set_content(data)

Сохраняет контент документа в gzip-сжатом виде.

Параметры:

data (str или bytes) – Данные для сохранения.

title

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

updated_at

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

user_has_access(user)

Проверяет, есть ли у пользователя права на доступ к документу.

Параметры:

user (django.contrib.auth.models.User) – Пользователь для проверки.

Результат:

True, если доступ разрешен, иначе False.

Тип результата:

bool

viewers

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.

class core.models.PasswordResetCode(*args, **kwargs)

Базовые классы: Model

Модель для хранения кодов сброса пароля.

Параметры:

• user (django.contrib.auth.models.User) – Пользователь, запросивший сброс.

• code (str) – Шестизначный код подтверждения.

exception DoesNotExist

Базовые классы: ObjectDoesNotExist

exception MultipleObjectsReturned

Базовые классы: MultipleObjectsReturned

exception NotUpdated

Базовые классы: ObjectNotUpdated, DatabaseError

code

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

created_at

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_created_at(*, field=<django.db.models.fields.DateTimeField: created_at>, is_next=True, **kwargs)

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

id

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

is_valid()

Проверяет, действителен ли код сброса (не истек ли срок 15 минут).

Результат:

True, если код действителен.

Тип результата:

bool

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

user

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

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

Child.parent is a ForwardManyToOneDescriptor instance.

user_id

class core.models.Profile(*args, **kwargs)

Базовые классы: Model

Профиль пользователя с дополнительными данными (аватар).

Параметры:

• user (django.contrib.auth.models.User) – Связанный пользователь.

• avatar (str) – Путь к изображению аватара.

exception DoesNotExist

Базовые классы: ObjectDoesNotExist

exception MultipleObjectsReturned

Базовые классы: MultipleObjectsReturned

exception NotUpdated

Базовые классы: ObjectNotUpdated, DatabaseError

avatar

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

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>

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

class core.models.Report(*args, **kwargs)

Базовые классы: Model

Модель жалобы пользователя на другого пользователя.

Параметры:

• reporter (django.contrib.auth.models.User) – Пользователь, отправивший жалобу.

• reported_user (django.contrib.auth.models.User) – Пользователь, на которого отправлена жалоба.

• reason (str) – Причина жалобы.

• created_at (datetime) – Дата и время создания жалобы.

• resolved (bool) – Статус решения жалобы.

exception DoesNotExist

Базовые классы: ObjectDoesNotExist

exception MultipleObjectsReturned

Базовые классы: MultipleObjectsReturned

exception NotUpdated

Базовые классы: ObjectNotUpdated, DatabaseError

created_at

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_created_at(*, field=<django.db.models.fields.DateTimeField: created_at>, is_next=True, **kwargs)

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

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>

reason

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

reported_user

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

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

Child.parent is a ForwardManyToOneDescriptor instance.

reported_user_id

reporter

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

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

Child.parent is a ForwardManyToOneDescriptor instance.

reporter_id

resolved

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

class core.models.UserActivity(*args, **kwargs)

Базовые классы: Model

Модель отслеживания сетевой активности пользователя.

exception DoesNotExist

Базовые классы: ObjectDoesNotExist

exception MultipleObjectsReturned

Базовые классы: MultipleObjectsReturned

exception NotUpdated

Базовые классы: ObjectNotUpdated, DatabaseError

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

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

id

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

is_online()

Проверяет статус онлайна пользователя (активен в течение последних 5 минут).

last_seen

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>

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

class core.models.UserPunishment(*args, **kwargs)

Базовые классы: Model

Модель наказаний пользователя (баны и муты).

exception DoesNotExist

Базовые классы: ObjectDoesNotExist

exception MultipleObjectsReturned

Базовые классы: MultipleObjectsReturned

exception NotUpdated

Базовые классы: ObjectNotUpdated, DatabaseError

ban_reason

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

banned_at

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

id

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

is_banned

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

is_muted()

Проверяет, замучен ли пользователь на данный момент.

mute_left()

Возвращает время окончания мута.

mute_reason

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

muted_at

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

muted_until

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>

reports_count

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

core.models.create_user_profile(sender, instance, created, **kwargs)

Сигнал для автоматического создания профиля при регистрации пользователя.

core.models.save_user_profile(sender, instance, **kwargs)

Сигнал для сохранения профиля при сохранении пользователя.

core.tests module

class core.tests.DocumentTests(methodName='runTest')

Базовые классы: TestCase

setUp()

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

test_add_comment()

test_document_access()

test_document_compression()

test_save_document()

test_user_registration()

test_viewer_cannot_save_document()

class core.tests.WebSocketTests(methodName='runTest')

Базовые классы: TransactionTestCase

async test_websocket_connection()

core.views module

Модуль представлений (views.py) приложения core. Содержит логику обработки веб-запросов, рендеринг шаблонов и управление API-ответами для редактора кода, графической доски, профиля и панели администратора.

core.views.add_comment(request, doc_id)

Добавляет новый комментарий к документу с проверкой прав и статуса блокировки (ban/mute).

core.views.admin_complaints(request)

Админка: Отображение общего списка жалоб на комментарии.

core.views.admin_punishments(request)

Админка: История выданных наказаний (банов и мутов).

core.views.admin_reports(request)

Суперпользователь: Просмотр репортов на пользователей.

core.views.admin_users(request)

Суперпользователь: Просмотр списка всех пользователей.

core.views.ban_user(request, user_id)

Админка: Быстрый бан пользователя.

core.views.change_access(request, doc_id, user_id, role)

Изменяет уровень доступа пользователя к конкретному документу (только для владельцев).

core.views.change_avatar_view(request)

Позволяет пользователю изменить аватар профиля.

core.views.check_doc_access(request, doc)

Проверяет права доступа текущего пользователя к указанному документу. Защищает от IDOR, проверяя токены приглашения или права в базе данных.

Параметры:

• request – Объект HTTP-запроса.

• doc – Экземпляр модели Document.

Результат:

True, если доступ разрешен, иначе False.

Тип результата:

bool

core.views.complaints_view(request)

Админка: Отображает пользователей, отсортированных по количеству жалоб.

core.views.create_complaint(request, comment_id)

Создает жалобу на указанный комментарий от текущего пользователя.

core.views.create_project(request)

Создает новый документ или доску на основе переданного типа (doc_type).

core.views.delete_account(request)

Удаляет аккаунт текущего пользователя.

core.views.docs_view(request)

Возвращает сгенерированную страницу с документацией кода Sphinx.

core.views.document_members(request, doc_id)

Возвращает JSON со списком участников, имеющих доступ к документу.

core.views.download_compressed(request, doc_id)

Скачивает документ в сыром формате gzip.

core.views.download_document(request, doc_id, file_format='pdf')

Обрабатывает запрос на скачивание документа в выбранном формате (PDF, PNG, JPG).

core.views.editor_view(request, doc_id)

Отображает текстовый редактор кода для указанного документа.

core.views.get_comments(request, doc_id)

Получает JSON-список комментариев для выбранного документа.

core.views.grant_edit_access(request, doc_id)

Выдает права на редактирование документа указанному пользователю.

core.views.grant_view_access(request, doc_id)

Выдает права только на чтение документа.

core.views.home_view(request)

Отображает главную страницу. Если пользователь авторизован, выводит список его последних документов.

core.views.join_document(request, token)

Обрабатывает присоединение к документу по токену-приглашению.

core.views.login_view(request)

Отображает и обрабатывает форму авторизации пользователя.

core.views.logout_view(request)

Разлогинивает текущего пользователя.

core.views.mute_user(request, user_id)

Админка: Быстрый мут пользователя на 15 дней.

core.views.my_status(request)

Возвращает текущий статус наказаний авторизованного пользователя.

core.views.paint_editor_view(request, doc_id)

Отображает графический редактор (доску) для указанного документа.

core.views.paint_view(request)

Редирект на создание новой доски.

core.views.password_reset_request(request)

Запрос на восстановление пароля (генерация 6-значного кода и отправка на почту).

core.views.password_reset_verify(request)

Подтверждение кода сброса пароля и установка нового.

core.views.profile_view(request)

Отображает профиль пользователя со статистикой и документами.

core.views.punish_user(request, user_id, action)

Панель администратора: Управление наказаниями пользователей (бан, мут, разбан).

core.views.register_view(request)

Отображает и обрабатывает форму регистрации нового пользователя.

core.views.save_compressed(request, doc_id)

Сохраняет содержимое документа в сжатом виде из входящего JSON запроса. Поддерживает текстовый контент и снимки (canvas/base64) доски.

core.views.send_comment(request, doc_id)

Обрабатывает отправку нового комментария к документу.

core.views.serve_docs(request, path)

Обслуживает статические файлы сгенерированной документации Sphinx.

core.views.settings_view(request)

Отображает и обрабатывает форму настроек пользователя (изменение почты, имени и пароля).

Module contents