feat: adiciona suporte a anotações modernas em legal_process (#634)

* feat: adiciona suporte a anotações modernas em legal_process

* refactor: implementa variaveis do tipo Final[str]

---------

Co-authored-by: Nilton Pimentel <63605485+niltonpimentel02@users.noreply.github.com>

Author: felipecolen

CHANGELOG.md

@@ -16,6 +16,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Suporte a anotações modernas no `brutils/cep.py` [#637](https://github.com/brazilian-utils/python/pull/637)
 
+### Fixed
+
+- Suporte a anotações modernas `legal_process` [#622](https://github.com/brazilian-utils/brutils-python/pull/634)
+
 ## [2.3.0] - 2025-10-07
 
 ### Added

brutils/legal_process.py

@@ -3,16 +3,17 @@
 import re
 from datetime import datetime
 from random import randint
+from typing import Final
 
-ROOT_DIR = os.path.dirname(os.path.abspath(__file__))
-DATA_DIR = f"{ROOT_DIR}/data"
-VALID_IDS_FILE = f"{DATA_DIR}/legal_process_ids.json"
+ROOT_DIR: Final[str] = os.path.dirname(os.path.abspath(__file__))
+DATA_DIR: Final[str] = f"{ROOT_DIR}/data"
+VALID_IDS_FILE: Final[str] = f"{DATA_DIR}/legal_process_ids.json"
 
 # FORMATTING
 ############
 
 
-def remove_symbols(legal_process: str):  # type: (str) -> str
+def remove_symbols(legal_process: str) -> str:
     """
     Removes specific symbols from a given legal process.
 
@@ -35,7 +36,7 @@ def remove_symbols(legal_process: str):  # type: (str) -> str
     return legal_process.replace(".", "").replace("-", "")
 
 
-def format_legal_process(legal_process_id):  # type: (str) -> (str)
+def format_legal_process(legal_process_id: str) -> str | None:
     """
     Format a legal process ID into a standard format.
 
@@ -68,7 +69,7 @@ def format_legal_process(legal_process_id):  # type: (str) -> (str)
 ############
 
 
-def is_valid(legal_process_id):  # type: (str) -> bool
+def is_valid(legal_process_id: str) -> bool:
     """
     Check if a legal process ID is valid.
 
@@ -112,7 +113,9 @@ def is_valid(legal_process_id):  # type: (str) -> bool
     ) and valid_process
 
 
-def generate(year=datetime.now().year, orgao=randint(1, 9)):  # type: (int, int) -> (str)
+def generate(
+    year: int = datetime.now().year, orgao: int = randint(1, 9)
+) -> str | None:
     """
     Generate a random legal process ID number.
 
@@ -153,7 +156,7 @@ def generate(year=datetime.now().year, orgao=randint(1, 9)):  # type: (int, int)
         return f"{NNNNNNN}{DD}{year}{orgao}{TR}{OOOO}"
 
 
-def _checksum(basenum):  # type: (int) -> str
+def _checksum(basenum: int) -> str:
     """
     Checksum to compute the verification digit for a Legal Process ID number.
     `basenum` needs to be a digit without the verification id.

tests/test_legal_process.py

@@ -20,6 +20,10 @@ def test_format_legal_process(self):
             format_legal_process("00000000000000000000"),
             ("0000000-00.0000.0.00.0000"),
         )
+        self.assertIsInstance(
+            format_legal_process("00000000000000000000"),
+            str,
+        )
         self.assertIsNone(format_legal_process("2314194582005507"))
         self.assertIsNone(format_legal_process("0000000000000000000000000"))
         self.assertIsNone(format_legal_process("0000000000000000000asdasd"))
@@ -45,18 +49,21 @@ def test_remove_symbols(self):
         )
         self.assertEqual(remove_symbols("@...---...#"), "@#")
         self.assertEqual(remove_symbols("...---..."), "")
+        self.assertIsInstance(remove_symbols("...---..."), str)
 
     def test_generate(self):
         self.assertEqual(generate()[9:13], str(datetime.now().year))
         self.assertEqual(generate(year=3000)[9:13], "3000")
         self.assertEqual(generate(orgao=4)[13:14], "4")
         self.assertEqual(generate(year=3000, orgao=4)[9:13], "3000")
+        self.assertIsInstance(generate(year=3000, orgao=4)[9:13], str)
         self.assertIsNone(generate(year=1000, orgao=4))
         self.assertIsNone(generate(orgao=0))
 
     def test_check_sum(self):
         self.assertEqual(_checksum(546611720238150014), "77")
         self.assertEqual(_checksum(403818720238230498), "50")
+        self.assertIsInstance(_checksum(403818720238230498), str)
 
     def test_is_valid(self):
         self.assertIs(is_valid("10188748220234018200"), True)
@@ -66,6 +73,7 @@ def test_is_valid(self):
         self.assertIs(is_valid("455323469202340251"), False)
         self.assertIs(is_valid("455323469202340257123123123"), False)
         self.assertIs(is_valid("455323423QQWEQWSsasd&*(()"), False)
+        self.assertIsInstance(is_valid("455323423QQWEQWSsasd&*(()"), bool)
 
 
 if __name__ == "__main__":