From e9fb5ff4d4ce4b6aa85ad6d6672615b4cb09e524 Mon Sep 17 00:00:00 2001 From: Denis Date: Wed, 17 Oct 2018 12:33:04 +0300 Subject: [PATCH 1/9] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=B8=D0=BB?= =?UTF-8?q?=20=D0=BF=D0=BE=D1=8F=D1=81=D0=BD=D1=8F=D1=8E=D1=89=D0=B8=D0=B9?= =?UTF-8?q?=20=D1=82=D0=B5=D0=BA=D1=81=D1=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 7ad73b2c..58e23870 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,12 @@ безгранично гибкий код — это как сферический конь в вакууме. Теоретически возможен, но практической ценности не несет. +Если мы заранее будем знать как изменятся требования к коду через год, два или +десять лет, то уже сейчас можно заложить необходимые механизмы расширения +функциональности. К сожалению, такие сведения сложно получить, а зачастую +просто невозможно. Приходится опираться на свой опыт, опыт товарищей, +прорабатывать разные сценарии развития проекта, подстраховываться. + Один из часто встречающихся и оправданных приемов — это отделение обработки данных от процесса ввода/вывода. Рассмотрим несколько примеров. @@ -108,3 +114,10 @@ days_before_start ? 1)от источника данных; 2)от формата вывода в файл. +Кроме того, часть кода удалось превратить в чистые функции, что облегчит +тестирование и повторное использование. + +Стратегия по отделению операций ввода/вывода от обработки данных встречается +повсеместно, в самых разных программах: от небольших скриптов до серьезных и +крупных проектов. Это один из базовых приемов, нужно уверенно им владеть. + From 52a1d2b42b14cd16e1b6a5d2b36b0cf7c751f898 Mon Sep 17 00:00:00 2001 From: Denis Date: Wed, 17 Oct 2018 12:33:38 +0300 Subject: [PATCH 2/9] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=B8=D0=BB?= =?UTF-8?q?=20=D1=81=D1=81=D1=8B=D0=BB=D0=BA=D1=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 58e23870..5a2b6610 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ days_before_start ? 1)от источника данных; 2)от формата вывода в файл. -Кроме того, часть кода удалось превратить в чистые функции, что облегчит +Кроме того, часть кода удалось превратить в [чистые функции](https://devman.org/encyclopedia/decomposition/decomposition_pure_functions/), что облегчит тестирование и повторное использование. Стратегия по отделению операций ввода/вывода от обработки данных встречается From 4846789cce2932f1eae848269be88efd106e3eae Mon Sep 17 00:00:00 2001 From: Alina Date: Wed, 17 Oct 2018 12:34:44 +0300 Subject: [PATCH 3/9] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=B8=D0=BB?= =?UTF-8?q?=D0=B0=20=D0=BA=D0=B0=D1=80=D1=82=D0=B8=D0=BD=D0=BA=D1=83=20?= =?UTF-8?q?=D1=81=D0=BE=20=D1=81=D1=85=D0=B5=D0=BC=D0=BE=D0=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 7ad73b2c..c26851c5 100644 --- a/README.md +++ b/README.md @@ -108,3 +108,4 @@ days_before_start ? 1)от источника данных; 2)от формата вывода в файл. +![alt text](https://devman.org/assets/images/7_40__data_flow.png) \ No newline at end of file From 4fb288681d3dac182c839de6afd30812775372d3 Mon Sep 17 00:00:00 2001 From: dvmn-tasks <44063469+dvmn-tasks@users.noreply.github.com> Date: Tue, 7 Jul 2020 15:10:43 +0300 Subject: [PATCH 4/9] Update image link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c26851c5..d3c84658 100644 --- a/README.md +++ b/README.md @@ -108,4 +108,4 @@ days_before_start ? 1)от источника данных; 2)от формата вывода в файл. -![alt text](https://devman.org/assets/images/7_40__data_flow.png) \ No newline at end of file +![image](https://dvmn.org/filer/canonical/1594117412/678/) From 7a1f31adc84400e554bc0cbe3062e8fe7be65065 Mon Sep 17 00:00:00 2001 From: lostan89 Date: Thu, 14 Aug 2025 23:19:27 +0300 Subject: [PATCH 5/9] =?UTF-8?q?=D0=9E=D1=84=D0=BE=D1=80=D0=BC=D0=BB=D0=B5?= =?UTF-8?q?=D0=BD=D1=8B=20=D0=B7=D0=B0=D0=B3=D0=BE=D0=BB=D0=BE=D0=B2=D0=BA?= =?UTF-8?q?=D0=B8=20=D0=B2=20=D1=81=D1=82=D0=B0=D1=82=D1=8C=D0=B5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5a2b6610..dd91e6e4 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Ввод/вывод vs Обработка данных +# Ввод/вывод vs Обработка данных Ключевой критерий качества кода — это стоимость внесения в него изменений. @@ -16,7 +16,7 @@ Один из часто встречающихся и оправданных приемов — это отделение обработки данных от процесса ввода/вывода. Рассмотрим несколько примеров. -Пример. Подбор онлайн-курса +### Пример. Подбор онлайн-курса По условию задачи нужно скачать из сети данных об онлайн-курсах, выбрать из From 13cb928b82170b678ea645047b858c797070c80a Mon Sep 17 00:00:00 2001 From: lostan89 Date: Thu, 14 Aug 2025 23:27:15 +0300 Subject: [PATCH 6/9] =?UTF-8?q?=D0=92=D1=8B=D0=B4=D0=B5=D0=BB=D0=B8=D0=BB?= =?UTF-8?q?=20=D1=83=D1=87=D0=B0=D1=81=D1=82=D0=BA=D0=B8=20=D1=81=20=D0=BA?= =?UTF-8?q?=D0=BE=D0=B4=D0=BE=D0=BC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index dd91e6e4..83f94827 100644 --- a/README.md +++ b/README.md @@ -22,14 +22,14 @@ По условию задачи нужно скачать из сети данных об онлайн-курсах, выбрать из них лучшие и сохранить результат в xlsx файл. Вот фрагмент кода: -def get_courses_list(courses_url): +`def get_courses_list(courses_url): html = fetch_html(courses_url) if html: # .... parsing logic return courses_list else: print("can't load list of courses") - exit() + exit()` Теперь примерим на себя роль провидца и подумаем какой функционал потребуется через месяц: @@ -38,30 +38,30 @@ def get_courses_list(courses_url): В случае если адрес недоступен - постучаться по другому url в зеркало сайта. В случае ошибки сделать запись в лог и взять данные из ранее подготовленного кеша. -Как все это сделать когда def get_courses_list сама завершает программу ?! От -вызова exit() надо отказаться. Можно выбросить исключение и таким образом +Как все это сделать когда `def get_courses_list` сама завершает программу ?! От +вызова `exit()` надо отказаться. Можно выбросить исключение и таким образом сообщить о проблеме внешнему коду, пускай там разбираются. -Вызов print тоже стоит вынести из тела функции наружу. В рассмотренных +Вызов `print` тоже стоит вынести из тела функции наружу. В рассмотренных сценариях вывод в консоль зависит от общей логики загрузки данных и -многократных вызовов def get_courses_list. +многократных вызовов `def get_courses_list`. Что еще может потребоваться в скором будущем? Отладить и покрыть тестами парсер HTML страницы. Ускорить работу скрипта, хранить ранее скачанные страницы в кеше на жестком диске. -Ага, значит вызывать fetch_html() внутри def get_courses_list не такая уж -хорошая идея. Жить будет легче если передать в def get_courses_list строку с -HTML разметкой вместо courses_url. Вуаля, мы решили проблемы еще до их +Ага, значит вызывать `fetch_html()` внутри `def get_courses_list` не такая уж +хорошая идея. Жить будет легче если передать в `def get_courses_list` строку с +HTML разметкой вместо `courses_url`. Вуаля, мы решили проблемы еще до их появления на горизонте! Пойдем дальше. Код другой функции: -def get_course_info(html): - # ... parsing logic +`def get_course_info(html): + # ... parsing logic` - rating = soup.find_all('div', attrs={'class': 'ratings-text'}) + `rating = soup.find_all('div', attrs={'class': 'ratings-text'}) if rating: # check if rating is not empty list rating = rating[0].contents[0].text else: @@ -70,7 +70,7 @@ def get_course_info(html): # .... parsing logic - return course_data + return course_data` Что может произойти с кодом дальше? Если рейтинга нет — надо искать его на другом сайте. @@ -78,31 +78,31 @@ def get_course_info(html): Отчет о курсах без рейтинга выгружать в дополнительную вкладку xlsx, чтобы удобнее было руками проверять. Для всего этого нужно уметь отличать от прочих ситуацию "рейтинг неизвестен". -В Python для этих целей предусмотрено значение rating = None. А строку "No -rating yet" можно переместить туда где данные подготавливаются к выводу в xlsx. +В Python для этих целей предусмотрено значение `rating = None`. А строку `"No +rating yet"` можно переместить туда где данные подготавливаются к выводу в xlsx. Та же функция, часть вторая, последняя: -def get_course_info(html): - # ... more parsing logic is here +`def get_course_info(html): + # ... more parsing logic is here` - # number prefix is usefull for simple sorting data before output to xlsx + `# number prefix is usefull for simple sorting data before output to xlsx return { '1_title': title, '2_date': start_date, '3_language': language, '4_weeks': duration, "5_rating": rating - } + }` Сразу возникают вопросы. А если нужна еще одна выгрузка в формате csv, с другим порядком столбцов, как это сделать? Как заменить столбец 2_date на -days_before_start ? +`days_before_start` ? Кроме того, наперед известно, что пользовательский интерфейс — будь то вывод в консоль или запись в файл — меняется очень часто. Было бы удобно собрать все, что относится к форматированию вывода в одном месте. Например, всю логику -выгрузки в xlsx поместить в def fill_xlsx(workbook, courses):, а вывод в -консоль собрать внутри if __name__=='__main__':. Удастся избежать вычитывания +выгрузки в xlsx поместить в `def fill_xlsx(workbook, courses):`, а вывод в +консоль собрать внутри `if __name__=='__main__':`. Удастся избежать вычитывания и повторной отладки всей программы от начала до конца, ведь изменения локальны и изолированы. From f6babe7888fe95418f0418c2022bc7c1746acdf0 Mon Sep 17 00:00:00 2001 From: lostan89 Date: Thu, 14 Aug 2025 23:33:17 +0300 Subject: [PATCH 7/9] =?UTF-8?q?=D0=9E=D1=84=D0=BE=D1=80=D0=BC=D0=B8=D0=BB?= =?UTF-8?q?=20=D1=81=D0=BF=D0=B8=D1=81=D0=BA=D0=B8=20=D0=B2=20=D1=81=D1=82?= =?UTF-8?q?=D0=B0=D1=82=D1=8C=D0=B5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 83f94827..2c7b49fe 100644 --- a/README.md +++ b/README.md @@ -33,10 +33,10 @@ Теперь примерим на себя роль провидца и подумаем какой функционал потребуется через месяц: -В случае сетевой ошибки взять паузу в 10 секунд и повторить попытку, затем +1. В случае сетевой ошибки взять паузу в 10 секунд и повторить попытку, затем подождать еще 30 секунд и так далее. -В случае если адрес недоступен - постучаться по другому url в зеркало сайта. -В случае ошибки сделать запись в лог и взять данные из ранее подготовленного +2. В случае если адрес недоступен - постучаться по другому url в зеркало сайта. +3. В случае ошибки сделать запись в лог и взять данные из ранее подготовленного кеша. Как все это сделать когда `def get_courses_list` сама завершает программу ?! От вызова `exit()` надо отказаться. Можно выбросить исключение и таким образом @@ -48,9 +48,10 @@ Что еще может потребоваться в скором будущем? -Отладить и покрыть тестами парсер HTML страницы. -Ускорить работу скрипта, хранить ранее скачанные страницы в кеше на жестком +1. Отладить и покрыть тестами парсер HTML страницы. +2. Ускорить работу скрипта, хранить ранее скачанные страницы в кеше на жестком диске. + Ага, значит вызывать `fetch_html()` внутри `def get_courses_list` не такая уж хорошая идея. Жить будет легче если передать в `def get_courses_list` строку с HTML разметкой вместо `courses_url`. Вуаля, мы решили проблемы еще до их @@ -73,10 +74,11 @@ HTML разметкой вместо `courses_url`. Вуаля, мы решил return course_data` Что может произойти с кодом дальше? -Если рейтинга нет — надо искать его на другом сайте. -В xlsx указывать не просто отсутствие рейтинга, а еще на каких сайтах искал. -Отчет о курсах без рейтинга выгружать в дополнительную вкладку xlsx, чтобы +1. Если рейтинга нет — надо искать его на другом сайте. +2. В xlsx указывать не просто отсутствие рейтинга, а еще на каких сайтах искал. +3. Отчет о курсах без рейтинга выгружать в дополнительную вкладку xlsx, чтобы удобнее было руками проверять. + Для всего этого нужно уметь отличать от прочих ситуацию "рейтинг неизвестен". В Python для этих целей предусмотрено значение `rating = None`. А строку `"No rating yet"` можно переместить туда где данные подготавливаются к выводу в xlsx. @@ -111,8 +113,8 @@ rating yet"` можно переместить туда где данные по В результате мы пришли к ситуации, когда логика обработки данных слабо зависит: -1)от источника данных; -2)от формата вывода в файл. +1. от источника данных; +2. от формата вывода в файл. Кроме того, часть кода удалось превратить в [чистые функции](https://devman.org/encyclopedia/decomposition/decomposition_pure_functions/), что облегчит тестирование и повторное использование. From 02c4fd03f63d02a1d96b9d4e57b368eb764ee7cc Mon Sep 17 00:00:00 2001 From: lostan89 Date: Sat, 16 Aug 2025 12:40:39 +0300 Subject: [PATCH 8/9] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=BB=D0=B5?= =?UTF-8?q?=D0=BD=D0=B0=20=D0=BA=D0=B0=D1=80=D1=82=D0=B8=D0=BD=D0=BA=D0=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 2c7b49fe..e62d1181 100644 --- a/README.md +++ b/README.md @@ -22,14 +22,16 @@ По условию задачи нужно скачать из сети данных об онлайн-курсах, выбрать из них лучшие и сохранить результат в xlsx файл. Вот фрагмент кода: -`def get_courses_list(courses_url): +```python + def get_courses_list(courses_url): html = fetch_html(courses_url) if html: # .... parsing logic return courses_list else: print("can't load list of courses") - exit()` + exit() +``` Теперь примерим на себя роль провидца и подумаем какой функционал потребуется через месяц: @@ -38,6 +40,7 @@ 2. В случае если адрес недоступен - постучаться по другому url в зеркало сайта. 3. В случае ошибки сделать запись в лог и взять данные из ранее подготовленного кеша. + Как все это сделать когда `def get_courses_list` сама завершает программу ?! От вызова `exit()` надо отказаться. Можно выбросить исключение и таким образом сообщить о проблеме внешнему коду, пускай там разбираются. @@ -59,10 +62,11 @@ HTML разметкой вместо `courses_url`. Вуаля, мы решил Пойдем дальше. Код другой функции: -`def get_course_info(html): - # ... parsing logic` +```python + def get_course_info(html): + # ... parsing logic - `rating = soup.find_all('div', attrs={'class': 'ratings-text'}) + rating = soup.find_all('div', attrs={'class': 'ratings-text'}) if rating: # check if rating is not empty list rating = rating[0].contents[0].text else: @@ -71,7 +75,8 @@ HTML разметкой вместо `courses_url`. Вуаля, мы решил # .... parsing logic - return course_data` + return course_data +``` Что может произойти с кодом дальше? 1. Если рейтинга нет — надо искать его на другом сайте. @@ -85,17 +90,19 @@ rating yet"` можно переместить туда где данные по Та же функция, часть вторая, последняя: -`def get_course_info(html): - # ... more parsing logic is here` +```python + def get_course_info(html): + # ... more parsing logic is here - `# number prefix is usefull for simple sorting data before output to xlsx + # number prefix is usefull for simple sorting data before output to xlsx return { '1_title': title, '2_date': start_date, '3_language': language, '4_weeks': duration, "5_rating": rating - }` + } +``` Сразу возникают вопросы. А если нужна еще одна выгрузка в формате csv, с другим порядком столбцов, как это сделать? Как заменить столбец 2_date на `days_before_start` ? @@ -115,7 +122,7 @@ rating yet"` можно переместить туда где данные по 1. от источника данных; 2. от формата вывода в файл. - +![image](https://dvmn.org/filer/canonical/1594117412/678/) Кроме того, часть кода удалось превратить в [чистые функции](https://devman.org/encyclopedia/decomposition/decomposition_pure_functions/), что облегчит тестирование и повторное использование. From 8c01c1be6f6997f9167f57a0cf466fdbfc7454bd Mon Sep 17 00:00:00 2001 From: lostan89 Date: Mon, 18 Aug 2025 09:50:55 +0300 Subject: [PATCH 9/9] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e62d1181..97a3fb0e 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ них лучшие и сохранить результат в xlsx файл. Вот фрагмент кода: ```python - def get_courses_list(courses_url): +def get_courses_list(courses_url): html = fetch_html(courses_url) if html: # .... parsing logic @@ -63,7 +63,7 @@ HTML разметкой вместо `courses_url`. Вуаля, мы решил Пойдем дальше. Код другой функции: ```python - def get_course_info(html): +def get_course_info(html): # ... parsing logic rating = soup.find_all('div', attrs={'class': 'ratings-text'}) @@ -91,7 +91,7 @@ rating yet"` можно переместить туда где данные по Та же функция, часть вторая, последняя: ```python - def get_course_info(html): +def get_course_info(html): # ... more parsing logic is here # number prefix is usefull for simple sorting data before output to xlsx