giuseppenovielli/django-dry-project

A Django project with samples code strictly DRY (DON'T REPEAT YOURSELF)

Django DRY Project

A Django project with samples code strictly DRY (DON'T REPEAT YOURSELF)

Features

CRUD (Create Retrieve Update Delete)

CRUD are operations that most project implements. Django Rest Framework can be used for this purpose, to develop Rest API Endpoint.

---

• API with a Model

  • viewsets.ModelViewSet Use this class if you want enable to consume all CRUD operations
  • viewsets.GenericViewSet Use these classes to enable only some CRUD operations.

• API without a Model

  • viewsets.ViewSet Use this class if you want enable to consume all CRUD operations

• API with ExtraActions

  • decorators.action

---

• RETRIEVE

  • Simple queries
    • Search
  • Advanced queries
    • Django Filter
    • Manager Query Engine (Experimental)

• CREATE/UPDATE

  • Validations Model layer
    • Write Validations logic into Model.clean() that check model fields data integrity. If call Model.save() from Model.Form, Model.Serializer, ModelAdmin object MUST BE validated before saved into db.
    • Warnings
      • pre_save_full_clean_handler model.full_clean() is not called by default when invoke Model.save() method ISSUE
      • django_error_handler Improve conversion from exceptions.ValidationError() to serializer.ValidationError()
  • Validations View layer
    • Write Validations logic into ModelSerializer.validate() and ModelForms.clean() YES NOT DRY 😅 that check model fields data integrity using view parameters as request, that aren't accessible into Model class.
  • Single row
    • Model
  • Nested ForeignKey
    • Multiple Models

• UPDATE

  • Warnings
    • UpdateModelQuerySet Add this Mixing for prevent update not call Model.save() method. Unfortunately, there isn’t a workaround when creating or updating objects in bulk, since none of save(), pre_save, and post_save are called.

• DELETE

  • Validations Model layer
    • Write Validations logic into signals.pre_delete
  • Validations View layer
    • Write Validations logic into viewsets.destroy() YES NOT DRY 😅 that check model fields data integrity using view parameters as request, that aren't accessible into Model/Signal class.

---

Utils

Utils folder can be used to store utils method/class

• Create for each plugin, one utils file

---

Pagination

Client_PageNumberPagination class can be used to enable client custom pagination size.

• <url>?page_size=20 Get 20 items at time, get page=1 (default)
• <url>?page=2 Get the page number, get page_size=10 (default)
• <url>?page_size=20&page=2 Get 20 items at time, get page=2

---

BrowsableAPIRenderer DEBUG MODE ONLY

Debug_BrowsableAPIRenderer class can be used to use browsable api ONLY into DEBUG MODE.

django-dry-project's Issues

Django not incapsulated Model Validations

There are some issues that make a lot of confusions.

See encode/django-rest-framework#7850 (comment)

Implement THE BEST engine for make queries DRY and COMPLEX

We need to implements a query rule thats help to write complex query without repeat the same conditions into .filter() method.

Proposal
Manger-Query-Engine

DRF wrongly moves validation business logic from models to views

Start Django Rest Framework 3.0 announcement Model.full_clean() is not called before save instance into db.

This policy moves validation business logic from models to views and break DRY purpose.

encode/django-rest-framework#7850 (comment)

Workaround
ValidateModelSerializer

SPECS
It enable developers to run model.full_clean(), when serializers.is_valid() is called.
It also have limited support to nested writable serializer. Developers can pass into **kwargs parameters, other foreignKey not yet saved into db.

It is a valid compromise to help DRY purpose?