-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdjango_project_init.py
More file actions
4061 lines (3322 loc) · 119 KB
/
django_project_init.py
File metadata and controls
4061 lines (3322 loc) · 119 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
File: django_project_init.py
Purpose: Django项目初始化脚本,用于创建符合最佳实践的项目结构
"""
import datetime
import re
import os
import sys
import shutil
import subprocess
from pathlib import Path
import argparse
# 初始应用列表配置(当没有通过命令行指定应用时使用)
INITIAL_APPS = [
'main', # 默认主应用,表示系统的主要功能
]
# 禁止使用的应用名列表
FORBIDDEN_APP_NAMES = [
'admin', # Django内置管理后台
'auth', # Django认证系统
'contenttypes', # Django内容类型系统
'sessions', # Django会话系统
'messages', # Django消息系统
'staticfiles', # Django静态文件系统
'sites', # Django站点框架
]
# 建议的替代名称映射
APP_NAME_SUGGESTIONS = {
'admin': ['management', 'administration', 'backend'],
'auth': ['authentication', 'accounts', 'users'],
'staticfiles': ['assets', 'resources', 'static_resources'],
'messages': ['notifications', 'alerts'],
}
def check_forbidden_app_names(app_names):
"""
检查是否存在禁止使用的应用名
Args:
app_names: 要检查的应用名列表
Returns:
tuple: (是否包含禁用名, 禁用名列表, 建议名称字典)
"""
if app_names is None:
return False, [], {}
forbidden_names = []
suggestions = {}
for app_name in app_names:
if app_name in FORBIDDEN_APP_NAMES:
forbidden_names.append(app_name)
suggestions[app_name] = APP_NAME_SUGGESTIONS.get(app_name, [f'custom_{app_name}'])
return bool(forbidden_names), forbidden_names, suggestions
# 运行模式
MODE_INIT = 'init' # 初始化模式
MODE_ADD_APP = 'add' # 增加应用模式
def get_default_project_name():
"""获取默认项目名(当前目录名)"""
return Path.cwd().name
def check_project_exists(project_name):
"""检查项目是否已存在"""
project_dir = Path.cwd() / project_name
return project_dir.exists()
def parse_arguments():
"""解析命令行参数"""
parser = argparse.ArgumentParser(
description='Django项目初始化/应用添加脚本',
epilog='''
示例:
# 初始化新项目:
python django_project_init.py --mode init -p myproject
python django_project_init.py --mode init -p myproject -a user blog admin
# 在现有项目中添加应用:
python django_project_init.py --mode add -p myproject -a newapp1 newapp2
python django_project_init.py --mode add -a newapp --auto-update
# 还原配置到最新备份:
python django_project_init.py --restore # 在项目内执行
python django_project_init.py -p myproject --restore # 在项目外执行
'''
)
# restore操作作为独立的运行模式
parser.add_argument('--restore',
action='store_true',
default=False,
help='还原配置文件到最新备份')
# 运行模式,当有restore参数时忽略
parser.add_argument('--mode',
choices=[MODE_INIT, MODE_ADD_APP],
default=MODE_INIT,
help=f'运行模式: {MODE_INIT}=初始化项目, {MODE_ADD_APP}=添加应用')
# 项目名称参数
parser.add_argument('-p', '--project',
default=None,
help='项目名称(默认:当前目录名)')
# 应用名称参数
parser.add_argument('-a', '--apps',
nargs='*',
default=None,
help='要创建的应用列表(默认:main)')
# 自动更新设置参数
parser.add_argument('--auto-update',
action='store_true',
default=False,
help='自动更新项目配置文件(settings.py和urls.py)')
# 开发指南输出参数
parser.add_argument('--guide',
action='store_true',
default=False,
help='只输出开发指南文档')
# 开发指南输出文件名参数
parser.add_argument('--guide-output',
default='app_development_guide.md',
help='开发指南输出文件名(默认: app_development_guide.md)')
parser.add_argument('--no-rest-swagger',
action='store_true',
default=False,
help='不添加REST Framework和Swagger配置')
args = parser.parse_args()
# 当使用restore时,不需要检查其他参数
if args.restore:
if args.apps:
print("警告: 还原模式下不需要指定应用名称,将忽略 -a/--apps 参数")
if args.mode != MODE_INIT:
print("警告: 还原模式下不需要指定运行模式,将忽略 --mode 参数")
if args.auto_update:
print("警告: 还原模式下不需要指定自动更新,将忽略 --auto-update 参数")
# 如果没有指定项目名,使用当前目录名
if args.project is None:
args.project = get_default_project_name()
return args
def create_directory(path):
"""创建目录,如果目录不存在"""
try:
os.makedirs(path, exist_ok=True)
print(f"? 创建目录: {path}")
except Exception as e:
print(f"? 创建目录失败 {path}: {str(e)}")
return False
return True
def create_file(path, content=''):
"""创建文件,如果文件不存在"""
try:
if not os.path.exists(path):
with open(path, 'w', encoding='utf-8') as f:
f.write(content)
print(f"? 创建文件: {path}")
else:
print(f"! 文件已存在: {path}")
except Exception as e:
print(f"? 创建文件失败 {path}: {str(e)}")
return False
return True
def create_app_structure(app_name, project_name, base_dir):
"""创建应用的完整目录结构和文件"""
normalized_app_name = normalize_app_name(app_name)
class_name = get_app_class_name(normalized_app_name)
app_dir = base_dir / 'apps' / app_name
# 创建应用基础目录
directories = [
'migrations', # [Django必需] 数据库迁移文件目录
'core', # [自定义] 核心业务逻辑目录 - 存放所有与Django无关的业务逻辑、算法、数据处理等代码
# MVF目录 - 每个都有自己的__init__.py
'models', # 存放所有模型定义文件
'views', # 存放所有视图处理文件
'serializers', # 存放所有序列化器文件
'forms', # 存放所有表单定义文件
f'templates/{app_name}', # [Django] 应用级HTML模板目录
f'templates/{app_name}/components', # [Django] 可重用的模板组件目录
f'static/{app_name}/css', # [Django] CSS样式文件目录
f'static/{app_name}/js', # [Django] JavaScript文件目录
f'static/{app_name}/images', # [Django] 图片资源目录
'services', # [Django集成] 服务层目录 - 主要用于连接core层和Django层的facade服务
'helpers', # [Django集成] 辅助函数目录 - 处理Django相关的工具函数
'api', # [Django REST] REST API相关代码目录
'tests/test_services', # [测试] 服务层测试目录
'management/commands', # [Django] 自定义管理命令目录
]
# 确保基础目录创建成功
if not create_directory(app_dir):
return False
success = True # 添加成功标志
for directory in directories:
if not create_directory(app_dir / directory):
success = False
continue
# 修改:优化__init__.py创建逻辑
if not any(directory.startswith(prefix) for prefix in ['templates/', 'static/']):
if not create_file(app_dir / directory / '__init__.py',
f'"""\nFile: apps/{app_name}/{directory}/__init__.py\nPurpose: {directory}包的初始化文件\n"""\n'):
success = False
# 添加MVF目录的示例文件
mvf_examples = {
'models/base.py': f'''"""
File: apps/{app_name}/models/base.py
Purpose: 基础数据模型定义
"""
from django.db import models
class BaseModel(models.Model):
"""所有模型的基类"""
created_at = models.DateTimeField(auto_now_add=True, verbose_name='创建时间')
updated_at = models.DateTimeField(auto_now=True, verbose_name='更新时间')
class Meta:
abstract = True
''',
'views/base.py': f'''"""
File: apps/{app_name}/views/base.py
Purpose: 基础视图定义
"""
from django.shortcuts import render
from django.views import View
class BaseView(View):
"""基础视图类"""
template_name = None
def get_context_data(self, **kwargs):
context = {{
'title': '{app_name.title()}',
'project_name': '{project_name}'
}}
context.update(kwargs)
return context
''',
'serializers/base.py': f'''"""
File: apps/{app_name}/serializers/base.py
Purpose: 基础序列化器定义
"""
from rest_framework import serializers
class BaseModelSerializer(serializers.ModelSerializer):
"""基础模型序列化器"""
class Meta:
abstract = True
read_only_fields = ['created_at', 'updated_at']
def validate(self, attrs):
"""通用验证钩子"""
return super().validate(attrs)
''',
'forms/base.py': f'''"""
File: apps/{app_name}/forms/base.py
Purpose: 基础表单定义
"""
from django import forms
class BaseForm(forms.Form):
"""基础表单类"""
def clean(self):
cleaned_data = super().clean()
return cleaned_data
'''
}
# 创建MVF示例文件
for file_path, content in mvf_examples.items():
if not create_file(app_dir / file_path, content):
success = False
# 添加init文件
mvf_examples.update({
'models/__init__.py': f'''"""
File: apps/{app_name}/models/__init__.py
Purpose: 汇总导出所有模型
"""
from apps.{normalized_app_name}.models.base import BaseModel
''',
'views/__init__.py': f'''"""
File: apps/{app_name}/views/__init__.py
Purpose: 汇总导出所有视图
"""
from apps.{normalized_app_name}.views.base import BaseView
''',
'forms/__init__.py': f'''"""
File: apps/{app_name}/forms/__init__.py
Purpose: 汇总导出所有表单
"""
from apps.{normalized_app_name}.forms.base import BaseForm
'''
})
# 举个实际模块的例子
if app_name == 'data_processor': # 假设这是数据处理应用
mvf_examples.update({
'models/excel_data.py': f'''"""
File: apps/{app_name}/models/excel_data.py
Purpose: Excel数据模型定义
"""
from .base import BaseModel
class ExcelData(BaseModel):
"""Excel数据模型"""
file_name = models.CharField(max_length=255, verbose_name='文件名')
sheet_name = models.CharField(max_length=100, verbose_name='工作表名')
row_count = models.IntegerField(verbose_name='行数')
# 其他字段...
''',
'views/excel_processor.py': f'''"""
File: apps/{app_name}/views/excel_processor.py
Purpose: Excel处理视图
"""
from apps.{normalized_app_name}.views.base import BaseView
from apps.{normalized_app_name}.services.excel_service import ExcelService
class ExcelUploadView(BaseView):
template_name = '{app_name}/excel_upload.html'
def post(self, request):
service = ExcelService()
result = service.process_upload(request.FILES['file'])
return JsonResponse(result)
''',
'forms/excel_upload.py': f'''"""
File: apps/{app_name}/forms/excel_upload.py
Purpose: Excel上传表单
"""
from .base import BaseForm
class ExcelUploadForm(BaseForm):
file = forms.FileField(label='Excel文件')
sheet_name = forms.CharField(label='工作表名', required=False)
def clean_file(self):
file = self.cleaned_data['file']
if not file.name.endswith(('.xlsx', '.xls')):
raise forms.ValidationError('请上传Excel文件')
return file
'''
})
normalized_app_name = normalize_app_name(app_name)
class_name = get_app_class_name(normalized_app_name)
# 创建应用基础文件
files = {
'__init__.py': f'"""\nFile: apps/{normalized_app_name}/__init__.py\nPurpose: {normalized_app_name}应用的初始化文件\n"""\n',
'apps.py': f'''"""
File: apps/{normalized_app_name}/apps.py
Purpose: {normalized_app_name}应用的配置类
Warning: 此文件由系统自动生成,请勿手动修改
"""
from django.apps import AppConfig
class {class_name}Config(AppConfig):
default_auto_field = 'django.db.models.BigAutoField'
name = 'apps.{normalized_app_name}'
verbose_name = '{normalized_app_name.title().replace("_", " ")}模块'
''',
'urls.py': f'''"""
File: apps/{normalized_app_name}/urls.py
Purpose: {normalized_app_name}应用的URL配置
"""
from django.urls import path
from apps.{normalized_app_name}.views.base import BaseView
app_name = '{normalized_app_name}'
urlpatterns = [
path('', BaseView.as_view(), name='index'),
]
''',
'admin.py': f'''"""
File: apps/{app_name}/admin.py
Purpose: {app_name}应用的后台管理配置
"""
from django.contrib import admin
# Register your models here.
''',
'constants.py': f'''"""
File: apps/{app_name}/constants.py
Purpose: {app_name}应用的常量定义
"""
# Application-specific constants
''',
'exceptions.py': f'''"""
File: apps/{app_name}/exceptions.py
Purpose: {app_name}应用的自定义异常
"""
class {app_name.title()}Error(Exception):
"""Base exception for {app_name} app"""
pass
''',
'utils.py': f'''"""
File: apps/{app_name}/utils.py
Purpose: {app_name}应用的工具函数
"""
# Utility functions
''',
'services/data_service.py': f'''"""
File: apps/{app_name}/services/data_service.py
Purpose: {app_name}应用的数据服务
"""
# Data service functions
''',
'helpers/formatters.py': f'''"""
File: apps/{app_name}/helpers/formatters.py
Purpose: {app_name}应用的格式化助手函数
"""
# Formatting helper functions
''',
'api/views.py': f'''"""
File: apps/{app_name}/api/views.py
Purpose: {app_name}应用的API视图
"""
from rest_framework import viewsets
# API Views
''',
'api/urls.py': f'''"""
File: apps/{app_name}/api/urls.py
Purpose: {app_name}应用的API路由配置
"""
from django.urls import path, include
from rest_framework.routers import DefaultRouter
router = DefaultRouter()
# router.register('resource', ViewSet)
urlpatterns = [
path('', include(router.urls)),
]
''',
'tests/test_models.py': f'''"""
File: apps/{app_name}/tests/test_models.py
Purpose: {app_name}应用的模型测试
"""
from django.test import TestCase
# Model tests
''',
'tests/test_views.py': f'''"""
File: apps/{app_name}/tests/test_views.py
Purpose: {app_name}应用的视图测试
"""
from django.test import TestCase, Client
class ViewTests(TestCase):
def setUp(self):
self.client = Client()
def test_index_view(self):
response = self.client.get('/{app_name}/')
self.assertEqual(response.status_code, 200)
''',
'tests/test_services/test_data_service.py': f'''"""
File: apps/{app_name}/tests/test_services/test_data_service.py
Purpose: {app_name}应用的服务测试
"""
from django.test import TestCase
# Service tests
''',
'management/commands/process_data.py': f'''"""
File: apps/{app_name}/management/commands/process_data.py
Purpose: {app_name}应用的示例管理命令
"""
from django.core.management.base import BaseCommand
class Command(BaseCommand):
help = '处理{app_name}数据的示例命令'
def add_arguments(self, parser):
parser.add_argument('--action', type=str, help='要执行的操作')
def handle(self, *args, **options):
self.stdout.write(self.style.SUCCESS('命令执行成功'))
''',
f'templates/{app_name}/base.html': f'''{{% extends "../base.html" %}}
{{% block title %}}{app_name.title()} - {{{{project_name}}}}{{% endblock %}}
{{% block content %}}
{{% endblock %}}
''',
f'templates/{app_name}/index.html': f'''{{% extends "{app_name}/base.html" %}}
{{% block title %}}{{{{title}}}}{{% endblock %}}
{{% block content %}}
<div class="container mx-auto px-4 py-8">
<h1 class="text-3xl font-bold mb-4">{{{{title}}}}</h1>
{{% if app_name == "main" %}}<p class="text-lg">欢迎使用 {{{{project_name}}}} 系统</p>{{% endif %}}
</div>
{{% endblock %}}
''',
f'templates/{app_name}/components/header.html': '''{% load static %}
<header class="main-header">
<nav class="container mx-auto px-4 py-2">
<!-- Header content -->
</nav>
</header>
''',
f'static/{app_name}/css/style.css': '''/* Application specific styles */
''',
f'static/{app_name}/js/main.js': '''// Application specific JavaScript
''',
'bootstrap.py': f'''"""
File: apps/{app_name}/bootstrap.py
Purpose: 应用启动器,用于设置Python导入路径和项目关键常量
"""
import os
import sys
from typing import Tuple, Optional, Set, List
from pathlib import Path
class PathManager:
"""路径管理器,处理Python导入路径的添加和去重"""
_instance = None
_initialized_paths: Set[str] = set() # 类变量,跟踪所有已初始化的路径
def __new__(cls):
"""确保PathManager为单例"""
if cls._instance is None:
cls._instance = super().__new__(cls)
return cls._instance
@staticmethod
def _normalize_path(path: str) -> str:
"""标准化路径格式,确保路径比较的一致性"""
return os.path.normpath(os.path.abspath(path))
def add_paths(self, *paths: str) -> List[str]:
"""
将路径添加到Python导入路径中,确保不重复添加
Args:
*paths: 要添加的路径列表
Returns:
List[str]: 实际添加的路径列表(排除重复的)
"""
# 标准化所有输入路径
normalized_paths = {{self._normalize_path(p) for p in paths}}
# 排除已经初始化过的路径
new_paths = normalized_paths - self._initialized_paths
if not new_paths:
return []
# 移除可能存在的重复路径(考虑不同形式的相同路径)
for path in list(sys.path):
norm_path = self._normalize_path(path)
if norm_path in new_paths:
sys.path.remove(path)
# 添加新路径到sys.path开头
added_paths = []
for path in new_paths: # 使用new_paths而不是paths_to_add
sys.path.insert(0, path)
added_paths.append(path)
self._initialized_paths.add(path)
return added_paths
def get_current_paths(self) -> Set[str]:
"""获取当前的Python导入路径集合(标准化后的)"""
return {{self._normalize_path(path) for path in sys.path}}
def get_initialized_paths(self) -> Set[str]:
"""获取所有已经初始化过的路径"""
return self._initialized_paths.copy()
def _get_env_path(env_var: str, default: Optional[str] = None) -> Optional[str]:
"""获取环境变量中定义的路径,如果存在则返回绝对路径"""
path = os.getenv(env_var)
if path:
return os.path.abspath(path)
return default
def setup_paths() -> Tuple[str, str]:
"""
设置应用级别和项目级别的Python导入路径
Returns:
Tuple[str, str]: (应用根目录路径, 项目根目录路径)
"""
# 首先尝试从环境变量获取路径
app_root = _get_env_path('APP_ROOT')
project_root = _get_env_path('PROJECT_ROOT')
if not all([app_root, project_root]):
# 获取当前文件所在目录(应用根目录)
app_root = os.path.dirname(os.path.abspath(__file__))
# 获取项目根目录(当前目录往上两级)
project_root = os.path.dirname(os.path.dirname(app_root))
# 实例化路径管理器
path_manager = PathManager()
# 标准化路径
app_root = path_manager._normalize_path(app_root)
project_root = path_manager._normalize_path(project_root)
# 验证目录是否存在
if not all(os.path.isdir(d) for d in (app_root, project_root)):
raise RuntimeError(
f"Invalid paths - app_root: {{app_root}}, project_root: {{project_root}}"
)
# 使用PathManager添加路径
path_manager.add_paths(project_root, app_root)
return app_root, project_root
# 在模块导入时自动执行路径设置
APP_ROOT, PROJECT_ROOT = setup_paths()
# 导出项目关键路径常量
APPS_DIR = os.path.dirname(APP_ROOT)
CONFIG_DIR = os.path.join(PROJECT_ROOT, 'config')
LOGS_DIR = os.path.join(PROJECT_ROOT, 'logs')
MEDIA_DIR = os.path.join(PROJECT_ROOT, 'media')
STATIC_DIR = os.path.join(PROJECT_ROOT, 'static')
TEMPLATES_DIR = os.path.join(PROJECT_ROOT, 'templates')
UPLOADS_DIR = os.path.join(MEDIA_DIR, 'uploads')
# 定义Path对象,方便路径操作
APP_ROOT_PATH = Path(APP_ROOT)
PROJECT_ROOT_PATH = Path(PROJECT_ROOT)
APPS_PATH = Path(APPS_DIR)
CONFIG_PATH = Path(CONFIG_DIR)
LOGS_PATH = Path(LOGS_DIR)
MEDIA_PATH = Path(MEDIA_DIR)
STATIC_PATH = Path(STATIC_DIR)
TEMPLATES_PATH = Path(TEMPLATES_DIR)
UPLOADS_PATH = Path(UPLOADS_DIR)
# 确保关键目录存在
for directory in (LOGS_DIR, MEDIA_DIR, STATIC_DIR, UPLOADS_DIR):
os.makedirs(directory, exist_ok=True)
def get_app_name() -> str:
"""获取当前应用的名称"""
return os.path.basename(APP_ROOT)
def get_relative_path(path: str) -> str:
"""获取相对于项目根目录的相对路径"""
return os.path.relpath(path, PROJECT_ROOT)
def get_python_paths() -> Set[str]:
"""获取当前的Python路径集合(用于调试)"""
path_manager = PathManager()
return path_manager.get_current_paths()
# 如果这个文件被直接运行,打印路径信息用于调试
if __name__ == '__main__':
path_manager = PathManager()
print(f"Current Configuration:")
print(f"=====================")
print(f"Project Root: {{PROJECT_ROOT}}")
print(f"Apps Dir: {{APPS_DIR}}")
print(f"App Root: {{APP_ROOT}}")
print(f"App Name: {{get_app_name()}}")
print(f"\\nInitialized Paths:")
print(f"=================")
for path in sorted(path_manager.get_initialized_paths()):
print(f" - {{path}}")
print(f"\\nPython Path:")
print(f"============")
for path in sorted(path_manager.get_current_paths()):
print(f" - {{path}}")
''',
'APP_DEVELOPMENT_GUIDE.md': get_app_development_guide(),
}
for file_path, content in files.items():
if not create_file(app_dir / file_path, content):
success = False
return success
def get_app_development_guide():
"""获取应用开发指南内容"""
return '''# Django应用开发规范指南
## 1. 目录结构与职责
### 1.1 核心业务目录 (core/)
- 用途:存放所有与Django无关的业务逻辑
- 特点:可独立运行、测试和复用
- 适合内容:
* 数据处理算法
* 业务逻辑
* 工具函数
* 自定义异常
* 数据模型(非Django ORM)
### 1.2 服务集成目录 (services/)
- 用途:连接core层和Django层
- 特点:负责数据转换和上下文处理
- 适合内容:
* Facade服务类
* 数据转换逻辑
* Django特定的服务封装
### 1.3 API目录 (api/)
- 用途:REST API实现
- 适合内容:
* 序列化器
* API视图
* URL路由配置
### 1.4 模板目录 (templates/)
- 用途:HTML模板
- 适合内容:
* 页面模板
* 可重用组件
### 1.5 静态文件目录 (static/)
- 用途:前端资源
- 适合内容:
* CSS样式
* JavaScript脚本
* 图片资源
### 1.6 其他目录
- migrations/: 数据库迁移文件
- helpers/: Django相关的辅助函数
- tests/: 测试代码
- management/: 自定义管理命令
## 2. 应用开发流程示例:Excel文件上传与显示
### 开发流程示例说明
本示例展示了一个完整的Django应用开发流程,功能是上传Excel文件并显示内容。
通过这个例子说明如何:
1. 在core中开发核心功能
2. 通过服务层集成到Django
3. 提供API接口
4. 实现前端界面
### 2.1 需求描述
创建一个应用,允许用户:
1. 上传Excel文件
2. 解析并显示内容
3. 基本的数据验证
### 2.2 示例开发步骤
#### Step 1: 核心功能实现 (core/)
```python
# core/excel_processor.py
import pandas as pd
from typing import Dict, Any
class ExcelProcessor:
"""Excel处理核心类"""
def __init__(self, file_path: str):
self.file_path = file_path
def read_excel(self) -> Dict[str, Any]:
"""读取并解析Excel文件"""
try:
df = pd.read_excel(self.file_path)
return {
'columns': df.columns.tolist(),
'data': df.to_dict('records'),
'row_count': len(df),
'col_count': len(df.columns)
}
except Exception as e:
raise ExcelProcessError(f"Excel处理错误: {str(e)}")
# core/exceptions.py
class ExcelProcessError(Exception):
"""Excel处理相关的异常"""
pass
```
#### Step 2: 服务层实现 (services/)
```python
# services/excel_service.py
from django.core.files.uploadedfile import UploadedFile
from ..core.excel_processor import ExcelProcessor, ExcelProcessError
class ExcelService:
"""Excel处理服务"""
def process_upload(self, uploaded_file: UploadedFile) -> dict:
"""处理上传的Excel文件"""
try:
# 保存上传文件
file_path = self._save_file(uploaded_file)
# 使用核心处理器
processor = ExcelProcessor(file_path)
result = processor.read_excel()
return {
'status': 'success',
'data': result
}
except ExcelProcessError as e:
return {
'status': 'error',
'message': str(e)
}
def _save_file(self, file: UploadedFile) -> str:
"""保存上传的文件"""
# 文件保存逻辑
pass
```
#### Step 3: API实现 (api/)
```python
# api/serializers.py
from rest_framework import serializers
class ExcelUploadSerializer(serializers.Serializer):
file = serializers.FileField()
# api/views.py
from rest_framework.views import APIView
from rest_framework.response import Response
from ..services.excel_service import ExcelService
class ExcelUploadView(APIView):
def post(self, request):
file = request.FILES.get('file')
if not file:
return Response({'error': 'No file uploaded'}, status=400)
service = ExcelService()
result = service.process_upload(file)
return Response(result)
```
#### Step 4: URL配置 (urls.py)
```python
from django.urls import path
from .api.views import ExcelUploadView
app_name = 'excel_processor'
urlpatterns = [
path('upload/', ExcelUploadView.as_view(), name='upload'),
]
```
#### Step 5: 前端模板 (templates/)
```html
<!-- templates/excel_processor/upload.html -->
{% extends "base.html" %}
{% block content %}
<div class="container">
<h2>Excel文件上传</h2>
<form id="uploadForm">
{% csrf_token %}
<input type="file" name="file" accept=".xlsx,.xls">
<button type="submit">上传</button>
</form>
<div id="result"></div>
</div>
{% endblock %}
{% block extra_js %}
<script>
document.getElementById('uploadForm').onsubmit = async (e) => {
e.preventDefault();
const formData = new FormData(e.target);
try {
const response = await fetch('/api/excel/upload/', {
method: 'POST',
body: formData
});
const result = await response.json();
// 显示结果
displayResult(result);
} catch (error) {
console.error('Upload failed:', error);
}
};
</script>
{% endblock %}
```
### 2.3 开发顺序建议
1. **先开发核心功能**
- 在core/目录下实现基本功能
- 可以写个简单的测试脚本验证
- 确保功能正确且独立可用
2. **编写服务层**
- 创建services/下的服务类
- 处理文件上传等Django特定逻辑
- 调用core层的功能
3. **实现API**
- 创建序列化器
- 实现API视图