oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Standardise docstring summary line placement.

Browse Source
This commit is contained in:
Marek Wolan
2023-07-07 10:28:00 +01:00
parent 653d76ec62
commit 5618283cc5
36 changed files with 350 additions and 175 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/primaite/nodes/active_node.py
View File

@@ -52,7 +52,8 @@ class ActiveNode(Node):
@property
def software_state(self) -> SoftwareState:
"""Get the software_state.
"""
Get the software_state.
:return: The software_state.
"""
@@ -60,7 +61,8 @@ class ActiveNode(Node):
@software_state.setter
def software_state(self, software_state: SoftwareState):
"""Get the software_state.
"""
Get the software_state.
:param software_state: Software State.
"""
@@ -78,7 +80,8 @@ class ActiveNode(Node):
)
def set_software_state_if_not_compromised(self, software_state: SoftwareState):
"""Sets Software State if the node is not compromised.
"""
Sets Software State if the node is not compromised.
Args:
software_state: Software State
@@ -104,7 +107,8 @@ class ActiveNode(Node):
self._software_state = SoftwareState.GOOD
def set_file_system_state(self, file_system_state: FileSystemState):
"""Sets the file system state (actual and observed).
"""
Sets the file system state (actual and observed).
Args:
file_system_state: File system state
@@ -130,7 +134,8 @@ class ActiveNode(Node):
)
def set_file_system_state_if_not_compromised(self, file_system_state: FileSystemState):
"""Sets the file system state (actual and observed) if not in a compromised state.
"""
Sets the file system state (actual and observed) if not in a compromised state.
Use for green PoL to prevent it overturning a compromised state