Skip to content

Deprecate get_default_value() #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
minrk merged 1 commit into from
Jun 15, 2015
Merged

Deprecate get_default_value() #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions traitlets/config/configurable.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ def class_get_trait_help(cls, trait, inst=None):
lines.append(indent('Current: %r' % getattr(inst, trait.name), 4))
else:
try:
dvr = repr(trait.get_default_value())
dvr = repr(trait.default_value)
except Exception:
dvr = None # ignore defaults we can't construct
if dvr is not None:
Expand Down Expand Up @@ -259,7 +259,7 @@ def c(s):
for name, trait in iteritems(cls.class_own_traits(config=True)):
help = trait.get_metadata('help') or ''
lines.append(c(help))
lines.append('# c.%s.%s = %r'%(cls.__name__, name, trait.get_default_value()))
lines.append('# c.%s.%s = %r'%(cls.__name__, name, trait.default_value))
lines.append('')
return '\n'.join(lines)

Expand All @@ -286,7 +286,7 @@ def class_config_rst_doc(cls):

# Default value
try:
dv = trait.get_default_value()
dv = trait.default_value
dvr = repr(dv)
except Exception:
dvr = dv = None # ignore defaults we can't construct
Expand Down
20 changes: 10 additions & 10 deletions traitlets/traitlets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,20 +371,20 @@ def init(self):
pass

def get_default_value(self):
"""Retrieve the static default value for this trait"""
return self.default_value
"""DEPRECATED: Retrieve the static default value for this trait.

def validate_default_value(self, obj):
"""Retrieve and validate the static default value"""
v = self.get_default_value()
return self._validate(obj, v)
Use self.default_value instead
"""
warn("get_default_value is deprecated: use the .default_value attribute",
stacklevel=2)
return self.default_value

def init_default_value(self, obj):
"""DEPRECATED: Set the static default value for the trait type.
"""
warn("init_default_value is deprecated, and may be removed in the future",
stacklevel=2)
value = self.validate_default_value()
value = self._validate(obj, self.default_value)
obj._trait_values[self.name] = value
return value

Expand Down Expand Up @@ -414,7 +414,7 @@ def instance_init(self, obj):
# use provides a static default, transfer that to obj._trait_values.
if (self._dynamic_default_callable(obj) is None) \
and (self.default_value is not Undefined):
v = self.validate_default_value(obj)
v = self._validate(obj, self.default_value)
if self.name is not None:
obj._trait_values[self.name] = v

Expand Down Expand Up @@ -452,7 +452,7 @@ def __set__(self, obj, value):
try:
old_value = obj._trait_values[self.name]
except KeyError:
old_value = self.get_default_value()
old_value = self.default_value

obj._trait_values[self.name] = new_value
try:
Expand Down Expand Up @@ -1135,7 +1135,7 @@ def __init__(self, trait_types, **metadata):
"""
self.trait_types = trait_types
self.info_text = " or ".join([tt.info_text for tt in self.trait_types])
self.default_value = self.trait_types[0].get_default_value()
self.default_value = self.trait_types[0].default_value
super(Union, self).__init__(**metadata)

def instance_init(self, obj):
Expand Down