Инженер и данные

Псевдокод - прием инженера.

🔍 Дата инженеры много работают с кодом. В этом посте я хочу поделиться простым лайф хаком, который мне не раз сохранил нервы и время.

Попроси джуна и он сразу пойдет писать код, попроси сеньора и он сначала продумает решение от начала до конца (может для нескольких вариантов) и только потом напишет код.

💬 А продумывать помогает очень простой и удобный прием - псевдокод.

Псевдокод - описание простым человеческим языком конкретных шагов и действий, которые должны быть выполнены, чтобы мы получили желаемое поведение кода (метода, sql запроса). По сути мы отбрасываем синтаксис языка программирования и пишем с синтаксисом естественного языка 😉

❗️Не путать с докстринг (docstrings). Докситринг для клиентов метода/класса - описание как использовать метод и для чего он нужен. А псевдокод для разработчиков - отражает конкретные действия в коде, то есть то как именно выполняется задача.

Вот пример псевдокода в методе класса на пайтоне. Хотя можно использовать везде и в sql запросах тоже.

   def set_lead_id(self, *, crm_uri, calls_storage_uri):
        """
        Performs actions to enrich calls data by lead_id and project_key
        """
        # pseudocode
        # Option 1:
        # group calls in the same time range 
        # (half an hour) in order to reduce count of requests to crm
        # reduce calls by caller number
        # execute as many requests to crm as groups passing time range and phone. get lead_id, project.
        # assign lead_id and project to every call in the initial calls list matching by phone. 
        # The assumption: all calls with the same phone number within a half an hour will have the same lead_id
        # Option 2:
        # get calls without lead within time range
        # prepare request for every call with time range as call datetime +/- 2 minutes
        # combine requests with UNION clause
        # execute combined request to crm. get lead_id, project.
        # push data to calls table

        # Use option 2
        # дальше пишем код, используя вариант 2

📝 Любой код всего лишь техническая реализация какого-то алгоритма/логики, то есть до того как написать код мы знаем зачем нам он нам нужен.

Псевдокод позволяет:
🔸продумать цепочку действий от начала до конца не отвлекаясь на синтаксис языка
🔸увидеть логические противоречия до того как вы уже написали половину кода.
🔸увидеть допущения и спорные моменты, которые были не очевидны
🔸увидеть плюсы и минусы разных вариантов, оценить их потенциальное быстродейтсвие, выбрать лучший
🔸делегировать написание самого кода кому-то (так еще не пробовал, но идея хорошая. Сюда же входит использование AI. А что? Чем псевдокод не промпт для chat gpt? 🤔)

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

Так и получилось в моем недавнем кейсе. Метод стал медленно работать. Я прочитал псевдокод, понял работу метода, понял в каком месте есть потенциальная проблема, затем внес изменения сначала в псевдокод, убедился что логически это будет работать, затем легко нашел нужное место в коде и быстро внес изменения. Готово! 5 минут потратил, закрыл и забыл еще на месяц, на полгода или больше, пока логика снова не поменяется. 🙌

‼️И еще помните! Комментарий, который не соответствует коду хуже, чем отсутствующий комментарий.

Please open Telegram to view this post

VIEW IN TELEGRAM

🔥10👍4

466 viewsedited 08:49