khiops.core.internals.common

Submodule of khiops.core.internals

Common utility functions and classes

CLASS	DESCRIPTION
`SystemSettings`	Khiops system settings
`CommandLineOptions`	Khiops command line options

FUNCTION	DESCRIPTION
`type_error_message`	Formats a type error message
`invalid_keys_message`	Formats an invalid keyword parameter message
`deprecation_message`	Formats a deprecation message
`is_string_like`	Returns True if an object is a valid Python string or sequence of bytes
`is_list_like`	Returns True if an object is list-like
`is_dict_like`	Returns True if an object is dict-like
`is_iterable`	Return True if a container object is iterable, but not string-like

Classes

Khiops system settings

Note

These settings are not available in the CommandLineOptions.

See class docstring

METHOD	DESCRIPTION
`check`	Checks the types of the system settings

Checks the types of the system settings

RAISES	DESCRIPTION
`TypeError`	If any of the system settings does not have the proper type.
`ValueError`	If `max_cores` or `memory_limit_mb` are set to negative numbers.

Khiops command line options

ATTRIBUTE	DESCRIPTION
`log_file_path`	Path of the log file for the Khiops process (command line option `-e` of the desktop app). If equal to "" then it writes no log file. TYPE: `str, default ""`
`output_scenario_path`	Path of the output Khiops scenario file (command line option `-o` of the desktop app). If the empty string is specified no output scenario file is generated. TYPE: `str, default ""`
`task_file_path`	Path of the task file for the Khiops process (command line option `-p` of the desktop app). If equal to "" then it writes no task file. TYPE: `str, default ""`

See class docstring

METHOD	DESCRIPTION
`check`	Checks the types of the command line options

Checks the types of the command line options

RAISES	DESCRIPTION
`TypeError`	If any of the command line options does not have the proper type.

Formats a type error message

PARAMETER	DESCRIPTION
`variable_name`	Name of the variable for whom the type error is signaled. TYPE: `str`
`variable`	Actual variable for whom the type error is signaled. TYPE: `any`
`target_types`	Expected types for `variable`, either as a type or as a string. TYPE: `list` DEFAULT: `()`

RETURNS	DESCRIPTION
`str`	The type error message.

Formats an invalid keyword parameter message

Formats a deprecation message

Returns True if an object is a valid Python string or sequence of bytes

Returns True if an object is list-like

An object is list-like if and only if inherits from collections.abc.Sequence and it is not string-like <is_string_like>

Returns True if an object is dict-like

An object is dict-like if and only if inherits from the collections.abc.Mapping.

Return True if a container object is iterable, but not string-like