fix(mypy): fix type errs

Author: BobTheBuidler

sphinx_autodoc_vyper/cli.py

@@ -9,7 +9,7 @@
 from .server import serve_docs
 
 
-def main():
+def main() -> None:
     """Main entry point for the CLI."""
     parser = argparse.ArgumentParser(
         description="Generate Sphinx documentation for Vyper contracts"

sphinx_autodoc_vyper/generator.py

@@ -5,23 +5,17 @@
 from .parser import Contract
 
 
-class SphinxGenerator:
-    """Generate Sphinx documentation for Vyper contracts."""
+INDEX_RST = """Vyper Smart Contracts Documentation
+================================
 
-    def __init__(self, output_dir: str):
-        self.output_dir = output_dir
-        self.docs_dir = os.path.join(output_dir, "docs")
-        os.makedirs(self.docs_dir, exist_ok=True)
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
 
-    def generate(self, contracts: List[Contract]):
-        """Generate Sphinx documentation."""
-        self._generate_conf_py()
-        self._generate_index_rst(contracts)
-        self._generate_contract_docs(contracts)
+"""
 
-    def _generate_conf_py(self):
-        """Generate Sphinx configuration file."""
-        conf_content = """# Configuration file for Sphinx documentation
+
+CONF_CONTENT = """# Configuration file for Sphinx documentation
 
 project = 'Vyper Smart Contracts'
 copyright = '2023'
@@ -39,26 +33,37 @@ def _generate_conf_py(self):
 html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']
 """
-        with open(os.path.join(self.docs_dir, "conf.py"), "w", encoding="utf-8") as f:
-            f.write(conf_content)
 
-    def _generate_index_rst(self, contracts: List[Contract]):
-        """Generate index.rst file."""
-        content = """Vyper Smart Contracts Documentation
-================================
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+class SphinxGenerator:
+    """Generate Sphinx documentation for Vyper contracts."""
 
-"""
+    def __init__(self, output_dir: str):
+        self.output_dir = output_dir
+        self.docs_dir = os.path.join(output_dir, "docs")
+        os.makedirs(self.docs_dir, exist_ok=True)
+
+    def generate(self, contracts: List[Contract]) -> None:
+        """Generate Sphinx documentation."""
+        self._generate_conf_py()
+        self._generate_index_rst(contracts)
+        self._generate_contract_docs(contracts)
+
+    def _generate_conf_py(self) -> None:
+        """Generate Sphinx configuration file."""
+        with open(os.path.join(self.docs_dir, "conf.py"), "w", encoding="utf-8") as f:
+            f.write(CONF_CONTENT)
+
+    def _generate_index_rst(self, contracts: List[Contract]) -> None:
+        """Generate index.rst file."""
+        content = INDEX_RST
         for contract in contracts:
             content += f"   {contract.name}\n"
 
         with open(os.path.join(self.docs_dir, "index.rst"), "w", encoding="utf-8") as f:
             f.write(content)
 
-    def _generate_contract_docs(self, contracts: List[Contract]):
+    def _generate_contract_docs(self, contracts: List[Contract]) -> None:
         """Generate documentation for each contract."""
         for contract in contracts:
             content = f"""{contract.name}

sphinx_autodoc_vyper/server.py

@@ -5,9 +5,10 @@
 import os
 import webbrowser
 from pathlib import Path
+from typing import NoReturn
 
 
-def serve_docs(port: int = 8000):
+def serve_docs(port: int = 8000) -> NoReturn:
     """Serve the documentation on a local development server."""
     build_dir = Path("docs/_build/html")
 

tests/conftest.py

@@ -6,7 +6,7 @@
 
 
 @pytest.fixture
-def sample_contract():
+def sample_contract() -> str:
     """Sample Vyper contract content."""
     return '''"""
 ERC20 Token Implementation
@@ -43,7 +43,7 @@ def balance_of(account: address) -> uint256:
 
 
 @pytest.fixture
-def contracts_dir(tmp_path, sample_contract):
+def contracts_dir(tmp_path: Path, sample_contract: str) -> Path:
     """Create a temporary directory with sample contracts."""
     contracts = tmp_path / "contracts"
     contracts.mkdir()
@@ -62,7 +62,7 @@ def contracts_dir(tmp_path, sample_contract):
 
 
 @pytest.fixture
-def output_dir(tmp_path):
+def output_dir(tmp_path: Path) -> Path:
     """Create a temporary output directory."""
     output = tmp_path / "output"
     output.mkdir()

tests/test_generator.py

@@ -2,11 +2,12 @@
 
 import os
 import pytest
+from pathlib import Path
 from sphinx_autodoc_vyper.generator import SphinxGenerator
 from sphinx_autodoc_vyper.parser import VyperParser
 
 
-def test_sphinx_generation(contracts_dir, output_dir):
+def test_sphinx_generation(contracts_dir: Path, output_dir: Path) -> None:
     """Test complete Sphinx documentation generation."""
     # Parse contracts
     parser = VyperParser(str(contracts_dir))
@@ -44,7 +45,7 @@ def test_sphinx_generation(contracts_dir, output_dir):
     assert "balance_of" in token_content
 
 
-def test_contract_rst_generation(contracts_dir, output_dir):
+def test_contract_rst_generation(contracts_dir: Path, output_dir: Path) -> None:
     """Test detailed RST file generation for contracts."""
     parser = VyperParser(str(contracts_dir))
     contracts = parser.parse_contracts()

tests/test_parser.py

@@ -1,10 +1,11 @@
 """Tests for the Vyper contract parser."""
 
 import pytest
+from pathlib import Path
 from sphinx_autodoc_vyper.parser import VyperParser, Contract, Function, Parameter
 
 
-def test_parse_contracts(contracts_dir):
+def test_parse_contracts(contracts_dir: Path) -> None:
     """Test parsing multiple contracts."""
     parser = VyperParser(str(contracts_dir))
     contracts = parser.parse_contracts()
@@ -14,7 +15,7 @@ def test_parse_contracts(contracts_dir):
     assert any(c.name == "nested_token" for c in contracts)
 
 
-def test_contract_parsing(contracts_dir):
+def test_contract_parsing(contracts_dir: Path) -> None:
     """Test detailed contract parsing."""
     parser = VyperParser(str(contracts_dir))
     contracts = parser.parse_contracts()
@@ -45,7 +46,7 @@ def test_contract_parsing(contracts_dir):
     assert "Get the token balance" in balance_func.docstring
 
 
-def test_parameter_parsing(contracts_dir):
+def test_parameter_parsing(contracts_dir: Path) -> None:
     """Test function parameter parsing."""
     parser = VyperParser(str(contracts_dir))
     contracts = parser.parse_contracts()
@@ -66,7 +67,7 @@ def test_parameter_parsing(contracts_dir):
     assert amount_param.type == "uint256"
 
 
-def test_empty_contract(tmp_path):
+def test_empty_contract(tmp_path: Path) -> None:
     """Test parsing an empty contract."""
     contracts_dir = tmp_path / "contracts"
     contracts_dir.mkdir()

tests/test_server.py

@@ -5,10 +5,11 @@
 import threading
 import time
 import requests
+from pathlib import Path
 from sphinx_autodoc_vyper.server import serve_docs
 
 
-def test_server_start(tmp_path):
+def test_server_start(tmp_path: Path) -> None:
     """Test server startup and accessibility."""
     # Create mock build directory
     build_dir = tmp_path / "docs" / "_build" / "html"
@@ -33,13 +34,13 @@ def test_server_start(tmp_path):
         pass
 
 
-def test_server_missing_docs(tmp_path):
+def test_server_missing_docs(tmp_path: Path) -> None:
     """Test server behavior with missing documentation."""
     with pytest.raises(FileNotFoundError):
         serve_docs()
 
 
-def _get_free_port():
+def _get_free_port() -> int:
     """Get an available port number."""
     with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
         s.bind(("", 0))