roland
/
python_examples
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add comments

This commit is contained in:
Roland Thomas Jr 2024-06-09 15:52:30 -04:00
parent 6c50bd267e
commit c608c48dfb
Signed by: roland
GPG Key ID: 7C3C2B085A4C2872
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
cli/jql_utils.py
View File

@ -19,6 +19,7 @@ from rich.text import Text as RichText
class JQLLexer(RegexLexer): class JQLLexer(RegexLexer):
""" JQL Lexer for Pygments. """
name = "JQL" name = "JQL"
aliases = ["jql"] aliases = ["jql"]
filenames = ["*.jql"] filenames = ["*.jql"]
@ -63,6 +64,9 @@ class JQLLexer(RegexLexer):
class JQLStyles: class JQLStyles:
""" JQL Styles for Pygments.
Based on the Nord color palette: https://www.nordtheme.com/docs/colors-and-palettes
"""
nord: Style = Style.from_dict( nord: Style = Style.from_dict(
{ {
"pygments.whitespace": "#FFFFFF", "pygments.whitespace": "#FFFFFF",
@ -218,13 +222,16 @@ completions: Dict[str, List[str]] = {
class JQLPrinter: class JQLPrinter:
""" JQL Printer to print JQL queries with syntax highlighting. """
def __init__(self, console: Console): def __init__(self, console: Console):
self.console = console self.console = console
def print(self, text: str): def print(self, text: str):
""" Print JQL query with syntax highlighting. """
self.console.print(self.pygments_to_rich(text), end="") self.console.print(self.pygments_to_rich(text), end="")
def pygments_to_rich(self, text): def pygments_to_rich(self, text):
""" Convert Pygments tokens to RichText. """
tokens = list(JQLLexer().get_tokens(text)) tokens = list(JQLLexer().get_tokens(text))
rich_text = RichText() rich_text = RichText()
for token_type, value in tokens: for token_type, value in tokens:
@ -234,10 +241,12 @@ class JQLPrinter:
class JQLValidator(Validator): class JQLValidator(Validator):
""" JQL Validator to validate JQL queries. """
def __init__(self, jira_instance): def __init__(self, jira_instance):
self.jira = jira_instance self.jira = jira_instance
def validate(self, document): def validate(self, document):
""" Validate JQL query. """
text = document.text text = document.text
if text.lower() == "b" or text.lower() == "exit": if text.lower() == "b" or text.lower() == "exit":
return return
@ -284,6 +293,7 @@ def load_config():
class JQLPrompt: class JQLPrompt:
""" JQL Prompt to interact with JIRA using JQL queries. """
def __init__(self, jira): def __init__(self, jira):
self.jira: JIRA = jira self.jira: JIRA = jira
self.console: Console = Console(color_system="truecolor", record=True) self.console: Console = Console(color_system="truecolor", record=True)
@ -319,6 +329,10 @@ class JQLPrompt:
) )
def prompt(self) -> Optional[List[Issue]]: def prompt(self) -> Optional[List[Issue]]:
""" Prompt the user for a JQL query.
Returns:
Optional[List[Issue]]: List of JIRA issues.
"""
user_input: str = self.session.prompt() user_input: str = self.session.prompt()
self.issue_count = 0 self.issue_count = 0
if not user_input: if not user_input:
@ -346,6 +360,10 @@ class JQLPrompt:
self.console.print("[!] No issues found.", style="#BF616A bold") self.console.print("[!] No issues found.", style="#BF616A bold")
def multi_prompt(self) -> Optional[List[Issue]]: def multi_prompt(self) -> Optional[List[Issue]]:
""" Prompt the user for multiple JQL queries.
Returns:
Optional[List[Issue]]: List of JIRA issues.
"""
self.issues = [] self.issues = []
while True: while True:
try: try:
@ -367,6 +385,7 @@ class JQLPrompt:
self.console.print("[!] No issues added.", style="#BF616A bold") self.console.print("[!] No issues added.", style="#BF616A bold")
def save_log(self): def save_log(self):
""" Save the console log to a file. """
log_time = datetime.now().strftime("%Y-%m-%d_%H-%M-%S") log_time = datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
with open(f"jql_{log_time}.txt", "w") as log_file: with open(f"jql_{log_time}.txt", "w") as log_file:
log_file.write(self.console.export_text()) log_file.write(self.console.export_text())