Migrate wilhelm-graphdb Wiktionary data sub-module into wiktionary-data

.github/workflows/ci-cd.yaml

@@ -0,0 +1,90 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+---
+name: CI/CD
+
+"on":
+  pull_request:
+  push:
+    branches:
+      - master
+
+env:
+  PYTHON_VERSION: "3.10"
+
+jobs:
+  cancel-previous:
+    name: Cancel Previous Runs In Order to Allocate Action Resources Immediately for Current Run
+    if: github.ref != 'refs/heads/master'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Cancel previous
+        uses: styfle/[email protected]
+        with:
+          access_token: ${{ github.token }}
+
+#  yaml-lint:
+#    name: YAML Style Check
+#    runs-on: ubuntu-latest
+#    steps:
+#      - uses: actions/checkout@v3
+#      - uses: actionshub/yamllint@main
+#
+#  linkChecker:
+#    name: Link Check
+#    runs-on: ubuntu-latest
+#    steps:
+#      - uses: actions/checkout@v3
+#      - name: Link Checker
+#        uses: lycheeverse/[email protected]
+#        with:
+#          fail: true
+
+  sync-to-huggingface-space:
+    #needs: [yaml-lint, linkChecker]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          lfs: true
+      - name: Set up Python ${{ env.PYTHON_VERSION }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Download raw wiktionary data
+        run: wget https://kaikki.org/dictionary/raw-wiktextract-data.jsonl
+      - name: Install dependencies
+        run: pip3 install -r requirements.txt
+      - name: Process raw-wiktextract-data.jsonl
+        run: |
+          python3 ./extract.py -i raw-wiktextract-data.jsonl
+          rm raw-wiktextract-data.jsonl
+      - name: Push to hub
+        if: github.ref == 'refs/heads/master'
+        run: |
+          git config --global user.name "QubitPi"
+          git config --global user.email "[email protected]"
+
+          git lfs install
+          git lfs track "*-wiktextract-data.jsonl"
+          git lfs track "word-definition-graph-data.jsonl"
+
+          git add *-wiktextract-data.jsonl
+          git add word-definition-graph-data.jsonl
+
+          git commit -m "Extract raw-wiktextract-data.jsonl into per-language wiktextract-data.jsonl and generate graph data"
+          git push https://QubitPi:[email protected]/datasets/QubitPi/wiktionary-data master:main -f
+        env:
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}

.gitignore

@@ -0,0 +1,8 @@
+.idea/
+.DS_Store
+.venv
+raw-wiktextract-data.jsonl
+load.log
+data/
+__pycache__
+

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Jiaqi Liu
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,100 @@
+---
+license: apache-2.0
+pretty_name: English Wiktionary Data in JSONL
+language:
+  - en
+  - de
+  - grc
+  - la
+configs:
+  - config_name: Languages
+    data_files:
+    - split: German
+      path: german-wiktextract-data.jsonl
+    - split: Latin
+      path: latin-wiktextract-data.jsonl
+    - split: AncientGreek
+      path: ancient-greek-wiktextract-data.jsonl
+    - split: GraphData
+      path: word-definition-graph-data.jsonl
+tags:
+  - Wiktionary
+  - German
+  - Ancient Greek
+  - Latin
+  - Vocabulary
+size_categories:
+  - 1M<n<10M
+---
+
+Wiktionary Data on Hugging Face Datasets
+========================================
+
+![Python Version Badge]
+[![GitHub workflow status badge][GitHub workflow status badge]][GitHub workflow status URL]
+[![Hugging Face sync status badge]][Hugging Face sync status URL]
+[![Hugging Face dataset badge]][Hugging Face dataset URL]
+[![Apache License Badge]][Apache License, Version 2.0]
+
+[wiktionary-data]() is a sub-data extraction of the [English Wiktionary](https://en.wiktionary.org) that currently
+supports the following languages:
+
+- German
+- Latin
+- Ancient Greek
+- Old Persian
+
+[wiktionary-data]() was originally a sub-module of [wilhelm-graphdb](https://github.com/QubitPi/wilhelm-graphdb). While
+the dataset it's getting bigger, I noticed a wave of more exciting potentials this dataset can bring about that
+stretches beyond the scope of the containing project. Therefore I decided to promote it to a dedicated module; and here
+comes this repo.
+
+The Wiktionary language data is available on 🤗 [Hugging Face Datasets][Hugging Face dataset URL].
+
+```python
+from datasets import load_dataset
+dataset = load_dataset("QubitPi/wiktionary-data", split="German")
+```
+
+The available splits are
+
+- `German`
+- `Latin`
+- `AncientGreek`
+- `OldPersian`
+
+In addition, a separate split for graph data is offered:
+
+- `GraphData`
+
+This split contains all the languages and puts everything in a giant graph
+
+Development
+-----------
+
+Although [the original Wiktionary dump](https://dumps.wikimedia.org/) is available, parsing it from scratch involves
+rather complicated process. We would probably do it in the future. At present, however, we would simply take the awesome
+works by [tatuylonen](https://github.com/tatuylonen/wiktextract) which has already processed it and presented it in
+[in JSON format](https://kaikki.org/dictionary/rawdata.html). wiktionary-data takes the
+__raw Wiktextract data (JSONL, one object per line)__ option.
+
+License
+-------
+
+The use and distribution terms for [wiktionary-data]() are covered by the [Apache License, Version 2.0].
+
+[Apache License Badge]: https://img.shields.io/badge/Apache%202.0-F25910.svg?style=for-the-badge&logo=Apache&logoColor=white
+[Apache License, Version 2.0]: https://www.apache.org/licenses/LICENSE-2.0
+
+[Docker login command]: https://docker.qubitpi.org//reference/cli/docker/login/#options
+
+[GitHub workflow status badge]: https://img.shields.io/github/actions/workflow/status/QubitPi/wiktionary-data/ci-cd.yaml?branch=master&style=for-the-badge&logo=github&logoColor=white&label=CI/CD
+[GitHub workflow status URL]: https://github.com/QubitPi/wiktionary-data/actions/workflows/ci-cd.yaml
+
+[Hugging Face dataset badge]: https://img.shields.io/badge/Hugging%20Face%20Dataset-wilhelm--graphdb-FFD21E?style=for-the-badge&logo=huggingface&logoColor=white
+[Hugging Face dataset URL]: https://huggingface.co/datasets/QubitPi/wiktionary-data
+
+[Hugging Face sync status badge]: https://img.shields.io/github/actions/workflow/status/QubitPi/wiktionary-data/ci-cd.yaml?branch=master&style=for-the-badge&logo=github&logoColor=white&label=Hugging%20Face%20Sync%20Up
+[Hugging Face sync status URL]: https://github.com/QubitPi/wiktionary-data/actions/workflows/ci-cd.yaml
+
+[Python Version Badge]: https://img.shields.io/badge/Python-3.10-FFD845?labelColor=498ABC&style=for-the-badge&logo=python&logoColor=white

extract.py

@@ -0,0 +1,26 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+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)
+    args = vars(parser.parse_args())
+
+    extract_data(args["input"])
+    extract_graph(args["input"])

requirements.txt

@@ -0,0 +1 @@
+wilhelm_python_sdk

tests/wiktionary/wiktextract/test_german.py

@@ -0,0 +1,26 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import unittest
+
+from wiktionary.wiktextract.parse import get_definitions
+
+
+class TestGermanParse(unittest.TestCase):
+
+    def test_get_definitions(self):
+        self.assertEqual(
+            [],
+            get_definitions({"senses": []}),
+        )

tests/wiktionary/wiktextract/test_parse.py

@@ -0,0 +1,78 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import unittest
+
+from wiktionary.wiktextract.parse import get_audios
+from wiktionary.wiktextract.parse import get_definitions
+
+
+class TestParse(unittest.TestCase):
+
+    def test_get_definitions(self):
+        self.assertEqual(
+            [],
+            get_definitions({"senses": []}),
+        )
+
+    def test_get_definitions_empty(self):
+        self.assertEqual(
+            ["Volapük"],
+            get_definitions({
+                "senses": [
+                    {
+                        "glosses": [
+                            "Volapük"
+                        ]
+                    }
+                ]
+            }),
+        )
+
+        self.assertEqual(
+            ["Volapük"],
+            get_definitions({
+                "senses": [
+                    {
+                        "raw_glosses": [
+                            "Volapük"
+                        ]
+                    }
+                ]
+            }),
+        )
+
+
+    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"
+            }],
+            get_audios({
+                "sounds": [
+                    {
+                        "ipa": "/ˌvoːlaˈpyːk/"
+                    },
+                    {
+                        "ipa": "/ˌvɔla-/"
+                    },
+                    {
+                        "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"
+                    }
+                ]
+            })
+        )

wiktionary/wiktextract/extract.py

@@ -0,0 +1,90 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from wiktionary.wiktextract.german import get_gender_modifier
+from wiktionary.wiktextract.german import get_german_inflection
+
+
+def extract_data(wiktextract_data_path: str):
+    """
+    Extract data from raw-wiktextract-data.jsonl useful for wilhelmlang.com.
+
+    There will be 3 languages extracted, each of which in a dedicated .jsonl file:
+
+    1. German
+    2. Latin
+    3. Ancient Greek
+
+    Each line of the JSONL file has the following fields:
+
+    - term: the word of the language
+    - 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
+    """
+    import json
+    from wiktionary.wiktextract.parse import get_audios
+    from wiktionary.wiktextract.parse import get_definitions
+
+    with (open(wiktextract_data_path) as data,
+          open("german-wiktextract-data.jsonl", "w") as german,
+          open("latin-wiktextract-data.jsonl", "w") as latin,
+          open("ancient-greek-wiktextract-data.jsonl", "w") as ancient_greek
+    ):
+        for line in data:
+            vocabulary = json.loads(line)
+            if "lang" in vocabulary:
+                term = vocabulary["word"]
+                pos = vocabulary["pos"] if "pos" in vocabulary else "Unknown"
+                definitions = get_definitions(vocabulary)
+                audios = get_audios(vocabulary)
+
+                if vocabulary["lang"] == "German":
+                    term = get_gender_modifier(vocabulary) + term
+                    german.write(
+                        json.dumps({
+                            "term": term,
+                            "part of speech": pos,
+                            "definitions": definitions,
+                            "audios": audios,
+                            "inflection": get_german_inflection(vocabulary)
+                        })
+                    )
+                    german.write("\n")
+                if vocabulary["lang"] == "Latin":
+                    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("\n")
+
+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):
+        for line in data:
+            vocabulary = json.loads(line)
+            if "lang" in vocabulary:
+                term = vocabulary["word"]
+                if vocabulary["lang"] == "German":
+                    term = get_gender_modifier(vocabulary) + term
+
+                source_node = {"term": term, "language": vocabulary["lang"]}
+
+                definitions = get_definitions(vocabulary)
+                for definition in definitions:
+                    graph.write(json.dumps({"source": source_node, "target": definition, "label": "definition"}))
+                    graph.write("\n")

wiktionary/wiktextract/german.py

@@ -0,0 +1,127 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+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"]:
+            return "der "
+        if "German feminine nouns" in vocabulary["categories"]:
+            return "die "
+        if "German neuter nouns" in vocabulary["categories"]:
+            return "das "
+    return ""
+
+
+def get_german_inflection(vocabulary) -> dict:
+    inflections = {"declension": None, "conjugation": None}
+    if get_part_of_speech(vocabulary) == "noun":
+        inflections["declension"] = get_german_noun_declensions(vocabulary)
+    if get_part_of_speech(vocabulary) == "adj":
+        inflections["declension"] = get_german_adj_declensions(vocabulary)
+    return inflections
+
+
+def get_german_adj_declensions(vocabulary) -> dict:
+    """
+    There will be 3 x 3 list of maps for an adj. declensions with the first 3 corresponding to
+    `adj. degree <https://en.wikipedia.org/wiki/Adjective#Comparison_(degrees)>`_:
+
+    1. 3 for regular (positive) form
+    2. 3 for comparative form
+    3. 3 for mixed form
+
+    and the second 3 corresponding to the declension type of
+
+    1. strong declension
+    2. weak declension
+    3. mixed declension
+
+    Each list contains 4 maps. Each of the 4 maps is two-key indexed with the 1st index being the number & gender:
+
+    - "masculine"
+    - "feminine"
+    - "neuter"
+    - "plural
+
+    and the 2nd index being the case:
+
+    - "nominative"
+    - "genitive"
+    - "dative"
+    - "accusative"
+
+    An example data source can be found at https://en.wiktionary.org/wiki/mobil#Declension_2
+
+    :param vocabulary: a wiktextract JSONL line corresponding to an adjective (pos = "adj")
+
+    :return: a map with 3 entries, each for corresponds to a adj. degree with 3 corresponding sub-maps, totaling the 9
+    maps mentioned above. If the `vocabulary` does not have a `forms` field, where all declension info reside, this
+    function returns an empty map
+    """
+    if "forms" not in vocabulary:
+        return {}
+
+    forms = [form for form in vocabulary["forms"] if "source" in form and form["source"] == "declension"]
+
+    numbergenders = ["masculine", "feminine", "neuter", "plural"]
+
+    conjugations = {
+        "positive": {"strong": [], "weak": [], "mixed": []},
+        "comparative": {"strong": [], "weak": [], "mixed": []},
+        "superlative": {"strong": [], "weak": [], "mixed": []},
+    }
+
+    for degree in conjugations.keys():
+        for declension_type in ["strong", "weak", "mixed"]:
+            for numbergender in numbergenders:
+                dec_by_case = {}
+                for case in GERMAN_CASES:
+                    for declension in forms:
+                        tags = declension["tags"]
+                        if (degree in tags or degree == "positive") and declension_type in tags:
+                            if numbergender in tags and case in tags:
+                                if declension["form"]:
+                                    dec_by_case[case] = declension["form"]
+                if len(dec_by_case) > 0:
+                    conjugations[degree][declension_type].append(dec_by_case)
+
+    return conjugations
+
+
+
+def get_german_noun_declensions(vocabulary):
+    if "forms" not in vocabulary:
+        return {}
+
+    forms = [form for form in vocabulary["forms"] if "source" in form and form["source"] == "declension"]
+
+    numbers = ["singular", "plural"]
+
+    declensions = {}
+    for number in numbers:
+        dec_by_case = {}
+        for case in GERMAN_CASES:
+            for declension in forms:
+                tags = declension["tags"]
+                if number in tags and case in tags:
+                    if declension["form"]:
+                        dec_by_case[case] = declension["form"]
+        if len(dec_by_case) > 0:
+            declensions[number] = dec_by_case
+
+    return declensions

wiktionary/wiktextract/parse.py

@@ -0,0 +1,33 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+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]
+
+
+def get_audios(vocabulary) -> list:
+    audios = []
+    if "sounds" in vocabulary:
+        for sound in vocabulary["sounds"]:
+            audio = {}
+            if "ogg_url" in sound and sound["ogg_url"] is not None:
+                audio["ogg_url"] = sound["ogg_url"]
+            if "mp3_url" in sound and sound["mp3_url"] is not None:
+                audio["mp3_url"] = sound["mp3_url"]
+            if len(audio) > 0:
+                audios.append(audio)
+    return audios