3110 - Add some more module level docstrings.

src/primaite/game/agent/observations/acl_observation.py

@@ -1,4 +1,5 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""Observations for access control lists (ACLs) on routers and firewalls."""
 from __future__ import annotations
 
 from typing import Dict, List, Optional

src/primaite/simulator/system/services/arp/__init__.py

@@ -1 +1,2 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""Address Resolution Protocol software."""

src/primaite/simulator/system/services/arp/arp.py

@@ -1,4 +1,5 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""ARP software."""
 from __future__ import annotations
 
 from abc import abstractmethod

src/primaite/simulator/system/services/database/__init__.py

@@ -1 +1,2 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""Database simulation."""

src/primaite/simulator/system/services/database/database_service.py

@@ -1,4 +1,5 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""Database service."""
 from ipaddress import IPv4Address
 from typing import Any, Dict, List, Literal, Optional, Union
 from uuid import uuid4

src/primaite/simulator/system/services/dns/__init__.py

@@ -1 +1,2 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""Domain Name Service software."""

src/primaite/simulator/system/services/dns/dns_client.py

@@ -1,4 +1,5 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""DNS Client."""
 from ipaddress import IPv4Address
 from typing import Dict, Optional, TYPE_CHECKING
 

src/primaite/simulator/system/services/dns/dns_server.py

@@ -1,4 +1,5 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""DNS Server."""
 from ipaddress import IPv4Address
 from typing import Any, Dict, Optional
 

src/primaite/simulator/system/services/ftp/__init__.py

@@ -1 +1,2 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""File Transfer Protocol Software."""

src/primaite/simulator/system/services/ftp/ftp_client.py

@@ -1,4 +1,5 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""FTP Client."""
 from ipaddress import IPv4Address
 from typing import Dict, Optional
 

src/primaite/simulator/system/services/ftp/ftp_server.py

@@ -1,4 +1,5 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""FTP Server."""
 from typing import Any, Optional
 
 from pydantic import Field

src/primaite/simulator/system/services/ftp/ftp_service.py

@@ -1,4 +1,5 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""FTP Service base class."""
 from abc import ABC
 from ipaddress import IPv4Address
 from typing import Dict, Optional

src/primaite/simulator/system/services/icmp/__init__.py

@@ -1 +1,2 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""Internet Control Message Protocol."""

src/primaite/simulator/system/services/icmp/icmp.py

@@ -1,4 +1,5 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""Internet Control Message Protocol."""
 import secrets
 from ipaddress import IPv4Address
 from typing import Any, Dict, Optional, Tuple, Union

src/primaite/simulator/system/services/ntp/__init__.py

@@ -1 +1,2 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""NTP software."""

src/primaite/simulator/system/services/ntp/ntp_client.py

@@ -1,4 +1,5 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""NTP Client."""
 from datetime import datetime
 from ipaddress import IPv4Address
 from typing import Dict, Optional

src/primaite/simulator/system/services/ntp/ntp_server.py

@@ -1,4 +1,5 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""NTP Server."""
 from datetime import datetime
 from typing import Dict, Optional
 

src/primaite/simulator/system/services/terminal/__init__.py

@@ -1 +1,2 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""Command line interface on network nodes."""

src/primaite/simulator/system/services/terminal/terminal.py

@@ -1,4 +1,5 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""Command line interface on network nodes."""
 from __future__ import annotations
 
 from abc import abstractmethod

src/primaite/simulator/system/services/web_server/__init__.py

@@ -1 +1,2 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""HTTP server."""

src/primaite/simulator/system/services/web_server/web_server.py

@@ -1,4 +1,5 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""HTTP server."""
 from ipaddress import IPv4Address
 from typing import Any, Dict, List, Optional
 from urllib.parse import urlparse

src/primaite/utils/validation/__init__.py

@@ -1 +1,2 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+"""Special validation for use with pydantic."""

src/primaite/utils/validation/ip_protocol.py

@@ -1,5 +1,5 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
-# Define a custom IP protocol validator
+"""Validation for internet protocols."""
 from typing import Any
 
 from pydantic import BeforeValidator, TypeAdapter, ValidationError

src/primaite/utils/validation/ipv4_address.py

@@ -1,5 +1,5 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
-
+"""Validation for IPv4 addresses expressed as strings."""
 
 from ipaddress import IPv4Address
 from typing import Any, Final

src/primaite/utils/validation/port.py

@@ -1,5 +1,5 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
-# Define a custom port validator
+"""Custom port validation."""
 from typing import Any
 
 from pydantic import BeforeValidator, TypeAdapter, ValidationError