Add flake8 check to GitLab CI, and fix style problems identified by flake8

Author: daniel-jones-dev

.gitlab-ci.yml

@@ -31,10 +31,14 @@ before_script:
 
 # stage: check ----------------------
 
-formatting:
+black:
   stage: check
   script: poetry run black --check .
 
+flake8:
+  stage: check
+  script: poetry run flake8 deepl tests
+
 # stage: build ----------------------
 
 package:
@@ -56,16 +60,6 @@ package:
       vault: jenkins/client_libraries/test_server_url@backend
       file: false
 
-#.use-mock-server-template: &use_mock_server_template
-#  variables:
-#    DEEPL_SERVER_URL: http://localhost:3000
-#    DEEPL_MOCK_SERVER_PORT: 3000
-#    DEEPL_PROXY_URL: http://localhost:3001
-#    DEEPL_MOCK_PROXY_SERVER_PORT: 3001
-#
-#  after_script:
-#    - docker stop deepl-mock
-
 test:
   <<: *use_test_server_template
   stage: test

deepl/__main__.py

@@ -42,8 +42,8 @@ def action_languages(translator: deepl.Translator, glossary: bool):
         for language in target_languages:
             if language.supports_formality:
                 print(f"{language.code}: {language.name} (supports formality)")
-            else:
-                print(f"{language.code}: {language.name}")
+        else:
+            print(f"{language.code}: {language.name}")
 
 
 def action_document(
@@ -206,8 +206,9 @@ def get_parser(prog_name):
         "--proxy-url",
         default=None,
         metavar="URL",
-        help=f"proxy server URL to use for all connections; the {env_proxy_url} "
-        f"environment variable may be used as secondary fallback",
+        help="proxy server URL to use for all connections; the "
+        f"{env_proxy_url} environment variable may be used as secondary "
+        "fallback",
     )
 
     # Note: add_subparsers param 'required' is not available in py36
@@ -255,7 +256,8 @@ def add_common_arguments(subparser: argparse.ArgumentParser):
         type=str,
         choices=[enum.value for enum in deepl.SplitSentences],
         default=deepl.SplitSentences.DEFAULT.value,
-        help="control sentence splitting before translation, see API for information",
+        help="control sentence splitting before translation, see API for "
+        "information",
     )
     parser_text.add_argument(
         "--preserve-formatting",
@@ -399,16 +401,17 @@ def add_common_arguments(subparser: argparse.ArgumentParser):
         "--file",
         type=str,
         help="file to read glossary entries from. File must be in "
-        "tab-separated values (TSV) format: one entry-pair per line, each line "
-        "contains the source entry, a tab, then the target entry. Empty lines "
-        "are ignored.",
+        "tab-separated values (TSV) format: one entry-pair per line, each "
+        "line contains the source entry, a tab, then the target entry. Empty "
+        "lines are ignored.",
     )
 
     parser_glossary_list = glossary_subparsers.add_parser(
         "list",
         help="list available glossaries",
         description="list available glossaries",
     )
+    _ = parser_glossary_list  # Suppress unused variable warning
 
     parser_glossary_get = glossary_subparsers.add_parser(
         "get",
@@ -459,7 +462,7 @@ def main(args=None, prog_name=None):
 
     if args.command is None:
         # Support for Python 3.6 - subcommands cannot be required
-        sys.stderr.write(f"Error: command is required\n")
+        sys.stderr.write("Error: command is required\n")
         parser.print_help(sys.stderr)
         sys.exit(1)
 
@@ -500,7 +503,7 @@ def main(args=None, prog_name=None):
         elif args.command == "glossary":
             if args.subcommand is None:
                 # Support for Python 3.6 - subcommands cannot be required
-                sys.stderr.write(f"Error: glossary subcommand is required\n")
+                sys.stderr.write("Error: glossary subcommand is required\n")
                 parser_glossary.print_help(sys.stderr)
                 sys.exit(1)
 

deepl/http_client.py

@@ -124,8 +124,9 @@ def request_with_backoff(
                 )
 
             log_info(
-                f"Starting retry {backoff.get_num_retries() + 1} for request {method} {url} "
-                f"after sleeping for {backoff.get_time_until_deadline():.2f} seconds."
+                f"Starting retry {backoff.get_num_retries() + 1} for request "
+                f"{method} {url} after sleeping for "
+                f"{backoff.get_time_until_deadline():.2f} seconds."
             )
             backoff.sleep_until_deadline()
 

deepl/translator.py

@@ -227,7 +227,8 @@ def limit(self) -> Optional[int]:
 
         @property
         def valid(self) -> bool:
-            """True iff both the count and limit are set for this usage type."""
+            """True iff both the count and limit are set for this usage
+            type."""
             return self._count is not None and self._limit is not None
 
         @property
@@ -546,11 +547,13 @@ def _check_valid_languages(
         """Internal function to check given languages are valid."""
         if target_lang == "EN":
             raise DeepLException(
-                'target_lang="EN" is deprecated, please use "EN-GB" or "EN-US" instead.'
+                'target_lang="EN" is deprecated, please use "EN-GB" or "EN-US"'
+                "instead."
             )
         elif target_lang == "PT":
             raise DeepLException(
-                'target_lang="PT" is deprecated, please use "PT-PT" or "PT-BR" instead.'
+                'target_lang="PT" is deprecated, please use "PT-PT" or "PT-BR"'
+                "instead."
             )
 
     def _check_language_and_formality(
@@ -758,17 +761,19 @@ def translate_document_from_filepath(
 
         :param input_path: Path to document to be translated.
         :param output_path: Path to store translated document.
-        :param source_lang: (Optional) Language code of input document, for example "DE",
-            "EN", "FR". If omitted, DeepL will auto-detect the input language.
-        :param target_lang: Language code to translate document into, for example "DE",
-            "EN-US", "FR".
-        :param formality: (Optional) Desired formality for translation, as Formality
-            enum, "less" or "more".
+        :param source_lang: (Optional) Language code of input document, for
+            example "DE", "EN", "FR". If omitted, DeepL will auto-detect the
+            input language.
+        :param target_lang: Language code to translate document into, for
+            example "DE", "EN-US", "FR".
+        :param formality: (Optional) Desired formality for translation, as
+            Formality enum, "less" or "more".
         :param glossary: (Optional) glossary or glossary ID to use for
             translation. Must match specified source_lang and target_lang.
 
-        :raises DocumentTranslationException: If an error occurs during translation,
-            The exception includes information about the document request.
+        :raises DocumentTranslationException: If an error occurs during
+            translation. The exception includes information about the document
+            request.
         """
         with open(input_path, "rb") as in_file:
             with open(output_path, "wb") as out_file:
@@ -801,7 +806,8 @@ def translate_document(
 
         :param input_document: Document to translate as a file-like object. It
             is recommended to open files in binary mode.
-        :param output_document: File-like object to receive translated document.
+        :param output_document: File-like object to receive translated
+            document.
         :param source_lang: (Optional) Language code of input document, for
             example "DE", "EN", "FR". If omitted, DeepL will auto-detect the
             input language.