refactor: re-organize gitignore

* chore(pylint): enable pylint rule and reorganize gitignore * chore(pylint): fix pylint line-too-long pylint rule * improv: fix formatting issues * fix: fix pytest docstrings * improv: remove trailing disabled pylint error Co-authored-by: Daniel Kantor <[email protected]>
kantord · Feb 21, 2022 · 7d9d996 · 7d9d996
1 parent 9c27cfa
commit 7d9d996
Show file tree

Hide file tree

Showing 18 changed files with 146 additions and 71 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,48 +1,78 @@
-.DS_Store
+# IDE
+**/.DS_Store
+**/.vscode
+**/.idea/codeStyles/codeStyleConfig.xml
+**/.idea/jsLinters/eslint.xml
+**/.idea/LibreLingo.iml
+**/.idea/misc.xml
+**/.idea/modules.xml
+**/.idea/codeStyles/Project.xml
+**/.idea/inspectionProfiles/Project_Default.xml
+**/.idea/vcs.xml
+**/.idea/workspace.xml
+**/.vim
+
+
+# Dependencies
 /node_modules/
 **/node_modules/
 /src/node_modules/@sapper/
+.venv/
+.env
+/apps/*/poetry.lock
+
+
+# Development
 yarn-error.log
-apps/web/cypress/screenshots/
+.yarn
+.yarnrc
+*.pyc
+/apps/librelingo_json_export/profile.png
+profile.dat
+
+
+# Static files
 /apps/web/__sapper__/
 /static/files
+staticfiles/
+apps/web/static/files/noto-*
+
+
+# Cypress files
 .nyc_output/
 cypress-coverage/
 jest-coverage/
-cypress/videos
-.venv/
-/course_editor/db.sqlite3
-*.pyc
-.env
-/db.sqlite3
-/src/audios_to_fetch.csv
-localData/
-staticfiles/
-git_stats/
-/.idea/codeStyles/codeStyleConfig.xml
-/.idea/jsLinters/eslint.xml
-/.idea/LibreLingo.iml
-/.idea/misc.xml
-/.idea/modules.xml
-/.idea/codeStyles/Project.xml
-/.idea/inspectionProfiles/Project_Default.xml
-/.idea/vcs.xml
-/.idea/workspace.xml
-apps/web/static/files/noto-*
+**/cypress/videos
+apps/web/cypress/screenshots/
 apps/web/cypress/screenshots/**/__tkey-*.png
-.vim
+**/coverage/
+
+
+# Build
 apps/librelingo_tools/dist
 **/dist/
-*.tsbuildinfo
-report.*.*.json
-/coverage/
+
+
+# Documentation
 apps/docs/build/
+report.*.*.json
+*.tsbuildinfo
 __sapper__
-.yarn
-.yarnrc
+
+
+# Stats
+git_stats/
+
+
+# Data
+/course_editor/db.sqlite3
+/db.sqlite3
+/src/audios_to_fetch.csv
+/apps/librelingo_json_export/profile.png
+localData/
+
+
+# Courses
 /apps/web/src/courses/*-*
 /courses/*-*
-profile.dat
-/apps/librelingo_json_export/profile.png
-/apps/*/poetry.lock
-.vscode/
+
diff --git a/apps/librelingo_audios/librelingo_audios/cli.py b/apps/librelingo_audios/librelingo_audios/cli.py
@@ -1,7 +1,9 @@
-from pathlib import Path
 import collections
+from pathlib import Path
+
 import click  # type: ignore
 from librelingo_yaml_loader import load_course
+
 from librelingo_audios.update_audios import update_audios_for_course
 
 Settings = collections.namedtuple(
@@ -32,7 +34,8 @@ def ensure_output_directory(output_path, settings):
     "--destructive/--non-destructive",
     default=DEFAULT_SETTINGS.destructive,
     show_default=True,
-    help="--destructive deletes existing audio and re-generates from scratch. --non-destructive performs an iterative update.",
+    help="--destructive deletes existing audio and re-generates from scratch."
+    "--non-destructive performs an iterative update.",
 )
 def _command(input_path: str, output_path: str, course_name: str, dry_run, destructive):
     """

diff --git a/apps/librelingo_audios/librelingo_audios/update_audios.py b/apps/librelingo_audios/librelingo_audios/update_audios.py
@@ -1,12 +1,14 @@
-from pathlib import Path
-import subprocess
 import json
 import random
+import subprocess
+from pathlib import Path
 from typing import Set, Union
-from librelingo_audios.functions import list_required_audios
+
 from librelingo_types.data_types import Course, PhraseIdentity
 from librelingo_utils import audio_id
 
+from librelingo_audios.functions import list_required_audios
+
 
 def update_audios_for_course(
     output_path: str, course_name: str, course: Course, settings
@@ -106,11 +108,13 @@ def _generate_audio_with_tts(
 
     if settings.dry_run:
         print(
-            f"Would generate {destination_path} using {chosen_tts_settings.voice} {chosen_tts_settings.engine}"
+            f"Would generate {destination_path} "
+            f"using {chosen_tts_settings.voice} {chosen_tts_settings.engine}"
         )
     else:
         print(
-            f"Generating {destination_path} using {chosen_tts_settings.voice} {chosen_tts_settings.engine}"
+            f"Generating {destination_path} "
+            f"using {chosen_tts_settings.voice} {chosen_tts_settings.engine}"
         )
         # This is where more more TTS providers would be added with an if statement.
         # For now there is only Polly.

diff --git a/apps/librelingo_audios/tests/conftest.py b/apps/librelingo_audios/tests/conftest.py
@@ -50,6 +50,7 @@ def assert_output_matches(set_of_messages):
 
     return SimpleNamespace(
         assert_output_matches=assert_output_matches,
+        # pylint: disable=line-too-long
         message=SimpleNamespace(
             **{
                 "generating": lambda text: f"Generating {tmp_path / _mock_audio_file_for_text(text)} using Lupe standard",

diff --git a/apps/librelingo_fakes/librelingo_fakes/fakes.py b/apps/librelingo_fakes/librelingo_fakes/fakes.py
@@ -1,7 +1,8 @@
 """
 This package contains fake data for testing LibreLingo-related packages.
 
-The fake data is returned using the types from [librelingo-types](https://pypi.org/project/librelingo-types/).
+The fake data is returned using the types from
+[librelingo-types](https://pypi.org/project/librelingo-types/).
 
 ## Usage
 ```python
@@ -13,7 +14,8 @@
 fakes.courseEmpty  # This is an empty course
 ```
 
-For the full list of fakes, use the autocomplete or check out the [this file](https://github.com/LibreLingo/LibreLingo/blob/main/apps/librelingo_fakes/librelingo_fakes/fakes.py).
+# pylint: disable=line-too-long
+For the full list of fakes, use the autocomplete or check out[this file](https://github.com/LibreLingo/LibreLingo/blob/main/apps/librelingo_fakes/librelingo_fakes/fakes.py).
 
 ### Customizing fakes
 
@@ -29,20 +31,23 @@
 
 """
 
-from pathlib import Path
 import random
 from collections import namedtuple
-from librelingo_types import Course
-from librelingo_types import Module
-from librelingo_types import Skill
-from librelingo_types import Phrase
-from librelingo_types import Word
-from librelingo_types import License
-from librelingo_types import Language
-from librelingo_types import DictionaryItem
-from librelingo_types import Settings
-from librelingo_types import AudioSettings
-from librelingo_types import TextToSpeechSettings
+from pathlib import Path
+
+from librelingo_types import (
+    AudioSettings,
+    Course,
+    DictionaryItem,
+    Language,
+    License,
+    Module,
+    Phrase,
+    Settings,
+    Skill,
+    TextToSpeechSettings,
+    Word,
+)
 
 challenge1 = "challenge1"
 challenge2 = "challenge2"

diff --git a/apps/librelingo_json_export/librelingo_json_export/dictionary.py b/apps/librelingo_json_export/librelingo_json_export/dictionary.py
@@ -50,7 +50,8 @@ def _define_word(course: Course, word: Word, is_in_target_language):
         else course.source_language.name
     )
     raise ValueError(
-        f'The {language_name} word "{word}" does not have a definition. Please add it to the mini-dictionary.'
+        f'The {language_name} word "{word}" does not have a definition.'
+        "Please add it to the mini-dictionary."
     )
 
 

diff --git a/apps/librelingo_json_export/tests/test_challenges_define_word.py b/apps/librelingo_json_export/tests/test_challenges_define_word.py
@@ -9,7 +9,8 @@
 def test_definition_not_found():
     word = str(fakes.fake_value())
     pattern = re.escape(
-        f'The another language word "{word}" does not have a definition. Please add it to the mini-dictionary.'
+        f'The another language word "{word}" does not have a definition.'
+        "Please add it to the mini-dictionary."
     )
     with pytest.raises(ValueError, match=pattern):
         assert _define_word(fakes.course1, word, is_in_target_language=False) is True

diff --git a/apps/librelingo_json_export/tests/test_course_get_course_data.py b/apps/librelingo_json_export/tests/test_course_get_course_data.py
@@ -27,6 +27,7 @@ def test__get_course_data_return_value():
         "languageName": "my language",
         "languageCode": "de",
         "specialCharacters": ["ä", "ß"],
+        # pylint: disable=line-too-long
         "repositoryURL": "https://github.com/kantord/LibreLingo/tree/main/courses/spanish-from-english",
         "license": {
             "name": {

diff --git a/apps/librelingo_types/librelingo_types/data_types.py b/apps/librelingo_types/librelingo_types/data_types.py
@@ -28,6 +28,7 @@ class TextToSpeechSettings(
     pass
 
 
+# pylint: disable=line-too-long
 class AudioSettings(
     namedtuple(
         "AudioSettings",
@@ -78,6 +79,7 @@ class HunspellSettings(
     pass
 
 
+# pylint: disable=line-too-long
 class Settings(
     namedtuple(
         "Settings",
@@ -154,6 +156,7 @@ class Language(namedtuple("Language", ["name", "code"])):
     pass
 
 
+# pylint: disable=line-too-long
 class License(
     namedtuple(
         "License",
@@ -244,6 +247,7 @@ class Skill(
     pass
 
 
+# pylint: disable=line-too-long
 class Word(
     namedtuple(
         "Word",

diff --git a/apps/librelingo_yaml_loader/librelingo_yaml_loader/_spelling.py b/apps/librelingo_yaml_loader/librelingo_yaml_loader/_spelling.py
@@ -26,7 +26,8 @@ def _validate_phrase_in_target_language(phrase, course):
         for variant_subword in variant.split():
             if not course.settings.hunspell.target_language.spell(variant_subword):
                 raise RuntimeError(
-                    f'The {course.target_language.name} phrase "{variant}" is misspelled. The word "{variant_subword}" is unknown.'
+                    f'The {course.target_language.name} phrase "{variant}" is misspelled.'
+                    f'The word "{variant_subword}" is unknown.'
                 )
 
 
@@ -35,7 +36,8 @@ def _validate_phrase_in_source_language(phrase, course):
         for variant_subword in variant.split():
             if not course.settings.hunspell.source_language.spell(variant_subword):
                 raise RuntimeError(
-                    f'The {course.source_language.name} phrase "{variant}" is misspelled. The word "{variant_subword}" is unknown.'
+                    f'The {course.source_language.name} phrase "{variant}" is misspelled.'
+                    f'The word "{variant_subword}" is unknown.'
                 )
 
 

diff --git a/apps/librelingo_yaml_loader/librelingo_yaml_loader/yaml_loader.py b/apps/librelingo_yaml_loader/librelingo_yaml_loader/yaml_loader.py
@@ -150,7 +150,9 @@ def _convert_word(raw_word) -> Word:
     """
     Converts a YAML word definition into a Word() object
 
-    >>> _convert_word({'Images': ["abc"], 'Word': "cat", 'Synonyms': ["kitten"], 'Translation': "gato"})
+    >>> _convert_word(
+    ...     {'Images': ["abc"], 'Word': "cat", 'Synonyms': ["kitten"], 'Translation': "gato"}
+    ... )
     Word(in_target_language=['cat', 'kitten'], in_source_language=['gato'], pictures=['abc'])
     """
     return Word(
@@ -162,6 +164,7 @@ def _convert_word(raw_word) -> Word:
     )
 
 
+# pylint: disable=line-too-long
 def _convert_words(raw_words: List[Word]) -> List[Word]:
     """
     Converts each YAML word definition into Word() objects
@@ -183,6 +186,7 @@ def _convert_words(raw_words: List[Word]) -> List[Word]:
     return list(map(_convert_word, raw_words))
 
 
+# pylint: disable=line-too-long
 def _convert_phrase(raw_phrase) -> Phrase:
     """
     Converts a YAML phrase definition into a Phrase() object

diff --git a/apps/librelingo_yaml_loader/tests/test_yaml_loader.py b/apps/librelingo_yaml_loader/tests/test_yaml_loader.py
@@ -893,7 +893,8 @@ def test_load_skill_complains_about_misspelled_phrase_in_target_language(load_ya
         ),
     )
     expected_error = re.escape(
-        f'The {fake_course.target_language.name} phrase "{fake_phrase}" is misspelled. The word "{fake_word}" is unknown.'
+        f'The {fake_course.target_language.name} phrase "{fake_phrase}" is misspelled.'
+        f'The word "{fake_word}" is unknown.'
     )
     with pytest.raises(RuntimeError, match=expected_error):
         _load_skill(random_path, fake_course)
@@ -927,7 +928,8 @@ def test_load_skill_complains_about_misspelled_phrase_in_source_language(load_ya
         ),
     )
     expected_error = re.escape(
-        f'The {fake_course.source_language.name} phrase "{fake_phrase}" is misspelled. The word "{fake_word}" is unknown.'
+        f'The {fake_course.source_language.name} phrase "{fake_phrase}" is misspelled.'
+        f'The word "{fake_word}" is unknown.'
     )
     with pytest.raises(RuntimeError, match=expected_error):
         _load_skill(random_path, fake_course)
diff --git a/apps/tools/librelingo_tools/generate.py b/apps/tools/librelingo_tools/generate.py
@@ -78,7 +78,8 @@ def download_course(url, tempdir):
 def generate_course(links, courses_data, reldir, outdir, tdir, course_dir):
     logging.info("generate_course %s", course_dir)
     # pylint complains of "Catching too general exception Exception (broad-except)"
-    # but I don't know what kind of exception can happen there, so for now let's not catch any exception.
+    # but I don't know what kind of exception can happen there,
+    # so for now let's not catch any exception.
     # try:
     docs_dir = os.path.join(outdir, tdir)
     course = lili.load_course(course_dir)

diff --git a/apps/tools/librelingo_tools/lili-search.py b/apps/tools/librelingo_tools/lili-search.py
@@ -27,7 +27,11 @@ def main():
     for module in course.modules:
         for skill in module.skills:
 
-            # Word(in_target_language=['el chapeo', 'el chapeyo'], in_source_language=['the hat'], pictures=['hat1', 'hat2', 'hat3'])
+            # Word(
+            #   in_target_language=['el chapeo', 'el chapeyo'],
+            #   in_source_language=['the hat'],
+            #   pictures=['hat1', 'hat2', 'hat3']
+            # )
             for word in skill.words:
                 collect(
                     "target_word", module, skill, search_word, word.in_target_language