python.GeneratorSettingsSemantics.GeneratorSettingsSemantics Class Reference

Inheritance diagram for python.GeneratorSettingsSemantics.GeneratorSettingsSemantics:

Collaboration diagram for python.GeneratorSettingsSemantics.GeneratorSettingsSemantics:

Public Member Functions
	__init__ (self, cpp_type)
	store (self, assigned_value)
	default (self, default_commands)
	merge (self, current_value, incoming_value)
	opt_value (self, stored_value)

Static Private Attributes
list	__handled_types__ = [re.compile(r"^GeneratorSettings<.*>$")]

Detailed Description

Semantics for generator settings properties.

Gaudi sees the property as a sequence of strings, but CA merging receives
GeneratorSettingsLayer objects so fragments can be combined by precedence
before the final list is handed to the C++ component.

Definition at line 210 of file GeneratorSettingsSemantics.py.

Constructor & Destructor Documentation

__init__()

python.GeneratorSettingsSemantics.GeneratorSettingsSemantics.__init__	(		self,
			cpp_type )

Definition at line 220 of file GeneratorSettingsSemantics.py.

    def __init__(self, cpp_type):
        # SequenceSemantics needs the element semantics even though we store a
        # custom helper value instead of Gaudi's normal list helper.
        super().__init__(cpp_type, valueSem=getSemanticsFor("std::string"))
 

Member Function Documentation

default()

python.GeneratorSettingsSemantics.GeneratorSettingsSemantics.default	(		self,
			default_commands )

Store C++ defaults as the lowest-precedence command layer.

Definition at line 242 of file GeneratorSettingsSemantics.py.

    def default(self, default_commands):
        """Store C++ defaults as the lowest-precedence command layer."""
        if not default_commands:
            return GeneratorSettingsValue()
        if isinstance(default_commands, str):
            raise TypeError("generator settings must be assigned from a sequence")
        return GeneratorSettingsValue([
            GeneratorSettingsLayer(
                source=self.name or "<default>",
                values=tuple(default_commands or ()),
                precedence=GeneratorSettingsPrecedence.BASE,
                report_context=self.name,
            )
        ])
 

merge()

python.GeneratorSettingsSemantics.GeneratorSettingsSemantics.merge	(		self,
			current_value,
			incoming_value )

Merge two unresolved layer sets during CA merging.

Definition at line 257 of file GeneratorSettingsSemantics.py.

    def merge(self, current_value, incoming_value):
        """Merge two unresolved layer sets during CA merging."""
        current_settings = self.store(current_value)
        incoming_settings = self.store(incoming_value)
        return GeneratorSettingsValue(
            current_settings.layers + incoming_settings.layers
        )
 

opt_value()

python.GeneratorSettingsSemantics.GeneratorSettingsSemantics.opt_value	(		self,
			stored_value )

Return the final plain command list.
This is the point where all layers are resolved. 
Print duplicate and conflict warnings here.

Definition at line 265 of file GeneratorSettingsSemantics.py.

    def opt_value(self, stored_value):
        """
        Return the final plain command list.
        This is the point where all layers are resolved. 
        Print duplicate and conflict warnings here.
        """
        settings_value = self.store(stored_value)
        return settings_value.resolve(report_context=self.name, emit_report=True)
 
 

store()

python.GeneratorSettingsSemantics.GeneratorSettingsSemantics.store	(		self,
			assigned_value )

Convert user input into the internal unresolved layer container.

Definition at line 225 of file GeneratorSettingsSemantics.py.

    def store(self, assigned_value):
        """Convert user input into the internal unresolved layer container."""
        if isinstance(assigned_value, GeneratorSettingsValue):
            return assigned_value
        if isinstance(assigned_value, GeneratorSettingsLayer):
            return GeneratorSettingsValue([assigned_value])
        if isinstance(assigned_value, str):
            raise TypeError("generator settings must be assigned from a sequence")
        return GeneratorSettingsValue([
            GeneratorSettingsLayer(
                source=self.name or "<unknown>",
                values=tuple(assigned_value or ()),
                precedence=GeneratorSettingsPrecedence.USER,
                report_context=self.name,
            )
        ])
 

Member Data Documentation

__handled_types__

list python.GeneratorSettingsSemantics.GeneratorSettingsSemantics.__handled_types__ = [re.compile(r"^GeneratorSettings<.*>$")]

staticprivate

Definition at line 218 of file GeneratorSettingsSemantics.py.

---

The documentation for this class was generated from the following file:

• GeneratorSettingsSemantics.py