Англійська для розробників OCaml

Розмови OCaml сильно опираються на точний словник типової системи, тому що вся цінність мови полягає в ловленні помилок під час компіляції через типи, яких більшість мов не мають. Обговорення коду OCaml без цього словника означає повернення до нечітких термінів, на зразок « типова річ », для поняттів, які вашим колегам слід назвати точно.

Ключовий словник

** Алгебраїчний тип даних (ADT) ** — тип, створений за допомогою поєднання інших типів або як добуток (запис з декількома полями, всі з яких присутні одночасно) або як сума (варіант, точно один з декількох можливих форм), це основа того, як OCaml моделює дані. “Модельуйте це як алгебраїчний тип даних замість запису з купою необмежених полів — варіант робить нелегальні стани буквально непередбачуваними, тому ви не можете отримати порядок Paid, який також має нульовий amount.”

** Перевірка повноти ** — перевірка компілятора, що збіг шаблону охоплює всі можливі конструктори варіанту, відмовляючись компілювати (або принаймні попереджаючи), якщо відсутній певний випадок, таким чином OCaml запобігає цілому класу помилок типу « забулося обробляти цей випадок ». “Додати новий регістр Refunded до варіанту і дозволити перевірці вичерпності зробити свою роботу — кожен збіг виразів обробки OrderStatus тепер не буде компілюватися, поки ви не оновите його, тому ми не можемо відправити це напівоброблене.”

** Functor ** — у OCaml, модуль, який приймає інший модуль як параметр і створює новий модуль, відмінний від математичного або Haskell- сенсу цього слова, використовується для створення загальних, багаторазово використовуваних абстракцій рівня модуля.

• “Ми написали це як функтор, параметризований модулем порівняння, отже, однакова реалізація збалансованого дерева працює для будь- якого типу ключа, який можна впорядкувати, без дублювання логіки дерева.” *

** Підпис модуля (файл .mli) ** — файл інтерфейсу, який визначає, які саме типи і значення буде показано модулем, приховуючи всі інші, надаючи вам інкапсуляцію, яку вимагає компілятор, а не лише домовленість щодо назв. “Не виставляйте внутрішню функцію helper — залиште її поза .mli, і підпис модуля буде вимагати, щоб виклики справді не могли до неї дістатися, а не тільки те, що вони не повинні.”

** Полиморфний варіант ** — відкритий, структурно типізований варіант (написаний з початковим зворотним знаком), який не потрібно оголошувати заздалегідь у єдиному визначенні типу, обмінюючи деякі з безпечних звичайних варіантів на більшу гнучкість у межах модулів.

• “Ми використовували поліморфний варіант навмисно, оскільки ця функція повинна приймати результати від трьох не пов’ язаних модулів, без того, щоб ці модулі залежали від одного типу спільного варіанту.” *

Звичайні фрази

• «Чи це моделюється як алгебраїчний тип даних, чи ми відстежуємо дійсні стани з булівськими і сподіваємося на найкраще?»
• Чи перевірка вичерпності ловить це, чи ми десь замовкли попередження?»
• Чи має це бути функтор, так що він може бути повторно використаний у різних типах модулів, або достатньо однієї конкретної реалізації?
• Чи є це значення в підписі модуля, чи воно має залишатися внутрішнім?
• Чи нам дійсно потрібен поліморфний варіант, чи буде звичайний варіант безпечнішим?»

Приклади речення

Пояснення вибору дизайну у перегляді: “Я моделював стан платежу як алгебраїчний тип даних замість структури з рядком стану і трьома опціональними полями — тепер Refunded оплата просто не може мати нуль refundedAt, тому що конструктор варіантів вимагає цього.”

Позначати ризиковане збігнення шаблону: “Це збіг не є вичерпним — єдине попередження компілятора, тому що у нас є випадки з підказками, які поглинають все, що означає, що новий варіант випадків, доданий пізніше, безмовно потрапить у цей випадок з підказками, замість того, щоб не вдалося збудувати.”

Опис розробки модуля: “Ми написали кеш як функтор над модулем ключів, тому одна й та ж логіка вилучення використовується для рядкових ключів, цілих ключів і нашого нетипового типу OrderId без трьох окремих реалізацій.”

Професійні поради

• Використовуйте ** алгебраїчний тип даних **, коли ви відчуваєте спокусу представити стан за допомогою комбінації булевих чи нульових полів — це ідіомний спосіб OCaml зробити недійсні стани неможливими до представлення, і переглядачі очікуватимуть цього.
• Ніколи не приглушуйте попередження про ** перевірку вичерпності ** за допомогою загального випадка шаблону, якщо ви навмисно не вирішили, що нові випадки слід ігнорувати типово — це рішення має бути явним і переглянутим, а не випадковим.
• Використовувати ** функтор **, якщо ви маєте справжнє, структурне повторне використання між типами модулів, а не лише поверхневу схожість — надмірне використання функторів робить код важчим для читання, ніж дублювання, якого слід уникати.
• Тримайте ** підпис модуля ** мінімальним і навмисним — розглядайте файл .mli як фактичний контракт, який ви переглядаєте, оскільки це те, від чого залежать інші інженери, а не файл реалізації.
• Типово, звичайні варіанти слід використовувати замість ** поліморфних варіантів **, якщо вам не потрібна гнучкість структури — поліморфні варіанти обмінюються доповіддю компілятора щодо гнучкості, і цей обмін має бути свідомим.

Практичні вправи

1. Поясніть різницю між алгебраїчним типом даних і звичайним записом з необов’ язковими полями.
2. Описати, чому перевірка повноти має значення, коли пізніше додається новий варіант.
3. Напишіть речення, яке обґрунтовує використання функтора замість дублювання реалізації.

В практиці: оновлення комунікації для професійного співробітництва

Для не- рідних англомовних людей, які вчаться орієнтуватися в нюансах професійного розвитку комунікації - особливо в технічно зосередженому середовищі, як OCaml - це не тільки про знання * визначення * термінів. Це розуміння того, як ці терміни використовуються в контексті, і, що важливіше, як виразити свої ідеї чітко і переконливо колегам. Значною перешкодою часто є не самі технічні концепції, а тонкі зміни у фразуваннях, що вказують на різні рівні впевненості, досвіду або намірів. Розглянемо коментар перегляду коду: « Ця функція може отримати користь від деяких операцій з помилками. » — це звучить просто, але що, якщо переглядач хоче більше, ніж просто * деяких * операцій? Додавши контекст, наприклад, «Чи можете ви реалізувати надійну обробку помилок, включаючи конкретні винятки для InvalidInput і NetworkError, з детальним журналюванням?», Ви відразу ж проясните очікування. Аналогічно, повідомлення Slack, що вимагає реалізації функції, недостатньо ефективне; його оформлення як «Чи можете ви дослідити додавання підтримки для аналізу CSV? Ми отримуємо все більше запитів від команди з науки про дані для імпорту результатів. ” демонструє розуміння більш широкого впливу і відповідно приоритизує запит.

Інша поширена проблема виникає при обговоренні проектних рішень, особливо щодо складних алгебраїчних типів даних або повноти відповідності шаблонів. Просто заявивши «код не обробляє всі випадки» не є дієздатним зворотнім зв’язком. Замість цього, більш продуктивним підходом буде: « Я помітив, що тип Option не повністю вичерпано у цьому збігу шаблонів; ми повинні переконатися, що * кожен * можливий варіант обробляється, щоб уникнути помилок під час виконання і поліпшити надійність ». Ця фраза підкреслює потенційний ризик (помилка під час виконання) і пропонує конкретне рішення (вичерпання шаблону). Ефективне спілкування також залежить від визнання внесених компромісів. Сказати «Ми не можемо зробити це, тому що це занадто складно» не допомагає; натомість, «Хоча цей підхід є елегантним, введення цього рівня складності може вплинути на продуктивність і збільшити витрати на обслуговування. Давайте дослідимо альтернативні стратегії, які балансують виразність з ефективністю. ” демонструє більш обдуману перспективу.

Крім того, термінологія навколо функторів — особливо при обговоренні того, як вони пов’язані з модульними системами — може бути легко неправильно інтерпретована. Фраза «Цей функтор спрощує взаємодію між модулями» не повністю передає переваги композиції і абстракції. Краще було б сказати: « Використовуючи цей функтор, ми досягли більш високого рівня модульності, зменшивши дублювання коду і поліпшивши підтримку за допомогою інкапсулювання спільної функціональності ». Це підкреслює конкретні переваги, отримані за допомогою застосування функціональної концепції. Врешті-решт, точність мови відображає увагу до деталей - якість, високо оцінена в розробці програмного забезпечення.

Ось приклад використання ocamlfind для розв’ язання залежностей:

ocamlfind install core -mode dynamic

Ця команда демонструє запит певної бібліотеки ( core ) і вказує режим встановлення ( dynamic ), що важливо при обговоренні керування залежностями і процесів збирання — важливий словник для будь- якої дискусії про розробку OCaml.