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

#2676: Updated doc strings

Browse Source
This commit is contained in:
Nick Todd
2024-07-19 12:54:01 +01:00
parent e4ade6ba54
commit 82a11b8b85
1 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/primaite/session/io.py
View File

@@ -156,18 +156,17 @@ def store_nmne_config(nmne_config: Dict) -> NMNEConfig:
""" """
Store configuration for capturing Malicious Network Events (MNEs). Store configuration for capturing Malicious Network Events (MNEs).
This function updates global settings related to NMNE capture, including whether to capture This function updates settings related to NMNE capture, stored in NMNEConfig including whether
NMNEs and what keywords to use for identifying NMNEs. to capture NMNEs and the keywords to use for identifying NMNEs.
The function ensures that the settings are updated only if they are provided in the The function ensures that the settings are updated only if they are provided in the
`nmne_config` dictionary, and maintains type integrity by checking the types of the provided `nmne_config` dictionary, and maintains type integrity by relying on pydantic validators.
values.
:param nmne_config: A dictionary containing the NMNE configuration settings. Possible keys :param nmne_config: A dictionary containing the NMNE configuration settings. Possible keys
include: include:
"capture_nmne" (bool) to indicate whether NMNEs should be captured; "capture_nmne" (bool) to indicate whether NMNEs should be captured;
"nmne_capture_keywords" (list of strings) to specify keywords for NMNE identification. "nmne_capture_keywords" (list of strings) to specify keywords for NMNE identification.
:rvar dataclass with data read from config file. :rvar class with data read from config file.
""" """
nmne_capture_keywords: List[str] = [] nmne_capture_keywords: List[str] = []
# Update the NMNE capture flag, defaulting to False if not specified or if the type is incorrect # Update the NMNE capture flag, defaulting to False if not specified or if the type is incorrect