Renamed Property

class properties.Renamed(new_name, **kwargs)[source]

Property that allows renaming of other properties.

Assign the old name to a Renamed Property that points to the new name. Getting, setting, and deleting using the old name will warn the user then redirect to the new name.

For example, when updating this code for PEP8

class MyClass(properties.HasProperties):
    myStringProp = properties.String('My string property')

backwards compatibility can be maintained with

class MyClass(properties.HasProperties):
    my_string_prop = properties.String('My string property')
    myStringProp = properties.Renamed('my_string_prop')


  • new_name - the new name of the property that was renamed.

Available keywords:

  • warn - raise a warning when this property is used (default: True)