Public Member Functions
	__init__ (self, str rule)

bool	is_match_all (self)

bool\|None	accept (self, str agent_name)

Public Attributes
str	agent_name = "any" else rule

Protected Attributes
bool	_accept = True

Detailed Description

Filter for the names associated with client agents.

Parameters
----------
rule : `str`
    String specifying filtering rule for a single name, or catch-all rule.
    The rule consist of the agent name prefixed by minus or optional plus
    sign. Catch-all rule uses name "any". If the rule starts with minus
    sign then matching agent will be rejected. Otherwise matching agent
    is accepted.

Definition at line 141 of file monitor.py.

Constructor & Destructor Documentation

◆ init()

lsst.dax.apdb.monitor.MonFilter.__init__	(		self,
		str	rule )

Definition at line 154 of file monitor.py.

    def __init__(self, rule: str):
        self._accept = True
        if rule.startswith("-"):
            self._accept = False
            rule = rule[1:]
        elif rule.startswith("+"):
            rule = rule[1:]
        self.agent_name = "" if rule == "any" else rule
 

Member Function Documentation

◆ accept()

bool \| None lsst.dax.apdb.monitor.MonFilter.accept	(		self,
		str	agent_name )

Return filtering decision for specified agent name.

Parameters
----------
agent_name : `str`
    Name of the client agent that produces monitoring record.

Returns
-------
decision : `bool` or `None`
    `True` if the agent is accepted, `False` if agent is rejected.
    `None` is returned if this rule does not match agent name and
    decision should be made by the next rule.

Definition at line 173 of file monitor.py.

    def accept(self, agent_name: str) -> bool | None:
        """Return filtering decision for specified agent name.
 
        Parameters
        ----------
        agent_name : `str`
            Name of the client agent that produces monitoring record.
 
        Returns
        -------
        decision : `bool` or `None`
            `True` if the agent is accepted, `False` if agent is rejected.
            `None` is returned if this rule does not match agent name and
            decision should be made by the next rule.
        """
        if not self.agent_name or agent_name == self.agent_name:
            return self._accept
        return None
 
 

◆ is_match_all()

bool lsst.dax.apdb.monitor.MonFilter.is_match_all ( self )

Return `True` if this rule is a catch-all rule.

Returns
-------
is_match_all : `bool`
    `True` if rule name is `-any`, `+any`, or `any`.

Definition at line 163 of file monitor.py.

    def is_match_all(self) -> bool:
        """Return `True` if this rule is a catch-all rule.
 
        Returns
        -------
        is_match_all : `bool`
            `True` if rule name is `-any`, `+any`, or `any`.
        """
        return not self.agent_name
 

Member Data Documentation

◆ _accept

bool lsst.dax.apdb.monitor.MonFilter._accept = True

protected

Definition at line 155 of file monitor.py.

◆ agent_name

str lsst.dax.apdb.monitor.MonFilter.agent_name = "any" else rule

Definition at line 161 of file monitor.py.

The documentation for this class was generated from the following file:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/dax_apdb/gb88ae4c679+7dec8f19df/python/lsst/dax/apdb/monitor.py

Public Member Functions

Public Attributes

Protected Attributes