fixing pylint issues

Author: nithinjamespallicka

src/datu/telemetry/product/events.py

@@ -1,3 +1,5 @@
+"""Telemetry events for product usage."""
+
 from typing import Any, ClassVar, Dict
 
 from datu.app_config import settings

src/datu/telemetry/product/posthog.py

@@ -1,3 +1,5 @@
+"""PostHog telemetry client for product usage tracking."""
+
 import importlib
 import logging
 import platform

tests/integrations/sql_server/conftest.py

@@ -1,6 +1,6 @@
 """Common fixtures for tests in integrations sql_server module ."""
 
-# pylint: disable=redefined-outer-name
+# pylint: disable=redefined-outer-name disable=unused-argument disable=import-outside-toplevel
 import pytest
 
 

tests/routers/test_chat.py

@@ -1,4 +1,5 @@
-# tests/routers/test_chat.py
+"""Test suite for the chat router."""
+
 import pytest
 from fastapi import FastAPI
 from fastapi.testclient import TestClient
@@ -8,6 +9,7 @@
 
 
 def _client() -> TestClient:
+    """Create a test client for the chat router."""
     app = FastAPI()
     app.include_router(chat.router, prefix="/chat/sql")
     return TestClient(app)
@@ -18,6 +20,8 @@ def _client() -> TestClient:
 
 @pytest.mark.asyncio
 async def test_happy_path_with_mcp(monkeypatch):
+    """Test that the happy path with MCP enabled works correctly."""
+
     async def fake_generate_response(_msgs, _sys):
         return "Query name: Sales\n```sql\nSELECT 1;\n```"
 
@@ -36,6 +40,8 @@ async def fake_generate_response(_msgs, _sys):
 
 @pytest.mark.asyncio
 async def test_error_path_with_mcp(monkeypatch):
+    """Test that the error path with MCP enabled works correctly."""
+
     async def boom(*_a, **_k):
         raise RuntimeError("LLM down")
 
@@ -55,6 +61,8 @@ async def boom(*_a, **_k):
 
 @pytest.mark.asyncio
 async def test_passthrough_to_generate_sql_core(monkeypatch):
+    """Test that the passthrough to generate_sql_core works correctly."""
+
     async def fake_generate_sql_core(request: ChatRequest):
         return {"assistant_response": "core path", "queries": []}
 

tests/services/conftest.py

@@ -38,6 +38,7 @@ def cached_schema():
 
     @staticmethod
     def raw_schema_dict():
+        """Return a raw schema dictionary."""
         return {
             "profile_name": "test_profile",
             "output_name": "test_output",
@@ -58,6 +59,8 @@ def raw_schema_dict():
 
 @pytest.fixture
 def sample_schema():
+    """Return a function that can generate schemas with parameters."""
+
     # Return a function that can generate schemas with parameters
     def _factory(timestamp: float = 1234567890.0):
         return SchemaTestFixtures.sample_schema(timestamp=timestamp)
@@ -67,4 +70,5 @@ def _factory(timestamp: float = 1234567890.0):
 
 @pytest.fixture
 def raw_schema_dict():
+    """Return a raw schema dictionary."""
     return SchemaTestFixtures.raw_schema_dict()

tests/services/test_sql_generator.py

@@ -23,6 +23,8 @@
 from src.datu.services.sql_generator import core
 from src.datu.services.sql_generator.normalizer import normalize_for_preview
 
+# pylint: disable=redefined-outer-name disable=unused-argument disable=import-outside-toplevel
+
 
 @pytest.fixture(autouse=True)
 def _reset_db_connector(monkeypatch):

tests/telemetry/product/conftest.py

@@ -1,10 +1,14 @@
+"""Common fixtures for tests in telemetry product module."""
+
 import pytest
 
 from datu.telemetry.product.events import ProductTelemetryEvent
 
 
+# pylint: disable=import-outside-toplevel
 @pytest.fixture
 def sample_event_data():
+    """Fixture for sample event data."""
     return {
         "event_name": "test_event",
         "user_id": "12345",
@@ -15,6 +19,7 @@ def sample_event_data():
 
 @pytest.fixture
 def event(sample_event_data):
+    """Fixture for a ProductTelemetryEvent."""
     return ProductTelemetryEvent(
         event_name=sample_event_data["event_name"],
         user_id=sample_event_data["user_id"],
@@ -25,18 +30,21 @@ def event(sample_event_data):
 
 @pytest.fixture
 def sample_event():
+    """Fixture for a sample ProductTelemetryEvent."""
     return ProductTelemetryEvent(foo="bar")
 
 
 @pytest.fixture
 def telemetry_settings():
+    """Fixture for telemetry settings."""
     from datu.telemetry.config import TelemetryConfig
 
     return TelemetryConfig(api_key="dummy_key", package_name="datu-core")
 
 
 @pytest.fixture
 def posthog_client(telemetry_settings):
+    """Fixture for PostHog client."""
     from datu.telemetry.product.posthog import PostHogClient
 
     return PostHogClient(telemetry_settings=telemetry_settings)

tests/telemetry/product/test_events.py

@@ -1,21 +1,26 @@
+"""Tests for telemetry product events."""
+
 import pytest
 
 from datu.telemetry.product.events import MCPClientEvent, OpenAIEvent, ProductTelemetryEvent
 
 
 def test_event_initialization(event, sample_event_data):
+    """Test that event initializes correctly with given data."""
     assert event.properties["event_name"] == sample_event_data["event_name"]
     assert event.properties["user_id"] == sample_event_data["user_id"]
     assert event.properties["timestamp"] == sample_event_data["timestamp"]
     assert event.properties["properties"] == sample_event_data["properties"]
 
 
 def test_event_name_and_batch_key(event):
+    """Test that event name and batch key are set correctly."""
     assert event.name == "ProductTelemetryEvent"
     assert event.batch_key == event.name
 
 
 def test_batching_same_type(event):
+    """Test that batching works for events of the same type."""
     other = ProductTelemetryEvent(event_name="other_event")
     batched = event.batch(other)
 
@@ -25,6 +30,8 @@ def test_batching_same_type(event):
 
 
 def test_batching_different_type_raises():
+    """Test that batching raises an error for events of different types."""
+
     class AnotherEvent(ProductTelemetryEvent):
         pass
 
@@ -35,6 +42,7 @@ class AnotherEvent(ProductTelemetryEvent):
 
 
 def test_batch_size_increment(event):
+    """Test that batch size increments correctly."""
     # Initial batch_size
     assert event.batch_size == 1
     event.batch(ProductTelemetryEvent())
@@ -44,6 +52,7 @@ def test_batch_size_increment(event):
 
 
 def test_mcp_client_event_properties():
+    """Test that MCPClientEvent initializes correctly with given data."""
     servers = ["playwright", "puppeteer"]
     event = MCPClientEvent(server_names=servers)
 
@@ -56,7 +65,8 @@ def test_mcp_client_event_properties():
 
 
 def test_openai_event_properties():
-    from datu.app_config import get_app_settings
+    """Test that OpenAIEvent initializes correctly with given data."""
+    from datu.app_config import get_app_settings  # pylint: disable=import-outside-toplevel
 
     app_settings = get_app_settings()
     data = {"user_id": "123", "action": "test"}

tests/telemetry/product/test_posthog.py

@@ -1,7 +1,13 @@
+"""Tests for PostHog telemetry client."""
+
+from pathlib import Path
 from unittest.mock import patch
 
+# pylint: disable=import-outside-toplevel disable=redefined-outer-name disable=unused-argument
+
 
 def test_posthog_client_initialization(posthog_client, telemetry_settings):
+    """Test that PostHogClient initializes correctly."""
     from datu.telemetry.product.posthog import PostHogClient
 
     assert posthog_client.settings == telemetry_settings
@@ -12,6 +18,7 @@ def test_posthog_client_initialization(posthog_client, telemetry_settings):
 
 
 def test_user_id_creation(tmp_path):
+    """Test that user ID is created and read correctly."""
     from datu.telemetry.config import TelemetryConfig
     from datu.telemetry.product.posthog import PostHogClient
 
@@ -30,8 +37,7 @@ def test_user_id_creation(tmp_path):
 
 
 def test_user_id_fallback_patch():
-    from pathlib import Path
-
+    """Test that user ID falls back to unknown when file access fails."""
     from datu.telemetry.config import TelemetryConfig
     from datu.telemetry.product.posthog import PostHogClient
 
@@ -47,6 +53,7 @@ def test_user_id_fallback_patch():
 
 
 def test_base_context(monkeypatch):
+    """Test that base context is created correctly."""
     from datu.telemetry.config import TelemetryConfig
     from datu.telemetry.product.posthog import PostHogClient
 
@@ -61,6 +68,7 @@ def test_base_context(monkeypatch):
 
 
 def test_capture_single_event(monkeypatch, posthog_client, sample_event):
+    """Test that a single event is captured correctly."""
     # Ensure _send is called
     called = {}
 
@@ -74,6 +82,7 @@ def fake_send(event):
 
 
 def test_capture_batching(monkeypatch):
+    """Test that event batching works correctly."""
     from datu.telemetry.config import TelemetryConfig
     from datu.telemetry.product.events import ProductTelemetryEvent
     from datu.telemetry.product.posthog import PostHogClient

tests/telemetry/test_config.py

@@ -1,5 +1,9 @@
+"""Tests for telemetry configuration."""
+
+
 def test_config():
-    from datu.telemetry.config import get_telemetry_settings
+    """Test that telemetry settings are loaded correctly."""
+    from datu.telemetry.config import get_telemetry_settings  # pylint: disable=import-outside-toplevel
 
     settings = get_telemetry_settings()
     assert settings.api_key == "phc_m74dfR9nLpm2nipvkL2swyFDtNuQNC9o2FL2CSbh6Je"