Как вы описываете минимальное количество секунд до времени ожидания как переменную?

Question

У меня есть метод. Язык для этого вопроса не важен, но вот заглушки в Java и Python, поэтому людям есть, с чем иметь дело:

Token getToken(long seconds){
   ...
}

def get_token(seconds):
   ...

Документация для этого метода гласит:

Получить текущий токен или новый.

Гарантирует, что возвращенный токен будет действителен не менее указанного количества секунд.

Поскольку я не являюсь носителем английского языка, две вещи меня озадачивают.

Я бы хотел назвать аргумент для моего метода более понятным, чем seconds, но он не должен быть слишком длинным. Я рассмотрел следующее (стиль Python):

• timeout_seconds
• minimum_timeout_seconds
• minimum_timeout
• required_timeout
• required_timeout_seconds

Я не думаю, что кто-то из них на месте, и они немного длинны на мой вкус. Что люди предпочитают? Есть ли слово, которое может выразить цель лучше, чем те, которые я использовал?

Во-вторых, документация для аргумента гласит:

Количество секунд, которое должно пройти, по крайней мере, до истечения срока действия текущего токена. Если до истечения времени осталось меньше этого количества секунд, токен будет обновлен автоматически.

Я не чувствую, что формулировка здесь правильная. Есть мысли?

Answer 1

Поскольку вы имеете дело с токенами, я бы взял Web-токен JSON (JWT) RFC в качестве вдохновения. Следовательно, я бы использовал

expires_in_seconds

в качестве имени переменной, если используется стиль Python.

Слово «тайм-аут» чаще используется, когда операция перестает пытаться преуспеть во всем, что она пытается сделать, тогда как «истекает» означает, что субъект (в данном случае токен) подходит к концу срок действия.

Что касается документации, я бы предпочел:

Количество секунд, в течение которых токен действителен.

Тем не менее, похоже, что код, который вы используете, может пытаться создать свой собственный стандарт веб-токенов, о чем я бы предупреждал! например «Если до истечения осталось меньше этого количества секунд, токен будет автоматически обновлен», - кажется странным.