#2042: pre-commit changes

This commit is contained in:
Nick Todd
2023-11-15 10:58:24 +00:00
parent d31fce202c
commit 9deb130d10

View File

@@ -1,18 +1,17 @@
from ipaddress import IPv4Address
from typing import Dict, Optional
from primaite import getLogger
from primaite.simulator.network.protocols.ntp import NTPPacket
from primaite.simulator.network.transmission.network_layer import IPProtocol
from primaite.simulator.network.transmission.transport_layer import Port
from primaite.simulator.system.services.service import Service
from primaite import getLogger
_LOGGER = getLogger(__name__)
class NTPClient(Service):
"""Represents a NTP client as a service"""
"""Represents a NTP client as a service."""
ntp_server: Optional[IPv4Address] = None
"The NTP server the client sends requests to."
@@ -47,12 +46,12 @@ class NTPClient(Service):
pass
def send(
self,
payload: NTPPacket,
session_id: Optional[str] = None,
dest_ip_address: Optional[IPv4Address] = None,
dest_port: [Port] = Port.NTP,
**kwargs,
self,
payload: NTPPacket,
session_id: Optional[str] = None,
dest_ip_address: IPv4Address = ntp_server,
dest_port: [Port] = Port.NTP,
**kwargs,
) -> bool:
"""Requests NTP data from NTP server.
@@ -74,20 +73,18 @@ class NTPClient(Service):
payload: NTPPacket,
session_id: Optional[str] = None,
**kwargs,
):
"""Receives time data from server
) -> bool:
"""Receives time data from server.
:param payload: The payload to be sent.
:param session_id: The Session ID the payload is to originate from. Optional.
:return: True if successful, False otherwise.
"""
if not (isinstance(payload, NTPPacket) and
payload.ntp_request.ntp_client):
if not (isinstance(payload, NTPPacket) and payload.ntp_request.ntp_client):
_LOGGER.debug(f"{payload} is not a NTPPacket")
return False
# XXX: compare received datetime with current time. Log error if differ by more than x ms?
if payload.ntp_reply.ntp_datetime:
self.sys_log.info(
f"{self.name}: Received time update from NTP server{payload.ntp_reply.ntp_datetime}")
self.sys_log.info(f"{self.name}: Received time update from NTP server{payload.ntp_reply.ntp_datetime}")
return True