refactor(core): вынесены общие excel-хелперы в core и переиспользованы в courses, partner_programs, users и vacancy

Author: Toksi86

core/utils.py

@@ -1,12 +1,16 @@
 import logging
 import io
+import urllib.parse
 import unicodedata
 import pandas as pd
 
 from django.core.mail import EmailMultiAlternatives
+from django.http import HttpResponse
+from openpyxl.cell.cell import ILLEGAL_CHARACTERS_RE
 
 
 logger = logging.getLogger()
+EXCEL_CELL_MAX = 32767
 
 
 class Email:
@@ -88,3 +92,33 @@ def ascii_filename(filename: str) -> str:
     ascii_name = "".join(char if char.isascii() else "_" for char in safe_name)
     ascii_name = " ".join(ascii_name.split())
     return ascii_name or "export"
+
+
+def sanitize_excel_value(value):
+    if value is None:
+        return ""
+    if isinstance(value, (int, float, bool)):
+        return value
+
+    text = str(value).replace("\r\n", "\n").replace("\r", "\n")
+    text = ILLEGAL_CHARACTERS_RE.sub(" ", text)
+    if len(text) > EXCEL_CELL_MAX:
+        text = text[: EXCEL_CELL_MAX - 3] + "..."
+    return text
+
+
+def build_xlsx_download_response(binary_data: bytes, *, base_name: str) -> HttpResponse:
+    safe_name = sanitize_filename(base_name)
+    encoded_file_name = urllib.parse.quote(f"{safe_name}.xlsx")
+    fallback_filename = f"{ascii_filename(base_name)}.xlsx"
+
+    response = HttpResponse(
+        binary_data,
+        content_type="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+    )
+    response["Content-Disposition"] = (
+        "attachment; "
+        f"filename=\"{fallback_filename}\"; "
+        f"filename*=UTF-8''{encoded_file_name}"
+    )
+    return response

courses/services/export_course_results.py

@@ -1,15 +1,12 @@
 import io
-import urllib.parse
 from collections import defaultdict
 from zoneinfo import ZoneInfo
 
-from django.http import HttpResponse
 from django.utils import timezone
 from django.db.models import Prefetch
 from openpyxl import Workbook
-from openpyxl.cell.cell import ILLEGAL_CHARACTERS_RE
 
-from core.utils import ascii_filename, sanitize_filename
+from core.utils import build_xlsx_download_response, sanitize_excel_value
 from courses.models import (
     Course,
     CourseLessonContentStatus,
@@ -27,7 +24,6 @@
 
 
 MSK_TZ = ZoneInfo("Europe/Moscow")
-EXCEL_CELL_MAX = 32767
 BASE_HEADERS = (
     "Имя и Фамилия",
     "Email",
@@ -38,19 +34,6 @@
 )
 
 
-def sanitize_excel_value(value):
-    if value is None:
-        return ""
-    if isinstance(value, (int, float, bool)):
-        return value
-
-    text = str(value).replace("\r\n", "\n").replace("\r", "\n")
-    text = ILLEGAL_CHARACTERS_RE.sub(" ", text)
-    if len(text) > EXCEL_CELL_MAX:
-        text = text[: EXCEL_CELL_MAX - 3] + "..."
-    return text
-
-
 def _format_msk_datetime(value) -> str:
     if value is None:
         return ""
@@ -256,22 +239,9 @@ def build_course_results_workbook_bytes(course: Course) -> bytes:
     return buffer.getvalue()
 
 
-def build_course_results_export_response(course: Course) -> HttpResponse:
+def build_course_results_export_response(course: Course):
     binary_data = build_course_results_workbook_bytes(course)
 
     date_suffix = timezone.now().astimezone(MSK_TZ).strftime("%d.%m.%Y")
     base_name = f"course-results - {course.title} - {date_suffix}"
-    safe_name = sanitize_filename(base_name)
-    encoded_file_name = urllib.parse.quote(f"{safe_name}.xlsx")
-    fallback_filename = f"{ascii_filename(base_name)}.xlsx"
-
-    response = HttpResponse(
-        binary_data,
-        content_type="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
-    )
-    response["Content-Disposition"] = (
-        "attachment; "
-        f"filename=\"{fallback_filename}\"; "
-        f"filename*=UTF-8''{encoded_file_name}"
-    )
-    return response
+    return build_xlsx_download_response(binary_data, base_name=base_name)

partner_programs/admin.py

@@ -1,15 +1,14 @@
 import re
-import urllib.parse
 
 import tablib
 from django import forms
 from django.contrib import admin
 from django.db.models import QuerySet
-from django.http import HttpRequest, HttpResponse
+from django.http import HttpRequest
 from django.urls import path
 from django.utils import timezone
 
-from core.utils import XlsxFileToExport, ascii_filename, sanitize_filename
+from core.utils import XlsxFileToExport, build_xlsx_download_response
 from mailing.views import MailingTemplateRender
 from partner_programs.models import (
     PartnerProgram,
@@ -220,12 +219,7 @@ def get_export_file(self, partner_program: PartnerProgram):
         file_name = (
             f"{partner_program.name} {timezone.now().strftime('%d-%m-%Y %H:%M:%S')}"
         )
-        response = HttpResponse(
-            content_type="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
-            headers={"Content-Disposition": f'attachment; filename="{file_name}.xlsx"'},
-        )
-        response.write(binary_data)
-        return response
+        return build_xlsx_download_response(binary_data, base_name=file_name)
 
     def get_export_rates_view(self, request, object_id):
         rates_data_to_write: list[dict] = self._get_prepared_rates_data_for_export(
@@ -240,19 +234,7 @@ def get_export_rates_view(self, request, object_id):
         program_name = PartnerProgram.objects.get(pk=object_id).name
         date_suffix = timezone.now().strftime("%d.%m.%y")
         base_name = f"scores - {program_name or 'program'} - {date_suffix}"
-        safe_name = sanitize_filename(base_name)
-        encoded_file_name: str = urllib.parse.quote(f"{safe_name}.xlsx")
-        fallback_filename = f"{ascii_filename(base_name)}.xlsx"
-        response = HttpResponse(
-            binary_data_to_export,
-            content_type="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
-        )
-        response["Content-Disposition"] = (
-            "attachment; "
-            f"filename=\"{fallback_filename}\"; "
-            f"filename*=UTF-8''{encoded_file_name}"
-        )
-        return response
+        return build_xlsx_download_response(binary_data_to_export, base_name=base_name)
 
     def _get_prepared_rates_data_for_export(self, program_id: int) -> list[dict]:
         """

partner_programs/services.py

@@ -1,10 +1,10 @@
 import logging
 from collections import OrderedDict
 
-from openpyxl.cell.cell import ILLEGAL_CHARACTERS_RE
 from django.db.models import Prefetch
 from django.utils import timezone
 
+from core.utils import sanitize_excel_value
 from partner_programs.models import (
     PartnerProgram,
     PartnerProgramField,
@@ -171,33 +171,6 @@ def get_project_scores_info(self) -> dict[str, str]:
     ("team_members", "Состав команды"),
     ("leader_full_name", "Имя фамилия лидера"),
 ]
-EXCEL_CELL_MAX = 32767  # лимит символов в ячейке Excel
-
-
-def sanitize_excel_value(value):
-    """
-    Приводит значение к безопасному для openpyxl виду:
-    - None -> ""
-    - для строк: вычищает запрещённые символы, нормализует переносы строк,
-      и обрезает до лимита Excel (32767).
-    - для чисел/булевых оставляет как есть.
-    """
-    if value is None:
-        return ""
-
-    if isinstance(value, (int, float, bool)):
-        return value
-
-    text = str(value)
-    text = text.replace("\r\n", "\n").replace("\r", "\n")
-    text = ILLEGAL_CHARACTERS_RE.sub(" ", text)
-
-    if len(text) > EXCEL_CELL_MAX:
-        text = text[: EXCEL_CELL_MAX - 3] + "..."
-
-    return text
-
-
 def _leader_full_name(user):
     if not user:
         return ""

partner_programs/views.py

@@ -1,10 +1,8 @@
 import io
-import urllib.parse
 
 from django.contrib.auth import get_user_model
 from django.db import IntegrityError, transaction
 from django.db.models import Exists, OuterRef, Prefetch
-from django.http import FileResponse, HttpResponse
 from django.shortcuts import get_object_or_404
 from django.utils import timezone
 from django.utils.timezone import now
@@ -20,7 +18,11 @@
 
 from core.serializers import EmptySerializer, SetLikedSerializer, SetViewedSerializer
 from core.services import add_view, set_like
-from core.utils import XlsxFileToExport, ascii_filename, sanitize_filename
+from core.utils import (
+    XlsxFileToExport,
+    build_xlsx_download_response,
+    sanitize_excel_value,
+)
 from partner_programs.helpers import date_to_iso
 from partner_programs.models import (
     PartnerProgram,
@@ -50,7 +52,6 @@
     build_program_field_columns,
     prepare_project_scores_export_data,
     row_dict_for_link,
-    sanitize_excel_value,
 )
 from partner_programs.utils import filter_program_projects_by_field_name
 from projects.models import Collaborator, Project
@@ -655,20 +656,7 @@ def get(self, request, pk: int):
 
         date_suffix = timezone.now().strftime("%d.%m.%y")
         base_name = f"scores - {program.name or 'program'} - {date_suffix}"
-        safe_name = sanitize_filename(base_name)
-        filename = f"{safe_name}.xlsx"
-        encoded_file_name: str = urllib.parse.quote(filename)
-        fallback_filename = f"{ascii_filename(base_name)}.xlsx"
-        response = HttpResponse(
-            binary_data_to_export,
-            content_type="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
-        )
-        response["Content-Disposition"] = (
-            "attachment; "
-            f"filename=\"{fallback_filename}\"; "
-            f"filename*=UTF-8''{encoded_file_name}"
-        )
-        return response
+        return build_xlsx_download_response(binary_data_to_export, base_name=base_name)
 
 
 class PartnerProgramExportProjectsAPIView(APIView):
@@ -732,23 +720,7 @@ def _export(self, program: PartnerProgram, only_submitted: bool):
         label = "projects_review" if only_submitted else "projects"
         date_suffix = timezone.now().strftime("%d.%m.%y")
         base_name = f"{label} - {program.name or 'program'} - {date_suffix}"
-        fname_base = sanitize_filename(base_name)
-        filename = f"{fname_base}.xlsx"
-        encoded_file_name: str = urllib.parse.quote(filename)
-        fallback_filename = f"{ascii_filename(base_name)}.xlsx"
-
-        response = FileResponse(
-            bio,
-            as_attachment=True,
-            filename=filename,
-            content_type="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
-        )
-        response["Content-Disposition"] = (
-            "attachment; "
-            f"filename=\"{fallback_filename}\"; "
-            f"filename*=UTF-8''{encoded_file_name}"
-        )
-        return response
+        return build_xlsx_download_response(bio.getvalue(), base_name=base_name)
 
     def get(self, request, pk: int):
         program = self._get_program(pk)

users/admin.py

@@ -1,4 +1,3 @@
-import urllib.parse
 from datetime import date
 
 import tablib
@@ -12,7 +11,7 @@
 from django.utils.timezone import now
 
 from core.admin import SkillToObjectInline
-from core.utils import XlsxFileToExport
+from core.utils import XlsxFileToExport, build_xlsx_download_response
 from mailing.views import MailingTemplateRender
 from users.models import UserAchievementFile
 from users.services.users_activity import UserActivityDataPreparer
@@ -296,16 +295,10 @@ def get_users_activity(self, _) -> HttpResponse:
         binary_data_to_export: bytes = xlsx_file_writer.get_binary_data_from_self_file()
         xlsx_file_writer.clear_buffer()
 
-        encoded_file_name: str = urllib.parse.quote("активность_пользователей.xlsx")
-        response = HttpResponse(
+        return build_xlsx_download_response(
             binary_data_to_export,
-            content_type="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+            base_name="активность_пользователей",
         )
-        response["Content-Disposition"] = (
-            f"attachment; filename*=UTF-8''{encoded_file_name}"
-        )
-
-        return response
 
     def get_export_users_emails(self, users):
         response_data = tablib.Dataset(
@@ -396,13 +389,7 @@ def get_export_users_emails(self, users):
         #     response_data.append([user.first_name + " " + user.last_name, user.email])
 
         binary_data = response_data.export("xlsx")
-        file_name = "users"
-        response = HttpResponse(
-            content_type="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
-            headers={"Content-Disposition": f'attachment; filename="{file_name}.xlsx"'},
-        )
-        response.write(binary_data)
-        return response
+        return build_xlsx_download_response(binary_data, base_name="users")
 
 
 class UserAchievementFileInline(admin.TabularInline):

vacancy/admin.py

@@ -1,9 +1,9 @@
 import tablib
 from django.contrib import admin
-from django.http import HttpResponse
 from django.urls import path
 
 from core.admin import SkillToObjectInline
+from core.utils import build_xlsx_download_response
 from vacancy.models import Vacancy, VacancyResponse
 
 
@@ -64,13 +64,10 @@ def excel_email_leaders_vacancies(self, data: list):
             response_data.append(row_to_add)
 
         binary_data = response_data.export("xlsx")
-        file_name = "email_of_leaders_with_users"
-        response = HttpResponse(
-            content_type="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
-            headers={"Content-Disposition": f'attachment; filename="{file_name}.xlsx"'},
+        return build_xlsx_download_response(
+            binary_data,
+            base_name="email_of_leaders_with_users",
         )
-        response.write(binary_data)
-        return response
 
 
 @admin.register(VacancyResponse)