Чи вважається анти-зразком читати STDIN з бібліотеки?

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

Мій колега каже просто прочитати з STDIN (використовуючи Python:), code = input("Enter code: ")а потім дозволити користувачу передати його, проте мені це здається поганою практикою, оскільки бібліотека (у цьому випадку, безумовно, буде використана) у фоновому завданні на сервері .

Мені було цікаво, вважають це чи не анти-зразком чи ні.

Як загальне керівництво, бібліотеки повинні бути повністю відключені від навколишнього середовища. Це означає, що вони не повинні виконувати операції над стандартними потоками, над певними файлами або очікувати щодо середовища чи контексту, яким вони користуються.

Звичайно, з цього правила є винятки, але це має бути дуже вагома причина. У випадку використання stdinя не можу знайти жодної причини (якщо тільки ваша бібліотека фактично не пропонує підпрограми для читання з stdin, як, наприклад, std::cinз C ++). Крім того, прийом потоків вводу / виводу з параметра, а не їх жорстке кодування, додає стільки гнучкості, що робити це не варто.

Я вважав би це не обов'язково анти-шаблоном, а лише погано розробленою бібліотекою. Слід запитати рядок як параметр методу, де вхід може бути переданий безпосередньо в.

Якщо це не відповідає цьому використанню, то параметром методу може бути потік, при цьому STDIN передається в метод.

Якщо це не відповідає такому використанню, то бібліотека недостатньо гнучка.

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

Якщо він читає з stdin, це означає, що він хотів би взяти на себе програмне право власності на stdin. Це, ймовірно, не сумісне з будь-якою іншою бібліотекою, яка читає зі stdin, менш специфічний протокол того, яким чином вони використовують спільне використання. Принаймні мій власний особистий словник, це зробить бібліотеку основою , що є дорогим компромісом.

Але в цьому випадку бібліотека, ймовірно, повинна просто брати дескриптор вхідного файлу.

Відповідь @ Paul92 - це хороша загальна дискусія, але я хотів би запропонувати можливе чисте рішення для цього:

Бібліотека, цей код повинен бути пристосований до будь-якого середовища виконання, тому ви не можете дійсно запитувати STDINякийсь важливий біт даних. З однієї причини, користувачі вашої бібліотеки можуть бути недоступними з кількох причин. Натомість ви можете скористатись якоюсь формою стратегії, щоб налаштувати спосіб отримання маркера.

У Python, мабуть, найкращим варіантом є передача стратегії отримання токена як параметр функції. Щось схоже:

def stdin_prompt():
    return input("Enter code: ")

def my_library_function(arg1, arg2, ... argn, token_provider = stdin_prompt):
    ...
    token = token_provider()
    ...
    return stuff

# somewhere in the user code
stuff = my_library_function(a1, a2, ... an, lambda: "123456")

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

Вся відповідальність за надання точної механіки маркера тепер покладається на функцію бібліотеки. Споживач функції тепер несе відповідальність за придбання маркера будь-якими способами, доступними під час виконання. Він може запитати STDIN, але він може також виконувати функцію поштового шлюзу, зачекайте, поки повідомлення з’явиться у папці "Вхідні", прочитайте його, витягніть маркер і повністю автоматизуйте процес. Це може бути діалог GUI або веб-форма. Все, що насправді - усі варіанти зараз у руках споживача бібліотеки.