Task_508 ruff: docstrings

.dns/dns_api.py

@@ -7,7 +7,7 @@
 import logging
 import os
 import re
-import subprocess
+import subprocess  # noqa: S404
 from collections import defaultdict
 from dataclasses import dataclass
 from enum import StrEnum
@@ -189,7 +189,7 @@ class BindDNSServerManager:
     """Bind9 DNS server manager."""
 
     @staticmethod
-    def _get_zone_obj_by_zone_name(zone_name) -> dns.zone.Zone:
+    def _get_zone_obj_by_zone_name(zone_name: str) -> dns.zone.Zone:
         """Get DNS zone object by zone name.
 
         Algorithm:
@@ -582,7 +582,7 @@ def restart(self) -> None:
         Algorithm:
             1. Call rndc reconfig.
         """
-        subprocess.run(  # noqa: S603
+        subprocess.run(
             [
                 "/usr/sbin/rndc",
                 "reconfig",
@@ -846,8 +846,8 @@ def update_record(
         self,
         old_record: DNSRecord,
         new_record: DNSRecord,
-        record_type,
-        zone_name,
+        record_type: DNSRecordType,
+        zone_name: str,
     ) -> None:
         """Update a record in a zone (value or TTL).
 
@@ -998,7 +998,11 @@ def get_server_settings() -> list[DNSServerParam]:
 
 
 async def get_dns_manager() -> type[BindDNSServerManager]:
-    """Get DNS server manager client."""
+    """Get DNS server manager client.
+
+    Returns:
+        BindDNSServerManager: dns manager.
+    """
     return BindDNSServerManager()
 
 
@@ -1043,15 +1047,23 @@ def delete_zone(
 async def get_all_records_by_zone(
     dns_manager: Annotated[BindDNSServerManager, Depends(get_dns_manager)],
 ) -> list[DNSZone]:
-    """Get all DNS records grouped by zone."""
+    """Get all DNS records grouped by zone.
+
+    Returns:
+        list[DNSZone]: List of DNSZone objects with records.
+    """
     return dns_manager.get_all_records()
 
 
 @zone_router.get("/forward")
 async def get_forward_zones(
     dns_manager: Annotated[BindDNSServerManager, Depends(get_dns_manager)],
 ) -> list[DNSForwardZone]:
-    """Get all forward DNS zones."""
+    """Get all forward DNS zones.
+
+    Returns:
+        list[DNSForwardZone]: List of DNSForwardZone objects.
+    """
     return await dns_manager.get_forward_zones()
 
 
@@ -1141,7 +1153,11 @@ def update_dns_server_settings(
 async def get_server_settings(
     dns_manager: Annotated[BindDNSServerManager, Depends(get_dns_manager)],
 ) -> list[DNSServerParam]:
-    """Get list of modifiable server settings."""
+    """Get list of modifiable server settings.
+
+    Returns:
+        list[DNSServerParam]: List of server parameters.
+    """
     return dns_manager.get_server_settings()
 
 
@@ -1155,7 +1171,11 @@ def setup_server(
 
 
 def create_app() -> FastAPI:
-    """Create FastAPI app."""
+    """Create FastAPI app.
+
+    Returns:
+        FastAPI: FastAPI application instance.
+    """
     app = FastAPI(
         name="DNSServerManager",
         title="DNSServerManager",

.docker/lint.Dockerfile

@@ -21,7 +21,7 @@ RUN --mount=type=cache,target=$POETRY_CACHE_DIR poetry install --with linters --
 # The runtime image, used to just run the code provided its virtual environment
 FROM python:3.12.6-slim-bookworm AS runtime
 
-WORKDIR /app
+WORKDIR /md
 RUN set -eux;
 
 ENV VIRTUAL_ENV=/venvs/.venv \
@@ -31,5 +31,7 @@ ENV VIRTUAL_ENV=/venvs/.venv \
 
 COPY --from=builder ${VIRTUAL_ENV} ${VIRTUAL_ENV}
 
-COPY app /app
-COPY pyproject.toml ./
+COPY app ./app
+COPY tests ./tests
+COPY .kerberos ./.kerberos
+COPY pyproject.toml ./

.github/workflows/checks.yml

@@ -26,7 +26,7 @@ jobs:
       - name: Run linters
         env:
           NEW_TAG: linter
-        run: docker run $NEW_TAG ruff check --output-format=github .
+        run: docker run $NEW_TAG ruff check --output-format=github . --preview
 
   ruff_format:
     runs-on: ubuntu-latest
@@ -46,7 +46,7 @@ jobs:
       - name: Run linters
         env:
           NEW_TAG: linter
-        run: docker run $NEW_TAG ruff format --check
+        run: docker run $NEW_TAG ruff format --check --preview
 
   mypy:
     runs-on: ubuntu-latest
@@ -86,4 +86,4 @@ jobs:
       - name: Run tests
         env:
           TAG: tests
-        run: docker compose -f docker-compose.remote.test.yml up --no-log-prefix --attach md-test --exit-code-from md-test
+        run: docker compose -f docker-compose.remote.test.yml up --no-log-prefix --attach md-test --exit-code-from md-test