khiops.core.helpers.build_multi_table_dictionary_domain does not behave as expected

[tramora]

Description

When using khiops.core.helpers.build_multi_table_dictionary_domain a user @MathieuCoupe does not get what he expects
(the root table appears twice in the dictionary and the additional table is missing)

Questions/Ideas

The user rewrote a quick version of the function that would fullfil his need

def build_multi_table_dictionary(root: Dictionary, secondary: Dictionary) -> DictionaryDomain:
    # Build and initialize root target dictionary from the input dictionary domain
    root_target_dictionary = Dictionary()
    root_target_dictionary.name = root.name
    root_target_dictionary.key = root.key
    root_target_dictionary.root = True

    # Copy the variables from source dictionary to target dictionary
    for source_variable in root.variables:
        root_target_dictionary.add_variable(source_variable)

    # Build target variable for the target root dictionary
    target_variable = Variable()
    target_variable.name = secondary.name
    target_variable.type = "Table"
    target_variable.object_type = secondary.name
    root_target_dictionary.add_variable(target_variable)

    # copy the secondary dictionary
    secondary_target_dictionary = secondary.copy()

    # Build target domain and add dictionaries to it
    result = DictionaryDomain()
    result.add_dictionary(root_target_dictionary)
    result.add_dictionary(secondary_target_dictionary)

    return result

[MathieuCoupe]

Result from api method:

root_dictionary.add_dictionary(cdrs_dictionary.get_dictionary('CDRs'))
mt_dict = kh.build_multi_table_dictionary_domain(dictionary_domain=root_dictionary, root_dictionary_name='root', secondary_table_variable_name='CDRs')
print(mt_dict)

gives:

#Khiops 

Root	Dictionary	root	(trio_event_emitter)
{
	Categorical	trio_event_emitter		;	
	Table(root)	CDRs		;	
};

Dictionary	root	(trio_event_emitter)
{
	Categorical	trio_event_emitter		;	
	Categorical	label		;	
	Numerical	random		;	
};

Result from custom method:

mt_dict = build_multi_table_dictionary(root=root_dictionary.get_dictionary('root'), secondary=cdrs_dictionary.get_dictionary('CDRs'))
print(mt_dict)

#Khiops 
Root	Dictionary	root	(trio_event_emitter)
{
	Categorical	trio_event_emitter		;	
	Categorical	label		;	
	Numerical	random		;	
	Table(CDRs)	CDRs		;	
};
Dictionary	CDRs	(trio_event_emitter)
{
	Numerical	fact_1_a		;	
	Numerical	fact_1_b		;	
	Numerical	fact_1_c		;	
	Numerical	fact_1_d		;	
	Numerical	fact_1_e		;	
	Numerical	fact_2_a		;	
	Numerical	fact_2_b		;	
	Numerical	fact_2_c		;	
	Numerical	fact_2_d		;	
	Numerical	fact_2_e		;	
	Numerical	fact_3_a		;	
	Numerical	fact_3_b		;	
	Numerical	fact_3_c		;	
	Numerical	fact_3_d		;	
	Numerical	fact_3_e		;	
	Categorical	trio_event_emitter		;	
	Numerical	trio_event_emitter_suffix		;	
};

[tramora]

@MathieuCoupe : this build_multi_table_dictionary_domain helper function (with a misleading name) has an internal purpose and should not have been exposed. It will be marked "deprecated" and removed in the next major version (v11 family).

The only way to create a multi-tables dictionary is what you did in your utility function :
creating Dictionary instances and adding them to a DictionaryDomain. There is no such coarse grain function that would create a dictionary in one call.

[popescu-v]

Improving the docstring of this function can be envisaged for the next release.

[popescu-v]

Closed as done by PR #395