📤 move helper methods to separate files

Author: gy-mate

src/moodle_to_vikwikiquiz/helpers.py

@@ -0,0 +1,19 @@
+from os import system
+from pathlib import Path
+from time import sleep
+
+from send2trash import send2trash  # type: ignore
+
+
+def clear_terminal() -> None:
+    system("clear||cls")
+
+
+def wait_for_pastebot_to_recognize_copy() -> None:
+    print("Waiting 2 seconds for Pastebot to recognize it...")
+    sleep(2)
+    print("...done!")
+
+
+def remove_uploaded_files(folder: Path) -> None:
+    send2trash(folder)

src/moodle_to_vikwikiquiz/main.py

@@ -1,20 +1,13 @@
 from argparse import ArgumentParser, Namespace
 import logging
 from pathlib import Path
-from platform import system
 from sys import version_info
-from time import sleep
-from urllib.parse import quote, urlencode
-from webbrowser import open_new_tab
-
-# future: delete the comment below when stubs for the package below are available
-from pyperclip import copy  # type: ignore
-from send2trash import send2trash  # type: ignore
 
+from .wiki import create_article, get_article_instructions, log_in_to_wiki  # type: ignore
 from .quiz.illustrations.state_of_illustrations import StateOfIllustrations  # type: ignore
 from .quiz.grading_types import GradingType  # type: ignore
 from .quiz.quiz import Quiz  # type: ignore
-from .quiz.quiz_helpers import clear_terminal  # type: ignore
+from .helpers import clear_terminal, wait_for_pastebot_to_recognize_copy  # type: ignore
 
 
 def main() -> None:
@@ -69,108 +62,6 @@ def main() -> None:
     logging.getLogger(__name__).debug("Program finished!")
 
 
-def get_article_instructions(
-    quiz: Quiz, wiki_domain: str
-) -> tuple[str, dict[str, str], dict[str, str], dict[str, str]]:
-    wikitext_instructions = """
-<!-- További teendőid (ebben a sorrendben):
-• e komment feletti sorba illeszd be a vágólapodra másolt tartalmat
-• kattints az 'Előnézet megtekintése' gombra"""
-    operating_system = system()
-    wiki_modifier_keys = {
-        "Darwin": "Control-Option",
-        "Linux": "Alt-Shift",
-        "Windows": "Alt-Shift",
-    }
-    wiki_editor_keys = {"Show preview": "P", "Publish page": "S"}
-    if operating_system == "Darwin" or operating_system == "Linux":
-        wikitext_instructions += f" ({wiki_modifier_keys[operating_system]}-{wiki_editor_keys["Show preview"]})"
-    wikitext_instructions += """
-• javítsd a helyesírást és a formázást (ha szükséges), különös tekintettel a képletekre"""
-    match quiz.state_of_illustrations:
-        case StateOfIllustrations.YesAndAvailable:
-            upload_directory = quiz.get_illustrations_ready_for_upload()
-            go_to_folder_keyboard_shortcuts = {
-                "Darwin": "Command-Shift-G",
-                "Linux": "Ctrl-L",
-                "Windows": "Ctrl-L",
-            }
-            print(
-                f"""The batch upload page of the wiki will now be opened. After that, please...
-• click on 'Fájlok kiválasztása...'"""
-            )
-            if operating_system == "Darwin" or operating_system == "Linux":
-                copy(str(upload_directory))
-                print(
-                    f"""    • press {go_to_folder_keyboard_shortcuts[operating_system]}
-        • paste the content of the clipboard
-        • press Enter"""
-                )
-            else:
-                print("    • open the following folder: " + str(upload_directory))
-            print(
-                """    • select all files in the folder
-    • click on 'Upload'
-• return here."""
-            )
-            input("\nPlease press Enter then follow these instructions...")
-            open_new_tab(
-                f"{wiki_domain}/Speciális:TömegesFeltöltés/moodle-to-vikwikiquiz"
-            )
-            input("Please press Enter if you're done with uploading...")
-            if upload_directory:
-                remove_uploaded_files(upload_directory)
-            clear_terminal()
-
-            print("Great! I've deleted the uploaded files from your disk.\n")
-        case StateOfIllustrations.YesButUnavailable:
-            wikitext_instructions += """
-• töltsd fel kézzel, egyesével a piros linkekkel formázott illusztrációkat
-    • másold ki a megfelelő "Fájl:" wikitext után található generált fájlnevet
-    • kattints a szerkesztő eszköztárában található 'Képek és médiafájlok' gombra
-    • töltsd fel az illusztrációt"""
-        case StateOfIllustrations.Nil:
-            pass
-    wikitext_instructions += """
-• töröld ezt a kommentet
-• kattints a 'Lap mentése' gombra"""
-    if operating_system == "Darwin" or operating_system == "Linux":
-        wikitext_instructions += f" ({wiki_modifier_keys[operating_system]}-{wiki_editor_keys["Publish page"]})"
-    wikitext_instructions += """
--->"""
-    parameters_for_opening_edit = {
-        "action": "edit",
-        "summary": "Kvíz bővítése "
-        "a https://github.com/gy-mate/moodle-to-vikwikiquiz segítségével importált Moodle-kvíz(ek)ből",
-        "preload": "Sablon:Előbetöltés",
-        "preloadparams[]": wikitext_instructions,
-    }
-    clear_terminal()
-    return (
-        operating_system,
-        parameters_for_opening_edit,
-        wiki_editor_keys,
-        wiki_modifier_keys,
-    )
-
-
-def log_in_to_wiki(wiki_domain: str) -> None:
-    input(
-        """Let's log in to the wiki! Please...
-• if you see the login page, log in
-• when you see the main page of the wiki, return here.
-
-Please press Enter to open the login page..."""
-    )
-    open_new_tab(f"{wiki_domain}/index.php?title=Speciális:Belépés")
-    input("Please press Enter if you've logged in...")
-    clear_terminal()
-
-
-def remove_uploaded_files(folder: Path) -> None:
-    send2trash(folder)
-
-
 def parse_arguments() -> Namespace:
     parser = ArgumentParser(
         "Convert graded and downloaded Moodle quizzes to a vik.viki quiz wikitext."
@@ -258,102 +149,5 @@ def get_grading() -> GradingType:
             clear_terminal()
 
 
-def create_article(
-    args: Namespace,
-    parameters_for_opening_edit: dict[str, str],
-    quiz_title: str,
-    quiz_wikitext: str,
-    wiki_domain: str,
-    wiki_modifier_keys: dict[str, str],
-    wiki_editor_keys: dict[str, str],
-    operating_system: str,
-) -> None:
-    if args.new:
-        parameters_for_opening_edit_with_paste = parameters_for_opening_edit.copy()
-        parameters_for_opening_edit_with_paste.update(
-            {
-                "preload": "Sablon:Előbetöltés",
-                "preloadparams[]": quiz_wikitext,
-            }
-        )
-        parameters_for_opening_edit_with_paste["summary"] = (
-            parameters_for_opening_edit_with_paste["summary"].replace(
-                "bővítése", "létrehozása"
-            )
-        )
-        url = f"{wiki_domain}/{quiz_title}?{urlencode(parameters_for_opening_edit_with_paste)}"
-        if len(url) < 2048:
-            return open_article_paste_text(args, quiz_wikitext, url)
-        else:
-            open_article(args, parameters_for_opening_edit, url)
-    else:
-        del parameters_for_opening_edit["preload"]
-        del parameters_for_opening_edit["preloadparams[]"]
-    copy(quiz_wikitext)
-    print("\nThe wikitext of the quiz has been copied to the clipboard!")
-    url = f"{wiki_domain}/{quote(quiz_title)}?{urlencode(parameters_for_opening_edit)}"
-    if not args.new:
-        print(
-            f"""
-The existing article will now be opened for editing. After that, please...
-• scroll to the bottom of the wikitext in the editor
-• add a new line
-• paste the content of the clipboard in that line
-• click on the 'Előnézet megtekintése' button ({wiki_modifier_keys[operating_system]}-{wiki_editor_keys["Show preview"]})
-• correct the spelling and formatting (if necessary), especially the formulas
-• click on the 'Lap mentése' button ({wiki_modifier_keys[operating_system]}-{wiki_editor_keys["Publish page"]})"""
-        )
-        input("\nPlease press Enter then follow these instructions...")
-    open_new_tab(url)
-    print(
-        "\nThe edit page of the quiz article has been opened in your browser!", end=" "
-    )
-    if args.new:
-        print("Please follow the instructions there.")
-
-
-def open_article_paste_text(args: Namespace, quiz_wikitext: str, url: str) -> None:
-    copy(quiz_wikitext)
-    print(
-        "\nThe wikitext of the quiz has been copied to the clipboard! "
-        "This will be overwritten but you may recall it later if you use an app like Pastebot."
-    )
-    wait_for_pastebot_to_recognize_copy()
-    if args.verbose:
-        copy(url)
-        print("The URL has been copied to the clipboard!")
-    open_new_tab(url)
-    print(
-        "\nThe edit page of the new quiz article has been opened in your browser with the wikitext pre-filled! "
-        "Please upload illustrations manually, if there are any."
-    )
-    return
-
-
-def open_article(
-    args: Namespace, parameters_for_opening_edit: dict[str, str], url: str
-) -> None:
-    logging.getLogger(__name__).warning(
-        "I can't create the article automatically "
-        "because the URL would be too long for some browsers (or the server)."
-    )
-    if args.verbose:
-        copy(url)
-        print(
-            "\nThis URL has been copied to the clipboard! "
-            "It will be overwritten but you may recall it later if you use an app like Pastebot."
-        )
-        wait_for_pastebot_to_recognize_copy()
-    parameters_for_opening_edit["summary"] = parameters_for_opening_edit[
-        "summary"
-    ].replace("bővítése", "létrehozása")
-
-
-def wait_for_pastebot_to_recognize_copy() -> None:
-    print("Waiting 2 seconds for Pastebot to recognize it...")
-    sleep(2)
-    print("...done!")
-
-
 if __name__ == "__main__":
     main()

src/moodle_to_vikwikiquiz/quiz/helpers.py

@@ -0,0 +1,61 @@
+from re import sub
+from uuid import uuid4
+
+# noinspection PyPackageRequirements
+from pylatexenc.latexencode import unicode_to_latex  # type: ignore
+
+from .illustrations.illustration import Illustration  # type: ignore
+from .questions.helpers import format_latex_as_wikitext  # type: ignore
+from .quiz_element import QuizElement  # type: ignore
+from .illustrations.state_of_illustrations import StateOfIllustrations  # type: ignore
+from .questions.question import Question  # type: ignore
+from .questions.question_types import QuestionType  # type: ignore
+
+
+def prettify(text: str) -> str:
+    text = strip_whitespaces(text)
+    text = format_latex_as_wikitext(text)
+    return text
+
+
+def strip_whitespaces(text: str) -> str:
+    text = text.strip("., \n")
+    text = sub(r" \n|\r\n|\s{2}", " ", text)
+    return text
+
+
+def truncate_filename(element_text: str, extension: str, quiz_name: str) -> str:
+    number_of_element_text_words = 5
+    while number_of_element_text_words > 1:
+        split_element_text = element_text.split()
+        split_truncated_element_text = " ".join(
+            split_element_text[:number_of_element_text_words]
+        )
+        upload_filename = create_upload_filename(
+            quiz_name, split_truncated_element_text + "…", extension
+        )
+        if not filename_too_long(upload_filename):
+            return upload_filename
+        number_of_element_text_words -= 1
+
+    # noinspection PyUnboundLocalVariable
+    split_truncated_element_text = split_truncated_element_text[:15]
+    upload_filename = create_upload_filename(
+        quiz_name, split_truncated_element_text + "…", extension
+    )
+    return upload_filename
+
+
+def filename_too_long(upload_filename) -> bool:
+    return len(upload_filename) > 100
+
+
+def create_upload_filename(
+    quiz_name: str, name_of_illustration: str, extension: str, make_unique: bool = False
+) -> str:
+    upload_filename = f'"{name_of_illustration}"'
+    if make_unique:
+        random_hash = uuid4().hex[:6]
+        upload_filename += f" – válaszlehetőség {random_hash}"
+    upload_filename += f" ({quiz_name}){extension}"
+    return upload_filename

src/moodle_to_vikwikiquiz/quiz/illustrations/helpers.py

@@ -0,0 +1,66 @@
+from pathlib import Path
+from urllib.parse import unquote, urlparse
+
+from bs4 import Tag
+
+from ..helpers import create_upload_filename, filename_too_long, truncate_filename  # type: ignore
+from .illustration import Illustration  # type: ignore
+from .state_of_illustrations import StateOfIllustrations  # type: ignore
+from ..questions.answers.answer import Answer  # type: ignore
+from ..questions.question import Question  # type: ignore
+from ..quiz_element import QuizElement  # type: ignore
+
+
+def get_element_illustration(
+    tag: Tag,
+    element_text: str,
+    quiz_name: str,
+    element: QuizElement,
+    state_of_illustrations: StateOfIllustrations,
+    current_folder: Path,
+    question_name: str | None = None,
+) -> Illustration | None:
+    if image := tag.find("img"):
+        assert isinstance(image, Tag)
+        illustration_url = image["src"]
+        assert isinstance(illustration_url, str)
+        illustration_url_parsed = urlparse(illustration_url)
+        illustration_url_parsed = illustration_url_parsed._replace(query="")
+        illustration_url_string = illustration_url_parsed.geturl()
+        illustration_path_string = unquote(illustration_url_string)
+        illustration_path = Path(illustration_path_string)
+        original_file_path_string = current_folder / illustration_path
+        original_file_path = Path(original_file_path_string)
+        extension = original_file_path.suffix
+
+        if element is Question:
+            illustration_size = 500
+        elif element is Answer:
+            illustration_size = 250
+        else:
+            raise ValueError(f"Unexpected QuizElement type: {element}!")
+
+        if element_text == "":
+            assert question_name
+            max_question_name_length = 15
+            if len(question_name) > max_question_name_length:
+                question_name = f"{question_name[:max_question_name_length]}…"
+            upload_filename = create_upload_filename(
+                quiz_name,
+                question_name,
+                extension,
+                make_unique=True,
+            )
+        else:
+            upload_filename = create_upload_filename(quiz_name, element_text, extension)
+            if filename_too_long(upload_filename):
+                upload_filename = truncate_filename(element_text, extension, quiz_name)
+
+        return Illustration(
+            upload_filename=upload_filename,
+            size_in_pixels=illustration_size,
+            state_of_illustrations=state_of_illustrations,
+            original_file_path=original_file_path,
+        )
+    else:
+        return None

src/moodle_to_vikwikiquiz/quiz/questions/answer.py renamed to src/moodle_to_vikwikiquiz/quiz/questions/answers/answer.py

@@ -1,6 +1,5 @@
-from ..illustrations.illustration import Illustration  # type: ignore
-from ..quiz_element import QuizElement  # type: ignore
-from ..illustrations.state_of_illustrations import StateOfIllustrations  # type: ignore
+from ...illustrations.illustration import Illustration  # type: ignore
+from ...quiz_element import QuizElement  # type: ignore
 
 
 class Answer(QuizElement):