linting

Author: johnml1135

.github/workflows/ci.yml

@@ -55,7 +55,7 @@ jobs:
           node-version: "14"
       - name: Lint with pyright
         run: |
-          npm install -g [email protected].386
+          npm install -g [email protected].399
           poetry run pyright
       - name: Test with pytest
         run: poetry run pytest --cov --cov-report=xml

README.md

@@ -10,14 +10,6 @@ Machine is available as a pip package:
 pip install sil-machine
 ```
 
-## setup
-
-You can use the devcontainer (normal process), or you can setup outside of one, especially if you don't have a GPU.
-
-* Install poetry
-* `poetry install` for everything
-* `poetry install --without gpu` if you don't have a NVIDA gpu
-
 ## Tutorials
 
 If you would like to find out more about how to use Machine, check out the tutorial Jupyter notebooks:

machine/corpora/paratext_project_terms_parser_base.py

@@ -45,7 +45,7 @@ def parse(self, term_categories: Sequence[str], use_term_glosses: bool = True) -
         else:
             term_id_to_category_dict = {}
 
-        terms_glosses_doc: Optional[ElementTree.ElementTree] = None
+        terms_glosses_doc: Optional[ElementTree.ElementTree[ElementTree.Element]] = None
         resource_name = None
         if self._settings.language_code is not None:
             resource_name = _SUPPORTED_LANGUAGE_TERMS_LOCALIZATION_XMLS.get(self._settings.language_code)
@@ -57,7 +57,7 @@ def parse(self, term_categories: Sequence[str], use_term_glosses: bool = True) -
             with open_binary(_SUPPORTED_LANGUAGE_TERMS_LOCALIZATION_XMLS_PACKAGE, resource_name) as stream:
                 terms_glosses_doc = ElementTree.parse(stream)
 
-        term_renderings_doc: Optional[ElementTree.ElementTree] = None
+        term_renderings_doc: Optional[ElementTree.ElementTree[ElementTree.Element]] = None
         if self._exists("TermRenderings.xml"):
             with self._open("TermRenderings.xml") as stream:
                 term_renderings_doc = ElementTree.parse(stream)
@@ -136,7 +136,7 @@ def _strip_parens(term_string: str, left: str = "(", right: str = ")") -> str:
     return term_string
 
 
-def _get_category_per_id(biblical_terms_doc: ElementTree.ElementTree) -> Dict[str, str]:
+def _get_category_per_id(biblical_terms_doc: ElementTree.ElementTree[ElementTree.Element]) -> Dict[str, str]:
     term_id_to_category_dict: Dict[str, str] = {}
 
     for term in biblical_terms_doc.findall(".//Term"):

machine/corpora/paratext_project_text_updater_base.py

@@ -1,12 +1,11 @@
 from abc import ABC, abstractmethod
 from typing import BinaryIO, Optional, Sequence, Tuple, Union
 
-from .scripture_update_block_handler import ScriptureUpdateBlockHandler
-
 from ..utils.typeshed import StrPath
 from .paratext_project_settings import ParatextProjectSettings
 from .paratext_project_settings_parser_base import ParatextProjectSettingsParserBase
 from .scripture_ref import ScriptureRef
+from .scripture_update_block_handler import ScriptureUpdateBlockHandler
 from .update_usfm_parser_handler import UpdateUsfmMarkerBehavior, UpdateUsfmParserHandler, UpdateUsfmTextBehavior
 from .usfm_parser import parse_usfm
 

machine/corpora/scripture_update_block_handler.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
+
 from abc import ABC
 
 from .scripture_update_block import ScriptureUpdateBlock

machine/corpora/zip_paratext_project_terms_parser.py

@@ -19,5 +19,5 @@ def _exists(self, file_name: StrPath) -> bool:
 
     def _open(self, file_name: StrPath) -> Optional[BinaryIO]:
         if file_name in self._archive.namelist():
-            return BytesIO(self._archive.read(file_name))
+            return BytesIO(self._archive.read(str(file_name)))
         return None

poetry.lock

@@ -83,7 +83,7 @@ pytest-cov = "^4.1.0"
 ipykernel = "^6.7.0"
 jupyter = "^1.0.0"
 pandas = "^2.0.3"
-pyright = { extras = ["nodejs"], version = "^1.1.362" }
+pyright = { extras = ["nodejs"], version = "^1.1.399" }
 decoy = "^2.1.0"
 pep8-naming = "^0.14.1"
 

pyproject.toml

@@ -230,7 +230,7 @@ def test_paragraph_in_verse():
 
     result_strip = r"""\id MAT
 \c 1
-\p 
+\p
 \v 1 Update 1
 \s1
 \v 2