HackSoftware/Django-Styleguide
1
1
Fork 0
mirror of https://github.com/HackSoftware/Django-Styleguide.git synced 2024-11-22 09:36:36 +03:00
Code Issues Packages Projects Releases Wiki Activity

Bump Handling updates with a service section

Browse Source 
- Remove the early copy-pasted version of `model_update`
- Stick to linking to the actual current implementation of `model_update`
This commit is contained in:
Radoslav Georgiev 2022-11-29 14:54:40 +02:00
parent e95252916c
commit bac4059efd
1 changed files with 3 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -2716,38 +2716,15 @@ def user_update(*, user: User, data) -> User:
- We're calling the generic `model_update` service for the fields that have no side-effects related to them (meaning that they're just set to the value that we provide). - We're calling the generic `model_update` service for the fields that have no side-effects related to them (meaning that they're just set to the value that we provide).
- This pattern allows us to extract the repetitive field setting in a generic service and perform only the specific tasks inside of the update service (side-effects). - This pattern allows us to extract the repetitive field setting in a generic service and perform only the specific tasks inside of the update service (side-effects).
- We can be smart & provide the `update_fields` kwarg, when saving the instance. This way, in the `UPDATE` query, we'll only send values that are actually updated.
The generic `model_update` implementation looks like this:
```python
def model_update(
*,
instance: DjangoModelType,
fields: List[str],
data: Dict[str, Any]
) -> Tuple[DjangoModelType, bool]:
has_updated = False
for field in fields:
if field not in data:
continue
if getattr(instance, field) != data[field]:
has_updated = True
setattr(instance, field, data[field])
if has_updated:
instance.full_clean()
instance.save(update_fields=fields)
return instance, has_updated
```
The full implementations of these services can be found in our example project: The full implementations of these services can be found in our example project:
- [`model_update`](https://github.com/HackSoftware/Django-Styleguide-Example/blob/master/styleguide_example/common/services.py) - [`model_update`](https://github.com/HackSoftware/Django-Styleguide-Example/blob/master/styleguide_example/common/services.py)
- [`user_update`](https://github.com/HackSoftware/Django-Styleguide-Example/blob/master/styleguide_example/users/services.py) - [`user_update`](https://github.com/HackSoftware/Django-Styleguide-Example/blob/master/styleguide_example/users/services.py)
If you are going to include `model_update` in your project, make sure to [read the tests](https://github.com/HackSoftware/Django-Styleguide-Example/blob/master/styleguide_example/common/tests/services/test_model_update.py) & include them too!
## DX (Developer Experience) ## DX (Developer Experience)
A section with various things that can make your Django developer life better. A section with various things that can make your Django developer life better.