Merge pull request #1380 from tisnik/lcore-1556-fixed-docstrings

tisnik · web-flow · commit d78c57e17b64 · 2026-03-23T16:55:06.000+01:00
LCORE-1556: Fixed docstrings
diff --git a/pyproject.toml b/pyproject.toml
@@ -224,7 +224,7 @@ disable = ["R0801"]
 extend-exclude = ["tests/profiles/syntax_error.py"]
 
 [tool.ruff.lint]
-extend-select = ["TID251", "UP006", "UP007", "UP010", "UP017", "UP035", "RUF100", "B009", "B010", "DTZ005"]
+extend-select = ["TID251", "UP006", "UP007", "UP010", "UP017", "UP035", "RUF100", "B009", "B010", "DTZ005", "D202"]
 
 [tool.ruff.lint.flake8-tidy-imports.banned-api]
 unittest = { msg = "use pytest instead of unittest" }
diff --git a/tests/integration/endpoints/test_config_integration.py b/tests/integration/endpoints/test_config_integration.py
@@ -75,7 +75,6 @@ async def test_config_endpoint_fails_without_configuration(
         test_request (Request): FastAPI request fixture
         test_auth (AuthTuple): noop authentication fixture
     """
-
     # Verify that HTTPException is raised when configuration is not loaded
     with pytest.raises(HTTPException) as exc_info:
         await config_endpoint_handler(auth=test_auth, request=test_request)
diff --git a/tests/integration/endpoints/test_health_integration.py b/tests/integration/endpoints/test_health_integration.py
@@ -142,7 +142,6 @@ async def test_health_readiness_client_error(
         test_response: FastAPI response object
         test_auth: noop authentication tuple
     """
-
     # Verify that RuntimeError propagates from the endpoint (not caught)
     with pytest.raises(RuntimeError) as exc_info:
         await readiness_probe_get_method(auth=test_auth, response=test_response)
diff --git a/tests/unit/app/endpoints/test_conversations_v2.py b/tests/unit/app/endpoints/test_conversations_v2.py
@@ -57,7 +57,6 @@ def test_build_turn_without_tool_calls(self) -> None:
 
     def test_build_turn_with_tool_calls(self) -> None:
         """Test building a turn when tool calls and results are present."""
-
         tool_calls = [
             ToolCallSummary(
                 id="call_1",
diff --git a/tests/unit/app/endpoints/test_feedback.py b/tests/unit/app/endpoints/test_feedback.py
@@ -60,7 +60,6 @@ def test_is_feedback_disabled(mocker: MockerFixture) -> None:
 
 async def test_assert_feedback_enabled_disabled(mocker: MockerFixture) -> None:
     """Test that assert_feedback_enabled raises HTTPException when feedback is disabled."""
-
     # Simulate feedback being disabled
     mocker.patch("app.endpoints.feedback.is_feedback_enabled", return_value=False)
 
@@ -74,7 +73,6 @@ async def test_assert_feedback_enabled_disabled(mocker: MockerFixture) -> None:
 
 async def test_assert_feedback_enabled(mocker: MockerFixture) -> None:
     """Test that assert_feedback_enabled does not raise an exception when feedback is enabled."""
-
     # Simulate feedback being enabled
     mocker.patch("app.endpoints.feedback.is_feedback_enabled", return_value=True)
 
@@ -101,7 +99,6 @@ async def test_feedback_endpoint_handler(
     mocker: MockerFixture, feedback_request_data: dict[str, Any]
 ) -> None:
     """Test that feedback_endpoint_handler processes feedback for different payloads."""
-
     mock_authorization_resolvers(mocker)
 
     # Mock the dependencies
@@ -200,7 +197,6 @@ def test_store_feedback(
     mocker: MockerFixture, feedback_request_data: dict[str, Any]
 ) -> None:
     """Test that store_feedback correctly stores various feedback payloads."""
-
     configuration.user_data_collection_configuration.feedback_storage = "fake-path"
 
     # Patch filesystem and helpers
@@ -248,7 +244,6 @@ def test_store_feedback_on_io_error(
     mocker: MockerFixture, feedback_request_data: dict[str, Any]
 ) -> None:
     """Test the OSError and IOError handlings during feedback storage."""
-
     # non-writable path
     # avoid touching the real filesystem; simulate a permission error on open
     configuration.user_data_collection_configuration.feedback_storage = "fake-path"
diff --git a/tests/unit/app/endpoints/test_tools.py b/tests/unit/app/endpoints/test_tools.py
@@ -839,22 +839,18 @@ class TestInputSchemaToParameters:
 
     def test_none_schema(self) -> None:
         """Test that None schema returns empty list."""
-
         assert _input_schema_to_parameters(None) == []
 
     def test_empty_schema(self) -> None:
         """Test that empty dict returns empty list."""
-
         assert _input_schema_to_parameters({}) == []
 
     def test_schema_without_properties(self) -> None:
         """Test that schema without properties returns empty list."""
-
         assert _input_schema_to_parameters({"type": "object"}) == []
 
     def test_single_required_param(self) -> None:
         """Test conversion of a single required parameter."""
-
         schema = {
             "type": "object",
             "properties": {
@@ -875,7 +871,6 @@ def test_single_required_param(self) -> None:
 
     def test_optional_param_with_default(self) -> None:
         """Test conversion of an optional parameter with a default value."""
-
         schema = {
             "type": "object",
             "properties": {
@@ -896,7 +891,6 @@ def test_optional_param_with_default(self) -> None:
 
     def test_multiple_params_mixed_required(self) -> None:
         """Test conversion with a mix of required and optional parameters."""
-
         schema = {
             "type": "object",
             "properties": {
diff --git a/tests/unit/authentication/test_k8s.py b/tests/unit/authentication/test_k8s.py
@@ -318,7 +318,6 @@ async def test_auth_dependency_no_token_readiness_liveness_endpoints_2(
     For this test the skip_for_health_probes configuration parameter is set to
     False.
     """
-
     config_dict = {
         "name": "test",
         "service": {
diff --git a/tests/unit/authorization/test_resolvers.py b/tests/unit/authorization/test_resolvers.py
@@ -29,7 +29,6 @@ def claims_to_token(claims: dict) -> str:
         claims)>.foo_signature", where the payload is base64url-encoded without
         padding.
     """
-
     string_claims = json.dumps(claims)
     b64_encoded_claims = (
         base64.urlsafe_b64encode(string_claims.encode()).decode().rstrip("=")
diff --git a/tests/unit/metrics/test_utis.py b/tests/unit/metrics/test_utis.py
@@ -7,7 +7,6 @@
 
 async def test_setup_model_metrics(mocker: MockerFixture) -> None:
     """Test the setup_model_metrics function."""
-
     # Mock the LlamaStackAsLibraryClient
     mock_client = mocker.patch(
         "client.AsyncLlamaStackClientHolder.get_client"
diff --git a/tests/unit/models/config/test_authentication_configuration.py b/tests/unit/models/config/test_authentication_configuration.py
@@ -30,7 +30,6 @@
 
 def test_authentication_configuration() -> None:
     """Test the AuthenticationConfiguration constructor."""
-
     auth_config = AuthenticationConfiguration(
         module=AUTH_MOD_NOOP,
         skip_tls_verification=False,
@@ -56,7 +55,6 @@ def test_authentication_configuration() -> None:
 
 def test_authentication_configuration_rh_identity() -> None:
     """Test the AuthenticationConfiguration with RH identity token."""
-
     auth_config = AuthenticationConfiguration(
         module=AUTH_MOD_RH_IDENTITY,
         skip_tls_verification=False,
@@ -78,7 +76,6 @@ def test_authentication_configuration_rh_identity() -> None:
 
 def test_authentication_configuration_rh_identity_default_value() -> None:
     """Test the AuthenticationConfiguration with RH identity token."""
-
     auth_config = AuthenticationConfiguration(
         module=AUTH_MOD_RH_IDENTITY,
         skip_tls_verification=False,
@@ -100,7 +97,6 @@ def test_authentication_configuration_rh_identity_default_value() -> None:
 
 def test_authentication_configuration_rh_identity_one_entitlement() -> None:
     """Test the AuthenticationConfiguration with RH identity token."""
-
     auth_config = AuthenticationConfiguration(
         module=AUTH_MOD_RH_IDENTITY,
         skip_tls_verification=False,
@@ -122,7 +118,6 @@ def test_authentication_configuration_rh_identity_one_entitlement() -> None:
 
 def test_authentication_configuration_rh_identity_more_entitlements() -> None:
     """Test the AuthenticationConfiguration with RH identity token."""
-
     auth_config = AuthenticationConfiguration(
         module=AUTH_MOD_RH_IDENTITY,
         skip_tls_verification=False,
@@ -156,7 +151,6 @@ def test_authentication_configuration_rh_identity_but_insufficient_config() -> N
 
     Expects a ValidationError with the message "RH Identity configuration must be specified".
     """
-
     with pytest.raises(
         ValidationError, match="RH Identity configuration must be specified"
     ):
@@ -171,7 +165,6 @@ def test_authentication_configuration_rh_identity_but_insufficient_config() -> N
 
 def test_authentication_configuration_jwk_token() -> None:
     """Test the AuthenticationConfiguration with JWK token."""
-
     auth_config = AuthenticationConfiguration(
         module=AUTH_MOD_JWK_TOKEN,
         skip_tls_verification=False,
@@ -200,7 +193,6 @@ def test_authentication_configuration_jwk_token_but_insufficient_config() -> Non
     `module=AUTH_MOD_JWK_TOKEN` and an empty `JwkConfiguration` must raise a
     `ValidationError` containing the text "JwkConfiguration".
     """
-
     with pytest.raises(ValidationError, match="JwkConfiguration"):
         AuthenticationConfiguration(
             module=AUTH_MOD_JWK_TOKEN,
@@ -214,7 +206,6 @@ def test_authentication_configuration_jwk_token_but_insufficient_config() -> Non
 
 def test_authentication_configuration_jwk_token_but_not_config() -> None:
     """Test the AuthenticationConfiguration with JWK token."""
-
     with pytest.raises(
         ValidationError,
         match="Value error, JWK configuration must be specified when using JWK token",
@@ -239,7 +230,6 @@ def test_authentication_configuration_jwk_broken_config() -> None:
     `jwk_config`, and asserts that accessing `jwk_configuration` raises
     ValueError with message "JWK configuration should not be None".
     """
-
     auth_config = AuthenticationConfiguration(
         module=AUTH_MOD_JWK_TOKEN,
         skip_tls_verification=False,
@@ -536,7 +526,6 @@ def test_authentication_configuration_in_config_jwktoken() -> None:
 
 def test_authentication_configuration_api_token() -> None:
     """Test the AuthenticationConfiguration with API Token."""
-
     auth_config = AuthenticationConfiguration(
         module=AUTH_MOD_APIKEY_TOKEN,
         skip_tls_verification=False,
@@ -561,7 +550,6 @@ def test_authentication_configuration_api_token() -> None:
 
 def test_authentication_configuration_api_key_but_insufficient_config() -> None:
     """Test the AuthenticationConfiguration with API Token."""
-
     with pytest.raises(
         ValidationError,
         match="API Key configuration section must be "
diff --git a/tests/unit/models/config/test_byok_rag.py b/tests/unit/models/config/test_byok_rag.py
@@ -16,7 +16,6 @@
 
 def test_byok_rag_configuration_default_values() -> None:
     """Test the ByokRag constructor."""
-
     byok_rag = ByokRag(  # pyright: ignore[reportCallIssue]
         rag_id="rag_id",
         vector_db_id="vector_db_id",
@@ -41,7 +40,6 @@ def test_byok_rag_configuration_nondefault_values() -> None:
     vector_db_id match the provided inputs and that db_path is converted to a
     Path.
     """
-
     byok_rag = ByokRag(
         rag_id="rag_id",
         rag_type="rag_type",
@@ -61,7 +59,6 @@ def test_byok_rag_configuration_nondefault_values() -> None:
 
 def test_byok_rag_configuration_wrong_dimension() -> None:
     """Test the ByokRag constructor."""
-
     with pytest.raises(ValidationError, match="should be greater than 0"):
         _ = ByokRag(
             rag_id="rag_id",
@@ -75,7 +72,6 @@ def test_byok_rag_configuration_wrong_dimension() -> None:
 
 def test_byok_rag_configuration_empty_rag_id() -> None:
     """Test the ByokRag constructor."""
-
     with pytest.raises(
         ValidationError, match="String should have at least 1 character"
     ):
@@ -98,7 +94,6 @@ def test_byok_rag_configuration_empty_rag_type() -> None:
         ValidationError: if `rag_type` is an empty string; error message
         includes "String should have at least 1 character".
     """
-
     with pytest.raises(
         ValidationError, match="String should have at least 1 character"
     ):
@@ -114,7 +109,6 @@ def test_byok_rag_configuration_empty_rag_type() -> None:
 
 def test_byok_rag_configuration_empty_embedding_model() -> None:
     """Test the ByokRag constructor."""
-
     with pytest.raises(
         ValidationError, match="String should have at least 1 character"
     ):
@@ -130,7 +124,6 @@ def test_byok_rag_configuration_empty_embedding_model() -> None:
 
 def test_byok_rag_configuration_empty_vector_db_id() -> None:
     """Test the ByokRag constructor."""
-
     with pytest.raises(
         ValidationError, match="String should have at least 1 character"
     ):
@@ -146,7 +139,6 @@ def test_byok_rag_configuration_empty_vector_db_id() -> None:
 
 def test_byok_rag_configuration_custom_score_multiplier() -> None:
     """Test ByokRag with custom score_multiplier."""
-
     byok_rag = ByokRag(
         rag_id="rag_id",
         vector_db_id="vector_db_id",
@@ -158,7 +150,6 @@ def test_byok_rag_configuration_custom_score_multiplier() -> None:
 
 def test_byok_rag_configuration_score_multiplier_must_be_positive() -> None:
     """Test that score_multiplier must be greater than 0."""
-
     with pytest.raises(ValidationError, match="greater than 0"):
         _ = ByokRag(
             rag_id="rag_id",
diff --git a/tests/unit/models/config/test_model_context_protocol_server.py b/tests/unit/models/config/test_model_context_protocol_server.py
@@ -43,7 +43,6 @@ def test_model_context_protocol_server_custom_provider() -> None:
 
 def test_model_context_protocol_server_required_fields() -> None:
     """Test that ModelContextProtocolServer requires name and url."""
-
     with pytest.raises(ValidationError):
         ModelContextProtocolServer()  # pyright: ignore[reportCallIssue]
 
diff --git a/tests/unit/models/requests/test_query_request.py b/tests/unit/models/requests/test_query_request.py
@@ -88,7 +88,6 @@ def test_validate_media_type(self, mocker: MockerFixture) -> None:
         model, and media_type "text/plain", and asserts the logger's warning
         method was not called.
         """
-
         # Mock the logger
         mock_logger = mocker.Mock(spec=Logger)
         mocker.patch("models.requests.logger", mock_logger)
diff --git a/tests/unit/utils/test_endpoints.py b/tests/unit/utils/test_endpoints.py
@@ -38,7 +38,6 @@ def test_create_referenced_documents_http_urls_referenced_document_format(
         self,
     ) -> None:
         """Test HTTP URLs with ReferencedDocument format."""
-
         mock_chunk1 = type("MockChunk", (), {"source": "https://example.com/doc1"})()
         mock_chunk2 = type("MockChunk", (), {"source": "https://example.com/doc2"})()
 
@@ -59,7 +58,6 @@ def test_create_referenced_documents_http_urls_referenced_document_format(
 
     def test_create_referenced_documents_document_ids_with_metadata(self) -> None:
         """Test document IDs with metadata enrichment."""
-
         mock_chunk1 = type("MockChunk", (), {"source": "doc_id_1"})()
         mock_chunk2 = type("MockChunk", (), {"source": "doc_id_2"})()
 
@@ -87,7 +85,6 @@ def test_create_referenced_documents_document_ids_with_metadata(self) -> None:
 
     def test_create_referenced_documents_skips_tool_names(self) -> None:
         """Test that tool names like 'knowledge_search' are skipped."""
-
         mock_chunk1 = type("MockChunk", (), {"source": "knowledge_search"})()
         mock_chunk2 = type("MockChunk", (), {"source": "https://example.com/doc1"})()
 
@@ -104,7 +101,6 @@ def test_create_referenced_documents_skips_tool_names(self) -> None:
 
     def test_create_referenced_documents_skips_empty_sources(self) -> None:
         """Test that chunks with empty or None sources are skipped."""
-
         mock_chunk1 = type("MockChunk", (), {"source": None})()
         mock_chunk2 = type("MockChunk", (), {"source": ""})()
         mock_chunk3 = type("MockChunk", (), {"source": "https://example.com/doc1"})()
@@ -124,7 +120,6 @@ def test_create_referenced_documents_skips_empty_sources(self) -> None:
 
     def test_create_referenced_documents_deduplication(self) -> None:
         """Test that duplicate sources are deduplicated."""
-
         mock_chunk1 = type("MockChunk", (), {"source": "https://example.com/doc1"})()
         mock_chunk2 = type(
             "MockChunk", (), {"source": "https://example.com/doc1"}
@@ -149,7 +144,6 @@ def test_create_referenced_documents_deduplication(self) -> None:
 
     def test_create_referenced_documents_invalid_urls(self) -> None:
         """Test handling of invalid URLs."""
-
         mock_chunk1 = type("MockChunk", (), {"source": "not-a-valid-url"})()
         mock_chunk2 = type("MockChunk", (), {"source": "https://example.com/doc1"})()
 
diff --git a/tests/unit/utils/test_llama_stack_version.py b/tests/unit/utils/test_llama_stack_version.py
@@ -26,7 +26,6 @@ async def test_check_llama_stack_version_minimal_supported_version(
     mocker: MockerFixture,
 ) -> None:
     """Test the check_llama_stack_version function."""
-
     # mock the Llama Stack client
     mock_client = mocker.AsyncMock()
     mock_client.inspect.version.return_value = VersionInfo(
@@ -42,7 +41,6 @@ async def test_check_llama_stack_version_maximal_supported_version(
     mocker: MockerFixture,
 ) -> None:
     """Test the check_llama_stack_version function."""
-
     # mock the Llama Stack client
     mock_client = mocker.AsyncMock()
     mock_client.inspect.version.return_value = VersionInfo(
@@ -58,7 +56,6 @@ async def test_check_llama_stack_version_too_small_version(
     mocker: MockerFixture,
 ) -> None:
     """Test the check_llama_stack_version function."""
-
     # mock the Llama Stack client
     mock_client = mocker.AsyncMock()
 
@@ -101,7 +98,6 @@ async def test_check_llama_stack_version_too_big_version(
     mocker: MockerFixture, subtests: SubTests
 ) -> None:
     """Test the check_llama_stack_version function."""
-
     # mock the Llama Stack client
     mock_client = mocker.AsyncMock()
 
diff --git a/tests/unit/utils/test_transcripts.py b/tests/unit/utils/test_transcripts.py
