1abe2a44f5
Completely rewrite how subscription validation is performed. Optimizes it quite a bit while also adding backend support for the upcoming `dissect` sub-command, where you can resolve any subscription into its 'raw' form for easier debugging when making scripting changes.
81 lines
2.2 KiB
Python
81 lines
2.2 KiB
Python
import re
|
|
|
|
from ytdl_sub.script.functions import Functions
|
|
from ytdl_sub.script.utils.exceptions import InvalidFunctionName
|
|
from ytdl_sub.script.utils.exceptions import InvalidVariableName
|
|
|
|
_NAME_REGEX_VALIDATOR = re.compile(r"^[a-z][a-z0-9_]*$")
|
|
|
|
|
|
def is_valid_name(name: str) -> bool:
|
|
"""
|
|
Returns
|
|
-------
|
|
True if the name adheres to the ``snake_case`` format. False otherwise.
|
|
"""
|
|
return re.match(_NAME_REGEX_VALIDATOR, name) is not None
|
|
|
|
|
|
def validate_variable_name(variable_name: str) -> str:
|
|
"""
|
|
Raises
|
|
------
|
|
InvalidVariableName
|
|
if the variable name is invalid
|
|
"""
|
|
if not is_valid_name(variable_name):
|
|
raise InvalidVariableName(
|
|
f"Variable name '{variable_name}' is invalid:"
|
|
" Names must be lower_snake_cased and begin with a letter."
|
|
)
|
|
|
|
if Functions.is_built_in(variable_name):
|
|
raise InvalidVariableName(
|
|
f"Variable name '{variable_name}' is invalid:"
|
|
" The name is used by a built-in function and cannot be overwritten."
|
|
)
|
|
|
|
return variable_name
|
|
|
|
|
|
def validate_custom_function_name(custom_function_name: str) -> None:
|
|
"""
|
|
Raises
|
|
------
|
|
InvalidFunctionName
|
|
If the function name is invalid
|
|
InvalidVariableName
|
|
if the variable name is invalid
|
|
"""
|
|
if not is_valid_name(custom_function_name):
|
|
raise InvalidFunctionName(
|
|
f"Custom function name '%{custom_function_name}' is invalid:"
|
|
" Names must be %lower_snake_cased and begin with a letter."
|
|
)
|
|
|
|
if Functions.is_built_in(custom_function_name):
|
|
raise InvalidFunctionName(
|
|
f"Custom function name '%{custom_function_name}' is invalid:"
|
|
" The name is used by a built-in function and cannot be overwritten."
|
|
)
|
|
|
|
|
|
def is_function(override_name: str):
|
|
"""
|
|
Whether the definition is a function or not.
|
|
"""
|
|
return override_name.startswith("%")
|
|
|
|
|
|
def to_function_name(function_key: str) -> str:
|
|
"""
|
|
Drop the % in %custom_function
|
|
"""
|
|
return function_key[1:]
|
|
|
|
|
|
def to_function_definition_name(function_key: str) -> str:
|
|
"""
|
|
Add % in %custom_function
|
|
"""
|
|
return f"%{function_key}"
|