This class is intended to encapsulate common operations that may be needed when dealing with deprecated input variable names. More...

Collaboration diagram for deprecation_management.DeprecationManager:

Static Public Member Functions
def	HasDeprecatedVariable (context_string, parameters, old_variable_name, new_variable_name)
	Check if a given deprecated variable is present in a given parameters object (Parameters object) More...

def	ReplaceDeprecatedVariableName (parameters, old_variable_name, new_variable_name)
	Replace a key by another. More...

Detailed Description

This class is intended to encapsulate common operations that may be needed when dealing with deprecated input variable names.

Its original purpose is the management of json-type input, although it may be extended to other input types.

The basic goals that inspired this encapsulation are:

Avoid repeating too much code.
Make these operations more robust.
Facilitate the evolution of terminology by concentrating the changes to be made around a single object.
Encourage better legacy-terminology handling, including appropriate error/warning handling.
Providing standard tools useful in the creation of conventional protocols for the modification of the API.

Member Function Documentation

def deprecation_management.DeprecationManager.HasDeprecatedVariable	(	context_string,
		parameters,
		old_variable_name,
		new_variable_name
	)

static

Check if a given deprecated variable is present in a given parameters object (Parameters object)

def deprecation_management.DeprecationManager.ReplaceDeprecatedVariableName	(	parameters,
		old_variable_name,
		new_variable_name
	)

static

Replace a key by another.

The old key is assumed to be present.

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

/home/runner/work/Documentation/Documentation/master/kratos/python_scripts/deprecation_management.py