host.mods.md

module host.mods

Abstract method for other modules.

Global Variables

• ME: # -- coding: utf-8 --

• TYPE_PROBLEM

• TYPE_SYSTEM

• TYPE_INTRO

• TYPES

---

class BaseModule

Module interface.

method __init__

__init__(path: Path)

initialize class.

---

property log

log.

Args:

Returns: Logger:

---

property network_ports

network_ports.

Args:

Returns: List[Dict[str, int]]:

---

method as_dict

as_dict() → Dict[str, str]

as_dict.

Args:

Returns:

• Dict[str, str]: Dict representing the questions object

---

class SystemModule

method __init__

__init__(path: Path)

---

property log

log.

Args:

Returns: Logger:

---

property network_ports

network_ports.

Args:

Returns: List[Dict[str, int]]:

---

method as_dict

as_dict() → Dict[str, str]

as_dict.

Args:

Returns:

• Dict[str, str]: Dict representing the questions object

---

class QuestionModule

method __init__

__init__(path: Path)

---

property log

log.

Args:

Returns: Logger:

---

property network_ports

network_ports.

Args:

Returns: List[Dict[str, int]]:

---

property question_intro

question_intro.

Args:

Returns: Intro:

---

property questions

questions.

Args:

Returns: List[str]:

---

property runtime_background_processes

runtime_background_processes.

Args:

Returns: List[str]:

---

method as_dict

as_dict() → Dict[str, str]

as_dict.

Args:

Returns:

• Dict[str, str]: Dict representing the questions object

---

method question_export_entry

question_export_entry() → Dict[str, Any]

question_export_entry.

Args:

Returns:

• Dict[str, Any]: export ready to insert into questions.json

---

class MainIntroModule

method __init__

__init__(path: Path)

---

property log

log.

Args:

Returns: Logger:

---

property main_intro

question_intro.

Args:

Returns: Intro:

---

property network_ports

network_ports.

Args:

Returns: List[Dict[str, int]]:

---

method as_dict

as_dict() → Dict[str, str]

as_dict.

Args:

Returns:

• Dict[str, str]: Dict representing the questions object

---

method main_info_export_entry

main_info_export_entry() → Dict[str, Any]

---

class ModulesCollection

Collection of modules.

---

classmethod all

all() → Iterator[BaseModule]

all.

Args:

Yields:

• Module: yield all modules

---

classmethod main_intro

main_intro() → MainIntroModule

main_intro.

Args:

Returns:

• Module: main intro module

Raises:

• PreCheckFail: if validation fails

---

classmethod network_ports

network_ports() → Iterator[Tuple[str, int]]

network_ports.

Args:

Yields: Tuple[str, int]

---

classmethod problem_collection

problem_collection() → Iterator[QuestionModule]

problem_collection.

Args:

Yields: Module:

---

classmethod register

register(module: BaseModule)

register.

Args:

• module (Module): module

Raises:

• PreCheckFail: if validation fails

---

classmethod system_collection

system_collection() → Iterator[SystemModule]

system_collection.

Args:

Yields: Module:

---

class ModuleLoader

---

classmethod load

load(path: Path)

initialize class.

---

This file was automatically generated via lazydocs.