-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsteps.txt
3298 lines (2488 loc) · 94 KB
/
steps.txt
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
1. Setup
Create folder && cd in
Create venv
Activate venv
Install poetry
Poetry init
poetry add django
poetry shell (optionally)
django-admin
django-admin startproject config .
-------------------------------------------------------------------------
2-3. OOP & Django Basics
py manage.py runserver
sb.sqlite3 created
nav to http://127.0.0.1:8000//admin
close
py manage.py migrate && py manage.py runserver
py manage.py createsuperuser
config > settings.py > change timezone and language of server
-------------------------------------------------------------------------
4. Django Apps
py manage.py startapp houses
houses > models > Create house models
config > settings >
installed_apps = system_apps + custom_apps
add houses app to custom apps ("houses.apps.HousesConfig")
houses > admin >
from .models import House
@admin.register(House)
class HouseAdmin(admin.ModelAdmin):
pass
killserver & py manage.py makemigrations & migrate & runserver
Add House > Save > Change __str__ of model so it no longer shows "object"
models >
def __str__(self):
return self.name
admin >
list_display = ["name", "price_per_night", "pets_allowed",]
list_filter = ["price_per_night", "pets_allowed",]
search_fields = ["address__startswith",]
-------------------------------------------------------------------------
5. Users App
py manage.py startapp users
config > settings > "users.apps.UsersConfig" add
models >
from django.contrib.auth.models import AbstractUser
class User(AbstractUser):
pass
config > settings > AUTH_USER_MODEL = "users.User"
Gut db and migrations files
py manage.py makemigrations
py manage.py migrate
py manage.py createsuperuser
admin >
from django.contrib.auth.admin import UserAdmin
from .models import UserModel
@admin.register(UserModel)
class CustomUserAdmin(UserAdmin):
pass
overwrite AbstractUser first and last names to be non-editable
first_name = models.CharField(
max_length=150,
editable=False,
)
last_name = models.CharField(
max_length=150,
editable=False,
)
do user model custom fields
defaults for is_host and name so existing users dont get error
add fieldsets/ fields to admin
fieldsets = (
("Profile",
{
"fields":("username","password","name","email","is_host"),
},
),
("Permissions",
{
"fields": (
"is_active",
"is_staff",
"is_superuser",
"groups",
"user_permissions"
),
"classes": ("collapse",),
},
),
("Important Dates",
{
"fields":("last_login","date_joined"),
"classes": ("collapse",),
},
),
)
fields = ["email","password","name"]
visit http://127.0.0.1:8000/admin/users/user/1/change/
do list_display
add foreign key of user to house as owner
owner = models.ForeignKey(
"users.User",
on_delete=models.CASCADE, (SetNULL for payments - records u need to keep)
)
killserver gut db and migrations
uninstall houses from settings
delete houses app
makemigrations migrate createsuperuser runserver
-------------------------------------------------------------------------
6. Models & Admin
poetry add Pillow
0. USER
users.models >
class GenderChoices(models.TextChoices):
MALE = ("male", "Male")
FEMALE = ("female", "Female")
class LanguageChoices(models.TextChoices):
EN = "en", "English"
JP = "jp", "Japanese"
class CurrencyChoices(models.TextChoices):
AUD = "aud", "Australian Dollar"
JPY = "jpy", "Japanese Yen"
profile_photo = models.ImageField(blank=True)
gender = models.CharField(max_length=10, choices=GenderChoices.choices,)
language = models.CharField(max_length=2, choices=LangaugeChoices.choices,)
currency = models.CharField(max_length=3, choices=CurrencyChoices.choices,)
py manage.py makemigrations && py manage.py migrate
py manage.py createsuperuser
py manage.py runserver
users.admin >
add to profile fieldset fields
"profile_photo",
"gender",
"language",
"currency",
1. ROOM
py manage.py startapp rooms
config > settings.py > "rooms.apps.RoomsConfig", <-- Customapp
rooms > models > Define Room model
2. MANY TO MANY
startapp common
settings -> "common.apps.CommonConfig",
Define abstract model CommonModel
class CommonModel(models.Model):
created_at = models.DateTimeField(auto_now_add=True)
updated_at = models.DateTimeField(auto_now=True)
class Meta:
abstract = True
Define Amenity -
py manage.py makemigrations
py manage.py migrate
3. room > admin > Room, Amenity Admin
4. Rooms Admin
list_display, list_filter, readonly_fields,
5. Experiences
py manage.py startapp experiences
install in settings
define experience and perk
py manage.py makemigrations && py manage.py migrate
admin > Experience & Perk Admin
Add str method to models
6. Categories
py manage.py startapp categories
install in settings
define categories model - name & kind
add class Meta verbose_name_plural and str methods
add category field to experiences & rooms models set_null on delete, nullable and blankable
admin > CategoryAdmin
7. Reviews
py manage.py startapp reviews
install in settings
define reviews model - user, room, experience, payload, rating
py manage.py makemigrations && migrate
admin > ReviewAdmin
8. Wishlists
py manage.py startapp wishlists
install in settings
define model -
py manage.py makemigrations && py manage.py migrate
admin > WishlistAdmin
9. Bookings
py manage.py startapp bookings
install in settings
define models -
py manage.py makemigrations && py manage.py migrate
admin
10. Medias
py manage.py startapp medias
install in settings
define models - photo, video (use onetoone for video experience)
py manage.py makemigrations && py manage.py migrate
admin
11. Direct Messages
py manage.py startapp direct_messages
install in settings
define models - Room, Message
py manage.py makemigrations && py manage.py migrate
admin
dm apps > dmconfig > verbose_name = "Direct Messages"
-------------------------------------------------------------------------
7. ORM
1. Intro
py manage.py shell (python interactive console with apps installed)
READ
a = Room.objects.get(name="")
print(a.pk)
print(a.owner.email) etc
UPDATE
a.price = 20
a.save()
2. filter, get, create, delete
Room.objects.all()
Room.objects.get(var=value) get a single record
Room.objects.filter(pets_allowed=True)
Room.objects.filter(price__gt=15)
search greater or less than or gt or equals/lt or equals gte lte
or name__startswith="Apt"
data = {
name = "Amenity from console",
}
am = Amenity.objects.create(data)
to_delete = Amenity.objects.get(pk=7)
to_delete.delete()
3. QuerySets
Room.objects.filter(pets_allowed=True).exclude(price__lte=15).filter(name__contains="poo")
or
Room.objects.filter(pets_allowed=True, name__contains="poo", price__gt=15)
.count()
.all()[:5]
4. Admin methods
__exact __iexact="beatles blog"
__contains="bob" icontains
__startswith __istartswith
__endswith __iendswith
__range
__date
__year __month time, hour
.exists()
add "total_amenities" to admin for room &
add to model def
def total_amenities(self):
return self.amenities.count()
or
add to admin panel
def total_amenities(self, room):
return room.amenities.count()
5. ForeignKey Filter & Reverse Accessors
Room.objects.filter(owner__username='tg')
owner__username__startswith etc.
or
(recommended out of two)
me = User.objects.get(pk=1)
me.room_set.all()
6. Related Name related_name
Customise the name of reverse accessors
simply add 'related_name="[NAME OF MODEL]"' to each model with a foreign key
for room:
owner = models.ForeignKey(
"users.User",
on_delete=models.CASCADE,
related_name="rooms',
)
now you can call the rooms for each user from the user model:
user.rooms.all()
change rooms, wishlists, reviews, medias, bookings, direct_messages, experiences models to add related_name
& migrate
SAME AS backref in flask
-------------------------------------------------------------------------
8. POWER ADMIN
1. Methods
rooms > models >
def rating(self):
count = self.reviews.count()
if count == 0:
return "No reviews"
else:
total_rating = 0
for review in self.reviews.all().values("rating"): <---------OPTOMISATION RETURN ONLY CERTAIN VALUES with .values("var")
total_rating += review["rating"]
return round(total_rating / count, 2)
rooms > admin >
"reviews" in list_display
2. Search fields
rooms > admin >
search_fields = [
"^name",
"=price",
"owner__username",
]
^ = startswith
= = exact
__var = search on foreignkey
3. Admin actions
rooms > admin >
at top:
@admin.action(description="Set all prices to zero")
def reset_prices(model_admin, request, queryset):
for room in rooms.all():
room.price = 0
room.save()
add to roomadmin:
actions = [
reset_prices,
]
4. Custom Filters
Ordering of filters matters
reviews > admin >
class WordFilter(admin.SimpleListFilter):
title = "Filter by Words"
parameter_name = "potato"
def lookups(self, request, model_admin):
return [
("good", "Good"),
("great", "Great"),
("awesome", "Awesome")
]
def queryset(self, request, queryset):
return queryset
# replace queryset with reviews in this case
list_filter = [
WordFilter,
"rating",
"user__is_host",
"room__category",
"room__pets_allowed",
]
-------------------------------------------------------------------------
9. URLS & VIEWS
1. Views
rooms > views >
from django.http import HttpResponse
def say_hello(req):
return HttpResponse("hello")
config > urls >
from rooms import views as room_views
urlpatterns = [
path("rooms", room_views.say_hello)
]
2. Include
create urls.py for each app and import them in the config
config urls >
from django.contrib import admin
from django.urls import path, include
urlpatterns = [
path("admin/", admin.site.urls),
path("rooms/", include("rooms.urls")),
]
rooms urls >
from . import views
from django.urls import path
urlpatterns = [
path("", views.say_hello),
]
3. URL Arguments
rooms > views >
from django.shortcuts import render
from django.http import HttpResponse
def see_one_room(req, room_id):
return HttpResponse(f"{room_id}")
def see_all_rooms(req):
return HttpResponse("All rooms")
rooms > urls >
from . import views
from django.urls import path
urlpatterns = [
path("", views.see_all_rooms),
path("<int:room_id>", views.see_one_room),
]
4. render
NOT RECOMMENDED (FLASK/JINJA STYLE) - WILL USE REACT
in views
return render(req, "all_rooms.html", {
"rooms": all_rooms
})
create rooms > templates/all_rooms.html
5. Django Templates
in html Templates >
{{var}}
{% for room in rooms %}
<li>{{room.name}}
<a href="/rooms/{{room.pk}}>
<br />
{% for amenity in rooms.amenities %}
<span>{{amenity.name}}</span>
{% endfor %}
/>
</li>
{% endfor %}
6. DoesNotExist
rooms > views >
try:
room = Room.objects.get(pk=room_id)
return HttpResponse(f"{room}")
except Room.DoesNotExist:
return render(req, "404.html")
7. Django v. React
NO MORE TEMPLATES :D
React for frontend
-------------------------------------------------------------------------
10. DJANGO REST FRAMEWORK
poetry add djangorestframework
settings.py >
add
THIRD_PARTY_APPS = [
"rest_framework"
]
add to installed apps
1. JSONResponse (NOT RECOMMENDED)
NONONONONO
categories > create urls.py >
from . import views
from django.urls import path
urlpatterns = [
path("", views.categories),
]
config/urls.py >
path("categories/", include("categories.urls")),
NONONONONO
2. api_view
NONONONONO
views >
from django.core import serializers
def categories(req):
all = Category.objects.all()
return JsonResponse(
{
"ok": True,
"categories": serializers.serialize("json", all),
}
NONONONONO
3. Serializer
YESYESYESYESYES SORTA REPETITIVE
categories > create serializers.py
from rest_framework import serializers
class CategorySerializer(serializers.Serializer):
name = serializers.CharField(required=True)
kind = serializers.CharField()
views >
@api_view()
def categories(req):
all = Category.objects.all()
serializer = CategorySerializer(
all,
many=True,
)
return Response(
{
"ok": True,
"categories": serializer.data,
}
)
@api_view(["GET", "POST"])
4. POST requests
urls >
path("<int:pk>", views.category)
views >
def categories(req):
if req.method == "GET":
all = Category.objects.all()
serializer = CategorySerializer(
all,
many=True,
)
return Response(serializer.data)
elif req.method == "POST":
Category.objects.create(
name ---
kind -- req.data['']
)
return Response({"created":True})
@api_view()
def category(req, pk):
cat = Category.objects.get(pk=pk)
serializer = CategorySerializer(cat)
return Response(serializer.data)
5. is_valid()
serializer.is_valid()
serializer.errors
IntegerField(read_only=True)
6. save()
if is_valid():
a = serializer.save()
return Response(
a,
status=200
)
else:
return Response(
serializer.errors,
status=400
)
Category.objects.create(**validated_data)
7. update()
from rest_framework.exceptions import NotFound
try:
cat = Category.objects.get(pk=pk)
except DoesNotExist:
raise NotFound
if req.mth == get:
ser = ...
return ...
elif reqmeth ==put:
ser = catser(
cat,
data=ser.data,
partial=True,
)
if ser,isvalid()
updated = ser.save()
return res(catserializer(updated), status=200)
else
return res(ser.err)
8. DELETE
if req.meth == del
cat.delete()
return res(status=nocontent204)
--------
UPDATE URLS
config > urls >
path("api/v1/categories/", include("categories.urls")),
--------
9. APIView
DELETE THE ABOVE
urls >
urlpatterns = [
path("", views.Categories.as_view()),
path("<int:pk>", views.CategoryDetail.as_view()),
]
views >
from .models import Category
from .serializers import CategorySerializer
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.exceptions import NotFound
from rest_framework.status import (
HTTP_200_OK,
HTTP_201_CREATED,
HTTP_202_ACCEPTED,
HTTP_204_NO_CONTENT,
HTTP_400_BAD_REQUEST,
)
class Categories(APIView):
def get(self, req):
all_cat = Category.objects.all()
serializer = CategorySerializer(
all_cat,
many=True,
)
return Response(
serializer.data,
status=HTTP_200_OK,
)
def post(self, req):
serializer = CategorySerializer(data=req.data)
if serializer.is_valid():
new_cat = serializer.save()
return Response(
CategorySerializer(new_cat).data,
status=201,
)
else:
return Response(serializer.errors)
class CategoryDetail(APIView):
def get_obj(self, pk):
try:
record = Category.objects.get(pk=pk)
except Category.DoesNotExist:
raise NotFound
return record
def get(self, req, pk):
ser = CategorySerializer(self.get_obj(pk))
return Response(
ser.data,
status=HTTP_200_OK,
)
def delete(self, req, pk):
cat = self.get_obj(pk)
cat.delete()
return Response(status=HTTP_204_NO_CONTENT)
def put(self, req, pk):
ser = CategorySerializer(
self.get_obj(pk=pk),
req.data,
partial=True,
)
if ser.is_valid():
updated = ser.save()
return Response(
CategorySerializer(updated).data,
status=HTTP_202_ACCEPTED,
)
else:
return Response(
ser.errors,
status=HTTP_400_BAD_REQUEST,
)
10. ModelSerializer
RECOMMENDED
from rest_framework import serializers
from .models import Category
class CategorySerializer(serializers.ModelSerializer):
class Meta:
model = Category
exclude = ['id','created_at']
OR fields = [a, b, c, d]
11. ModelViewSet
NOT RECOMMENDED
views >
from rf.viewsets import ModelViewSet
class CategoryViewSet(ModelViewSet):
serializer_class = CategorySerializer
queryset = Category.objects.all()
urls >
urlpatterns = [
path("", views.CategoryViewSet.as_view({
'get':'list','post':'create',
})),
path("<int:pk>", views.CategoryViewSet.as_view({
'get':'retrieve','put':'partial_updated','delete':'destroy',
})),
]
12. Conclusion
Use APIView and ModelSerializer
-------------------------------------------------------------------------
11. REST API
1. All Amenities & AmenityDetail
conf > urls >
urlpatterns = [
path("admin/", admin.site.urls),
path("graphql", GraphQLView.as_view(schema=schema)),
path("api/v1/rooms/", include("rooms.urls")),
path("api/v1/categories/", include("categories.urls")),
]
rooms/views >
from .models import Amenity
from .serializers import AmenitySerializer
from rest_framework.exceptions import NotFound
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.status import (
HTTP_200_OK,
HTTP_201_CREATED,
HTTP_202_ACCEPTED,
HTTP_204_NO_CONTENT,
HTTP_400_BAD_REQUEST,
)
class Amenities(APIView):
def get(self, req):
all = Amenity.objects.all()
ser = AmenitySerializer(all, many=True)
return Response(
ser.data,
status=HTTP_200_OK,
)
def post(self, req):
ser = AmenitySerializer(data=req.data)
if ser.is_valid():
a = ser.save()
return Response(
AmenitySerializer(a).data,
status=HTTP_201_CREATED,
)
class AmenityDetail(APIView):
def go(self, pk):
try:
return Amenity.objects.get(pk=pk)
except Amenity.DoesNotExist:
raise NotFound
def get(self, req, pk):
a = self.go(pk)
ser = AmenitySerializer(a)
return Response(
ser.data,
status=HTTP_200_OK,
)
def delete(self, req, pk):
a = self.go(pk)
a.delete()
return Response(
status=HTTP_204_NO_CONTENT,
)
def put(self, req, pk):
a = self.go(pk)
ser = AmenitySerializer(
a,
data=req.data,
partial=True,
)
if ser.is_valid():
ua = ser.save()
return Response(
AmenitySerializer(ua).data,
status=HTTP_202_ACCEPTED,
)
else:
return Response(
status=HTTP_400_BAD_REQUEST,
)
rooms > urls >
from . import views
from django.urls import path
urlpatterns = [
path("amenities/", views.Amenities.as_view()),
path("amenities/<int:pk>/", views.AmenityDetail.as_view()),
]
rooms/serializers >
from rest_framework.serializers import ModelSerializer
from .models import Amenity
class AmenitySerializer(ModelSerializer):
class Meta:
model = Amenity
fields = "__all__"
2. Perks & PerkDetail
above rinse/repeat
3. Rooms
above rinse/repeat
Expand foreignkeys
NOTRECOMMENDED
serializer > RS > Meta
depth = 1
4. RoomDetail
keep database from overfetching (get all):
room/serializer >
class RoomListSerializer(ModelSerializer):
class Meta:
model = Room
fields = ["pk", "name", "country", "city", "price",]
class RoomDetailSerializer(ModelSerializer):
owner = TinyUserSerializer()
amenities = AmenitySerializer(many=True)
category = CategorySerializer()
class Meta:
model = Room
fields = "__all__"
users/serializer >
from rest_framework.serializers import ModelSerializer
from .models import User
class TinyUserSerializer(ModelSerializer):
class Meta:
model = User
fields = [
"id",
"username",
]
5. Create Room
to prevent users from modifying the request to alter another
user's account, we make owner read only
class RoomDetailSerializer(ModelSerializer):
owner = TinyUserSerializer(read_only=True)
amenities = AmenitySerializer(many=True)
category = CategorySerializer()
class Meta:
model = Room
fields = "__all__"
6. Room owner
views
class Rooms(APIView):
def get(self, req):
all = Room.objects.all()
ser = RoomListSerializer(
all,
many=True,
)
return Response(
ser.data,
status=HTTP_200_OK,
)
def post(self, req):
if req.user.is_authenticated:
ser = RoomDetailSerializer(
data=req.data,
)
if ser.is_valid():
new = ser.save(owner=req.user)
ser = RoomListSerializer(new)
return Response(
ser.data,
status=HTTP_201_CREATED,