Source code for ucsschool.importer.utils.computer_pyhook

# -*- coding: utf-8 -*-
#
# Univention UCS@school
#
# Copyright 2016-2025 Univention GmbH
#
# https://www.univention.de/
#
# All rights reserved.
#
# The source code of this program is made available
# under the terms of the GNU Affero General Public License version 3
# (GNU AGPL V3) as published by the Free Software Foundation.
#
# Binary versions of this program provided by Univention to you as
# well as other copyrighted, protected or trademarked materials like
# Logos, graphics, fonts, specific documentations and configurations,
# cryptographic keys etc. are subject to a license agreement between
# you and Univention and not subject to the GNU AGPL V3.
#
# In the case you use this program under the terms of the GNU AGPL V3,
# the program is provided in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public
# License with the Debian GNU/Linux or Univention distribution in file
# /usr/share/common-licenses/AGPL-3; if not, see
# <http://www.gnu.org/licenses/>.

"""Base class for all Python based Computer hooks."""

from typing import Dict, List, Optional  # noqa: F401

from ucsschool.lib.models.computer import SchoolComputer  # noqa: F401

from .import_pyhook import ImportPyHook




class ComputerPyHook(ImportPyHook):
    """
    Base class for Python based computer import hooks.

    The base class' :py:meth:`__init__()` provides the following attributes:

    * self.lo          # LDAP connection object (2)
    * self.logger      # Python logging instance

    If multiple hook classes are found, hook functions with higher
    priority numbers run before those with lower priorities. None disables
    a function (no need to remove it / comment it out).

    """

    priority = {"pre_create": None, "post_create": None}  # type: Dict[str, Optional[int]]



    def pre_create(self, computer, row):  # type: (SchoolComputer, List[str]) -> None
        """
        Run code before creating a computer.

        * The computer does not exist in LDAP, yet.
        * `computer.dn` is the future DN of the computer,
        * set `priority["pre_create"]` to an `int`, to enable this method

        :param SchoolComputer computer: Computer (subclass of SchoolComputer)
        :param List[str] row: the CSV line (split by the separator)
        :return: None
        """
        pass




    def post_create(self, computer, row):  # type: (SchoolComputer, List[str]) -> None
        """
        Run code after creating a computer.

        * The hook is only executed if adding the computer succeeded.
        * `computer` will be an :py:class:`SchoolComputer`, loaded from LDAP.
        * set `priority["post_create"]` to an int, to enable this method

        :param SchoolComputer computer: Computer (subclass of SchoolComputer)
        :param List[str] row: the CSV line (split by the separator)
        :return: None
        """
        pass