Anaconda のカスタマイズ

• Red Hat Enterprise Linux ISO を抽出します。
• カスタマイズを含む新規ブートイメージを作成します。

• デフォルトのオプションをカスタマイズします。
• オプションを追加します。
• 視覚的スタイル (色と背景) を変更します。

• menuentry: エントリーのタイトルを定義します。これは引用符または二重引用符 (' または ") で指定されます。--class オプションを使用して、メニューエントリーを異なるクラスにグループ化できます。これは、GRUB2 テーマを使用してスタイルを変更できます。

  注記

  各メニューエントリーの定義は中括弧 ({}) で囲む必要があります。

• linux: ブートするカーネル (上記の例では /images/pxeboot/vmlinuz) と、その他の追加オプション (存在する場合) を定義します。これらのオプションをカスタマイズして、ブートエントリーの動作を変更できます。Anaconda に適用可能なオプションの詳細は、RHEL の自動インストール を参照してください。主なオプションは inst.ks= で、キックスタートファイルの場所を指定できます。ブート ISO イメージにキックスタートファイルを配置し、inst.ks= オプションを使用してその場所を指定できます。たとえば、kickstart.ks ファイルをイメージの root ディレクトリーに配置し、inst.ks=hd:LABEL=RHEL-10-0-BaseOS-x86_64:/kickstart.ks を使用できます。また、dracut.cmdline(7) の man ページに記載されている dracut オプションを使用することもできます。

  重要

  ディスクラベルを使用して特定のドライブを参照する場合 (例: inst.stage2=hd:LABEL=RHEL-10-0-BaseOS-x86_64)、すべてのスペースを \x20 に置き換えます。

• initrd: ロードする初期 RAM ディスク (initrd) イメージの場所。grub.cfg 設定ファイルで使用されるその他のオプションは以下のとおりです。

  • set timeout: デフォルトのメニューエントリーが自動的に使用される前に、ブートメニューが表示される時間の長さを決定します。デフォルト値は 60 です。つまり、メニューが 60 秒間表示されます。この値を -1 に設定すると、タイムアウトを完全に無効にします。

    注記

    この設定によりデフォルトのブートエントリーがすぐに有効になるため、ヘッドレスインストールの実行時にタイムアウトを 0 に設定すると便利です。

• submenu: submenu ブロックを使用すると、メインメニューにエントリーを表示する代わりに、サブメニューを作成してその下にいくつかのエントリーをグループ化できます。デフォルト設定の Troubleshooting サブメニューには、既存のシステムをレスキューするエントリーが含まれます。エントリーのタイトルは、引用符または二重引用符 (' または ") で囲まれています。submenu ブロックには、上記のように 1 つ以上のメニューエントリー定義が含まれており、ブロック全体は中括弧 ({}) で囲まれています。以下に例を示します。

  submenu 'Submenu title' {
    menuentry 'Submenu option 1' {
      linux /images/pxeboot/vmlinuz inst.stage2=hd:LABEL=RHEL-10-0-BaseOS-x86_64 nomodeset quiet
      initrd /images/pxeboot/initrd.img
    }
    menuentry 'Submenu option 2' {
      linux /images/pxeboot/vmlinuz inst.stage2=hd:LABEL=RHEL-10-0-BaseOS-x86_64 inst.rescue quiet
      initrd /images/pxeboot/initrd.img
    }
  }

  Copy to Clipboard Toggle word wrap
• set default: デフォルトエントリーを決定します。エントリー番号は 0 から始まります。3 番目のエントリーをデフォルトにしたい場合は、set default=2 などを使用します。
• theme: GRUB2 テーマファイルが含まれるディレクトリーを決定します。テーマを使用して、ブートローダーの視覚的な要素 (背景、フォント、および特定の要素の色) をカスタマイズできます。

• menuentry: エントリーのタイトルを定義します。これは引用符または二重引用符 (' または ") で指定されます。--class オプションを使用して、メニューエントリーを異なる クラス にグループ化できます。このクラスは、GRUB2 テーマを使用してスタイルを変更できます。

  注記

  上記の例で示すように、各メニューエントリー定義は中括弧 ({}) で囲む必要があります。

• linuxefi: ブートするカーネル (例では /images/pxeboot/vmlinuz) と、その他の追加オプション (存在する場合) を定義します。

  これらのオプションをカスタマイズして、ブートエントリーの動作を変更できます。

  主なオプションは inst.ks= で、キックスタートファイルの場所を指定できます。ブート ISO イメージにキックスタートファイルを配置し、inst.ks= オプションを使用してその場所を指定できます。たとえば、kickstart.ks ファイルをイメージの root ディレクトリーに配置し、inst.ks=hd:LABEL=RHEL-10-0-BaseOS-x86_64:/kickstart.ks を使用できます。

  システムの dracut.cmdline(7) man ページに記載されている dracut オプションを使用することもできます。

  重要

  ディスクラベルを使用して特定のドライブを参照する場合 (例: inst.stage2=hd:LABEL=RHEL-10-BaseOS-x86_64)、すべてのスペースを \x20 に置き換えます。

• initrdefi: ロードする初期 RAM ディスク (initrd) イメージの場所。

• set timeout: デフォルトのメニューエントリーが自動的に使用される前に、ブートメニューが表示される時間の長さを決定します。デフォルト値は 60 です。つまり、メニューが 60 秒間表示されます。この値を -1 に設定すると、タイムアウトを完全に無効にします。

  注記

  この設定によりデフォルトのブートエントリーがすぐに有効になるため、ヘッドレスインストールの実行時にタイムアウトを 0 に設定すると便利です。

• submenu: submenu ブロックを使用すると、メインメニューにエントリーを表示する代わりに、サブメニューを作成してその下にいくつかのエントリーをグループ化できます。デフォルト設定の Troubleshooting サブメニューには、既存のシステムをレスキューするエントリーが含まれます。

  エントリーのタイトルは引用符または二重引用符 (' または ") です。

  submenu ブロックには上記のように 1 つ以上の menuentry 定義が含まれ、ブロック全体が中括弧 ({}) で囲まれています。以下に例を示します。

  submenu 'Submenu title' {
    menuentry 'Submenu option 1' {
      linuxefi /images/pxeboot/vmlinuz inst.stage2=hd:LABEL=RHEL-10-0-BaseOS-x86_64 nomodeset quiet
      initrdefi /images/pxeboot/initrd.img
    }
    menuentry 'Submenu option 2' {
      linuxefi /images/pxeboot/vmlinuz inst.stage2=hd:LABEL=RHEL-10-0-BaseOS-x86_64 inst.rescue quiet
      initrdefi /images/pxeboot/initrd.img
    }
  }

  Copy to Clipboard Toggle word wrap
• set default: デフォルトエントリーを決定します。エントリー番号は 0 から始まります。3 番目 のエントリーをデフォルトのエントリーに設定する場合は、set default=2 などを使用します。
• theme: GRUB2 テーマファイルを含むディレクトリーを決定します。テーマを使用して、ブートローダーの視覚的な要素 (背景、フォント、および特定の要素の色) をカスタマイズできます。

• ISO イメージをダウンロードしてデプロイメントしている。

• 独自のブランディングマネージメントを作成している。

  ブートイメージのダウンロードと抽出は、Red Hat Enterprise Linux ブートイメージの抽出 を参照してください。

• pykickstart - キックスタートファイルを解析し、検証します。また、インストールを動作させる値を保存するデータ構造も提供します。
• dnf - パッケージをインストールして依存関係を解決するパッケージマネージャー
• blivet - ストレージ管理に関連するすべてのアクティビティーを処理します。
• pyanaconda - キーボードおよびタイムゾーンの選択、ネットワーク設定、ユーザー作成など、Anaconda のユーザーインターフェイスおよびモジュールが含まれます。システム指向の機能を実行するためのさまざまなユーティリティーも提供します。
• python-meh - クラッシュ発生時に追加のシステム情報を収集して保存する例外ハンドラーを含みます。また、この情報を libreport ライブラリーに渡します。それ自体は ABRT プロジェクト に含まれます。
• dasbus - D-Bus ライブラリーと、anaconda のモジュールと外部コンポーネントとの通信を有効にします。
• python-simpleline - Anaconda テキストモードでユーザーの対話を管理するテキスト UI フレームワークライブラリー
• gtk - GUI を作成および管理する Gnome ツールキットライブラリー

• Boss - 内部モジュール検出、ライフサイクル、およびコーディネーションを管理します。
• Localization - ロケールを管理します。
• Network - ネットワークを処理します。
• Payloads - rpm、ostree、tar などの異なる形式でインストール用のデータを処理します。ペイロードはインストール用のデータのソースを管理します。ソースは CD-ROM、HDD、NFS、URL などの形式によって異なる可能性があります。
• Security - セキュリティー関連機能を管理します。
• Services - サービスを処理します。
• Storage - blivet を使用してストレージを管理します。
• Subscription - subscription-manager ツールと Red Hat Lightspeed を処理します。
• Timezone - 時間、日付、ゾーン、および時刻の同期を処理します。
• Users - ユーザーおよびグループを作成します。

• インストーラー画面をフォローする柔軟性。
• デフォルト設定を保持する柔軟性。
• 設定された値の概要を説明します。
• 拡張性をサポートします。ハブは、何も並べ替えることなく追加でき、複雑な順序の依存関係を解決できます。
• グラフィカルおよびテキストモードでのインストールをサポートします。

• ready: 到着できるかどうかを示します。たとえば、インストーラーがパッケージソースを設定している場合は、スポークがグレーで色化され、設定が完了するまでアクセスできません。
• completed - スポークが完了しているかどうかをマークします (必要なすべての値が設定されます)。
• mandatory - インストールを続行する前にスポークにアクセスする 必要がある かどうかを決定します。たとえば、ディスクの自動パーティション設定を使用する場合でも、Installation Destination スポークにアクセスする必要があります。
• status: (ハブのスポーク名で表示される) 内で設定された値の短いサマリーを提供します。

• 非同期呼び出しおよびリターンハンドラーを使用するプログラム
• 呼び出しが完了するまで呼び出しを待機する同期呼び出しを使用するプログラム

• 各インターフェイス (グラフィカルインターフェイスおよびテキストインターフェイス) のサポートは個別のサブパッケージで利用可能です。このサブパッケージには、グラフィカルインターフェイスには gui、テキストベースのインターフェイスには tui という名前が付けられています。
• gui および tui パッケージには、spokes サブパッケージが含まれています。^[1]
• パッケージに含まれるモジュールには任意の名前があります。
• gui/ および tui/ ディレクトリーには、任意の名前の Python モジュールを含めることができます。
• アドオンの実際の作業を実行するサービスがあります。このサービスは、Python またはその他の言語で記述できます。
• サービスは、D-Bus およびキックスタートのサポートを実装します。
• アドオンには、サービスの自動起動を有効にするファイルが含まれます。

• builderObjects: スポークの .glade ファイルからすべての最上位オブジェクトをリスト表示します。これは、子オブジェクトでスポークに (再帰的に) 公開される必要があります。すべてをスポークに公開する必要がある場合は、リストを空にする必要があります。
• mainWidgetName: .glade ファイルで定義されているようにメインウィンドウウィジェット (Add Link) の ID が含まれます。
• uiFile: .glade ファイルの名前が含まれます。
• category: スポークが属するカテゴリーのクラスが含まれます。
• icon: ハブ上のスポークに使用するアイコンの識別子が含まれます。
• title: ハブ上のスポークに使用するタイトルを定義します。

前提条件

• アドオンにキックスタートのサポートが含まれている。Anaconda アドオンの構造 を参照してください。
• Anaconda 固有の Gtk ウィジェット (SpokeWindow など) が含まれる anaconda-widgets および anaconda-widgets-devel パッケージがインストールされている。

手順

• アドオンのグラフィカルユーザーインターフェイス (GUI) のサポートを追加するには、次の例に従って、必要なすべての定義を含む次のモジュールを作成します。

  # will never be translated
  _ = lambda x: x
  N_ = lambda x: x
  
  # the path to addons is in sys.path so we can import things from org_fedora_hello_world
  from org_fedora_hello_world.gui.categories.hello_world import HelloWorldCategory
  from pyanaconda.ui.gui.spokes import NormalSpoke
  
  # export only the spoke, no helper functions, classes or constants
  all = ["HelloWorldSpoke"]
  
  class HelloWorldSpoke(FirstbootSpokeMixIn, NormalSpoke):
      """
      Class for the Hello world spoke. This spoke will be in the Hello world
      category and thus on the Summary hub. It is a very simple example of a unit
      for the Anaconda's graphical user interface. Since it is also inherited form
      the FirstbootSpokeMixIn, it will also appear in the Initial Setup (successor
      of the Firstboot tool).
  
      :see: pyanaconda.ui.common.UIObject
      :see: pyanaconda.ui.common.Spoke
      :see: pyanaconda.ui.gui.GUIObject
      :see: pyanaconda.ui.common.FirstbootSpokeMixIn
      :see: pyanaconda.ui.gui.spokes.NormalSpoke
  
      """
  
      # class attributes defined by API #
  
      # list all top-level objects from the .glade file that should be exposed
      # to the spoke or leave empty to extract everything
      builderObjects = ["helloWorldSpokeWindow", "buttonImage"]
  
      # the name of the main window widget
      mainWidgetName = "helloWorldSpokeWindow"
  
      # name of the .glade file in the same directory as this source
      uiFile = "hello_world.glade"
  
      # category this spoke belongs to
      category = HelloWorldCategory
  
      # spoke icon (will be displayed on the hub)
      # preferred are the -symbolic icons as these are used in Anaconda's spokes
      icon = "face-cool-symbolic"
  
      # title of the spoke (will be displayed on the hub)
      title = N_("_HELLO WORLD")

  Copy to Clipboard Toggle word wrap

  __all__ 属性は spoke クラスをエクスポートします。この後に、以前 GUI アドオンの基本機能 で言及した、属性の定義を含む定義の最初の行が続きます。これらの属性値は、com_example_hello_world/gui/spokes/hello.glade ファイルで定義されるウィジェットを参照します。この他に、以下の 2 つの重要な属性があります。

• category。この値は、com_example_hello_world.gui.categories モジュールの HelloWorldCategory クラスからインポートされます。アドオンへのパスが sys.path にある HelloWorldCategory。これにより、com_example_hello_world パッケージから値をインポートできます。category 属性は N_ function 名の一部で、変換用の文字列をマークしますが、変換は後の段階で行われるため、変換されていない文字列のバージョンを返します。

• title。この属性の定義にはアンダースコアが 1 つ含まれています。title 属性アンダースコアは、タイトル自体の先頭をマークし、Alt+H キーボードショートカットを使用してスポークに到達できるようにします。

  通常、クラス定義のヘッダーとクラス attributes の定義に続くのは、クラスのインスタンスを初期化するコンストラクターです。Anaconda グラフィカルインターフェイスオブジェクトの場合、新しいインスタンスの初期化には __init__ メソッドおよび initialize メソッドの 2 つのメソッドがあります。

  このようなメソッドが 2 つある理由は、spoke の初期化に時間がかかる可能性があるため、あるタイミングで GUI オブジェクトがメモリーに作成され、別のタイミングで完全に初期化される可能性があるためです。したがって、__init__ メソッドは親の __init__ メソッドのみを呼び出し、たとえば、GUI 以外の属性を初期化する必要があります。一方、インストーラーのグラフィカルユーザーインターフェイスの初期化時に呼び出される initialize メソッドは、スポークの完全な初期化を完了する必要があります。

  Hello World add-on の例で、以下のようにこの 2 つのメソッドを定義します。__init__ メソッドに渡される引数の数および説明をメモしてください。以下に例を示します。

  def __init__(self, data, storage, payload):
      """
      :see: pyanaconda.ui.common.Spoke.init
      :param data: data object passed to every spoke to load/store data
      from/to it
      :type data: pykickstart.base.BaseHandler
      :param storage: object storing storage-related information
      (disks, partitioning, boot loader, etc.)
      :type storage: blivet.Blivet
      :param payload: object storing packaging-related information
      :type payload: pyanaconda.packaging.Payload
  
      """
  
      NormalSpoke.init(self, data, storage, payload)
      self._hello_world_module = HELLO_WORLD.get_proxy()
  
  def initialize(self):
      """
      The initialize method that is called after the instance is created.
      The difference between init and this method is that this may take
      a long time and thus could be called in a separate thread.
      :see: pyanaconda.ui.common.UIObject.initialize
      """
      NormalSpoke.initialize(self)
      self._entry = self.builder.get_object("textLines")
      self._reverse = self.builder.get_object("reverseCheckButton")

  Copy to Clipboard Toggle word wrap

  __init__ メソッドに渡されるデータパラメーターは、すべてのデータが保存されるキックスタートファイルのメモリー内ツリーのような表示になります。ancestor の __init__ メソッドのいずれかで、self.data 属性に格納されます。これにより、クラス内の他のすべてのメソッドで構造の読み取りおよび修正が可能になります。

  注記

  RHEL10 以降、storage object は利用できなくなりました。アドオンがストレージ設定と対話する必要がある場合は、Storage DBus モジュールを使用します。

  HelloWorldData クラスは Hello World アドオンの例 ですでに定義されているため、このアドオンの self.data にはすでにサブツリーがあります。クラスのインスタンスである root は self.data.addons.com_example_hello_world として利用できます。

  ancestor の __init__ が実行するもう 1 つのアクションは、スポークの .glade ファイルを使用して GtkBuilder のインスタンスを初期化し、それを self.builder として保存することです。initialize メソッドは GtkBuilder を使用して、キックスタートファイルの %addon セクションにあるテキストを表示および変更するために使用される GtkTextEntry を取得します。

  __init__ および initialize メソッドは両方とも、スポークの作成時に重要となります。ただし、スポークの主なロールは、スポークの値の表示と設定を変更または確認したいユーザーがアクセスすることです。これを有効にするには、その他の 3 つの方法を使用できます。

• refresh: スポークがアクセスされようとするときに呼び出されます。このメソッドは、スポーク (主に UI 要素) の状態を更新し、表示されるデータが内部データ構造と一致するようにします。これにより、self.data 構造に保存されている現在の値が表示されるようにします。
• apply: スポークが残っている場合に呼び出され、UI 要素の値を self.data 構造に戻す際に使用されます。

• execute: ユーザーがスポークを離れる場合に呼び出され、スポークの新しい状態に基づいてランタイムの変更を実行する際に使用されます。

  これらの関数は、以下のように Hello World アドオンのサンプルに実装されます。

  def refresh(self):
      """
      The refresh method that is called every time the spoke is displayed.
      It should update the UI elements according to the contents of
      internal data structures.
      :see: pyanaconda.ui.common.UIObject.refresh
      """
      lines = self._hello_world_module.Lines
      self._entry.get_buffer().set_text("".join(lines))
      reverse = self._hello_world_module.Reverse
      self._reverse.set_active(reverse)
  
  def apply(self):
      """
      The apply method that is called when user leaves the spoke. It should
      update the D-Bus service with values set in the GUI elements.
      """
      buf = self._entry.get_buffer()
      text = buf.get_text(buf.get_start_iter(),
                          buf.get_end_iter(),
                          True)
      lines = text.splitlines(True)
      self._hello_world_module.SetLines(lines)
  
      self._hello_world_module.SetReverse(self._reverse.get_active())
  
  def execute(self):
    """
    The execute method that is called when the spoke is exited. It is
    supposed to do all changes to the runtime environment according to
    the values set in the GUI elements.
  
    """
  
    # nothing to do here
    pass

  Copy to Clipboard Toggle word wrap

  複数の追加のメソッドを使用して、スポークの状態を制御できます。

• ready: スポークへアクセスできるかどうかを判断します。値が "False" の場合は spoke へアクセスできません。たとえば、パッケージソースを設定する前に Package Selection スポークにアクセスできません。
• completed - スポークが完了しているかどうかを確認します。

• mandatory: スポークが必須かどうかを判別します。たとえば、自動パーティションを使用する場合でも、常にアクセスする必要がある Installation Destination スポークが必須かどうか判別します。

  これらの属性はすべて、インストールプロセスの現在の状態に基づいて動的に決定する必要があります。以下は、Hello World アドオンでのこれらのメソッドの実装例です。これには、HelloWorldData クラスの text 属性に特定の値を設定する必要があります。

  @property
  def ready(self):
      """
      The ready property reports whether the spoke is ready, that is, can be visited
      or not. The spoke is made (in)sensitive based on the returned value of the ready
      property.
  
      :rtype: bool
  
      """
  
      # this spoke is always ready
      return True
  
  
  @property
  def mandatory(self):
      """
      The mandatory property that tells whether the spoke is mandatory to be
      completed to continue in the installation process.
  
      :rtype: bool
  
      """
  
      # this is an optional spoke that is not mandatory to be completed
      return False

  Copy to Clipboard Toggle word wrap

  これらのプロパティーが定義された後、スポークはそのアクセス可能性と完全性を制御できますが、内部で設定された値のサマリーを提供することはできません。スポークにアクセスして、スポークがどのように設定されているかを確認する必要がありますが、これは望ましくない場合があります。このため、status という追加のプロパティーが存在します。このプロパティーには、設定された値の短いサマリーを含む 1 行のテキストが含まれ、スポークタイトルの下のハブに表示することができます。

  status プロパティーは、以下のように Hello World の例のアドオンで定義されます。

  @property
  def status(self):
      """
      The status property that is a brief string describing the state of the
      spoke. It should describe whether all values are set and if possible
      also the values themselves. The returned value will appear on the hub
      below the spoke's title.
      :rtype: str
      """
      lines = self._hello_world_module.Lines
      if not lines:
          return _("No text added")
      elif self._hello_world_module.Reverse:
          return _("Text set with {} lines to reverse").format(len(lines))
      else:
          return _("Text set with {} lines").format(len(lines))

  Copy to Clipboard Toggle word wrap

  例で説明しているプロパティーをすべて定義した後に、アドオンには、グラフィカルユーザーインターフェイス (GUI) とキックスタートを示す完全なサポートがあります。

  注記

  ここで示した例は非常にシンプルで、制御を含むものはありません。GUI で機能的かつインタラクティブなスポークを開発するには、Python Gtk プログラミングに関する知識が必要です。

  主な制限の 1 つとして、それぞれのスポークに独自のメインウィンドウ (SpokeWindow ウィジェットのインスタンス) が必要である点が挙げられます。このウィジェットは、Anaconda 固有の他のウィジェットとともに、anaconda-widgets パッケージにあります。Glade など、GUI サポートでアドオンの開発に必要な他のファイルは、anaconda-widgets-devel パッケージで見つけることができます。

  グラフィカルインターフェイスのサポートモジュールに必要なメソッドをすべて含めたら、次のセクションに進み、テキストベースのユーザーインターフェイスのサポートを追加できます。

• カーソルの移動には対応していません。代わりに、ラインプリンターのように動作します。
• 視覚的機能拡張 (異なる色やフォントの使用など) はサポートしません。

• title: GUI の title 引数と同様にスポークのタイトルを決定します。
• category: スポークのカテゴリーを文字列として判別します。カテゴリー名はどこにも表示されず、グループ化にのみ使用されます。

前提条件

• Anaconda add-on structure の説明に従って、tui ディレクトリーに新しいサブパッケージセットを作成している。

手順

• 以下の例に従って、アドオン Text User Interface (TUI) のサポートを追加するために必要なすべての定義を含むモジュールを作成します。

  class HelloWorldSpoke(NormalTUISpoke):
      # category this spoke belongs to
      category = HelloWorldCategory
  
  def init(self, *args, kwargs): """ Create the representation of the spoke. :see: simpleline.render.screen.UIScreen """ super().init(*args, kwargs)
      self.title = N_("Hello World")
      self._hello_world_module = HELLO_WORLD.get_proxy()
      self._container = None
      self._reverse = False
      self._lines = ""
  
  def initialize(self):
      """
      The initialize method that is called after the instance is created.
      The difference between init and this method is that this may take
      a long time and thus could be called in a separated thread.
  
      :see: pyanaconda.ui.common.UIObject.initialize
      """
      # nothing to do here
      super().initialize()
  
  def setup(self, args=None):
      """
      The setup method that is called right before the spoke is entered.
      It should update its state according to the contents of DBus modules.
  
      :see: simpleline.render.screen.UIScreen.setup
      """
      super().setup(args)
  
      self._reverse = self._hello_world_module.Reverse
      self._lines = self._hello_world_module.Lines
  
      return True
  
  def refresh(self, args=None):
      """
      The refresh method that is called every time the spoke is displayed.
      It should generate the UI elements according to its state.
  
      :see: pyanaconda.ui.common.UIObject.refresh
      :see: simpleline.render.screen.UIScreen.refresh
      """
      super().refresh(args)
  
      self._container = ListColumnContainer(
          columns=1
      )
      self._container.add(
          CheckboxWidget(
              title="Reverse",
              completed=self._reverse
          ),
          callback=self._change_reverse
      )
      self._container.add(
          EntryWidget(
              title="Hello world text",
              value="".join(self._lines)
          ),
          callback=self._change_lines
      )
  
      self.window.add_with_separator(self._container)
  
  def _change_reverse(self, data):
      """
      Callback when user wants to switch checkbox.
      Flip state of the "reverse" parameter which is boolean.
      """
      self._reverse = not self._reverse
  
  def _change_lines(self, data):
      """
      Callback when user wants to input new lines.
      Show a dialog and save the provided lines.
      """
      dialog = Dialog("Lines")
      result = dialog.run()
      self._lines = result.splitlines(True)
  
  def input(self, args, key):
      """
      The input method that is called by the main loop on user's input.
  
      * If the input should not be handled here, return it.
      * If the input is invalid, return InputState.DISCARDED.
      * If the input is handled and the current screen should be refreshed,
        return InputState.PROCESSED_AND_REDRAW.
      * If the input is handled and the current screen should be closed,
        return InputState.PROCESSED_AND_CLOSE.
  
      :see: simpleline.render.screen.UIScreen.input
      """
      if self._container.process_user_input(key):
          return InputState.PROCESSED_AND_REDRAW
  
      if key.lower() == Prompt.CONTINUE:
          self.apply()
          self.execute()
          return InputState.PROCESSED_AND_CLOSE
  
      return super().input(args, key)
  
  def apply(self):
      """
      The apply method is not called automatically for TUI. It should be called
      in input() if required. It should update the contents of internal data
      structures with values set in the spoke.
      """
      self._hello_world_module.SetReverse(self._reverse)
      self._hello_world_module.SetLines(self._lines)
  
  def execute(self):
      """
      The execute method is not called automatically for TUI. It should be called
      in input() if required. It is supposed to do all changes to the runtime
      environment according to the values set in the spoke.
      """
      # nothing to do here
      pass

  Copy to Clipboard Toggle word wrap

  詳細と最新のコードは、Hello World Anaconda Addon - GitHub Repository を参照してください。

  注記

  ancestor の init のみを呼び出す場合は init メソッドを上書きする必要はありませんが、この例のコメントでは、一般的な方法でスポーククラスのコンストラクターへ渡された引数を記述します。

  上の例では、以下のようになります。

• setup メソッドは、各エントリーのスポークの内部属性のデフォルト値を設定します。これは、refresh メソッドによって表示され、input メソッドによって更新され、apply メソッドによって使用されて内部データ構造を更新します。
• execute メソッドの目的は、GUI の同等のメソッドの目的と同じです。この場合、このメソッドは効果がありません。
• input メソッドはテキストインターフェイスに固有のものです。キックスタートまたは GUI には同等のものはありません。input メソッドはユーザーの対話を行います。
• input メソッドは、入力された文字列を処理し、そのタイプと値に応じてアクションを取ります。上記の例は値を要求してから、それを内部属性 (キー) として保存します。より複雑なアドオンでは、通常、文字をアクションとして解析したり、数値を整数に変換したり、追加の画面を表示したり、ブール値を切り替えたりするなど、重要なアクションを実行する必要があります。

• この入力を別の画面で処理する必要がある場合に備えて、入力クラスの return 値は、InputState enum または input 文字列自体のいずれかである必要があります。グラフィカルモードとは対照的に、apply メソッドと execute メソッドは、スポークを離れるときに自動的に呼び出されません。入力メソッドから明示的に呼び出す必要があります。スポークの画面を閉じる (非表示にする) 場合も同様です。close メソッドから明示的に呼び出す必要があります。

  別のスポークで入力した追加情報が必要な場合など、別の画面を表示するには、別の TUIObject をインスタンス化し、ScreenHandler.push_screen_modal() を使用してそれを表示します。

  テキストベースのインターフェイスの制限により、TUI スポークは非常によく似た構造を持つ傾向があり、ユーザーがチェックまたはチェックを外して入力する必要があるチェックボックスまたはエントリーのリストで構成されます。

前提条件

• Anaconda アドオン構造 で説明されているように、TUI ディレクトリーの下に新しいサブパッケージのセットを追加しました。

手順

• 以下の例に従って、アドオン Text User Interface (TUI) のサポートを追加するために必要なすべての定義を含むモジュールを作成します。

  class HelloWorldEditSpoke(NormalTUISpoke):
      """Example class demonstrating usage of editing in TUI"""
      category = HelloWorldCategory
  
      def init(self, data, storage, payload):
          """
          :see: simpleline.render.screen.UIScreen
          :param data: data object passed to every spoke to load/store data
                       from/to it
          :type data: pykickstart.base.BaseHandler
          :param storage: object storing storage-related information
                          (disks, partitioning, boot loader, etc.)
          :type storage: blivet.Blivet
          :param payload: object storing packaging-related information
          :type payload: pyanaconda.packaging.Payload
          """
          super().init(self, *args, **Kwargs)
  
          self.title = N_("Hello World Edit")
          self._container = None
  
          # values for user to set
          self._checked = False
          self._unconditional_input = ""
          self._conditional_input = ""
  
      def refresh(self, args=None):
          """
          The refresh method that is called every time the spoke is displayed.
          It should update the UI elements according to the contents of self.data.
          :see: pyanaconda.ui.common.UIObject.refresh
          :see: simpleline.render.screen.UIScreen.refresh
          :param args: optional argument that may be used when the screen is
                       scheduled
          :type args: anything
          """
          super().refresh(args)
          self._container = ListColumnContainer(columns=1)
  
          # add ListColumnContainer to window (main window container)
          # this will automatically add numbering and will call callbacks when required
          self.window.add(self._container)
  
          self._container.add(CheckboxWidget(title="Simple checkbox", completed=self._checked),
                              callback=self._checkbox_called)
          self._container.add(EntryWidget(title="Unconditional text input",
                                          value=self._unconditional_input),
                              callback=self._get_unconditional_input)
  
          # show conditional input only if the checkbox is checked
          if self._checked:
              self._container.add(EntryWidget(title="Conditional password input",
                                              value="Password set" if self._conditional_input
                                              else ""),
                                  callback=self._get_conditional_input)
  
          self.window.add_with_separator(self._container)
  
      def _checkbox_called(self, data):  # pylint: disable=unused-argument
          """Callback when user wants to switch checkbox.
  
          :param data: can be passed when adding callback in container (not used here)
          :type data: anything
          """
          self._checked = not self._checked
  
      def _get_unconditional_input(self, data):  # pylint: disable=unused-argument
          """Callback when the user wants to set unconditional input.
  
          :param data: can be passed when adding callback in container (not used here)
          :type data: anything
          """
          dialog = Dialog(
              "Unconditional input",
              conditions=[self._check_user_input]
          )
          self._unconditional_input = dialog.run()
  
      def _get_conditional_input(self, data):  # pylint: disable=unused-argument
          """Callback when the user wants to set conditional input.
  
          :param data: can be passed when adding callback in container (not used here)
          :type data: anything
          """
          dialog = PasswordDialog(
              "Unconditional password input",
              policy_name=PASSWORD_POLICY_ROOT
          )
          self._conditional_input = dialog.run()
  
      def _check_user_input(self, user_input, report_func):
          """Check if the user has written a valid value.
  
          :param user_input: user input for validation
          :type user_input: str
  
          :param report_func: function for reporting errors on user input
          :type report_func: func with one param
          """
          if re.match(r'^\w+$', user_input):
              return True
          else:
              report_func("You must set at least one word")
              return False
  
      def input(self, args, key):
          """
          The input method that is called by the main loop on user's input.
  
          :param args: optional argument that may be used when the screen is
                       scheduled
          :type args: anything
          :param key: user's input
          :type key: unicode
          :return: if the input should not be handled here, return it, otherwise
                   return InputState.PROCESSED or InputState.DISCARDED if the input was
                   processed successfully or not respectively
          :rtype: enum InputState
          """
          if self._container.process_user_input(key):
              return InputState.PROCESSED_AND_REDRAW
          else:
              return super().input(args, key)
  
  
      @property
      def completed(self):
          # completed if user entered something non-empty to the Conditioned input
          return bool(self._conditional_input)
  
      @property
      def status(self):
          return "Hidden input %s" % ("entered" if self._conditional_input
                                      else "not entered")
  
      def apply(self):
          # nothing needed here, values are set in the self.args tree
          pass

  Copy to Clipboard Toggle word wrap

  詳細と最新のコードは、Hello World NormalTUISpoke - GitHub Repository を参照してください。

前提条件

• アドオンを作成している。
• D-Bus ファイルにアクセスできる。
• lorax パッケージがインストールされている。