From e9fb5ff4d4ce4b6aa85ad6d6672615b4cb09e524 Mon Sep 17 00:00:00 2001 From: Denis Date: Wed, 17 Oct 2018 12:33:04 +0300 Subject: [PATCH 01/10] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=B8?= =?UTF-8?q?=D0=BB=20=D0=BF=D0=BE=D1=8F=D1=81=D0=BD=D1=8F=D1=8E=D1=89=D0=B8?= =?UTF-8?q?=D0=B9=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 02/10] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=B8?= =?UTF-8?q?=D0=BB=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 03/10] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=B8?= =?UTF-8?q?=D0=BB=D0=B0=20=D0=BA=D0=B0=D1=80=D1=82=D0=B8=D0=BD=D0=BA=D1=83?= =?UTF-8?q?=20=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 04/10] 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 8c8ccdc300c35c8a5871e987701fe6c45a773704 Mon Sep 17 00:00:00 2001 From: Vitaliy Date: Thu, 25 Dec 2025 16:07:46 +0300 Subject: [PATCH 05/10] Add link.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 5a2b6610..d7c8c34f 100644 --- a/README.md +++ b/README.md @@ -113,6 +113,7 @@ days_before_start ? 1)от источника данных; 2)от формата вывода в файл. +![image](https://dvmn.org/filer/canonical/1594117412/678/) Кроме того, часть кода удалось превратить в [чистые функции](https://devman.org/encyclopedia/decomposition/decomposition_pure_functions/), что облегчит тестирование и повторное использование. From 8d322e6071cacbd579e6d710ce8786cc687971f1 Mon Sep 17 00:00:00 2001 From: Vitaliy Date: Thu, 25 Dec 2025 16:10:41 +0300 Subject: [PATCH 06/10] Highlighting headings.md --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d7c8c34f..38306b5d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Ввод/вывод vs Обработка данных +# Ввод/вывод vs Обработка данных Ключевой критерий качества кода — это стоимость внесения в него изменений. @@ -16,7 +16,7 @@ Один из часто встречающихся и оправданных приемов — это отделение обработки данных от процесса ввода/вывода. Рассмотрим несколько примеров. -Пример. Подбор онлайн-курса +## Пример. Подбор онлайн-курса По условию задачи нужно скачать из сети данных об онлайн-курсах, выбрать из @@ -30,8 +30,9 @@ def get_courses_list(courses_url): else: print("can't load list of courses") exit() -Теперь примерим на себя роль провидца и подумаем какой функционал потребуется -через месяц: + +## Теперь примерим на себя роль провидца и подумаем какой функционал потребуется +## через месяц: В случае сетевой ошибки взять паузу в 10 секунд и повторить попытку, затем подождать еще 30 секунд и так далее. @@ -46,7 +47,7 @@ def get_courses_list(courses_url): сценариях вывод в консоль зависит от общей логики загрузки данных и многократных вызовов def get_courses_list. -Что еще может потребоваться в скором будущем? +## Что еще может потребоваться в скором будущем? Отладить и покрыть тестами парсер HTML страницы. Ускорить работу скрипта, хранить ранее скачанные страницы в кеше на жестком @@ -56,7 +57,7 @@ def get_courses_list(courses_url): HTML разметкой вместо courses_url. Вуаля, мы решили проблемы еще до их появления на горизонте! -Пойдем дальше. Код другой функции: +## Пойдем дальше. Код другой функции: def get_course_info(html): # ... parsing logic @@ -71,7 +72,8 @@ def get_course_info(html): # .... parsing logic return course_data -Что может произойти с кодом дальше? + +## Что может произойти с кодом дальше? Если рейтинга нет — надо искать его на другом сайте. В xlsx указывать не просто отсутствие рейтинга, а еще на каких сайтах искал. @@ -81,7 +83,7 @@ def get_course_info(html): В Python для этих целей предусмотрено значение rating = None. А строку "No rating yet" можно переместить туда где данные подготавливаются к выводу в xlsx. -Та же функция, часть вторая, последняя: +## Та же функция, часть вторая, последняя: def get_course_info(html): # ... more parsing logic is here @@ -106,8 +108,7 @@ days_before_start ? и повторной отладки всей программы от начала до конца, ведь изменения локальны и изолированы. -Вместо заключения - +## Вместо заключения В результате мы пришли к ситуации, когда логика обработки данных слабо зависит: From dacb468113246e4850184fbf363a221c353a85b8 Mon Sep 17 00:00:00 2001 From: Vitaliy Date: Thu, 25 Dec 2025 16:11:34 +0300 Subject: [PATCH 07/10] highlighting code.md --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 38306b5d..77d24afa 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ По условию задачи нужно скачать из сети данных об онлайн-курсах, выбрать из них лучшие и сохранить результат в xlsx файл. Вот фрагмент кода: - +```py def get_courses_list(courses_url): html = fetch_html(courses_url) if html: @@ -30,6 +30,7 @@ def get_courses_list(courses_url): else: print("can't load list of courses") exit() +``` ## Теперь примерим на себя роль провидца и подумаем какой функционал потребуется ## через месяц: @@ -58,7 +59,7 @@ HTML разметкой вместо courses_url. Вуаля, мы решили появления на горизонте! ## Пойдем дальше. Код другой функции: - +```py def get_course_info(html): # ... parsing logic @@ -72,6 +73,7 @@ def get_course_info(html): # .... parsing logic return course_data +``` ## Что может произойти с кодом дальше? @@ -84,7 +86,7 @@ def get_course_info(html): rating yet" можно переместить туда где данные подготавливаются к выводу в xlsx. ## Та же функция, часть вторая, последняя: - +```py def get_course_info(html): # ... more parsing logic is here @@ -96,6 +98,7 @@ def get_course_info(html): '4_weeks': duration, "5_rating": rating } +``` Сразу возникают вопросы. А если нужна еще одна выгрузка в формате csv, с другим порядком столбцов, как это сделать? Как заменить столбец 2_date на days_before_start ? From f5cf453fadba2f88054ac96d740297de40f1d242 Mon Sep 17 00:00:00 2001 From: Vitaliy Date: Thu, 25 Dec 2025 16:19:14 +0300 Subject: [PATCH 08/10] Highlighting cod.md --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 77d24afa..47bc50ba 100644 --- a/README.md +++ b/README.md @@ -32,33 +32,33 @@ def get_courses_list(courses_url): exit() ``` -## Теперь примерим на себя роль провидца и подумаем какой функционал потребуется -## через месяц: + Теперь примерим на себя роль провидца и подумаем какой функционал потребуется + через месяц: В случае сетевой ошибки взять паузу в 10 секунд и повторить попытку, затем подождать еще 30 секунд и так далее. В случае если адрес недоступен - постучаться по другому url в зеркало сайта. В случае ошибки сделать запись в лог и взять данные из ранее подготовленного кеша. -Как все это сделать когда def get_courses_list сама завершает программу ?! От -вызова exit() надо отказаться. Можно выбросить исключение и таким образом +Как все это сделать когда `def get_courses_list` сама завершает программу ?! От +вызова `exit()` надо отказаться. Можно выбросить исключение и таким образом сообщить о проблеме внешнему коду, пускай там разбираются. Вызов 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.` Вуаля, мы решили проблемы еще до их появления на горизонте! -## Пойдем дальше. Код другой функции: +Пойдем дальше. Код другой функции: ```py def get_course_info(html): # ... parsing logic @@ -75,17 +75,17 @@ def get_course_info(html): return course_data ``` -## Что может произойти с кодом дальше? +Что может произойти с кодом дальше? Если рейтинга нет — надо искать его на другом сайте. В xlsx указывать не просто отсутствие рейтинга, а еще на каких сайтах искал. Отчет о курсах без рейтинга выгружать в дополнительную вкладку xlsx, чтобы удобнее было руками проверять. Для всего этого нужно уметь отличать от прочих ситуацию "рейтинг неизвестен". -В Python для этих целей предусмотрено значение rating = None. А строку "No -rating yet" можно переместить туда где данные подготавливаются к выводу в xlsx. +В Python для этих целей предусмотрено значение `rating = None`. А строку `"No +rating yet"` можно переместить туда где данные подготавливаются к выводу в xlsx. -## Та же функция, часть вторая, последняя: +Та же функция, часть вторая, последняя: ```py def get_course_info(html): # ... more parsing logic is here @@ -100,14 +100,14 @@ def get_course_info(html): } ``` Сразу возникают вопросы. А если нужна еще одна выгрузка в формате csv, с -другим порядком столбцов, как это сделать? Как заменить столбец 2_date на -days_before_start ? +другим порядком столбцов, как это сделать? Как заменить столбец `2_date` на +`days_before_start` ? Кроме того, наперед известно, что пользовательский интерфейс — будь то вывод в консоль или запись в файл — меняется очень часто. Было бы удобно собрать все, что относится к форматированию вывода в одном месте. Например, всю логику -выгрузки в xlsx поместить в def fill_xlsx(workbook, courses):, а вывод в -консоль собрать внутри if __name__=='__main__':. Удастся избежать вычитывания +выгрузки в xlsx поместить в `def fill_xlsx(workbook, courses):`, а вывод в +консоль собрать внутри ``if __name__=='__main__':.`` Удастся избежать вычитывания и повторной отладки всей программы от начала до конца, ведь изменения локальны и изолированы. From d23c1846632e496cec34d3b4de89e80484f9efe1 Mon Sep 17 00:00:00 2001 From: Vitaliy Date: Sun, 28 Dec 2025 12:47:59 +0300 Subject: [PATCH 09/10] Issued the lists.md --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 47bc50ba..c98f37ca 100644 --- a/README.md +++ b/README.md @@ -34,11 +34,11 @@ def get_courses_list(courses_url): Теперь примерим на себя роль провидца и подумаем какой функционал потребуется через месяц: - -В случае сетевой ошибки взять паузу в 10 секунд и повторить попытку, затем + +1. В случае сетевой ошибки взять паузу в 10 секунд и повторить попытку, затем подождать еще 30 секунд и так далее. -В случае если адрес недоступен - постучаться по другому url в зеркало сайта. -В случае ошибки сделать запись в лог и взять данные из ранее подготовленного +1. В случае если адрес недоступен - постучаться по другому url в зеркало сайта. +1. В случае ошибки сделать запись в лог и взять данные из ранее подготовленного кеша. Как все это сделать когда `def get_courses_list` сама завершает программу ?! От вызова `exit()` надо отказаться. Можно выбросить исключение и таким образом @@ -50,8 +50,8 @@ def get_courses_list(courses_url): Что еще может потребоваться в скором будущем? -Отладить и покрыть тестами парсер HTML страницы. -Ускорить работу скрипта, хранить ранее скачанные страницы в кеше на жестком +1. Отладить и покрыть тестами парсер HTML страницы. +1. Ускорить работу скрипта, хранить ранее скачанные страницы в кеше на жестком диске. Ага, значит вызывать `fetch_html()` внутри `def get_courses_list` не такая уж хорошая идея. Жить будет легче если передать в `def get_courses_list` строку с @@ -77,9 +77,9 @@ def get_course_info(html): Что может произойти с кодом дальше? -Если рейтинга нет — надо искать его на другом сайте. -В xlsx указывать не просто отсутствие рейтинга, а еще на каких сайтах искал. -Отчет о курсах без рейтинга выгружать в дополнительную вкладку xlsx, чтобы +1. Если рейтинга нет — надо искать его на другом сайте. +1. В xlsx указывать не просто отсутствие рейтинга, а еще на каких сайтах искал. +1. Отчет о курсах без рейтинга выгружать в дополнительную вкладку xlsx, чтобы удобнее было руками проверять. Для всего этого нужно уметь отличать от прочих ситуацию "рейтинг неизвестен". В Python для этих целей предусмотрено значение `rating = None`. А строку `"No @@ -115,8 +115,8 @@ def get_course_info(html): В результате мы пришли к ситуации, когда логика обработки данных слабо зависит: -1)от источника данных; -2)от формата вывода в файл. +1. от источника данных; +1. от формата вывода в файл. ![image](https://dvmn.org/filer/canonical/1594117412/678/) Кроме того, часть кода удалось превратить в [чистые функции](https://devman.org/encyclopedia/decomposition/decomposition_pure_functions/), что облегчит From 0030dd745b63f21e93a2a61b0a99f1e0043fda16 Mon Sep 17 00:00:00 2001 From: Vitaliy Date: Mon, 29 Dec 2025 14:25:31 +0300 Subject: [PATCH 10/10] Issued a list.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index c98f37ca..f5d76fbc 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,7 @@ def get_courses_list(courses_url): 1. В случае если адрес недоступен - постучаться по другому url в зеркало сайта. 1. В случае ошибки сделать запись в лог и взять данные из ранее подготовленного кеша. + Как все это сделать когда `def get_courses_list` сама завершает программу ?! От вызова `exit()` надо отказаться. Можно выбросить исключение и таким образом сообщить о проблеме внешнему коду, пускай там разбираются. @@ -53,6 +54,7 @@ def get_courses_list(courses_url): 1. Отладить и покрыть тестами парсер HTML страницы. 1. Ускорить работу скрипта, хранить ранее скачанные страницы в кеше на жестком диске. + Ага, значит вызывать `fetch_html()` внутри `def get_courses_list` не такая уж хорошая идея. Жить будет легче если передать в `def get_courses_list` строку с HTML разметкой вместо `courses_url.` Вуаля, мы решили проблемы еще до их @@ -81,6 +83,7 @@ def get_course_info(html): 1. В xlsx указывать не просто отсутствие рейтинга, а еще на каких сайтах искал. 1. Отчет о курсах без рейтинга выгружать в дополнительную вкладку xlsx, чтобы удобнее было руками проверять. + Для всего этого нужно уметь отличать от прочих ситуацию "рейтинг неизвестен". В Python для этих целей предусмотрено значение `rating = None`. А строку `"No rating yet"` можно переместить туда где данные подготавливаются к выводу в xlsx.