cornsnake.util_input

  1"""
  2Functions for handling user input with various formats and validations.
  3
  4[Documentation](http://docs.mrseanryan.cornsnake.s3-website-eu-west-1.amazonaws.com/cornsnake/util_input.html)
  5"""
  6
  7import os
  8
  9from . import config
 10from . import util_color
 11from . import util_validate
 12from . import util_date
 13
 14prompt_token = " >"
 15
 16QUESTION_COLOR = util_color.bcolors.OKCYAN
 17
 18
 19def input_custom(question, default):
 20    """
 21    Function to get user input with default value.
 22
 23    Args:
 24    question (str): The question to prompt the user.
 25    default: The default value for the input.
 26
 27    Returns:
 28    str: The user input value.
 29    """
 30    if isinstance(default, str):
 31        default = default.strip()
 32    if not config.IS_INTERACTIVE:
 33        print(question + str(default))
 34        return default
 35    return input(question).strip() or default
 36
 37
 38def input_with_format_date(question, default):
 39    """
 40    Function to get user input with date format validation.
 41
 42    Args:
 43    question (str): The question to prompt the user.
 44    default: The default value for the input.
 45
 46    Returns:
 47    str: The user input date value.
 48    """
 49    question = (
 50        util_color.colorize(question, QUESTION_COLOR)
 51        + f" [format = yyyy-mm-dd] [default is {default}]"
 52        + prompt_token
 53    )
 54    while True:
 55        answer = input_custom(question, default)
 56        if util_date.is_valid_date_yyyy_mm_dd(answer):
 57            return answer
 58
 59
 60def boolToYorN(value):
 61    """
 62    Function to convert boolean value to Y or N.
 63
 64    Args:
 65    value: Boolean value to convert.
 66
 67    Returns:
 68    str: 'Y' if True, 'N' if False.
 69    """
 70    if value:
 71        return "Y"
 72    return "N"
 73
 74
 75def input_list_of_branches(question, default):
 76    """
 77    Function to get a list of branch names from user input.
 78
 79    Args:
 80    question (str): The question to prompt the user.
 81    default: The default value for the input.
 82
 83    Returns:
 84    list: List of branch names.
 85    """
 86    if not config.IS_INTERACTIVE:
 87        return default
 88    items = []
 89    question = (
 90        util_color.colorize(question, QUESTION_COLOR)
 91        + f" [default is {default}]"
 92        + prompt_token
 93    )
 94    is_valid = False
 95    while not is_valid:
 96        answer = input_custom(question, "")
 97        if len(answer) > 0:
 98            error = util_validate.check_is_branch_name_or_empty(answer, "branch name")
 99            if error:
100                print(error)
101            else:
102                items.append(answer)
103        elif len(items) > 0:
104            is_valid = True
105        elif len(default) > 0:
106            items = default
107            is_valid = True
108    return items
109
110
111def input_branch_name_required(question, default):
112    """
113    Function to get a required branch name from user input.
114
115    Args:
116    question (str): The question to prompt the user.
117    default: The default value for the input.
118
119    Returns:
120    str: The user input branch name.
121    """
122    question = util_color.colorize(question, QUESTION_COLOR) + f"[Default = {default}]"
123    while True:
124        answer = input_custom(question, default)
125        if answer and len(answer) > 0:
126            error = util_validate.check_is_branch_name_or_empty(answer, "branch name")
127            if error:
128                print(error)
129            else:
130                return answer
131
132
133def input_required__dir_path(question, default):
134    """
135    Function to get a required directory path from user input.
136
137    Args:
138    question (str): The question to prompt the user.
139    default: The default value for the input.
140
141    Returns:
142    str: The user input directory path.
143    """
144    question = (
145        util_color.colorize(question, QUESTION_COLOR)
146        + f" [default is {default}]"
147        + prompt_token
148    )
149    while True:
150        answer = input_custom(question, default)
151        if len(answer) > 0:
152            if not os.path.isdir(answer):
153                print(" ! ERROR: That directory does not exist")
154            else:
155                return answer
156
157
158def input_with_format_y_or_n(question, default):
159    """
160    Function to get user input with Y or N format validation.
161
162    Args:
163    question (str): The question to prompt the user.
164    default: The default value for the input.
165
166    Returns:
167    bool: True for 'Y', False for 'N'.
168    """
169    question = (
170        util_color.colorize(question, QUESTION_COLOR)
171        + f" [Y or N] [default is {boolToYorN(default)}]"
172        + prompt_token
173    )
174    while True:
175        answer = input_custom(question, default)
176        if not config.IS_INTERACTIVE:
177            return answer
178        if len(answer) == 0 and default is not None:
179            return default
180        if answer == "Y":
181            return True
182        if answer == "N":
183            return False
184
185
186def input_with_format_git_filter_repo_size(question, default):
187    """
188    Function to get user input with Git filter repo size format validation.
189
190    Args:
191    question (str): The question to prompt the user.
192    default: The default value for the input.
193
194    Returns:
195    str: The user input Git filter repo size.
196    """
197    question = (
198        util_color.colorize(question, QUESTION_COLOR)
199        + f"[Values are like 256K or 1M or 1G][Default = {default}]"
200        + prompt_token
201    )
202    while True:
203        answer = input_custom(question, default)
204        if len(answer) == 0:
205            return default
206        if util_validate.is_valid_blob_size(answer):
207            return answer
208
209
210def input_optional(question, default):
211    """
212    Function to get optional user input.
213
214    Args:
215    question (str): The question to prompt the user.
216    default: The default value for the input.
217
218    Returns:
219    str: The user input value.
220    """
221    question = util_color.colorize(question, QUESTION_COLOR) + f"[Default = {default}]"
222    answer = input_custom(question, default)
223    return answer