Refactor with context managers for reading files (#9)

- Refactor dict literals, docstring and download splits (a2a086c3cc01c82a8e42d23442ca06eec344d0f0)
- Use context managers for reading files (8a5bfcbec0586eaf4c23950c6e06becf2d539e02)
- Refactor (52edc1241ee7657ed7521c13ab1d4d1c138e9669)
- Refactor yield per config (8c13accca8a7f73dc3129d093f1a245ef86ce23f)

alt.py

@@ -45,31 +45,27 @@ _WIKI_URL = "https://www2.nict.go.jp/astrec-att/member/mutiyama/ALT/ALT-Parallel
 
 
 class AltParallelConfig(datasets.BuilderConfig):
-    """BuilderConfig for ALT."""
+    """BuilderConfig for ALT Parallel."""
 
     def __init__(self, languages, **kwargs):
-        """BuilderConfig for ALT.
+        """BuilderConfig for ALT Parallel.
 
         Args:
-            for the `datasets.features.text.TextEncoder` used for the features feature.
-
-            languages: languages that will be used for translation. it should be one of the
+            languages: languages that will be used for translation.
             **kwargs: keyword arguments forwarded to super.
         """
 
         name = "alt-parallel"
 
         description = "ALT Parallel Corpus"
-        super(AltParallelConfig, self).__init__(
+        super().__init__(
             name=name,
             description=description,
             version=datasets.Version("1.0.0", ""),
             **kwargs,
         )
 
-        available_langs = set(
-            ["bg", "en", "en_tok", "fil", "hi", "id", "ja", "khm", "lo", "ms", "my", "th", "vi", "zh"]
-        )
+        available_langs = {"bg", "en", "en_tok", "fil", "hi", "id", "ja", "khm", "lo", "ms", "my", "th", "vi", "zh"}
         for language in languages:
             assert language in available_langs
 
@@ -184,7 +180,7 @@ class Alt(datasets.GeneratorBasedBuilder):
         else:
             data_path = dl_manager.download_and_extract(_URLs[self.config.name])
 
-        if self.config.name == "alt-my-transliteration" or self.config.name == "alt-my-west-transliteration":
+        if self.config.name in {"alt-my-transliteration", "alt-my-west-transliteration"}:
             return [
                 datasets.SplitGenerator(
                     name=datasets.Split.TRAIN,
@@ -192,9 +188,7 @@ class Alt(datasets.GeneratorBasedBuilder):
                 )
             ]
         else:
-            data_split = {}
-            for k in _SPLIT:
-                data_split[k] = dl_manager.download_and_extract(_SPLIT[k])
+            data_split = dl_manager.download(_SPLIT)
 
             return [
                 datasets.SplitGenerator(
@@ -220,95 +214,86 @@ class Alt(datasets.GeneratorBasedBuilder):
                     urlid = sp[0].replace("URL.", "")
                     allow_urls[urlid] = {"SNT.URLID": urlid, "url": sp[1]}
 
-        data = {}
         if self.config.name.startswith("alt-parallel"):
-            files = self.config.languages
-
             data = {}
-            for lang in files:
+            for lang in self.config.languages:
                 file_path = os.path.join(basepath, "ALT-Parallel-Corpus-20191206", f"data_{lang}.txt")
-                fin = open(file_path, encoding="utf-8")
-                for line in fin:
-                    line = line.strip()
-                    sp = line.split("\t")
-
-                    _, urlid, sntid = sp[0].split(".")
-                    sntid = sntid.strip()  # Some lines have a trailing blank space: "SNT.102053.5598 " in data_fil.txt
-                    if urlid not in allow_urls:
-                        continue
-
-                    if sntid not in data:
-                        data[sntid] = {}
-                        data[sntid]["SNT.URLID"] = urlid
-                        data[sntid]["SNT.URLID.SNTID"] = sntid
-                        data[sntid]["url"] = allow_urls[urlid]["url"]
-                        data[sntid]["translation"] = {}
-
-                    # Note that Japanese and Myanmar texts have empty sentence fields in this release.
-                    if len(sp) >= 2:
-                        data[sntid]["translation"][lang] = sp[1]
-
-                fin.close()
+                with open(file_path, encoding="utf-8") as fin:
+                    for line in fin:
+                        line = line.strip()
+                        sp = line.split("\t")
+
+                        _, urlid, sntid = sp[0].split(".")
+                        # Some lines have a trailing blank space: "SNT.102053.5598 " in data_fil.txt
+                        sntid = sntid.strip()
+                        if urlid not in allow_urls:
+                            continue
+
+                        if sntid not in data:
+                            data[sntid] = {
+                                "SNT.URLID": urlid,
+                                "SNT.URLID.SNTID": sntid,
+                                "url": allow_urls[urlid]["url"],
+                                "translation": {},
+                            }
+
+                        # Note that Japanese and Myanmar texts have empty sentence fields in this release.
+                        if len(sp) >= 2:
+                            data[sntid]["translation"][lang] = sp[1]
+
+            for _id, item in enumerate(data.values()):
+                yield _id, item
 
         elif self.config.name == "alt-en":
             data = {}
             for fname in ["English-ALT-Draft.txt", "English-ALT-Reviewed.txt"]:
                 file_path = os.path.join(basepath, "English-ALT-20210218", fname)
-                fin = open(file_path, encoding="utf-8")
-                for line in fin:
-                    line = line.strip()
-                    sp = line.split("\t")
+                with open(file_path, encoding="utf-8") as fin:
+                    for line in fin:
+                        line = line.strip()
+                        sp = line.split("\t")
 
-                    _, urlid, sntid = sp[0].split(".")
-                    if urlid not in allow_urls:
-                        continue
+                        _, urlid, sntid = sp[0].split(".")
+                        if urlid not in allow_urls:
+                            continue
 
-                    d = {
-                        "SNT.URLID": urlid,
-                        "SNT.URLID.SNTID": sntid,
-                        "url": allow_urls[urlid]["url"],
-                        "status": None,
-                        "value": None,
-                    }
+                        d = {
+                            "SNT.URLID": urlid,
+                            "SNT.URLID.SNTID": sntid,
+                            "url": allow_urls[urlid]["url"],
+                            "status": "draft" if fname == "English-ALT-Draft.txt" else "reviewed",
+                            "value": sp[1],
+                        }
+
+                        data[sntid] = d
 
-                    d["value"] = sp[1]
-                    if fname == "English-ALT-Draft.txt":
-                        d["status"] = "draft"
-                    else:
-                        d["status"] = "reviewed"
+            for _id, item in enumerate(data.values()):
+                yield _id, item
 
-                    data[sntid] = d
-                fin.close()
         elif self.config.name == "alt-jp":
             data = {}
             for fname in ["Japanese-ALT-Draft.txt", "Japanese-ALT-Reviewed.txt"]:
                 file_path = os.path.join(basepath, "Japanese-ALT-20210218", fname)
-                fin = open(file_path, encoding="utf-8")
-                for line in fin:
-                    line = line.strip()
-                    sp = line.split("\t")
-                    _, urlid, sntid = sp[0].split(".")
-                    if urlid not in allow_urls:
-                        continue
-
-                    d = {
-                        "SNT.URLID": urlid,
-                        "SNT.URLID.SNTID": sntid,
-                        "url": allow_urls[urlid]["url"],
-                        "value": None,
-                        "status": None,
-                        "word_alignment": None,
-                        "en_tokenized": None,
-                        "jp_tokenized": None,
-                    }
+                with open(file_path, encoding="utf-8") as fin:
+                    for line in fin:
+                        line = line.strip()
+                        sp = line.split("\t")
+                        _, urlid, sntid = sp[0].split(".")
+                        if urlid not in allow_urls:
+                            continue
+
+                        d = {
+                            "SNT.URLID": urlid,
+                            "SNT.URLID.SNTID": sntid,
+                            "url": allow_urls[urlid]["url"],
+                            "value": sp[1],
+                            "status": "draft" if fname == "Japanese-ALT-Draft.txt" else "reviewed",
+                            "word_alignment": None,
+                            "en_tokenized": None,
+                            "jp_tokenized": None,
+                        }
 
-                    d["value"] = sp[1]
-                    if fname == "Japanese-ALT-Draft.txt":
-                        d["status"] = "draft"
-                    else:
-                        d["status"] = "reviewed"
-                    data[sntid] = d
-                fin.close()
+                        data[sntid] = d
 
             keys = {
                 "word_alignment": "word-alignment/data_ja.en-ja",
@@ -317,108 +302,105 @@ class Alt(datasets.GeneratorBasedBuilder):
             }
             for k in keys:
                 file_path = os.path.join(basepath, "Japanese-ALT-20210218", keys[k])
-                fin = open(file_path, encoding="utf-8")
-                for line in fin:
-                    line = line.strip()
-                    sp = line.split("\t")
+                with open(file_path, encoding="utf-8") as fin:
+                    for line in fin:
+                        line = line.strip()
+                        sp = line.split("\t")
 
-                    # Note that Japanese and Myanmar texts have empty sentence fields in this release.
-                    if len(sp) < 2:
-                        continue
+                        # Note that Japanese and Myanmar texts have empty sentence fields in this release.
+                        if len(sp) < 2:
+                            continue
 
-                    _, urlid, sntid = sp[0].split(".")
-                    if urlid not in allow_urls:
-                        continue
+                        _, urlid, sntid = sp[0].split(".")
+                        if urlid not in allow_urls:
+                            continue
 
-                    if sntid in data:
+                        if sntid in data:
+                            data[sntid][k] = sp[1]
 
-                        data[sntid][k] = sp[1]
-                fin.close()
+            for _id, item in enumerate(data.values()):
+                yield _id, item
 
         elif self.config.name == "alt-my":
-            data = {}
+            _id = 0
             for fname in ["data"]:
                 file_path = os.path.join(basepath, "my-alt-190530", fname)
-                fin = open(file_path, encoding="utf-8")
-                for line in fin:
-                    line = line.strip()
-                    sp = line.split("\t")
-                    _, urlid, sntid = sp[0].split(".")
-                    if urlid not in allow_urls:
-                        continue
-
-                    data[sntid] = {
-                        "SNT.URLID": urlid,
-                        "SNT.URLID.SNTID": sntid,
-                        "url": allow_urls[urlid]["url"],
-                        "value": sp[1],
-                    }
-                fin.close()
+                with open(file_path, encoding="utf-8") as fin:
+                    for line in fin:
+                        line = line.strip()
+                        sp = line.split("\t")
+                        _, urlid, sntid = sp[0].split(".")
+                        if urlid not in allow_urls:
+                            continue
+
+                        yield _id, {
+                            "SNT.URLID": urlid,
+                            "SNT.URLID.SNTID": sntid,
+                            "url": allow_urls[urlid]["url"],
+                            "value": sp[1],
+                        }
+                        _id += 1
 
         elif self.config.name == "alt-km":
             data = {}
             for fname in ["data_km.km-tag.nova", "data_km.km-tok.nova"]:
                 file_path = os.path.join(basepath, "km-nova-181101", fname)
-                fin = open(file_path, encoding="utf-8")
-                for line in fin:
-                    line = line.strip()
-                    sp = line.split("\t")
-                    _, urlid, sntid = sp[0].split(".")
-                    if urlid not in allow_urls:
-                        continue
-
-                    k = "km_pos_tag" if fname == "data_km.km-tag.nova" else "km_tokenized"
-                    if sntid in data:
+                with open(file_path, encoding="utf-8") as fin:
+                    for line in fin:
+                        line = line.strip()
+                        sp = line.split("\t")
+                        _, urlid, sntid = sp[0].split(".")
+                        if urlid not in allow_urls:
+                            continue
+
+                        k = "km_pos_tag" if fname == "data_km.km-tag.nova" else "km_tokenized"
+                        if sntid not in data:
+                            data[sntid] = {
+                                "SNT.URLID": urlid,
+                                "SNT.URLID.SNTID": sntid,
+                                "url": allow_urls[urlid]["url"],
+                                "km_pos_tag": None,
+                                "km_tokenized": None,
+                            }
                         data[sntid][k] = sp[1]
-                    else:
-                        data[sntid] = {
-                            "SNT.URLID": urlid,
-                            "SNT.URLID.SNTID": sntid,
-                            "url": allow_urls[urlid]["url"],
-                            "km_pos_tag": None,
-                            "km_tokenized": None,
-                        }
-                        data[sntid][k] = sp[1]
-                fin.close()
+
+            for _id, item in enumerate(data.values()):
+                yield _id, item
 
         elif self.config.name == "alt-my-transliteration":
             file_path = os.path.join(basepath, "my-en-transliteration", "data.txt")
             # Need to set errors='ignore' because of the unknown error
             # UnicodeDecodeError: 'utf-8' codec can't decode byte 0xff in position 0: invalid start byte
             # It might due to some issues related to Myanmar alphabets
-            fin = open(file_path, encoding="utf-8", errors="ignore")
-            _id = 0
-            for line in fin:
-                line = line.strip()
+            with open(file_path, encoding="utf-8", errors="ignore") as fin:
+                for _id, line in enumerate(fin):
+                    line = line.strip()
 
-                # I don't know why there are \x00 between |||. They don't show in the editor.
-                line = line.replace("\x00", "")
-                sp = line.split("|||")
+                    # I don't know why there are \x00 between |||. They don't show in the editor.
+                    line = line.replace("\x00", "")
+                    sp = line.split("|||")
 
-                # When I read data, it seems to have empty sentence betweem the actual sentence. Don't know why?
-                if len(sp) < 2:
-                    continue
+                    # When I read data, it seems to have empty sentence betweem the actual sentence. Don't know why?
+                    if len(sp) < 2:
+                        continue
+
+                    yield _id, {
+                        "en": sp[0].strip(),
+                        "my": [sp[1].strip()],
+                    }
 
-                data[_id] = {"en": sp[0].strip(), "my": [sp[1].strip()]}
-                _id += 1
-            fin.close()
         elif self.config.name == "alt-my-west-transliteration":
             file_path = os.path.join(basepath, "western-myanmar-transliteration", "321.txt")
             # Need to set errors='ignore' because of the unknown error
             # UnicodeDecodeError: 'utf-8' codec can't decode byte 0xff in position 0: invalid start byte
             # It might due to some issues related to Myanmar alphabets
-            fin = open(file_path, encoding="utf-8", errors="ignore")
-            _id = 0
-            for line in fin:
-                line = line.strip()
-                line = line.replace("\x00", "")
-                sp = line.split("|||")
-
-                data[_id] = {"en": sp[0].strip(), "my": [k.strip() for k in sp[1].split("|")]}
-                _id += 1
-            fin.close()
-
-        _id = 1
-        for k in data:
-            yield _id, data[k]
-            _id += 1
+            with open(file_path, encoding="utf-8", errors="ignore") as fin:
+                for _id, line in enumerate(fin):
+                    line = line.strip()
+                    line = line.replace("\x00", "")
+                    sp = line.split("|||")
+
+                    yield _id, {
+                        "en": sp[0].strip(),
+                        "my": [k.strip() for k in sp[1].split("|")],
+                    }