Skip to content

Commit

Permalink
Add relevant notes in rule Atomicity of operations
Browse files Browse the repository at this point in the history
  • Loading branch information
nifadyev committed Sep 19, 2024
1 parent abfb19e commit 8a5dbc0
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
6 changes: 6 additions & 0 deletions EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,12 @@ result = calculate_weather(hello)
**Why?** Because the code becomes more readable, and there is no need to execute several statements in your head while reading the code. Code broken down into simple atomic operations is perceived much better than complex one-liners. Try to simplify your code as much as possible — code is more often read than written.


**Notes**:

* `ORM` syntax like `Model.objects.filter(...).select_related(...).distinct()` is a different story and it will be discussed in separate rule
* Rule was written before [PEP-678](https://peps.python.org/pep-0678/). Try to figure out the error if an exception is thrown in such a chain `foo.bar.bar.bar.bar.bar.bar.bar` (`nonetype object has no attribute bar`)


### Logical blocks

Try to divide the code into logical blocks — this way it will be much easier for the programmer to read and understand the essence.
Expand Down
7 changes: 6 additions & 1 deletion RU.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,12 @@ result = calculate_weather(hello)
```


**Почему?** Потому что код становится более читабельным, не нужно исполнять несколько выражений в голове во время чтения кода. Разбитый до простых атомных операций код воспринимается гораздо лучше, чем сложный уан-лайнер. Постарайтесь упростить свой код настолько, насколько это возможно - код чаще читается, чем пишется.
**Почему?** Потому что код становится более читабельным, не нужно исполнять несколько выражений в голове во время чтения кода. Разбитый до простых атомных операций код воспринимается гораздо лучше, чем сложный однострочник. Постарайтесь упростить свой код настолько, насколько это возможно - код чаще читается, чем пишется.

**Примечания**:

* К `ORM` синтаксу, например `Model.objects.filter(...).select_related(...).distinct()`, следует относиться иначе, что будет описано в отдельном правиле
* Правило было написано до принятия [PEP-678](https://peps.python.org/pep-0678/). Попробуйте найти ошибку, если возникло исключение в выражении `foo.bar.bar.bar.bar.bar.bar.bar` (`nonetype object has no attribute bar`)


### Логические блоки
Expand Down

0 comments on commit 8a5dbc0

Please sign in to comment.