reformat code and docstrings

Author: Findus23

docs/api_docs.rst

@@ -11,7 +11,7 @@ CLI
 ---
 
 
-.. automodule:: pylanguagetool
+.. automodule:: pylanguagetool.cli
    :members:
 
 Converters

pylanguagetool/api.py

@@ -9,21 +9,21 @@
     ...     api_url='https://languagetool.org/api/v2/',
     ...     lang='en-US',
     ... )
-    {'software': {'name': 'LanguageTool', 'version': '4.6-SNAPSHOT', 'buildDate': '2019-05-15 19:25', 'apiVersion': 1, 'premium': False, 'premiumHint': 'You might be missing errors only the Premium version can find. Contact us at support<at>languagetoolplus.com.', 'status': ''}, 'warnings': {'incompleteResults': False}, 'language': {'name': 'English (US)', 'code': 'en-US', 'detectedLanguage': {'name': 'English (US)', 'code': 'en-US', 'confidence': 0.561}}, 'matches': [{'message': 'Use "an" instead of \'a\' if the following word starts with a vowel sound, e.g. \'an article\', \'an hour\'', 'shortMessage': 'Wrong article', 'replacements': [{'value': 'an'}], 'offset': 8, 'length': 1, 'context': {'text': 'This is a example', 'offset': 8, 'length': 1}, 'sentence': 'This is a example', 'type': {'typeName': 'Other'}, 'rule': {'id': 'EN_A_VS_AN', 'description': "Use of 'a' vs. 'an'", 'issueType': 'misspelling', 'category': {'id': 'MISC', 'name': 'Miscellaneous'}}, 'ignoreForIncompleteSentence': False, 'contextForSureMatch': 1}]}
-
 """
+from typing import Optional
+
 import requests
 
 
-def get_languages(api_url):
+def get_languages(api_url: str) -> list[dict[str, str]]:
     """
     Return supported languages as a list of dictionaries.
 
     Args:
         api_url (str): API base url.
 
     Returns:
-        List[dict]:
+        list[dict]:
             Supported languages as a list of dictionaries.
 
             Each dictionary contains three keys, ``name``, ``code`` and
@@ -47,11 +47,15 @@ def _is_in_pwl(match, pwl):
     return word in pwl
 
 
-def check(input_text, api_url, lang, mother_tongue=None, preferred_variants=None,
-          enabled_rules=None, disabled_rules=None,
-          enabled_categories=None, disabled_categories=None,
-          enabled_only=False, picky=False, verbose=False,
-          pwl=None, username=None, api_key=None):
+def check(
+        input_text: str, api_url: str,
+        lang: str, pwl: list[str],
+        mother_tongue: Optional[str] = None,
+        preferred_variants: Optional[str] = None,
+        enabled_rules: Optional[str] = None, disabled_rules: Optional[str] = None,
+        enabled_categories: Optional[str] = None, disabled_categories: Optional[str] = None,
+        enabled_only: bool = False, picky: bool = False, verbose: bool = False,
+        username: Optional[str] = None, api_key: Optional[str] = None):
     """
     Check given text and return API response as a dictionary.
 
@@ -105,7 +109,7 @@ def check(input_text, api_url, lang, mother_tongue=None, preferred_variants=None
             If ``True``, a more verbose output will be printed. Defaults to
             ``False``.
 
-        pwl (List[str]):
+        pwl (list[str]):
             Personal world list. A custom dictionary of words that should be
             excluded from spell checking errors.
 
@@ -125,30 +129,38 @@ def check(input_text, api_url, lang, mother_tongue=None, preferred_variants=None
 
                 {
                     "language": {
-                        "code": "en-US",
+                        "name": "English (GB)",
+                        "code": "en-GB",
                         "detectedLanguage": {
-                            "code": "en-US",
+                            "name": "English (GB)",
+                            "code": "en-GB",
                             "confidence": 0.561,
-                            "name": "English (US)",
+                            "source": "fasttext",
                         },
-                        "name": "English (US)",
                     },
+                    "sentenceRanges": [[0, 17]],
+                    "extendedSentenceRanges": [
+                        {"from": 0, "to": 17, "detectedLanguages": [{"language": "en", "rate": 1.0}]}
+                    ],
                     "matches": [
                         {
-                            "context": {"length": 1, "offset": 8, "text": "This is a example"},
+                            "context": {"text": "This is a example", "offset": 8, "length": 1},
                             "contextForSureMatch": 1,
                             "ignoreForIncompleteSentence": False,
                             "length": 1,
-                            "message": "Use \"an\" instead of 'a' if the following word "
-                            "starts with a vowel sound, e.g. 'an article', 'an "
-                            "hour'",
+                            "message": "Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g.\xa0‘an article’, ‘an hour’.",
                             "offset": 8,
                             "replacements": [{"value": "an"}],
                             "rule": {
                                 "category": {"id": "MISC", "name": "Miscellaneous"},
                                 "description": "Use of 'a' vs. 'an'",
                                 "id": "EN_A_VS_AN",
                                 "issueType": "misspelling",
+                                "urls": [
+                                    {
+                                        "value": "https://languagetool.org/insights/post/indefinite-articles/"
+                                    }
+                                ],
                             },
                             "sentence": "This is a example",
                             "shortMessage": "Wrong article",
@@ -157,14 +169,12 @@ def check(input_text, api_url, lang, mother_tongue=None, preferred_variants=None
                     ],
                     "software": {
                         "apiVersion": 1,
-                        "buildDate": "2019-05-15 19:25",
+                        "buildDate": "2024-09-27 11:27:57 +0200",
+                        "version": "6.5",  
                         "name": "LanguageTool",
                         "premium": False,
-                        "premiumHint": "You might be missing errors only the Premium "
-                        "version can find. Contact us at "
-                        "support<at>languagetoolplus.com.",
+                        "premiumHint": "You might be missing errors only the Premium version can find. Contact us at support<at>languagetoolplus.com.",
                         "status": "",
-                        "version": "4.6-SNAPSHOT",
                     },
                     "warnings": {"incompleteResults": False},
                 }
@@ -212,4 +222,5 @@ def check(input_text, api_url, lang, mother_tongue=None, preferred_variants=None
             match for match in matches
             if not _is_in_pwl(match, pwl)
         ]
+    print(print(data))
     return data

pylanguagetool/cli.py

@@ -5,18 +5,22 @@
 import sys
 from importlib.metadata import version
 from pprint import pprint
+from typing import Any, Optional
 
-import configargparse
 from colorama import Fore, init as init_colors
+from configargparse import ArgumentParser
 
 from pylanguagetool import converters, CustomConfigFileParser, api
 
 indention = " " * 4
 
 
-def init_config():
-    p = configargparse.ArgParser(default_config_files=["~/.config/pyLanguagetool.conf"],
-                                 config_file_parser_class=CustomConfigFileParser)
+def init_config() -> tuple[dict[str, Any], ArgumentParser]:
+    """
+    Create ArgumentParser object
+    """
+    p = ArgumentParser(default_config_files=["~/.config/pyLanguagetool.conf"],
+                       config_file_parser_class=CustomConfigFileParser)
     p.add_argument("-V", "--version", default=False, action='store_true', help="print version and exit")
     p.add_argument("-v", "--verbose", env_var="VERBOSE", default=False, action='store_true', help="verbose output")
     p.add_argument("-a", "--api-url", env_var="API_URL", default="https://languagetool.org/api/v2/",
@@ -83,7 +87,7 @@ def init_config():
     return c, p
 
 
-def get_clipboard():
+def get_clipboard() -> str:
     """
     Return text stored in the operating system's clipboard.
 
@@ -101,12 +105,12 @@ def get_clipboard():
     return clipboard
 
 
-def get_input_text(config):
+def get_input_text(config: dict[str, Any]) -> tuple[Optional[str], Optional[str]]:
     """
     Return text from stdin, clipboard or file.
 
     Returns:
-        Tuple[str, str]:
+        tuple[Optional[str], Optional[str]]:
             A tuple contain of the text and an optional file extension.
             If the text does not come from a file, the extension part of the
             tuple will be none.
@@ -128,7 +132,11 @@ def get_input_text(config):
         sys.exit(1)
 
 
-def print_errors(response, api_url, print_color=True, rules=False, rule_categories=False, explain_rule=False):
+def print_errors(response, api_url: str, print_color: bool = True, rules: bool = False,
+                 rule_categories: bool = False, explain_rule: bool = False) -> None:
+    """
+    Print output from API response
+    """
     matches = response["matches"]
     language = response["language"]
     version = response["software"]["name"] + " " + response["software"]["version"]
@@ -140,13 +148,14 @@ def colored(text, color):
         else:
             return text
 
+    lang_name = language["detectedLanguage"]["name"]
+    lang_confidence = language["detectedLanguage"]["confidence"] * 100
     print(colored(
-        "{} detected ({:.0f}% confidence)".format(language["detectedLanguage"]["name"],
-                                                  language["detectedLanguage"]["confidence"] * 100)
+        f"{lang_name} detected ({lang_confidence:.0f}% confidence)"
         , Fore.LIGHTBLACK_EX))
     if language["detectedLanguage"]["code"] != language["code"]:
         print(colored(
-            "checking as {} text because of setting".format(language["name"])
+            f"checking as {language['name']} text because of setting"
             , Fore.LIGHTBLACK_EX))
     print()
 
@@ -212,7 +221,10 @@ def colored(text, color):
     print(colored(f"Text checked by {api_url} ({version})", Fore.LIGHTBLACK_EX))
 
 
-def main():
+def main() -> None:
+    """
+    The main CLI entry point.
+    """
     config, argparser = init_config()
 
     if config["verbose"]:
@@ -221,6 +233,8 @@ def main():
     if config['pwl']:
         with open(config['pwl']) as fs:
             config['pwl'] = [w.strip() for w in fs.readlines()]
+    else:
+        config['pwl'] = []
 
     input_text, inputtype = get_input_text(config)
     if not input_text:
@@ -234,7 +248,7 @@ def main():
         print("But it doesn't have to:")
         print("You can simply use the output of detex")
         if config["input file"]:
-            print("    $ detex {} | pylanguagetool".format(config["input file"]))
+            print(f"    $ detex {config['input file']} | pylanguagetool")
         print("or use the languagetool integration in TeXstudio.")
         sys.exit(3)
     check_text = converters.convert(input_text, inputtype)

pylanguagetool/converters.py

@@ -9,7 +9,7 @@
 supported_extensions = ["txt", "html", "md", "markdown", "rst", "ipynb", "json", "xliff"]
 
 
-def convert(source, texttype):
+def convert(source: str, texttype: str) -> str:
     """
     Convert files of various types to plaintext
 
@@ -40,7 +40,7 @@ def convert(source, texttype):
     return source
 
 
-def html2text(html):
+def html2text(html: str) -> str:
     """
     convert HTML to plaintext by parsing it with BeautifulSoup and removing code
 
@@ -63,7 +63,7 @@ def html2text(html):
     return soup.get_text()
 
 
-def markdown2html(markdown):
+def markdown2html(markdown: str) -> str:
     """
     convert Markdown to HTML via ``markdown2``
 
@@ -83,7 +83,7 @@ def markdown2html(markdown):
     return markdown2.markdown(markdown)
 
 
-def ipynb2markdown(ipynb):
+def ipynb2markdown(ipynb: str) -> str:
     """
     Extract Markdown cells from iPython Notebook
 
@@ -102,7 +102,7 @@ def ipynb2markdown(ipynb):
     return markdown
 
 
-def rst2html(rst):
+def rst2html(rst: str) -> str:
     """
     convert reStructuredText to HTML with ``docutils``
 
@@ -121,7 +121,7 @@ def rst2html(rst):
     return publish_string(rst, writer_name="html5")
 
 
-def transifexjson2txt(jsondata):
+def transifexjson2txt(jsondata: str) -> str:
     """
     extract translations from Transifex JSON file
 
@@ -141,7 +141,7 @@ def transifexjson2txt(jsondata):
     return text
 
 
-def xliff2txt(source):
+def xliff2txt(source: str) -> str:
     """
     extract translations from ``XLIFF`` file
 
@@ -164,9 +164,9 @@ def xliff2txt(source):
     return text
 
 
-def notinstalled(package, convert_from, convert_to):
+def notinstalled(package: str, convert_from: str, convert_to: str) -> None:
     print(
-        """{package} is needed to convert {source} to {target}
+        f"""{package} is needed to convert {convert_from} to {convert_to}
 you can install it with pip:
-pip install {package}""".format(package=package, source=convert_from, target=convert_to)
+pip install {package}"""
     )