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

Update the section about using mypy and type annotations

Browse Source 
- Closes #40
This commit is contained in:
Radoslav Georgiev 2022-01-16 16:15:48 +02:00
parent ea3fb8ad3a
commit df506bc2e2
No known key found for this signature in database
GPG Key ID: 0B7753A4DFCE646D
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -68,8 +68,8 @@ Django styleguide that we use in [HackSoft](https://hacksoft.io).
+ [Circular imports between tasks & services](#circular-imports-between-tasks--services)
* [Periodic Tasks](#periodic-tasks)
* [Configuration](#configuration-1)
- [Misc](#misc)
* [mypy / type annotations](#mypy--type-annotations)
- [DX (Developer Experience)](#dx-developer-experience)
* [`mypy` / type annotations](#mypy--type-annotations)
- [Django Styleguide in the Wild](#django-styleguide-in-the-wild)
- [Inspiration](#inspiration)
@ -2275,18 +2275,25 @@ Celery is a complex topic, so it's a good idea to invest time reading the docume
We constantly do that & find new things or find better approaches to our problems.
## Misc
## DX (Developer Experience)
### mypy / type annotations
A section with various things that can make your Django developer life better.
About type annotations & using `mypy`, [this tweet](https://twitter.com/queroumavodka/status/1294789817071542272) resonates a lot with our philosophy.
### `mypy` / type annotations
We have projects where we enforce `mypy` on CI and are very strict with types.
When it comes to using type annotations, alongside [`mypy`](https://mypy.readthedocs.io/en/stable/index.html), [this tweet](https://twitter.com/queroumavodka/status/1294789817071542272) **resonates a lot with our philosophy.**
We have projects where types are looser.
- We have projects where we enforce `mypy` and are very strict about ot.
- We have projects where types are looser and `mypy` is not used at all.
Context is king here.
In the [`Django-Styleguide-Example`](https://github.com/HackSoftware/Django-Styleguide-Example), we've configured `mypy`, using both <https://github.com/typeddjango/django-stubs> and <https://github.com/typeddjango/djangorestframework-stubs/>. You can check it as an example.
Additionally, this particular project - <https://github.com/wemake-services/wemake-django-template> - also has `mypy` configuration.
Figure out what is going to work best for you.
## Django Styleguide in the Wild
Here's a collection of different folks & companies, that have found the styleguide useful.