Source code for mcdreforged.info_reactor.info_filter

import dataclasses
from abc import ABC, abstractmethod
from typing import TYPE_CHECKING, Optional

if TYPE_CHECKING:
	from mcdreforged.info_reactor.info import Info
	from mcdreforged.plugin.type.plugin import AbstractPlugin




class InfoFilter(ABC):


	@abstractmethod
	def filter_server_info(self, info: 'Info') -> Optional[bool]:
		"""
		Filter an info object from the server output, check if it should be discarded

		If the server info object is discarded, it will not be echoed to the console output,
		and will not be processed by any of the remaining MCDR logic

		Do not affect innocent info objects; that is, do not discard those info that contains important messages (e.g. server start / stop),
		or MCDR might not work correctly

		This function is invoked right after an :class:`~mcdreforged.info_reactor.info.Info` object is parsed from server
		output

		To precisely control what actions MCDR should take next for the info object,
		you can edit its :attr:`~<mcdreforged.info_reactor.info.Info.action_flag>` in this function.
		Returning ``False`` is actually equivalent to::

			info.action_flag = InfoActionFlag.discarded()

		.. seealso:: class :class:`~mcdreforged.info_reactor.info.InfoActionFlag`

		:param info: The info object, which is parsed from server output, to check
		:return: False: discard the info object; other: do nothing
		"""
		...




@dataclasses.dataclass(frozen=True)
class InfoFilterHolder:
	filter: InfoFilter
	plugin: 'AbstractPlugin'