Address reviewer comments

Author: Enkidu93

machine/corpora/scripture_ref_usfm_parser_handler_base.py

@@ -25,7 +25,7 @@ def _is_embed_style(marker: Optional[str]) -> bool:
     return marker is not None and marker.strip("*") in _EMBED_STYLES
 
 
-def is_private_use_marker(marker: str):
+def _is_private_use_marker(marker: str) -> bool:
     return marker is not None and marker.startswith("z")
 
 
@@ -82,7 +82,7 @@ def start_para(
         attributes: Optional[Sequence[UsfmAttribute]],
     ) -> None:
         # ignore private-use markers
-        if is_private_use_marker(marker):
+        if _is_private_use_marker(marker):
             return
 
         if self._cur_verse_ref.is_default:
@@ -93,7 +93,7 @@ def start_para(
 
     def end_para(self, state: UsfmParserState, marker: str) -> None:
         # ignore private-use markers
-        if is_private_use_marker(marker):
+        if _is_private_use_marker(marker):
             return
 
         if self._current_text_type == ScriptureTextType.NONVERSE:
@@ -146,7 +146,7 @@ def start_char(
         self, state: UsfmParserState, marker: str, unknown: bool, attributes: Optional[Sequence[UsfmAttribute]]
     ) -> None:
         # ignore private-use markers
-        if is_private_use_marker(marker):
+        if _is_private_use_marker(marker):
             return
 
         # if we hit a character marker in a verse paragraph and we aren't in a verse, then start a non-verse segment
@@ -159,7 +159,7 @@ def end_char(
         self, state: UsfmParserState, marker: str, attributes: Optional[Sequence[UsfmAttribute]], closed: bool
     ) -> None:
         # ignore private-use markers
-        if is_private_use_marker(marker):
+        if _is_private_use_marker(marker):
             return
 
         if _is_embed_style(marker):
@@ -277,7 +277,7 @@ def _check_convert_verse_para_to_non_verse(self, state: UsfmParserState) -> None
             and state.is_verse_para
             and self._cur_verse_ref.verse_num == 0
             and not state.chapter_has_verse_zero
-            and not is_private_use_marker(para_tag.marker)
+            and not _is_private_use_marker(para_tag.marker)
         ):
             self._start_parent_element(para_tag.marker)
             self._start_non_verse_text_wrapper(state)

machine/corpora/update_usfm_parser_handler.py

@@ -38,7 +38,7 @@ def __init__(self, refs: Sequence[ScriptureRef], text: str, metadata: Optional[d
         self.metadata = metadata
 
 
-def sanitize_verse_data(verse_data: str) -> str:
+def _sanitize_verse_data(verse_data: str) -> str:
     return verse_data.replace("\u200F", "")
 
 
@@ -395,7 +395,7 @@ def _collect_updatable_tokens(self, state: UsfmParserState) -> None:
         while self._token_index <= state.index + state.special_token_count:
             token = state.tokens[self._token_index]
             if token.type == UsfmTokenType.VERSE and token.data is not None:
-                token.data = sanitize_verse_data(token.data)
+                token.data = _sanitize_verse_data(token.data)
             if self._current_text_type == ScriptureTextType.EMBED:
                 self._embed_tokens.append(token)
             elif (

machine/scripture/verse_ref.py

@@ -149,6 +149,8 @@ def verse_num(self) -> int:
 
     @verse_num.setter
     def verse_num(self, value: int) -> None:
+        if value < 0:
+            raise ValueError("The verse number cannot be negative.")
         self._verse_num = value
         self._verse = None