Skip to content

Use declarative summary method for all sub-configs #4739

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
svartkanin wants to merge 12 commits into
base: master
Choose a base branch
from
Open

Use declarative summary method for all sub-configs #4739

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
c66ca3f
Refactor configuration file
svartkanin Jun 9, 2026
0ed4ab7
Merge remote-tracking branch 'origin/master' into refactor-config
dgirtler Aug 11, 2026
e75e775
Update
dgirtler Aug 11, 2026
b65f591
Merge remote-tracking branch 'origin/master' into refactor-config
svartkanin Aug 30, 2026
6c21490
Merge remote-tracking branch 'origin/master' into refactor-config
svartkanin Aug 30, 2026
e96ca1b
Update
svartkanin Aug 30, 2026
303f7f4
Update
svartkanin Aug 30, 2026
ab7e458
Update
svartkanin Aug 30, 2026
015a74b
Merge remote-tracking branch 'origin/master' into refactor-config
svartkanin Aug 31, 2026
f2be09c
Fix tests
svartkanin Aug 31, 2026
2cfda8e
Update
svartkanin Sep 25, 2026
0d49ce2
Merge remote-tracking branch 'origin/master' into refactor-config
svartkanin Sep 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 8 additions & 58 deletions archinstall/lib/args.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
from archinstall.lib.models.application import ApplicationConfiguration, ZramConfiguration
from archinstall.lib.models.authentication import AuthenticationConfiguration
from archinstall.lib.models.bootloader import Bootloader, BootloaderConfiguration
from archinstall.lib.models.config import SubConfig
from archinstall.lib.models.config import SubConfig, SummaryLevel
from archinstall.lib.models.device import DiskEncryption, DiskLayoutConfiguration
from archinstall.lib.models.locale import LocaleConfiguration
from archinstall.lib.models.mirrors import MirrorConfiguration
Expand Down Expand Up @@ -95,55 +95,6 @@ class ArchConfigType(StrEnum):
PACMAN_CONFIG = auto()
CUSTOM_COMMANDS = auto()

def text(self) -> str:
match self:
case ArchConfigType.ARCHINSTALL_LANGUAGE:
return tr('ArchInstall Language')
case ArchConfigType.VERSION:
return tr('Version')
case ArchConfigType.SCRIPT:
return tr('Installation Script')
case ArchConfigType.LOCALE_CONFIG:
return tr('Locales')
case ArchConfigType.DISK_CONFIG:
return tr('Disk configuration')
case ArchConfigType.PROFILE_CONFIG:
return tr('Profile')
case ArchConfigType.MIRROR_CONFIG:
return tr('Mirrors and repositories')
case ArchConfigType.NETWORK_CONFIG:
return tr('Network')
case ArchConfigType.BOOTLOADER_CONFIG:
return tr('Bootloader')
case ArchConfigType.APP_CONFIG:
return tr('Application')
case ArchConfigType.AUTH_CONFIG:
return tr('Authentication')
case ArchConfigType.SWAP:
return tr('Swap')
case ArchConfigType.HOSTNAME:
return tr('Hostname')
case ArchConfigType.KERNELS:
return tr('Kernels')
case ArchConfigType.NTP:
return tr('Automatic time sync (NTP)')
case ArchConfigType.TIMEZONE:
return tr('Timezone')
case ArchConfigType.SERVICES:
return tr('Services')
case ArchConfigType.PACKAGES:
return tr('Additional packages')
case ArchConfigType.PACMAN_CONFIG:
return tr('Pacman')
case ArchConfigType.CUSTOM_COMMANDS:
return tr('Custom commands')
case ArchConfigType.USERS:
return tr('Users')
case ArchConfigType.ROOT_ENC_PASSWORD:
return tr('Root encrypted password')
case ArchConfigType.ENCRYPTION_PASSWORD:
return tr('Disk encryption password')


USER_CONFIG_FILE: Path = Path('user_configuration.json')
USER_CREDS_FILE: Path = Path('user_credentials.json')
Expand Down Expand Up @@ -442,7 +393,7 @@ def save_user_creds(
target.write_text(data)
target.chmod(stat.S_IRUSR | stat.S_IWUSR | stat.S_IRGRP)

def as_summary(self) -> str:
def as_summary(self, level: SummaryLevel = SummaryLevel.BASIC) -> str:
"""
Render a concise two-column summary of the current configuration.

Expand All @@ -451,15 +402,14 @@ def as_summary(self) -> str:
cfg: dict[str, str | list[str] | bool] = {}

for key, value in self.plain_cfg().items():
cfg[key.text()] = value

for config_type, obj in self.sub_cfg().items():
if not hasattr(obj, 'summary'):
continue
if isinstance(value, list):
value = ', '.join(value)
cfg[key.title()] = value

summary = obj.summary()
for sub_config in self.sub_cfg().values():
summary = sub_config.summary(level)

@codefiles codefiles Sep 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The level default (SummaryLevel.Basic) can be removed from all the summary methods if only as_summary calls them. as_summary already has SummaryLevel.Basic as the default for level and passes it to the summary methods here. If this is unnecessary duplication of the default, make level required for summary methods by removing the default from their parameters.

@svartkanin svartkanin Sep 25, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Explained in the comment above, this is the first use case for the new summary. In a follow up I'll use it for the installation confirmation screen as well which needs all the detailed setting summaries

if summary:
cfg[config_type.text()] = summary
cfg[sub_config.NAME] = summary

simple_summary = as_key_value_pair(cfg, ignore_empty=True)

Expand Down
116 changes: 82 additions & 34 deletions archinstall/lib/models/application.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from enum import StrEnum, auto
from typing import Any, NotRequired, Self, TypedDict, override

from archinstall.lib.models.config import SubConfig
from archinstall.lib.models.config import SubConfig, SummaryLevel
from archinstall.lib.translationhandler import tr


Expand Down Expand Up @@ -85,14 +85,21 @@ class ApplicationSerialization(TypedDict):


@dataclass
class AudioConfiguration:
class AudioConfiguration(SubConfig):
audio: Audio

NAME: str = tr('Audio')

@override
def json(self) -> AudioConfigSerialization:
return {
'audio': self.audio.value,
}

@override
def summary(self, level: SummaryLevel = SummaryLevel.BASIC) -> list[str]:

@codefiles codefiles Sep 26, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

level will need to be changed to _level for some summary methods because of a5e7446.

return [self.audio.value]

@classmethod
def parse_arg(cls, arg: dict[str, Any]) -> Self:
return cls(
Expand All @@ -101,26 +108,42 @@ def parse_arg(cls, arg: dict[str, Any]) -> Self:


@dataclass
class BluetoothConfiguration:
class BluetoothConfiguration(SubConfig):
enabled: bool

NAME: str = tr('Bluetooth')

@override
def json(self) -> BluetoothConfigSerialization:
return {'enabled': self.enabled}

@override
def summary(self, level: SummaryLevel = SummaryLevel.BASIC) -> list[str]:
if self.enabled:
return [tr('enabled')]
return []

@classmethod
def parse_arg(cls, arg: BluetoothConfigSerialization) -> Self:
return cls(arg['enabled'])


@dataclass
class PowerManagementConfiguration:
class PowerManagementConfiguration(SubConfig):
power_management: PowerManagement

NAME: str = tr('Power management')

@override
def json(self) -> PowerManagementConfigSerialization:
return {
'power_management': self.power_management.value,
}

@override
def summary(self, level: SummaryLevel = SummaryLevel.BASIC) -> list[str]:
return [self.power_management.value]

@classmethod
def parse_arg(cls, arg: PowerManagementConfigSerialization) -> Self:
return cls(
Expand All @@ -129,26 +152,42 @@ def parse_arg(cls, arg: PowerManagementConfigSerialization) -> Self:


@dataclass
class PrintServiceConfiguration:
class PrintServiceConfiguration(SubConfig):
enabled: bool

NAME: str = tr('Print service')

@override
def json(self) -> PrintServiceConfigSerialization:
return {'enabled': self.enabled}

@override
def summary(self, level: SummaryLevel = SummaryLevel.BASIC) -> list[str]:
if self.enabled:
return [tr('enabled')]
return []

@classmethod
def parse_arg(cls, arg: PrintServiceConfigSerialization) -> Self:
return cls(arg['enabled'])


@dataclass
class FirewallConfiguration:
class FirewallConfiguration(SubConfig):
firewall: Firewall

NAME: str = tr('Firewall')

@override
def json(self) -> FirewallConfigSerialization:
return {
'firewall': self.firewall.value,
}

@override
def summary(self, level: SummaryLevel = SummaryLevel.BASIC) -> list[str]:
return [self.firewall.value]

@classmethod
def parse_arg(cls, arg: dict[str, Any]) -> Self:
return cls(
Expand All @@ -157,12 +196,21 @@ def parse_arg(cls, arg: dict[str, Any]) -> Self:


@dataclass
class FontsConfiguration:
class FontsConfiguration(SubConfig):
fonts: list[FontPackage]

NAME: str = tr('Fonts')

@override
def json(self) -> FontsConfigSerialization:
return {'fonts': [f.value for f in self.fonts]}

@override
def summary(self, level: SummaryLevel = SummaryLevel.BASIC) -> list[str]:
if self.fonts:
return [', '.join(f.value for f in self.fonts)]
return []

@classmethod
def parse_arg(cls, arg: FontsConfigSerialization) -> Self:
return cls(fonts=[FontPackage(f) for f in arg['fonts']])
Expand All @@ -173,6 +221,8 @@ class ZramConfiguration(SubConfig):
enabled: bool
algorithm: ZramAlgorithm = ZramAlgorithm.ZSTD

NAME: str = tr('Zram')

@classmethod
def parse_arg(cls, arg: bool | dict[str, Any]) -> Self:
if isinstance(arg, bool):
Expand All @@ -190,16 +240,14 @@ def json(self) -> dict[str, bool | str]:
}

@override
def summary(self) -> list[str] | None:
out: list[str] = []

def summary(self, level: SummaryLevel = SummaryLevel.BASIC) -> list[str]:
if self.enabled:
out.append(tr('Zram enabled'))

out.append(tr('Zram algorithm {}').format(self.algorithm))
return out
return [
tr('enabled'),
tr('Algorithm "{}"').format(self.algorithm),
]

return None
return [tr('Zram disabled')]


@dataclass
Expand All @@ -211,6 +259,8 @@ class ApplicationConfiguration(SubConfig):
firewall_config: FirewallConfiguration | None = None
fonts_config: FontsConfiguration | None = None

NAME: str = tr('Application')

@classmethod
def parse_arg(
cls,
Expand Down Expand Up @@ -268,26 +318,24 @@ def json(self) -> ApplicationSerialization:
return config

@override
def summary(self) -> list[str]:
out: list[str] = []

if self.bluetooth_config and self.bluetooth_config.enabled:
out.append(tr('Bluetooth enabled'))

if self.audio_config:
out.append(tr('Audio server "{}"').format(self.audio_config.audio))
def summary(self, level: SummaryLevel = SummaryLevel.BASIC) -> list[str]:
configs = [
self.bluetooth_config,
self.audio_config,
self.power_management_config,
self.print_service_config,
self.firewall_config,
self.fonts_config,
]

if self.power_management_config:
out.append(tr('Power management "{}"').format(self.power_management_config.power_management))

if self.print_service_config and self.print_service_config.enabled:
out.append(tr('Print service enabled'))

if self.firewall_config:
out.append(tr('Firewall "{}"').format(self.firewall_config.firewall))
out: list[str] = []

if self.fonts_config and self.fonts_config.fonts:
fonts = ', '.join(f.value for f in self.fonts_config.fonts)
out.append(tr('Extra fonts "{}"').format(fonts))
for config in configs:
if config:
summary = config.summary(level)
if len(summary) == 1:
out.append(f'{config.NAME} "{summary[0]}"')
else:
out.append('?????')

return out
Loading
Loading