جنگو - هیوادار

پر کردن مودال با استفاده از اطلاعات فرم

نیاز بود که توی یک جدول اگر توی سلول یکی از ستونها کلیک کردیم یک مودال باز بشود. اما باید اطلاعاتی مربوط به آن ردیف به مودال پاس بدیم. متوجه شدم که این اطلاعات مربوط به ردیف مذکور را میتوان به عنوان یک پایامتر به سلول مربوطه اضافه کرد مثل:

<tbody>
	{% for f in feedbacks %}
		<tr>
			<td
				{% if f.active %} class="text-danger" {% endif %}
			>
				{% if f.active %} (فعال) {% endif %}v.{{f.feedback_version}}
			</td>
			<td>{{f.feedback_date}}</td>
			<td>{{f.user}}</td>
			<td>
				<div class="row">
					<div class="col-4">
						<a
							href="#"
							data-version="{{ f.feedback_version }}"
							main_points="{{ f.main_points|escape }}"
							secondary_points="{{ f.secondary_points|escape }}"
							guids="{{ f.guids_and_recommendations|escape }}"
							feedback_id="{{ f.id }}"
							feedback_version="{{ f.feedback_version }}"
							class="open-modal"
							style="cursor: pointer;"
						>
							جزئیات
						</a>
					</div>
				</div>
			</td>
		</tr>
	{% endfor %}
</tbody>

<tbody>

{% for f in feedbacks %}

<tr>

<td

{% if f.active %} class="text-danger" {% endif %}

{% if f.active %} (فعال) {% endif %}v.{{f.feedback_version}}

</td>

<td>{{f.feedback_date}}</td>

<td>

href="#"

data-version="{{ f.feedback_version }}"

main_points="{{ f.main_points|escape }}"

secondary_points="{{ f.secondary_points|escape }}"

guids="{{ f.guids_and_recommendations|escape }}"

feedback_id="{{ f.id }}"

feedback_version="{{ f.feedback_version }}"

class="open-modal"

style="cursor: pointer;"

جزئیات

</a>

</div>

</td>

</tr>

{% endfor %}

</tbody>

توی خود مودال یک سری فیلد خالی تعریف میکنیم که بعدا با جاواساکریپ اطلاعات پارامترها رو به اون اضافه کنیم:

{% block modals %}
    <div id="mapModal" class="modal fade" tabindex="-1" aria-labelledby="#mapModalLabel" aria-hidden="true">
        <div class="modal-dialog">
            <div class="modal-content">
                <div class="modal-header">
                    <h5 class="modal-title" id="mapModalLabel">
                        جزئیات
                    </h5>
                    <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
                </div>
                <div class="modal-body">
                    <p><strong>نسخه:</strong> <span id="modal-version"></span></p>
                    <p><strong>نکات اصلی:</strong> <span id="main_points"></span></p>
                    <p><strong>نکات فرعی:</strong> <span id="secondary_points"></span></p>
                    <p><strong>راهنماییها:</strong> <span id="guids"></span></p>
                </div>
                <div class="modal-footer">
                    <a href="#" data-bs-dismiss="modal">بستن</a>
                    <a id="activation_btn">
                        فعالسازی
                    </a>
                </div>
            </div>
        </div>
    </div>
{% endblock %}

{% block modals %}

جزئیات

</h5>

</div>

<p><strong>راهنماییها:</strong> <span id="guids"></span></p>

</div>

فعالسازی

</a>

</div>

{% endblock %}

الان توی اسکریپت زیر از هر ردیف سلول مربوطه رو بر اساس اسم کلاس میگیریم. بعد از اون سلول پارامترم مربوطه که دیتا بهش وصل شده رو بر میداریم بعد همون مقدارها رو به مودال میدیم:

<script>
	document.addEventListener('DOMContentLoaded', function () {
		document.querySelectorAll('.open-modal').forEach(function (cell) {
			cell.addEventListener('click', function () {
				const version = this.getAttribute('data-version');
				const main_points = this.getAttribute('main_points');
				const secondary_points = this.getAttribute('secondary_points');
				const guids = this.getAttribute('guids');
				const feedback_version = this.getAttribute('feedback_version');
				const feedback_id = this.getAttribute('feedback_id');

				document.getElementById('modal-version').textContent = version;
				document.getElementById('main_points').innerHTML  = main_points;
				document.getElementById('secondary_points').innerHTML  = secondary_points;
				document.getElementById('guids').innerHTML  = guids;
				document.getElementById('activation_btn').href = "/man/documents/versionactivate/"+feedback_id+"/"+feedback_version+"/";

				const mapModal = new bootstrap.Modal(document.getElementById('mapModal'));
				mapModal.show();
			});
		});
	});
</script>

document.addEventListener('DOMContentLoaded', function () {

document.querySelectorAll('.open-modal').forEach(function (cell) {

cell.addEventListener('click', function () {

const version = this.getAttribute('data-version');

const main_points = this.getAttribute('main_points');

const secondary_points = this.getAttribute('secondary_points');

const guids = this.getAttribute('guids');

const feedback_version = this.getAttribute('feedback_version');

const feedback_id = this.getAttribute('feedback_id');

document.getElementById('modal-version').textContent = version;

document.getElementById('main_points').innerHTML = main_points;

document.getElementById('secondary_points').innerHTML = secondary_points;

document.getElementById('guids').innerHTML = guids;

document.getElementById('activation_btn').href = "/man/documents/versionactivate/"+feedback_id+"/"+feedback_version+"/";

const mapModal = new bootstrap.Modal(document.getElementById('mapModal'));

mapModal.show();

});

</script>

annotate و عدم اعمال Index

این 2 کد را در نظر بگیرید:

Service.objects.annotate(
		cnt_p=Count('provided_links'), cnt_c=Count('consumed_links')
	).exclude(Q(cnt_p=0, cnt_c=0), st=2)

Service.objects.annotate(

cnt_p=Count('provided_links'), cnt_c=Count('consumed_links')

).exclude(Q(cnt_p=0, cnt_c=0), st=2)

Service.objects.exclude(st=2).annotate(
	cnt_p=Count('provided_links'), cnt_c=Count('consumed_links')
).exclude(cnt_p=0, cnt_c=0)

Service.objects.exclude(st=2).annotate(

cnt_p=Count('provided_links'), cnt_c=Count('consumed_links')

).exclude(cnt_p=0, cnt_c=0)

با تبدیل اولی به دومی زمان این query از 450 میلی ثانیه به 45 میلی ثانیه کاهش پیدا کرد. چرا؟

دلیل این بود که فیلدهای این مدل همگی Index بودند اما این ایندکسها اعمال نمی شدند چونکه annotate باعث میشود که کل جدول اسکن شود و عملا ایندکسها بی فایده باشند بنابراین حداقل st=0 را به قبل از annotate انتقال دادیم و این باعث شد برای annotate که اتفاقا از WHERE استفاده میکند از ایندکس استفاده شود.

مقایسه دو تکه کد

تفاوت دو کد زیر چیست و کدام بهتر است؟

class MagAttachment(models.Model):
    file = models.FileField(upload_to='mag/attachments', verbose_name='فایل اصلی')
    thumbnail = models.ImageField(upload_to='mag/attachments', verbose_name="نمایه", blank=True, null=True)

    def __str__(self):
        return str(self.file.name)

    def delete(self, *args, **kwargs):
        if self.file:
            self.file.delete(save=False)

        if self.thumbnail:
            self.thumbnail.delete(save=False)

        super().delete(*args, **kwargs)

    def get_thumbnail_url(self):
        if self.thumbnail:
            return self.thumbnail.url
        return static('images/placeholder.PNG')

class MagAttachment(models.Model):

file = models.FileField(upload_to='mag/attachments', verbose_name='فایل اصلی')

thumbnail = models.ImageField(upload_to='mag/attachments', verbose_name="نمایه", blank=True, null=True)

def __str__(self):

return str(self.file.name)

def delete(self, *args, **kwargs):

if self.file:

self.file.delete(save=False)

if self.thumbnail:

self.thumbnail.delete(save=False)

super().delete(*args, **kwargs)

def get_thumbnail_url(self):

if self.thumbnail:

return self.thumbnail.url

return static('images/placeholder.PNG')

class MagAttachment(models.Model):
    file = models.FileField(upload_to='mag/attachments', verbose_name='فایل اصلی')
    thumbnail = models.ImageField(upload_to='mag/attachments', verbose_name="نمایه", default='mag/placeholder.JPG')

    def __str__(self):
        return str(self.file.name)

    def delete(self, *args, **kwargs):
        if self.file:
            self.file.delete(save=False)

        if self.thumbnail and self.thumbnail.name != 'mag/placeholder.JPG':
            self.thumbnail.delete(save=False)

        super().delete(*args, **kwargs)

class MagAttachment(models.Model):

file = models.FileField(upload_to='mag/attachments', verbose_name='فایل اصلی')

thumbnail = models.ImageField(upload_to='mag/attachments', verbose_name="نمایه", default='mag/placeholder.JPG')

def __str__(self):

return str(self.file.name)

def delete(self, *args, **kwargs):

if self.file:

self.file.delete(save=False)

if self.thumbnail and self.thumbnail.name != 'mag/placeholder.JPG':

self.thumbnail.delete(save=False)

super().delete(*args, **kwargs)

در کد اول اگر thumbnail توسط کاربر انتخاب نشود یک فایل از مسیر mag آپلود میشود. و هنگام پاک شدن آبجکت مربوطه، اگر این آبجکت دارای این فایل پیشفرض بود پاک نشود که البته در این کد مربوطه خود به خود پاک می شود. پس یک باگ وجود دارد. گذشته از این باگ اگر 1000 بار کاربر بدون thumbnail فایل آپلود کند 1000 فایل تکراری ذخیره میشود.

در ضمن اگر فایل بهر دلیلی پاک شود یا نام آن تغییر کند سیستم دچار مشکل میشود.

در کد دوم اما اگر کاربر فایلی انتخاب نکند هیچ فایل پیش فرضی آپلود نمیشود بنابراین فایل تکراری دیده نمی شود و فضا هدر نمی روند.

از طرفی یک فایل static پاک نشده و هرکجا یک سند thumbnail نداشته باشد با متد get_thumbnail_url این فایل نشان داده میشود و دیگر سیستم دچار باگهای ناخواسته نمی شود.

تغییر queryset توی فرم جنگو

توی یک فرم میخوایم فیلدی که لیستی را به کاربر نشان میدهد را تغییری بدیم که همه مواردی که توی اون فیلد توی دیتابیس نیست را نشان ندهیم.

class MagForm(forms.ModelForm):
    class Meta:
        model = Mag
        fields = '__all__'

    def __init__(self, *args, **kwargs):
        super(MagForm, self).__init__(*args, **kwargs)
        self.fields['attachment'].queryset = MagAttachment.objects.filter(mag__isnull=True)

class MagForm(forms.ModelForm):

class Meta:

model = Mag

fields = '__all__'

def __init__(self, *args, **kwargs):

super(MagForm, self).__init__(*args, **kwargs)

self.fields['attachment'].queryset = MagAttachment.objects.filter(mag__isnull=True)

صحت سنجی فرمت فایل توی فرم جنگو

چطور توی یک فرم اگر یک فایل آپلود شده از یک فرمت خاص نبود ارور برگردونیم

class MagAttachmentForm(forms.ModelForm):
    class Meta:
        model = MagAttachment
        fields = '__all__'

    def clean_file(self):
        file = self.cleaned_data['file']
        content_type = file.content_type

        if content_type == 'application/pdf':
            return file
        else:
            raise forms.ValidationError('فرمت pdf')

class MagAttachmentForm(forms.ModelForm):

class Meta:

model = MagAttachment

fields = '__all__'

def clean_file(self):

file = self.cleaned_data['file']

content_type = file.content_type

if content_type == 'application/pdf':

return file

else:

raise forms.ValidationError('فرمت pdf')

تبدیل n+1 عدد query به 3 query

این یک مثال واقعی از بهبود یک پروژه است. query اولیه به شکل زیر بود:

bss_branch = Branch.objects.get(name__iexact="bss").office_set.all()

    for el in bss_branch:
        for svc in el.services.all():
            if svc in my_services:
                setattr(el, 'is_activated', True)
                break

bss_branch = Branch.objects.get(name__iexact="bss").office_set.all()

for el in bss_branch:

for svc in el.services.all():

if svc in my_services:

setattr(el, 'is_activated', True)

break

با ابزار django debug toolbar تعداد query های این تکه کد را مرور کردم و جاهایی که به سرور query زده میشود به این شکل است:

در خط Branch.objects.get(name__iexact=”bss”).office_set.all() یک query به دیتابیس زده میشود.

2. در خط for el in bss_branch: یک query به دیتابیس زده می شود.

3. در خط for svc in el.services.all(): یک query به دیتابیس زده میشود. یعنی اگر در bss_branch تعداد N المان وجود داشته باشد به ازای هر کدام یک query در این قسمت زده خواهد شد.

یعنی برای هر el که تعداد آن به اندازه bss_branch هست یک query جدید داریم

بنا براین در کد بالا یک query زده شده و branch ها استخراج شده (در قسمت 1) که ترجمه آن:

SELECT `branch`.`id`,
       `branch`.`name`,
       `branch`.`name_fixed`,
       `branch`.`title_en`,
       `branch`.`title_fa`,
       `branch`.`is_active`
  FROM `branch`
 WHERE `branch`.`name` LIKE 'bss'
 LIMIT 21

SELECT `branch`.`id`,

`branch`.`name`,

`branch`.`name_fixed`,

`branch`.`title_en`,

`branch`.`title_fa`,

`branch`.`is_active`

FROM `branch`

WHERE `branch`.`name` LIKE 'bss'

LIMIT 21

در قسمت دوم یک query زده شده و office های آن branch استخراج شده:

SELECT `office`.`id`,
       `office`.`name`,
       `office`.`name_fixed`,
       `office`.`title_en`,
       `office`.`title_fa`,
       `office`.`branch_id`,
       `office`.`is_active`
  FROM `office`
 WHERE `office`.`branch_id` = 2

SELECT `office`.`id`,

`office`.`name`,

`office`.`name_fixed`,

`office`.`title_en`,

`office`.`title_fa`,

`office`.`branch_id`,

`office`.`is_active`

FROM `office`

WHERE `office`.`branch_id` = 2

در قسمت سوم به ازای هر کدام از office ها یک query زده شده و service های آن استخراج شده به عنوان مثال یکیش رو آوردم:

SELECT `service`.`id`,
       `service`.`name`,
       `service`.`name_fixed`,
       `service`.`st`,
       `service`.`branch_id`,
       `service`.`office_id`,
       `service`.`company_object_id`,
       `service`.`managed_service_provider_id`,
       `service`.`development_service_provider_id`,
       `service`.`product`,
       `service`.`developer_id`,
       `service`.`persian_names`,
       `service`.`other_names`,
       `service`.`service_account_id`,
       `service`.`service_account_email`,
       `service`.`technician_id`,
       `service`.`service_manager_id`,
       `service`.`expert_id`,
       `service`.`arc_manager_id`,
       `service`.`arc_expert_id`,
       `service`.`description`,
       `service`.`active`,
       `service`.`domain`,
       `service`.`aspect`,
       `service`.`scope`,
       `service`.`service_nature`,
       `service`.`other_technical_representatives`,
       `service`.`other_vendor_emails`,
       `service`.`document_sender`,
       `service`.`document_sender_email`,
       `service`.`modules`,
       `service`.`service_status`,
       `service`.`description_and_approval`,
       `service`.`approver`
  FROM `service`
 WHERE `service`.`office_id` = 6

SELECT `service`.`id`,

`service`.`name`,

`service`.`name_fixed`,

`service`.`st`,

`service`.`branch_id`,

`service`.`office_id`,

`service`.`company_object_id`,

`service`.`managed_service_provider_id`,

`service`.`development_service_provider_id`,

`service`.`product`,

`service`.`developer_id`,

`service`.`persian_names`,

`service`.`other_names`,

`service`.`service_account_id`,

`service`.`service_account_email`,

`service`.`technician_id`,

`service`.`service_manager_id`,

`service`.`expert_id`,

`service`.`arc_manager_id`,

`service`.`arc_expert_id`,

`service`.`description`,

`service`.`active`,

`service`.`domain`,

`service`.`aspect`,

`service`.`scope`,

`service`.`service_nature`,

`service`.`other_technical_representatives`,

`service`.`other_vendor_emails`,

`service`.`document_sender`,

`service`.`document_sender_email`,

`service`.`modules`,

`service`.`service_status`,

`service`.`description_and_approval`,

`service`.`approver`

FROM `service`

WHERE `service`.`office_id` = 6

پس در مجموع N+1 درخواست دیتابیس query زدن شد.

حالا اینو بهینه میکنیم به کد زیر:

bss_branch = Branch.objects.get(name__iexact="bss").office_set.prefetch_related('services')

    for el in bss_branch:
        el.is_activated = any(svc in my_services for svc in el.services.all())

bss_branch = Branch.objects.get(name__iexact="bss").office_set.prefetch_related('services')

for el in bss_branch:

el.is_activated = any(svc in my_services for svc in el.services.all())

در این نمونه کد query های زیر را داریم:

در خط bss_branch = Branch.objects.get(name__iexact=”bss”).office_set.prefetch_related(‘services’) یک query به دیتابیس داریم.
در خط for el in bss_branch: یک query زده شده و office های branch را استخراج کرده.
دوباره در همان خط یک query زده شده و service های تمامی office ها یک جا استخراج شده در این قسمت دیگر N بار query زده نشده

query قسمت 1

SELECT `branch`.`id`,
       `branch`.`name`,
       `branch`.`name_fixed`,
       `branch`.`title_en`,
       `branch`.`title_fa`,
       `branch`.`is_active`
  FROM `branch`
 WHERE `branch`.`name` LIKE 'bss'
 LIMIT 21

SELECT `branch`.`id`,

`branch`.`name`,

`branch`.`name_fixed`,

`branch`.`title_en`,

`branch`.`title_fa`,

`branch`.`is_active`

FROM `branch`

WHERE `branch`.`name` LIKE 'bss'

LIMIT 21

query قسمت 2

SELECT `office`.`id`,
       `office`.`name`,
       `office`.`name_fixed`,
       `office`.`title_en`,
       `office`.`title_fa`,
       `office`.`branch_id`,
       `office`.`is_active`
  FROM `office`
 WHERE `office`.`branch_id` = 2

SELECT `office`.`id`,

`office`.`name`,

`office`.`name_fixed`,

`office`.`title_en`,

`office`.`title_fa`,

`office`.`branch_id`,

`office`.`is_active`

FROM `office`

WHERE `office`.`branch_id` = 2

query قسمت 3

SELECT `service`.`id`,
       `service`.`name`,
       `service`.`name_fixed`,
       `service`.`st`,
       `service`.`branch_id`,
       `service`.`office_id`,
       `service`.`company_object_id`,
       `service`.`managed_service_provider_id`,
       `service`.`development_service_provider_id`,
       `service`.`product`,
       `service`.`developer_id`,
       `service`.`persian_names`,
       `service`.`other_names`,
       `service`.`service_account_id`,
       `service`.`service_account_email`,
       `service`.`technician_id`,
       `service`.`service_manager_id`,
       `service`.`expert_id`,
       `service`.`arc_manager_id`,
       `service`.`arc_expert_id`,
       `service`.`description`,
       `service`.`active`,
       `service`.`domain`,
       `service`.`aspect`,
       `service`.`scope`,
       `service`.`service_nature`,
       `service`.`other_technical_representatives`,
       `service`.`other_vendor_emails`,
       `service`.`document_sender`,
       `service`.`document_sender_email`,
       `service`.`modules`,
       `service`.`service_status`,
       `service`.`description_and_approval`,
       `service`.`approver`
  FROM `service`
 WHERE `service`.`office_id` IN (6, 7, 8, 9, 10)

SELECT `service`.`id`,

`service`.`name`,

`service`.`name_fixed`,

`service`.`st`,

`service`.`branch_id`,

`service`.`office_id`,

`service`.`company_object_id`,

`service`.`managed_service_provider_id`,

`service`.`development_service_provider_id`,

`service`.`product`,

`service`.`developer_id`,

`service`.`persian_names`,

`service`.`other_names`,

`service`.`service_account_id`,

`service`.`service_account_email`,

`service`.`technician_id`,

`service`.`service_manager_id`,

`service`.`expert_id`,

`service`.`arc_manager_id`,

`service`.`arc_expert_id`,

`service`.`description`,

`service`.`active`,

`service`.`domain`,

`service`.`aspect`,

`service`.`scope`,

`service`.`service_nature`,

`service`.`other_technical_representatives`,

`service`.`other_vendor_emails`,

`service`.`document_sender`,

`service`.`document_sender_email`,

`service`.`modules`,

`service`.`service_status`,

`service`.`description_and_approval`,

`service`.`approver`

FROM `service`

WHERE `service`.`office_id` IN (6, 7, 8, 9, 10)

همانطور که توی کد بالا میبینید توی خط آخر تمامی query ها ادغام شده اند

بنابراین N+1 دستور query به 3 query تبدیل شد

مشکل ثبت مجدد فرم با رفرش

. توی کد زیر بعد از ثبت کردن فرم اگر صفحه را رفرش کنیم همان فرم دوباره ثبت میشود.

    if request.POST and 'comment_form_submit' in request.POST:
        feedback_comment_form = FeedbackCommentForm(request.POST)
        if feedback_comment_form.is_valid():
            body = feedback_comment_form.cleaned_data['body']
            DocumentComment.objects.create(
                document=d,
                user=request.user,
                body=body,
                comment_datetime=datetime.datetime.now()
            )

            context['comment_list'] = DocumentComment.objects.filter(document=d)
            DocumentLogger.log(request, d, 'ثبت کامنت ')
            messages.success(request, 'کامنت ثبت شد')

            return render(request, "man/documents/document-detail.html", context)

if request.POST and 'comment_form_submit' in request.POST:

feedback_comment_form = FeedbackCommentForm(request.POST)

if feedback_comment_form.is_valid():

body = feedback_comment_form.cleaned_data['body']

DocumentComment.objects.create(

document=d,

user=request.user,

body=body,

comment_datetime=datetime.datetime.now()

)

context['comment_list'] = DocumentComment.objects.filter(document=d)

DocumentLogger.log(request, d, 'ثبت کامنت ')

messages.success(request, 'کامنت ثبت شد')

return render(request, "man/documents/document-detail.html", context)

مشکل در فروم جنگو این جوری توضیح داده شده است:

یعنی بعد از POST موفق باید فرم را redirect کنیم که با این کار صفحه جدید با GET فراخوانی میشود در نتیجه اگر رفرش کنیم باز هم در خواست GET ارسال میگردد. یعنی کد را به شکل زیر تغییر میدهیم.

    if request.POST and 'comment_form_submit' in request.POST:
        feedback_comment_form = FeedbackCommentForm(request.POST)
        if feedback_comment_form.is_valid():
            body = feedback_comment_form.cleaned_data['body']
            DocumentComment.objects.create(
                document=d,
                user=request.user,
                body=body,
                comment_datetime=datetime.datetime.now()
            )

            context['comment_list'] = DocumentComment.objects.filter(document=d)
            DocumentLogger.log(request, d, 'ثبت کامنت ')
            messages.success(request, 'کامنت ثبت شد')
            url = reverse('man:management_documents_document_detail', args=[doc_id])
            return HttpResponseRedirect(url)

if request.POST and 'comment_form_submit' in request.POST:

feedback_comment_form = FeedbackCommentForm(request.POST)

if feedback_comment_form.is_valid():

body = feedback_comment_form.cleaned_data['body']

DocumentComment.objects.create(

document=d,

user=request.user,

body=body,

comment_datetime=datetime.datetime.now()

)

context['comment_list'] = DocumentComment.objects.filter(document=d)

DocumentLogger.log(request, d, 'ثبت کامنت ')

messages.success(request, 'کامنت ثبت شد')

url = reverse('man:management_documents_document_detail', args=[doc_id])

return HttpResponseRedirect(url)

serializer توی Django Rest Framework با دیتای ورودی چیکار میکنه؟

بهترین روش یادگیری یه فریم ورک خوندن کد خود فریم ورک و داکیومنت توی خود کد هست. برای serializer توی جنگو یک کامنت هست توی rest_framework/serializer.py که:

class BaseSerializer(Field):
    """
    The BaseSerializer class provides a minimal class which may be used
    for writing custom serializer implementations.

    Note that we strongly restrict the ordering of operations/properties
    that may be used on the serializer in order to enforce correct usage.

    In particular, if a `data=` argument is passed then:

    .is_valid() - Available.
    .initial_data - Available.
    .validated_data - Only available after calling `is_valid()`
    .errors - Only available after calling `is_valid()`
    .data - Only available after calling `is_valid()`

    If a `data=` argument is not passed then:

    .is_valid() - Not available.
    .initial_data - Not available.
    .validated_data - Not available.
    .errors - Not available.
    .data - Available.
    """

    def __init__(self, instance=None, data=empty, **kwargs):. . .

class BaseSerializer(Field):

"""

The BaseSerializer class provides a minimal class which may be used

for writing custom serializer implementations.

Note that we strongly restrict the ordering of operations/properties

that may be used on the serializer in order to enforce correct usage.

In particular, if a `data=` argument is passed then:

.is_valid() - Available.

.initial_data - Available.

.validated_data - Only available after calling `is_valid()`

.errors - Only available after calling `is_valid()`

.data - Only available after calling `is_valid()`

If a `data=` argument is not passed then:

.is_valid() - Not available.

.initial_data - Not available.

.validated_data - Not available.

.errors - Not available.

.data - Available.

"""

def __init__(self, instance=None, data=empty, **kwargs):. . .

خیلی خوب توضیح میده که اگر به serializer پارامتر data رو پاس داده باشیم تابع is_valid قابل استفاده است. و initial_data هم در دسترس هست که همون دیتایی هست که به API پاس داده شده. بعد از is_valid این داده ورودی به valid شده تبدیل میشه که میتونیم توی validated_data ببینیم. مثلا اگر Id به object مربوطه تبدیل میشه. و errors و data هم در دسترس خواهد بود. data درواقع اون رکورد جدیدی هست که ایجاد شده است.

مثال زیر رو ببینید:

    def create(self, request, *args, **kwargs):
        serializer = self.get_serializer(data=request.data)

        if not serializer.is_valid():
            return Response(
                {"errors": serializer.errors},
                status.HTTP_400_BAD_REQUEST
            )

        self.perform_create(serializer)

        print("-----------------------------")
        print(serializer.initial_data)
        print(serializer.validated_data)
        print(serializer.errors)
        print(serializer.data)

        create_update_related_chain(serializer.instance, False)
        return Response(serializer.data, status.HTTP_201_CREATED)

def create(self, request, *args, **kwargs):

serializer = self.get_serializer(data=request.data)

if not serializer.is_valid():

return Response(

{"errors": serializer.errors},

status.HTTP_400_BAD_REQUEST

)

self.perform_create(serializer)

print("-----------------------------")

print(serializer.initial_data)

print(serializer.validated_data)

print(serializer.errors)

print(serializer.data)

create_update_related_chain(serializer.instance, False)

return Response(serializer.data, status.HTTP_201_CREATED)

میبینید که بعد serializer.is_valid() مقادیر مربوطه رو پرینت کردم.

مثال خروجی هم در ادامه میبینید:

-----------------------------
{'provider': 159, 'consumer': 156, 'interface': 164, 'interface2': 161, 'protocol': 2, 'lt': 0, 'description': '', 'api': '', 'frequency': 0, 'ProviderVerified': False, 'ConsumerVerified': False, 'ESBVerified': False, 'api_gateway': False, 'active': False}
OrderedDict({'provider': <Service: Active probe(pixip)>, 'consumer': <Service: AOTA(hasin)>, 'interface': <Service: Behsa Proxy(external)>, 'interface2': <Service: GFEP(external)>, 'protocol': <Protocol: SFTP>, 'lt': 0, 'description': '', 'api': '', 'frequency': 0.0, 'ProviderVerified': False, 'ConsumerVerified': False, 'ESBVerified': False, 'api_gateway': False, 'active': False})
{}
{'id': 1303, 'provider': 159, 'provider_name': 'active_probe', 'consumer': 156, 'consumer_name': 'aota', 'interface': 164, 'interface_name': 'behsa_proxy', 'interface2': 161, 'interface2_name': 'gfep', 'protocol': 2, 'protocol_name': 'sftp', 'lt': 0, 'lt_display': 'COMMAND', 'description': '', 'api': '', 'frequency': 0.0, 'ProviderVerified': False, 'ConsumerVerified': False, 'ESBVerified': False, 'api_gateway': False, 'active': False}

-----------------------------

{'provider': 159, 'consumer': 156, 'interface': 164, 'interface2': 161, 'protocol': 2, 'lt': 0, 'description': '', 'api': '', 'frequency': 0, 'ProviderVerified': False, 'ConsumerVerified': False, 'ESBVerified': False, 'api_gateway': False, 'active': False}

OrderedDict({'provider': <Service: Active probe(pixip)>, 'consumer': <Service: AOTA(hasin)>, 'interface': <Service: Behsa Proxy(external)>, 'interface2': <Service: GFEP(external)>, 'protocol': <Protocol: SFTP>, 'lt': 0, 'description': '', 'api': '', 'frequency': 0.0, 'ProviderVerified': False, 'ConsumerVerified': False, 'ESBVerified': False, 'api_gateway': False, 'active': False})

{}

{'id': 1303, 'provider': 159, 'provider_name': 'active_probe', 'consumer': 156, 'consumer_name': 'aota', 'interface': 164, 'interface_name': 'behsa_proxy', 'interface2': 161, 'interface2_name': 'gfep', 'protocol': 2, 'protocol_name': 'sftp', 'lt': 0, 'lt_display': 'COMMAND', 'description': '', 'api': '', 'frequency': 0.0, 'ProviderVerified': False, 'ConsumerVerified': False, 'ESBVerified': False, 'api_gateway': False, 'active': False}

بازنویسی serializer توی Django Rest Framework

توی serializer های DRF گاهی لازمه وقتی متد list() اون صدا زده میشه باید قبلش دیتایی که ازش گرفته میشه تغییری بدیم برای این کار از متد to_representaion استفاده میکنیم.

class LinkAPISerializer(serializers.ModelSerializer):
    provider_name = serializers.CharField(source='provider.name_fixed', read_only=True)
    consumer_name = serializers.CharField(source='consumer.name_fixed', read_only=True)
    interface_name = serializers.CharField(source='interface.name_fixed', read_only=True)
    interface2_name = serializers.CharField(source='interface2.name_fixed', read_only=True)
    protocol_name = serializers.CharField(source='protocol.name_fixed', read_only=True)
    lt_display = serializers.CharField(source='get_lt_display', read_only=True)

    class Meta:
        model = Link
        fields = [
            'id', 'provider', 'provider_name', 'consumer', 'consumer_name', 'interface', 'interface_name', 'interface2',
            'interface2_name', 'protocol', 'protocol_name', 'lt', 'lt_display', 'description', 'api', 'frequency',
            'ProviderVerified', 'ConsumerVerified', 'ESBVerified', 'api_gateway', 'active'
        ]

    def to_representation(self, instance):
        data = super().to_representation(instance)
        if data.get('description'):
            data['description'] = data['description'].strip('\"')

        return data

class LinkAPISerializer(serializers.ModelSerializer):

provider_name = serializers.CharField(source='provider.name_fixed', read_only=True)

consumer_name = serializers.CharField(source='consumer.name_fixed', read_only=True)

interface_name = serializers.CharField(source='interface.name_fixed', read_only=True)

interface2_name = serializers.CharField(source='interface2.name_fixed', read_only=True)

protocol_name = serializers.CharField(source='protocol.name_fixed', read_only=True)

lt_display = serializers.CharField(source='get_lt_display', read_only=True)

class Meta:

model = Link

fields = [

'id', 'provider', 'provider_name', 'consumer', 'consumer_name', 'interface', 'interface_name', 'interface2',

'interface2_name', 'protocol', 'protocol_name', 'lt', 'lt_display', 'description', 'api', 'frequency',

'ProviderVerified', 'ConsumerVerified', 'ESBVerified', 'api_gateway', 'active'

]

def to_representation(self, instance):

data = super().to_representation(instance)

if data.get('description'):

data['description'] = data['description'].strip('\"')

return data

دپلوی React و Django در Docker

برای دپلوی کردن یک پروژه Django و React در داکر با کانفیگ زیر کار میکنیم:

version: '3.8'

services:
  frontend:
    build:
      context: ./frontend/shift-front
    container_name: frontend
    ports:
      - "3000:3000"
    volumes:
      - ./frontend/shift-front:/app  
      - ./frontend/shift-front/dist:/usr/share/nginx/html  
    environment:
      - NODE_ENV=production
    networks:
      - app-network
  backend:
    build:
      context: ./backend/shiftsupervisor
    container_name: backend
    ports:
      - "8000:8000"
    volumes:
      - ./backend/shiftsupervisor:/app  
      - ./backend/shiftsupervisor/static:/app/static  
      - ./backend/shiftsupervisor/staticfiles:/app/staticfiles  
      - ./backend/shiftsupervisor/media:/app/media  
    environment:
      - DEBUG=1
    networks:
      - app-network
  nginx:
    build:
        context: ./frontend/shift-front 
        dockerfile: Dockerfile
    container_name: nginx
    ports:
      - "80:80"
    volumes:
      - ./nginx/nginx.conf:/etc/nginx/nginx.conf:ro
      - ./backend/shiftsupervisor/static:/static
      - ./backend/shiftsupervisor/media:/media
    depends_on:
      - frontend
      - backend
    networks:
      - app-network
networks:
  app-network:
    driver: bridge

version: '3.8'

services:

frontend:

build:

context: ./frontend/shift-front

container_name: frontend

ports:

- "3000:3000"

volumes:

- ./frontend/shift-front:/app

- ./frontend/shift-front/dist:/usr/share/nginx/html

environment:

- NODE_ENV=production

networks:

- app-network

backend:

build:

context: ./backend/shiftsupervisor

container_name: backend

ports:

- "8000:8000"

volumes:

- ./backend/shiftsupervisor:/app

- ./backend/shiftsupervisor/static:/app/static

- ./backend/shiftsupervisor/staticfiles:/app/staticfiles

- ./backend/shiftsupervisor/media:/app/media

environment:

- DEBUG=1

networks:

- app-network

nginx:

build:

context: ./frontend/shift-front

dockerfile: Dockerfile

container_name: nginx

ports:

- "80:80"

volumes:

- ./nginx/nginx.conf:/etc/nginx/nginx.conf:ro

- ./backend/shiftsupervisor/static:/static

- ./backend/shiftsupervisor/media:/media

depends_on:

- frontend

- backend

networks:

- app-network

networks:

app-network:

driver: bridge

فایل بالا compose است و فایل backend/shiftsupervisor/Dockerfile

FROM python:3.12-slim

WORKDIR /app

RUN apt-get update && apt-get install -y --no-install-recommends \
    build-essential \
    libsqlite3-dev \
    && apt-get clean && rm -rf /var/lib/apt/lists/*

COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt

COPY . .


RUN python manage.py collectstatic --noinput

EXPOSE 8000
CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]

FROM python:3.12-slim

WORKDIR /app

RUN apt-get update && apt-get install -y --no-install-recommends \

build-essential \

libsqlite3-dev \

&& apt-get clean && rm -rf /var/lib/apt/lists/*

COPY requirements.txt .

RUN pip install --no-cache-dir -r requirements.txt

COPY . .

RUN python manage.py collectstatic --noinput

EXPOSE 8000

CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]

و فایل frontend/shiftfront/Dockerfile

FROM node:20 AS builder

WORKDIR /app

COPY package*.json ./
RUN npm install
COPY . ./
RUN npm run build

FROM nginx:latest
COPY --from=builder /app/dist /usr/share/nginx/html


EXPOSE 80
CMD ["nginx", "-g", "daemon off;"]

FROM node:20 AS builder

WORKDIR /app

COPY package*.json ./

RUN npm install

COPY . ./

RUN npm run build

FROM nginx:latest

COPY --from=builder /app/dist /usr/share/nginx/html

EXPOSE 80

CMD ["nginx", "-g", "daemon off;"]

و فایل nginx/nginx.conf

worker_processes 1;

events {
    worker_connections 1024;
}

http {
    include /etc/nginx/mime.types;
    default_type application/octet-stream;

    sendfile on;

    server {
        listen 80;

        location / {
            root /usr/share/nginx/html;
            index index.html;
            try_files $uri /index.html;
        }

        # Proxy requests to the backend
        location /api/ {
            rewrite ^/api/(.*)$ /$1 break;  # Remove /api/ before forwarding
            proxy_pass http://backend:8000;
            proxy_set_header Host $host;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        }

        location /static/ {
            alias /static/;
        }

        location /staticfiles/ {
            alias /app/staticfiles/;
        }

        location /media/ {
            alias /media/;
        }
    }
}

worker_processes 1;

events {

worker_connections 1024;

}

http {

include /etc/nginx/mime.types;

default_type application/octet-stream;

sendfile on;

server {

listen 80;

location / {

root /usr/share/nginx/html;

index index.html;

try_files $uri /index.html;

}

# Proxy requests to the backend

location /api/ {

rewrite ^/api/(.*)$ /$1 break; # Remove /api/ before forwarding

proxy_pass http://backend:8000;

proxy_set_header Host $host;

proxy_set_header X-Real-IP $remote_addr;

proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

}

location /static/ {

alias /static/;

}

location /staticfiles/ {

alias /app/staticfiles/;

}

location /media/ {

alias /media/;

}

در ضمن تنظیمات مهم برای settings.py

ALLOWED_HOSTS = [
    '*',  # Allow all hosts for testing purposes
    'localhost',
    '127.0.0.1',
    'frontend',
    'backend',
    'nginx',
]


MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
    'corsheaders.middleware.CorsMiddleware',
]

REST_FRAMEWORK = {
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.AllowAny',
    ]
}

CORS_ORIGIN_ALLOW_ALL = True

# If you want specific origins:
CORS_ALLOWED_ORIGINS = [
    'http://localhost:5173',
    'http://frontend:3000',
    'http://127.0.0.1:8000',
]


CORS_ALLOW_ALL_ORIGINS = True
CORS_ALLOW_CREDENTIALS = True

CSRF_TRUSTED_ORIGINS = [
    'http://localhost:5173',
    'http://127.0.0.1:8000',
    'http://frontend:3000',  # Container name and port
    'http://backend:8000',
    'http://nginx',
]


ROOT_URLCONF = 'config.urls'

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [BASE_DIR / 'templates'],  
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

WSGI_APPLICATION = 'config.wsgi.application'


DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': BASE_DIR / 'db.sqlite3',
    }
}

ALLOWED_HOSTS = [

'*', # Allow all hosts for testing purposes

'localhost',

'127.0.0.1',

'frontend',

'backend',

'nginx',

]

MIDDLEWARE = [

'django.middleware.security.SecurityMiddleware',

'django.contrib.sessions.middleware.SessionMiddleware',

'django.middleware.common.CommonMiddleware',

'django.middleware.csrf.CsrfViewMiddleware',

'django.contrib.auth.middleware.AuthenticationMiddleware',

'django.contrib.messages.middleware.MessageMiddleware',

'django.middleware.clickjacking.XFrameOptionsMiddleware',

'corsheaders.middleware.CorsMiddleware',

]

REST_FRAMEWORK = {

'DEFAULT_PERMISSION_CLASSES': [

'rest_framework.permissions.AllowAny',

]

}

CORS_ORIGIN_ALLOW_ALL = True

# If you want specific origins:

CORS_ALLOWED_ORIGINS = [

'http://localhost:5173',

'http://frontend:3000',

'http://127.0.0.1:8000',

]

CORS_ALLOW_ALL_ORIGINS = True

CORS_ALLOW_CREDENTIALS = True

CSRF_TRUSTED_ORIGINS = [

'http://localhost:5173',

'http://127.0.0.1:8000',

'http://frontend:3000', # Container name and port

'http://backend:8000',

'http://nginx',

]

ROOT_URLCONF = 'config.urls'

TEMPLATES = [

{

'BACKEND': 'django.template.backends.django.DjangoTemplates',

'DIRS': [BASE_DIR / 'templates'],

'APP_DIRS': True,

'OPTIONS': {

'context_processors': [

'django.template.context_processors.debug',

'django.template.context_processors.request',

'django.contrib.auth.context_processors.auth',

'django.contrib.messages.context_processors.messages',

]

WSGI_APPLICATION = 'config.wsgi.application'

DATABASES = {

'default': {

'ENGINE': 'django.db.backends.sqlite3',

'NAME': BASE_DIR / 'db.sqlite3',

}

فایل axiosConfig.jsx

import axios from "axios";

const getCSRFToken = () => {
  let csrfToken = null;
  const csrfCookie = document.cookie
    .split("; ")
    .find((row) => row.startsWith("csrftoken="));
  if (csrfCookie) {
    csrfToken = csrfCookie.split("=")[1];
  }

  return csrfToken;
};

const api = axios.create({
  baseURL: "/api/", // Add /api/ prefix
  headers: {
    "X-CSRFToken": getCSRFToken(),
    "Content-Type": "application/json",
  },
  withCredentials: true,
});

export default api;

import axios from "axios";

const getCSRFToken = () => {

let csrfToken = null;

const csrfCookie = document.cookie

.split("; ")

.find((row) => row.startsWith("csrftoken="));

if (csrfCookie) {

csrfToken = csrfCookie.split("=")[1];

}

return csrfToken;

};

const api = axios.create({

baseURL: "/api/", // Add /api/ prefix

headers: {

"X-CSRFToken": getCSRFToken(),

"Content-Type": "application/json",

withCredentials: true,

});

export default api;

و فایل vite.config.js

export default defineConfig({
  plugins: [react()],
  build: {
    outDir: "dist", 
  },
});

export default defineConfig({

plugins: [react()],

build: {

outDir: "dist",

});