Add Python style check to CI/CD (#3)

.github/workflows/ci-cd.yaml

@@ -51,8 +51,24 @@ jobs:
         with:
           fail: true
 
+  code-style:
+    name: Python Code Style Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Install dependencies
+        run: pip3 install -r requirements.txt
+      - name: Check import orders
+        run: isort --check .
+      - name: pep8
+        run: pycodestyle .
+
   sync-to-huggingface-space:
-    needs: [yaml-lint, linkChecker]
+    needs: [yaml-lint, linkChecker, code-style]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

.isort.cfg

@@ -0,0 +1,2 @@
+[settings]
+force_single_line = True

README.md

@@ -83,12 +83,18 @@ The Wiktionary language data is available on 🤗 [Hugging Face Datasets][Huggin
 
 ```python
 from datasets import load_dataset
-dataset = load_dataset("QubitPi/wiktionary-data", split="German")
+dataset = load_dataset("QubitPi/wiktionary-data")
 ```
 
 There are __two__ data subsets:
 
-1. __Languages__ subset that contains the sub-data extraction of the following splits:
+1. __Languages__ subset that contains extraction of a subset of supported languages:
+
+   ```console
+   dataset = load_dataset("QubitPi/wiktionary-data", "Wiktionary")
+   ```
+   
+   The subset contains the following splits
 
    - `German`
    - `Latin`
@@ -101,7 +107,13 @@ There are __two__ data subsets:
 
 2. __Graph__ subset that is useful for constructing knowledge graphs:
 
-   - `AllLanguage`: all the languages in a giant graph
+   ```console
+   dataset = load_dataset("QubitPi/wiktionary-data", "Knowledge Graph")
+   ```
+   
+   The subset contains the following splits
+
+   - `AllLanguage`: all the languages listed above in a giant graph
 
    The _Graph_ data ontology is the following:
 

extract.py

@@ -14,12 +14,16 @@
 from wiktionary.wiktextract.extract import extract_data
 from wiktionary.wiktextract.extract import extract_graph
 
-
 if __name__ == "__main__":
     import argparse
 
     parser = argparse.ArgumentParser(description='Post-process Wiktextract data')
-    parser.add_argument('-i', '--input', help='Raw data file, i.e. the path to raw-wiktextract-data.jsonl', required=True)
+    parser.add_argument(
+        '-i',
+        '--input',
+        help='Raw data file, i.e. the path to raw-wiktextract-data.jsonl',
+        required=True
+    )
     args = vars(parser.parse_args())
 
     extract_data(args["input"])

requirements.txt

@@ -1 +1,4 @@
 wilhelm_python_sdk
+
+pycodestyle
+isort

setup.cfg

@@ -0,0 +1,3 @@
+[pep8]
+max-line-length = 120
+exclude = ./.eggs,./build

tests/wiktionary/wiktextract/test_parse.py

@@ -53,12 +53,12 @@ class TestParse(unittest.TestCase):
             }),
         )
 
-
     def test_get_audios(self):
         self.assertEqual(
             [{
                 "ogg_url": "https://upload.wikimedia.org/wikipedia/commons/a/a8/De-Volap%C3%BCk.ogg",
-                "mp3_url": "https://upload.wikimedia.org/wikipedia/commons/transcoded/a/a8/De-Volap%C3%BCk.ogg/De-Volap%C3%BCk.ogg.mp3"
+                "mp3_url": "https://upload.wikimedia.org/wikipedia/commons/transcoded/a/a8/De-Volap%C3%BCk.ogg/" +
+                           "De-Volap%C3%BCk.ogg.mp3"
             }],
             get_audios({
                 "sounds": [
@@ -71,8 +71,9 @@ class TestParse(unittest.TestCase):
                     {
                         "audio": "De-Volapük.ogg",
                         "ogg_url": "https://upload.wikimedia.org/wikipedia/commons/a/a8/De-Volap%C3%BCk.ogg",
-                        "mp3_url": "https://upload.wikimedia.org/wikipedia/commons/transcoded/a/a8/De-Volap%C3%BCk.ogg/De-Volap%C3%BCk.ogg.mp3"
+                        "mp3_url": "https://upload.wikimedia.org/wikipedia/commons/transcoded/a/a8/" +
+                                   "De-Volap%C3%BCk.ogg/De-Volap%C3%BCk.ogg.mp3"
                     }
                 ]
             })
-        )
+        )

wiktionary/wiktextract/extract.py

@@ -26,9 +26,11 @@ def extract_data(wiktextract_data_path: str):
     - pos: the Part of Speech of this word
     - definitions: an array of definitions, each element of the array is a string
 
-    :param wiktextract_data_path: the path of the wiktextract jsonl file. Can be downloaded from https://kaikki.org/dictionary/rawdata.html
+    :param wiktextract_data_path: the path of the wiktextract jsonl file. Can be downloaded from
+    https://kaikki.org/dictionary/rawdata.html
     """
     import json
+
     from wiktionary.wiktextract.parse import get_audios
     from wiktionary.wiktextract.parse import get_definitions
 
@@ -40,8 +42,7 @@ def extract_data(wiktextract_data_path: str):
           open("old-persian-wiktextract-data.jsonl", "w") as old_persian,
           open("akkadian-wiktextract-data.jsonl", "w") as akkadian,
           open("elamite-wiktextract-data.jsonl", "w") as elamite,
-          open("sanskrit-wiktextract-data.jsonl", "w") as sanskrit
-    ):
+          open("sanskrit-wiktextract-data.jsonl", "w") as sanskrit):
         for line in data:
             vocabulary = json.loads(line)
             if "lang" in vocabulary:
@@ -63,25 +64,39 @@ def extract_data(wiktextract_data_path: str):
                     )
                     german.write("\n")
                 if vocabulary["lang"] == "Latin":
-                    latin.write(json.dumps({"term": term, "part of speech": pos, "definitions": definitions, "audios": audios}))
+                    latin.write(json.dumps(
+                        {"term": term, "part of speech": pos, "definitions": definitions, "audios": audios}
+                    ))
                     latin.write("\n")
                 if vocabulary["lang"] == "Ancient Greek":
-                    ancient_greek.write(json.dumps({"term": term, "part of speech": pos, "definitions": definitions, "audios": audios}))
+                    ancient_greek.write(json.dumps(
+                        {"term": term, "part of speech": pos, "definitions": definitions, "audios": audios}
+                    ))
                     ancient_greek.write("\n")
                 if vocabulary["lang"] == "Korean":
-                    korean.write(json.dumps({"term": term, "part of speech": pos, "definitions": definitions, "audios": audios}))
+                    korean.write(json.dumps(
+                        {"term": term, "part of speech": pos, "definitions": definitions, "audios": audios}
+                    ))
                     korean.write("\n")
                 if vocabulary["lang"] == "Old Persian":
-                    old_persian.write(json.dumps({"term": term, "part of speech": pos, "definitions": definitions, "audios": audios}))
+                    old_persian.write(json.dumps(
+                        {"term": term, "part of speech": pos, "definitions": definitions, "audios": audios}
+                    ))
                     old_persian.write("\n")
                 if vocabulary["lang"] == "Akkadian":
-                    akkadian.write(json.dumps({"term": term, "part of speech": pos, "definitions": definitions, "audios": audios}))
+                    akkadian.write(json.dumps(
+                        {"term": term, "part of speech": pos, "definitions": definitions, "audios": audios}
+                    ))
                     akkadian.write("\n")
                 if vocabulary["lang"] == "Elamite":
-                    elamite.write(json.dumps({"term": term, "part of speech": pos, "definitions": definitions, "audios": audios}))
+                    elamite.write(json.dumps(
+                        {"term": term, "part of speech": pos, "definitions": definitions, "audios": audios}
+                    ))
                     elamite.write("\n")
                 if vocabulary["lang"] == "Sanskrit":
-                    sanskrit.write(json.dumps({"term": term, "part of speech": pos, "definitions": definitions, "audios": audios}))
+                    sanskrit.write(json.dumps(
+                        {"term": term, "part of speech": pos, "definitions": definitions, "audios": audios}
+                    ))
                     sanskrit.write("\n")
 
 
@@ -90,6 +105,7 @@ LANGUAGES = ["German", "Latin", "Ancient Greek", "Korean", "Old Persian", "Akkad
 
 def extract_graph(wiktextract_data_path: str):
     import json
+
     from wiktionary.wiktextract.parse import get_definitions
 
     with (open(wiktextract_data_path) as data, open("word-definition-graph-data.jsonl", "w") as graph):

wiktionary/wiktextract/german.py

@@ -16,6 +16,7 @@ from wiktionary.wiktextract.parse import get_part_of_speech
 
 GERMAN_CASES = ["nominative", "genitive", "dative", "accusative"]
 
+
 def get_gender_modifier(vocabulary) -> str:
     if get_part_of_speech(vocabulary) == "noun" and "categories" in vocabulary:
         if "German masculine nouns" in vocabulary["categories"]:
@@ -103,7 +104,6 @@ def get_german_adj_declensions(vocabulary) -> dict:
     return conjugations
 
 
-
 def get_german_noun_declensions(vocabulary):
     if "forms" not in vocabulary:
         return {}

wiktionary/wiktextract/parse.py

@@ -15,8 +15,10 @@
 def get_part_of_speech(vocabulary) -> str:
     return vocabulary["pos"] if "pos" in vocabulary else "Unknown"
 
+
 def get_definitions(vocabulary) -> list:
-    return [sense["glosses"][0] if "glosses" in sense else sense["raw_glosses"][0] for sense in vocabulary["senses"] if "glosses" in sense or "raw_glosses" in sense]
+    return [sense["glosses"][0] if "glosses" in sense else sense["raw_glosses"][0] for sense in vocabulary["senses"] if
+            "glosses" in sense or "raw_glosses" in sense]
 
 
 def get_audios(vocabulary) -> list: