pyanaconda.modules.common.base.base_interface
=============================================

.. py:module:: pyanaconda.modules.common.base.base_interface


Classes
-------

.. autoapisummary::

   pyanaconda.modules.common.base.base_interface.KickstartModuleInterface


Module Contents
---------------

.. py:class:: KickstartModuleInterface

   Bases: :py:obj:`pyanaconda.modules.common.base.base_template.KickstartModuleInterfaceTemplate`


   DBus interface of a kickstart module.

   The implementation is provided by the KickstartModule class.


   .. py:method:: connect_signals()

      Connect the signals.



   .. py:property:: KickstartCommands
      :type: List[Str]


      Return names of kickstart commands handled by module.

      :returns: List of names of kickstart commands handled by module.


   .. py:property:: KickstartSections
      :type: List[Str]


      Return names of kickstart sections handled by module.

      :returns: List of names of kickstart sections handled by module.


   .. py:property:: KickstartAddons
      :type: List[Str]


      Return names of kickstart addons handled by module.

      :returns: List of names of kickstart addons handled by module.


   .. py:property:: Kickstarted
      :type: Bool


      Was this module set up by the kickstart?

      :return: True if module was set up by the kickstart, otherwise False


   .. py:method:: ReadKickstart(kickstart)

      Read the kickstart string.

      :param kickstart: a kickstart string
      :returns: a structure with a kickstart report



   .. py:method:: GenerateKickstart()

      Return a kickstart representation of the module

      :return: a kickstart string



   .. py:method:: CollectRequirements()

      Return installation requirements of this module.

      :return: a list of requirements



   .. py:method:: SetLocale(locale)

      Set the locale for the module.

      This function modifies the process environment, which is not thread-safe.
      It should be called before any threads are run.

      We cannot get around setting $LANG. Python's gettext implementation
      differs from C in that consults only the environment for the current
      language and not the data set via setlocale. If we want translations
      from python modules to work, something needs to be set in the
      environment when the language changes.

      Examples: "cs_CZ.UTF-8", "fr_FR"



   .. py:method:: ConfigureWithTasks()

      Configure the runtime environment.

      Note: Addons should use it instead of the setup method.

      :returns: a list of object paths of installation tasks



   .. py:method:: ConfigureBootloaderWithTasks(kernel_versions)

      Configure the bootloader after the payload installation.

      FIXME: This is a temporary workaround. The method might change.

      :param kernel_versions: a list of kernel versions
      :return: list of object paths of installation tasks



   .. py:method:: InstallWithTasks()

      Returns installation tasks of this module.

      Note: Addons should use it instead of the execute method.

      :returns: list of object paths of installation tasks



   .. py:method:: TeardownWithTasks()

      Returns teardown tasks for this module.

      :returns: list of object paths of installation tasks



   .. py:method:: Quit()

      Shut the module down.