src.utils.io module

helperfile for input/output functionality. Currently has methods for reading/writing - raw - .conf - .json - .sql

src.utils.io.force_ipv4_for_requests()

Return type:

None

src.utils.io.moveFile(file, dest)

Moves a file, to the provided destination

Parameters:

• file (str) – The filename, which is to move.

• dest (str) – The destination as a relative path (containing the new name).

Return type:

None

src.utils.io.readFileByLine(relPathToFile)

Read a file as an array of string lines.

Parameters:

relPathToFile (str) – The relative path to a file, which is to be read.

Returns:

lines – A list, containing each line per entry in the list.

Return type:

list[str]

src.utils.io.readJsonFile(pathToJson)

reads a passed json file.

Parameters:

pathToJson (str) – rel path to a json file

Returns:

data_dict – the json in dict format

Return type:

dict

src.utils.io.readSQLFile(relPathtoFile)

imports a .sql file.

imports each query of a passed .sql file as a list of strings

Parameters:

relPathtoFile (str) – relative path to the .sql file

Returns:

queries – a list of sql queries as strings

Return type:

list[str]

src.utils.io.readSettingsFile(rel_path_with_name)

Reads a passed .conf file

Parameters:

rel_path_with_name (str) – the relative path to a config file

Returns:

settings – the dictionary, containing the settings

Return type:

dict

src.utils.io.requestJsonFile(linkToJson, header=None, saveLocation=None)

request the json body of a provided link.

Parameters:

• linkToJson (str) – link to a .json body, to request

• saveLocation (str, optional) – when passed, saves the resulting json body

• header (str | None)

Returns:

data_dict – the json in dict format

Return type:

dict

src.utils.io.writeJsonFile(data, path)

Parameters:

• data (dict)

• path (str)

Return type:

None

src.utils.io.writeSettingsFile(settings, rel_path_with_name)

Writes the given lines to a .conf file at the provided relative path.

Parameters:

• lines (list[str]) – Lines to write to the config file.

• rel_path_with_name (str) – Relative path including the filename (e.g. “config/lsas.conf”).

• settings (dict[str, str])

Return type:

None

Dependency Diagrams (without externals):

Mode: exportMode: importMode: neighborMode: neighbor_reduced

Range 1Range 2Range 3Range 4Range 5

Import dependencies (collapsed)

Dependency Diagrams:

Mode: exportMode: importMode: neighborMode: neighbor_reduced

Range 1Range 2Range 3Range 4Range 5

Import dependencies (collapsed)