models.py

"""Types for cli2gui."""

from __future__ import annotations

from collections.abc import Callable
from dataclasses import dataclass
from enum import Enum
from typing import Any

SEP = "#%#"


@dataclass
class BuildSpec:
	"""Representation for the BuildSpec."""

	run_function: Callable[..., Any]
	parser: str | ParserType
	gui: str | GUIType
	theme: str | list[str]
	darkTheme: str | list[str]
	image: str
	program_name: str
	program_description: str
	max_args_shown: int
	menu: str | dict[str, Any]


@dataclass
class Item:
	"""Representation for an arg_item."""

	type: ItemType
	display_name: str
	commands: list[str]
	help: str
	dest: str
	default: Any
	required: bool = False
	choices: list[Any] = None
	nargs: str = None
	additional_properties: dict[str, Any] = None


class ItemType(Enum):
	"""Enum of ItemTypes."""

	RadioGroup = "RadioGroup"
	Bool = "Bool"
	File = "File"
	FileWrite = "FileWrite"
	Path = "Path"
	Choice = "Choice"
	Int = "Int"
	Text = "Text"
	Float = "Float"
	List = "List"
	Tuple = "Tuple"
	DateTime = "DateTime"


@dataclass
class Group:
	"""Representation for an argument group."""

	name: str
	arg_items: list[Item]
	groups: list[Group] | list[Any]


@dataclass
class ParserRep:
	"""Representation for a parser."""

	parser_description: str
	widgets: list[Group]


@dataclass
class FullBuildSpec:
	"""Representation for the FullBuildSpec (BuildSpec + ParserRep)."""

	run_function: Callable[..., Any]
	parser: str
	gui: str
	theme: str | list[str]
	darkTheme: str | list[str]
	image: str
	program_name: str
	program_description: str
	max_args_shown: int
	menu: str | dict[str, Any]
	parser_description: str
	widgets: list[Group]


# Supported parser types
class ParserType(str, Enum):
	"""Supported parser types.

	"""

	OPTPARSE = "optparse"
	ARGPARSE = "argparse"
	DEPHELL_ARGPARSE = "dephell_argparse"
	DOCOPT = "docopt"
	GETOPT = "getopt"
	CLICK = "click"
	CUSTOM = "input()"  # this seems like a pretty poor pattern to use


# Supported gui types
class GUIType(str, Enum):
	"""Supported gui types.

	"""

	PSG = "pysimplegui"
	WEB = "pysimpleguiweb"
	QT = "pysimpleguiqt"
	FSG = "freesimplegui"
	FSGWEB = "freesimpleguiweb"
	FSGQT = "freesimpleguiqt"
	DPG = "dearpygui"