⚡️ reduce import scopes; simplify Path joining and fix variable names

Author: gy-mate

src/moodle_to_vikwikiquiz/main.py

@@ -2,12 +2,13 @@
 import logging
 from pathlib import Path
 from platform import system
-import time
+from sys import version_info
+from time import sleep
 from urllib.parse import quote, urlencode
-import webbrowser
+from webbrowser import open_new_tab
 
 # future: delete the comment below when stubs for the package below are available
-import pyperclip  # type: ignore
+from pyperclip import copy  # type: ignore
 from send2trash import send2trash  # type: ignore
 
 from .quiz.illustrations.state_of_illustrations import StateOfIllustrations  # type: ignore
@@ -35,7 +36,7 @@ def main() -> None:
     )
     absolute_source_path: Path = args.source_path.resolve()
     quiz.import_file_or_files(
-        path=absolute_source_path,
+        source_path=absolute_source_path,
         recursively=args.recursive,
     )
     wiki_domain = "https://vik.wiki"
@@ -91,7 +92,7 @@ def get_article_instructions(
 • click on 'Fájlok kiválasztása...'"""
             )
             if operating_system == "Darwin" or operating_system == "Linux":
-                pyperclip.copy(str(upload_directory))
+                copy(str(upload_directory))
                 print(
                     f"""    • press {go_to_folder_keyboard_shortcuts[operating_system]}
         • paste the content of the clipboard
@@ -105,7 +106,7 @@ def get_article_instructions(
 • return here."""
             )
             input("\nPlease press Enter then follow these instructions...")
-            webbrowser.open_new_tab(
+            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...")
@@ -153,7 +154,7 @@ def log_in_to_wiki(wiki_domain: str) -> None:
 
 Please press Enter to open the login page..."""
     )
-    webbrowser.open_new_tab(f"{wiki_domain}/index.php?title=Speciális:Belépés")
+    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()
 
@@ -280,7 +281,7 @@ def create_article(
     else:
         del parameters_for_opening_edit["preload"]
         del parameters_for_opening_edit["preloadparams[]"]
-    pyperclip.copy(quiz_wikitext)
+    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:
@@ -295,7 +296,7 @@ def create_article(
 • 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...")
-    webbrowser.open_new_tab(url)
+    open_new_tab(url)
     print(
         "\nThe edit page of the quiz article has been opened in your browser!", end=" "
     )
@@ -304,16 +305,16 @@ def create_article(
 
 
 def open_article_paste_text(args: Namespace, quiz_wikitext: str, url: str) -> None:
-    pyperclip.copy(quiz_wikitext)
+    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:
-        pyperclip.copy(url)
+        copy(url)
         print("The URL has been copied to the clipboard!")
-    webbrowser.open_new_tab(url)
+    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."
@@ -329,7 +330,7 @@ def open_article(
         "because the URL would be too long for some browsers (or the server)."
     )
     if args.verbose:
-        pyperclip.copy(url)
+        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."
@@ -342,7 +343,7 @@ def open_article(
 
 def wait_for_pastebot_to_recognize_copy() -> None:
     print("Waiting 2 seconds for Pastebot to recognize it...")
-    time.sleep(2)
+    sleep(2)
     print("...done!")
 
 

src/moodle_to_vikwikiquiz/quiz/illustrations/illustration.py

@@ -1,12 +1,12 @@
 from pathlib import Path
-import re
+from re import sub
 
 from .state_of_illustrations import StateOfIllustrations  # type: ignore
 
 
 def remove_wiki_unsafe_characters(upload_filename) -> str:
-    upload_filename = re.sub(r"[{\[]", "(", upload_filename)
-    upload_filename = re.sub(r"[}\]]", ")", upload_filename)
+    upload_filename = sub(r"[{\[]", "(", upload_filename)
+    upload_filename = sub(r"[}\]]", ")", upload_filename)
     return upload_filename
 
 

src/moodle_to_vikwikiquiz/quiz/quiz.py

@@ -1,15 +1,14 @@
-import contextlib
+from contextlib import suppress
 
 # future: report false positive to JetBrains developers
 # noinspection PyUnresolvedReferences
-import os
+from os import getcwd, makedirs, path, rename, walk
 
 # noinspection PyUnresolvedReferences
 from pathlib import Path
 
-# noinspection PyUnresolvedReferences
-import re
-import shutil
+from re import compile
+from shutil import copy
 
 # noinspection PyUnresolvedReferences
 from bs4 import BeautifulSoup, Tag
@@ -28,17 +27,13 @@ def move_illustration_to_upload_folder(
     quiz_element: QuizElement, upload_directory: Path
 ) -> None:
     if illustration := quiz_element.illustration:
-        if not os.path.exists(upload_directory):
-            os.makedirs(upload_directory)
+        if not path.exists(upload_directory):
+            makedirs(upload_directory)
         original_file_path = illustration.original_file_path.resolve()
-        shutil.copy(original_file_path, upload_directory)
-        current_file_path = Path(
-            os.path.join(upload_directory, illustration.original_file_path.name)
-        )
-        new_file_path = os.path.join(
-            current_file_path.parent, illustration.upload_filename
-        )
-        os.rename(current_file_path, new_file_path)
+        copy(original_file_path, upload_directory)
+        current_file_path = upload_directory / illustration.original_file_path.name
+        new_file_path = current_file_path.parent / illustration.upload_filename
+        rename(current_file_path, new_file_path)
 
 
 class Quiz:
@@ -78,31 +73,31 @@ def __str__(self) -> str:
         text += "\n"
         return text
 
-    def import_file_or_files(self, path: Path, recursively: bool) -> None:
-        if not os.path.exists(path):
+    def import_file_or_files(self, source_path: Path, recursively: bool) -> None:
+        if not path.exists(source_path):
             raise FileNotFoundError(f"'{path}' does not exist!")
-        elif os.path.isfile(path):
-            self.import_questions(path, path.parent)
+        elif path.isfile(source_path):
+            self.import_questions(source_path, source_path.parent)
         else:
-            self.import_files(path, recursively)
+            self.import_files(source_path, recursively)
 
         if not self.questions:
             raise ValueError(f"No questions were imported from '{path}'!")
 
-    def import_files(self, path: Path, recursively: bool) -> None:
-        for directory, subdirectories, files in os.walk(path):
+    def import_files(self, source_path: Path, recursively: bool) -> None:
+        for directory, subdirectories, files in walk(source_path):
             for file in files:
                 self.import_questions(Path(file), Path(directory))
             if not recursively:
                 break
 
     def import_questions(self, file: Path, directory: Path) -> None:
-        file_path = os.path.join(directory, file)
+        file_path = path.join(directory, file)
         with open(file_path, "rb") as source_file:
             webpage = BeautifulSoup(source_file, "html.parser")
 
             accepted_questions = webpage.find_all(
-                "div", class_=re.compile(r"multichoice|calculatedmulti|truefalse")
+                "div", class_=compile(r"multichoice|calculatedmulti|truefalse")
             )
             for question in accepted_questions:
                 self.import_question(question, Path(file_path), directory, file)
@@ -117,7 +112,7 @@ def import_question(
     ) -> None:
         if self.state_of_illustrations == StateOfIllustrations.Nil:
             self.state_of_illustrations = get_if_has_illustration(question, directory, file)  # type: ignore
-        with contextlib.suppress(NotImplementedError):
+        with suppress(NotImplementedError):
             question_type = get_question_type(question)  # type: ignore
         correctly_answered, grade, maximum_points = get_grading_of_question(question)  # type: ignore
         # noinspection PyTypeChecker
@@ -138,7 +133,7 @@ def import_question(
                 maximum_points,
                 question_text,
                 question_type,
-                os.path.basename(file_path),
+                path.basename(file_path),
             )
         self.add_question_if_new(
             question_type,
@@ -257,13 +252,13 @@ def add_question(
             )
 
     def get_illustrations_ready_for_upload(self) -> Path | None:
-        upload_directory = Path(os.path.join(os.getcwd(), "to_upload"))
+        upload_directory = Path(path.join(getcwd(), "to_upload"))
         for question in self.questions:
             move_illustration_to_upload_folder(question, upload_directory)
             for answer in question.answers:
                 if answer.illustration:
                     move_illustration_to_upload_folder(answer, upload_directory)
-        if os.path.exists(upload_directory):
+        if path.exists(upload_directory):
             return upload_directory
         else:
             return None

src/moodle_to_vikwikiquiz/quiz/quiz_helpers.py

@@ -1,8 +1,8 @@
-import os
+from os import path, system
 from pathlib import Path
-import re
+from re import findall, sub
 from urllib.parse import unquote, urlparse
-import uuid
+from uuid import uuid4
 
 from bs4 import Tag
 
@@ -34,7 +34,7 @@ def get_grading_of_question(question: Tag) -> tuple[bool, float | None, float]:
     assert isinstance(found_tag, Tag)
 
     grading_text = found_tag.text
-    numbers_in_capture_groups: list[tuple[str, str]] = re.findall(
+    numbers_in_capture_groups: list[tuple[str, str]] = findall(
         r"(\d+)([.,]\d+)?", grading_text
     )
     numbers = [
@@ -158,7 +158,7 @@ def prettify(text: str) -> str:
 
 def strip_whitespaces(text: str) -> str:
     text = text.strip("., \n")
-    text = re.sub(r" \n|\r\n|\s{2}", " ", text)
+    text = sub(r" \n|\r\n|\s{2}", " ", text)
     return text
 
 
@@ -249,7 +249,7 @@ def get_question_data(
 
 def get_question_text(found_tag: Tag) -> str:
     assert isinstance(found_tag, Tag)
-    text = re.sub(r"\s?\r?\n\s?", " ", found_tag.text)
+    text = sub(r"\s?\r?\n\s?", " ", found_tag.text)
     text = text.rstrip()
     text = format_latex_as_wikitext(text)
     return text
@@ -273,7 +273,7 @@ def get_element_illustration(
         illustration_url_string = illustration_url_parsed.geturl()
         illustration_path_string = unquote(illustration_url_string)
         illustration_path = Path(illustration_path_string)
-        original_file_path_string = os.path.join(current_folder, illustration_path)
+        original_file_path_string = current_folder / illustration_path
         original_file_path = Path(original_file_path_string)
         extension = original_file_path.suffix
 
@@ -341,7 +341,7 @@ def create_upload_filename(
 ) -> str:
     upload_filename = f'"{name_of_illustration}"'
     if make_unique:
-        random_hash = uuid.uuid4().hex[:6]
+        random_hash = uuid4().hex[:6]
         upload_filename += f" – válaszlehetőség {random_hash}"
     upload_filename += f" ({quiz_name}){extension}"
     return upload_filename
@@ -358,17 +358,17 @@ def format_latex_as_wikitext(latex: Tag) -> str:
 
 @dispatch  # type: ignore
 def format_latex_as_wikitext(latex: str) -> str:
-    if re.findall(latex_start_anchored := r"^\s?\\?\\\(\s?(\s?\\(?=\\))?", latex):
-        wikitext = re.sub(latex_start_anchored, "<math>", latex)
+    if findall(latex_start_anchored := r"^\s?\\?\\\(\s?(\s?\\(?=\\))?", latex):
+        wikitext = sub(latex_start_anchored, "<math>", latex)
     else:
         latex_start = latex_start_anchored.replace(r"^\s?", "")
-        wikitext = re.sub(latex_start, "<math>", latex)
+        wikitext = sub(latex_start, "<math>", latex)
 
-    if re.findall(latex_end_anchored := r"\s*\\?\\\)\s?$", wikitext):
-        wikitext = re.sub(latex_end_anchored, "</math>", wikitext)
+    if findall(latex_end_anchored := r"\s*\\?\\\)\s?$", wikitext):
+        wikitext = sub(latex_end_anchored, "</math>", wikitext)
     else:
         latex_end = latex_end_anchored.replace(r"\s?$", "")
-        wikitext = re.sub(latex_end, "</math>", wikitext)
+        wikitext = sub(latex_end, "</math>", wikitext)
     return wikitext
 
 
@@ -396,12 +396,12 @@ def get_if_has_illustration(
 
 
 def get_if_illustrations_available(directory: Path, file: Path) -> StateOfIllustrations:
-    asset_folder = os.path.join(directory, f"{file.stem}_files")
-    if os.path.exists(asset_folder):
+    asset_folder = directory / f"{file.stem}_files"
+    if path.exists(asset_folder):
         return StateOfIllustrations.YesAndAvailable
     else:
         return StateOfIllustrations.YesButUnavailable
 
 
 def clear_terminal() -> None:
-    os.system("clear||cls")
+    system("clear||cls")