def _fetchObjectChildren(self, obj, obj_path):
"""
Fetches the children of a Python object.
Returns: list of TreeItems
"""
obj_children = []
path_strings = []
tree_items = []
# Only populate children for objects without their own editor
if not is_editable_type(obj):
is_attr_list = [False] * len(obj_children)
# Object attributes
# Needed to handle errors while getting object's attributes
# Related with spyder-ide/spyder#6728 and spyder-ide/spyder#9959
for attr_name in dir(obj):
try:
attr_value = getattr(obj, attr_name)
obj_children.append((attr_name, attr_value))
path_strings.append('{}.{}'.format(obj_path, attr_name)
if obj_path else attr_name)
is_attr_list.append(True)
except Exception:
# Attribute could not be get
pass
assert len(obj_children) == len(path_strings), "sanity check"
for item, path_str, is_attr in zip(obj_children, path_strings,
is_attr_list):
name, child_obj = item
tree_items.append(TreeItem(child_obj, name, path_str, is_attr))
return tree_items
def createEditor(self, parent, option, index, object_explorer=False):
"""Overriding method createEditor"""
val_type = index.sibling(index.row(), 1).data()
self.sig_open_editor.emit()
if index.column() < 3:
return None
if self.show_warning(index):
answer = QMessageBox.warning(
self.parent(), _("Warning"),
_("Opening this variable can be slow\n\n"
"Do you want to continue anyway?"),
QMessageBox.Yes | QMessageBox.No)
if answer == QMessageBox.No:
return None
try:
value = self.get_value(index)
if value is None:
return None
except ImportError as msg:
self.sig_editor_shown.emit()
module = str(msg).split("'")[1]
if module in ['pandas', 'numpy']:
if module == 'numpy':
val_type = 'array'
else:
val_type = 'dataframe, series'
QMessageBox.critical(
self.parent(), _("Error"),
_("Spyder is unable to show the {val_type} or object "
"you're trying to view because <tt>{module}</tt> was "
"not installed alongside Spyder. Please install "
"this package in your Spyder environment."
"<br>").format(val_type=val_type, module=module))
return
else:
QMessageBox.critical(
self.parent(), _("Error"),
_("Spyder is unable to show the variable you're "
"trying to view because the module "
"<tt>{module}</tt> was not found in your "
"Spyder environment. Please install "
"this package in your Spyder environment."
"<br>").format(module=module))
return
except Exception as msg:
QMessageBox.critical(
self.parent(), _("Error"),
_("Spyder was unable to retrieve the value of "
"this variable from the console.<br><br>"
"The error message was:<br>"
"%s") % to_text_string(msg))
return
key = index.model().get_key(index)
readonly = (isinstance(value, (tuple, set)) or self.parent().readonly
or not is_known_type(value))
# CollectionsEditor for a list, tuple, dict, etc.
if isinstance(value, (list, set, tuple, dict)) and not object_explorer:
from spyder.widgets.collectionseditor import CollectionsEditor
editor = CollectionsEditor(parent=parent)
editor.setup(value,
key,
icon=self.parent().windowIcon(),
readonly=readonly)
self.create_dialog(
editor,
dict(model=index.model(),
editor=editor,
key=key,
readonly=readonly))
return None
# ArrayEditor for a Numpy array
elif (isinstance(value, (ndarray, MaskedArray))
and ndarray is not FakeObject and not object_explorer):
editor = ArrayEditor(parent=parent)
if not editor.setup_and_check(value, title=key, readonly=readonly):
return
self.create_dialog(
editor,
dict(model=index.model(),
editor=editor,
key=key,
readonly=readonly))
return None
# ArrayEditor for an images
elif (isinstance(value, Image) and ndarray is not FakeObject
and Image is not FakeObject and not object_explorer):
arr = array(value)
editor = ArrayEditor(parent=parent)
if not editor.setup_and_check(arr, title=key, readonly=readonly):
return
conv_func = lambda arr: Image.fromarray(arr, mode=value.mode)
self.create_dialog(
editor,
dict(model=index.model(),
editor=editor,
key=key,
readonly=readonly,
conv=conv_func))
return None
# DataFrameEditor for a pandas dataframe, series or index
elif (isinstance(value, (DataFrame, Index, Series))
and DataFrame is not FakeObject and not object_explorer):
editor = DataFrameEditor(parent=parent)
if not editor.setup_and_check(value, title=key):
return
editor.dataModel.set_format(index.model().dataframe_format)
editor.sig_option_changed.connect(self.change_option)
self.create_dialog(
editor,
dict(model=index.model(),
editor=editor,
key=key,
readonly=readonly))
return None
# QDateEdit and QDateTimeEdit for a dates or datetime respectively
elif isinstance(value, datetime.date) and not object_explorer:
# Needed to handle NaT values
# See spyder-ide/spyder#8329
try:
value.time()
except ValueError:
self.sig_editor_shown.emit()
return None
if readonly:
self.sig_editor_shown.emit()
return None
else:
if isinstance(value, datetime.datetime):
editor = QDateTimeEdit(value, parent=parent)
else:
editor = QDateEdit(value, parent=parent)
editor.setCalendarPopup(True)
editor.setFont(get_font(font_size_delta=DEFAULT_SMALL_DELTA))
self.sig_editor_shown.emit()
return editor
# TextEditor for a long string
elif is_text_string(value) and len(value) > 40 and not object_explorer:
te = TextEditor(None, parent=parent)
if te.setup_and_check(value):
editor = TextEditor(value,
key,
readonly=readonly,
parent=parent)
self.create_dialog(
editor,
dict(model=index.model(),
editor=editor,
key=key,
readonly=readonly))
return None
# QLineEdit for an individual value (int, float, short string, etc)
elif is_editable_type(value) and not object_explorer:
if readonly:
self.sig_editor_shown.emit()
return None
else:
editor = QLineEdit(parent=parent)
editor.setFont(get_font(font_size_delta=DEFAULT_SMALL_DELTA))
editor.setAlignment(Qt.AlignLeft)
# This is making Spyder crash because the QLineEdit that it's
# been modified is removed and a new one is created after
# evaluation. So the object on which this method is trying to
# act doesn't exist anymore.
# editor.returnPressed.connect(self.commitAndCloseEditor)
self.sig_editor_shown.emit()
return editor
# ObjectExplorer for an arbitrary Python object
else:
show_callable_attributes = index.model().show_callable_attributes
show_special_attributes = index.model().show_special_attributes
dataframe_format = index.model().dataframe_format
if show_callable_attributes is None:
show_callable_attributes = False
if show_special_attributes is None:
show_special_attributes = False
from spyder.plugins.variableexplorer.widgets.objectexplorer \
import ObjectExplorer
editor = ObjectExplorer(
value,
name=key,
parent=parent,
show_callable_attributes=show_callable_attributes,
show_special_attributes=show_special_attributes,
dataframe_format=dataframe_format,
readonly=readonly)
editor.sig_option_changed.connect(self.change_option)
self.create_dialog(
editor,
dict(model=index.model(),
editor=editor,
key=key,
readonly=readonly))
return None
def createEditor(self, parent, option, index):
"""Overriding method createEditor"""
if self.show_warning(index):
answer = QMessageBox.warning(
self.parent(), _("Warning"),
_("Opening this variable can be slow\n\n"
"Do you want to continue anyway?"),
QMessageBox.Yes | QMessageBox.No)
if answer == QMessageBox.No:
return None
try:
value = self.get_value(index)
try:
self.old_obj = value.copy()
except AttributeError:
self.old_obj = copy.deepcopy(value)
if value is None:
return None
except Exception as msg:
QMessageBox.critical(
self.parent(), _("Error"),
_("Spyder was unable to retrieve the value of "
"this variable from the console.<br><br>"
"The error message was:<br>"
"<i>%s</i>") % to_text_string(msg))
return
self.current_index = index
key = index.model().get_key(index).obj_name
readonly = (isinstance(value, (tuple, set)) or self.parent().readonly
or not is_known_type(value))
# CollectionsEditor for a list, tuple, dict, etc.
if isinstance(value, (list, set, tuple, dict)):
from spyder.widgets.collectionseditor import CollectionsEditor
editor = CollectionsEditor(parent=parent)
editor.setup(value,
key,
icon=self.parent().windowIcon(),
readonly=readonly)
self.create_dialog(
editor,
dict(model=index.model(),
editor=editor,
key=key,
readonly=readonly))
return None
# ArrayEditor for a Numpy array
elif (isinstance(value, (ndarray, MaskedArray))
and ndarray is not FakeObject):
editor = ArrayEditor(parent=parent)
if not editor.setup_and_check(value, title=key, readonly=readonly):
return
self.create_dialog(
editor,
dict(model=index.model(),
editor=editor,
key=key,
readonly=readonly))
return None
# ArrayEditor for an images
elif (isinstance(value, Image) and ndarray is not FakeObject
and Image is not FakeObject):
arr = array(value)
editor = ArrayEditor(parent=parent)
if not editor.setup_and_check(arr, title=key, readonly=readonly):
return
conv_func = lambda arr: Image.fromarray(arr, mode=value.mode)
self.create_dialog(
editor,
dict(model=index.model(),
editor=editor,
key=key,
readonly=readonly,
conv=conv_func))
return None
# DataFrameEditor for a pandas dataframe, series or index
elif (isinstance(value, (DataFrame, Index, Series))
and DataFrame is not FakeObject):
editor = DataFrameEditor(parent=parent)
if not editor.setup_and_check(value, title=key):
return
editor.dataModel.set_format(index.model().dataframe_format)
editor.sig_option_changed.connect(self.change_option)
self.create_dialog(
editor,
dict(model=index.model(),
editor=editor,
key=key,
readonly=readonly))
return None
# QDateEdit and QDateTimeEdit for a dates or datetime respectively
elif isinstance(value, datetime.date):
if readonly:
return None
else:
if isinstance(value, datetime.datetime):
editor = QDateTimeEdit(value, parent=parent)
else:
editor = QDateEdit(value, parent=parent)
editor.setCalendarPopup(True)
editor.setFont(get_font(font_size_delta=DEFAULT_SMALL_DELTA))
return editor
# TextEditor for a long string
elif is_text_string(value) and len(value) > 40:
te = TextEditor(None, parent=parent)
if te.setup_and_check(value):
editor = TextEditor(value,
key,
readonly=readonly,
parent=parent)
self.create_dialog(
editor,
dict(model=index.model(),
editor=editor,
key=key,
readonly=readonly))
return None
# QLineEdit for an individual value (int, float, short string, etc)
elif is_editable_type(value):
if readonly:
return None
else:
editor = QLineEdit(parent=parent)
editor.setFont(get_font(font_size_delta=DEFAULT_SMALL_DELTA))
editor.setAlignment(Qt.AlignLeft)
# This is making Spyder crash because the QLineEdit that it's
# been modified is removed and a new one is created after
# evaluation. So the object on which this method is trying to
# act doesn't exist anymore.
# editor.returnPressed.connect(self.commitAndCloseEditor)
return editor
# An arbitrary Python object.
# Since we are already in the Object Explorer no editor is needed
else:
return None
def test_is_editable_type():
"""Test for get_type_string."""
# Bools
assert is_editable_type(True)
# Numeric type
numeric_types = [1, 1.5, 1 + 2j]
assert all([is_editable_type(t) for t in numeric_types])
# Lists
assert is_editable_type([1, 2, 3])
# Sets
assert is_editable_type({1, 2, 3})
# Dictionaries
assert is_editable_type({'a': 1, 'b': 2})
# Tuples
assert is_editable_type((1, 2, 3))
# Strings
assert is_editable_type('foo')
# Numpy objects
assert is_editable_type(np.array([1, 2, 3]))
masked_array = np.ma.MaskedArray([1, 2, 3], mask=[True, False, True])
assert is_editable_type(masked_array)
matrix = np.matrix([[1, 2], [3, 4]])
assert is_editable_type(matrix)
# Pandas objects
df = pd.DataFrame([1, 2, 3])
assert is_editable_type(df)
series = pd.Series([1, 2, 3])
assert is_editable_type(series)
index = pd.Index([1, 2, 3])
assert is_editable_type(index)
# PIL images
img = PIL.Image.new('RGB', (256, 256))
assert is_editable_type(img)
# Datetime objects
date = datetime.date(2010, 10, 1)
assert is_editable_type(date)
date = datetime.timedelta(-1, 2000)
assert is_editable_type(date)
# Other objects
class MyClass:
a = 1
assert not is_editable_type(MyClass)
my_instance = MyClass()
assert not is_editable_type(my_instance)
def createEditor(self, parent, option, index, object_explorer=False):
"""Overriding method createEditor"""
val_type = index.sibling(index.row(), 1).data()
self.sig_editor_creation_started.emit()
if index.column() < 3:
return None
if self.show_warning(index):
answer = QMessageBox.warning(
self.parent(), _("Warning"),
_("Opening this variable can be slow\n\n"
"Do you want to continue anyway?"),
QMessageBox.Yes | QMessageBox.No)
if answer == QMessageBox.No:
self.sig_editor_shown.emit()
return None
try:
value = self.get_value(index)
if value is None:
return None
except ImportError as msg:
self.sig_editor_shown.emit()
module = str(msg).split("'")[1]
if module in ['pandas', 'numpy']:
if module == 'numpy':
val_type = 'array'
else:
val_type = 'dataframe, series'
message = _("Spyder is unable to show the {val_type} or object"
" you're trying to view because <tt>{module}</tt>"
" is not installed. ")
if running_in_mac_app():
message += _("Please consider using the full version of "
"the Spyder MacOS application.<br>")
else:
message += _("Please install this package in your Spyder "
"environment.<br>")
QMessageBox.critical(
self.parent(), _("Error"),
message.format(val_type=val_type, module=module))
return
else:
if running_in_mac_app() or is_pynsist():
message = _("Spyder is unable to show the variable you're"
" trying to view because the module "
"<tt>{module}</tt> is not supported in the "
"Spyder Lite application.<br>")
else:
message = _("Spyder is unable to show the variable you're"
" trying to view because the module "
"<tt>{module}</tt> is not found in your "
"Spyder environment. Please install this "
"package in this environment.<br>")
QMessageBox.critical(self.parent(), _("Error"),
message.format(module=module))
return
except Exception as msg:
QMessageBox.critical(
self.parent(), _("Error"),
_("Spyder was unable to retrieve the value of "
"this variable from the console.<br><br>"
"The error message was:<br>"
"%s") % to_text_string(msg))
return
key = index.model().get_key(index)
readonly = (isinstance(value, (tuple, set)) or self.parent().readonly
or not is_known_type(value))
# We can't edit Numpy void objects because they could be anything, so
# this might cause a crash.
# Fixes spyder-ide/spyder#10603
if isinstance(value, np.void):
self.sig_editor_shown.emit()
return None
# CollectionsEditor for a list, tuple, dict, etc.
elif isinstance(value, (list, set, tuple, dict)) and not object_explorer:
from spyder.widgets.collectionseditor import CollectionsEditor
editor = CollectionsEditor(parent=parent)
editor.setup(value, key, icon=self.parent().windowIcon(),
readonly=readonly)
self.create_dialog(editor, dict(model=index.model(), editor=editor,
key=key, readonly=readonly))
return None
# ArrayEditor for a Numpy array
elif (isinstance(value, (np.ndarray, np.ma.MaskedArray)) and
np.ndarray is not FakeObject and not object_explorer):
# We need to leave this import here for tests to pass.
from .arrayeditor import ArrayEditor
editor = ArrayEditor(parent=parent)
if not editor.setup_and_check(value, title=key, readonly=readonly):
return
self.create_dialog(editor, dict(model=index.model(), editor=editor,
key=key, readonly=readonly))
return None
# ArrayEditor for an images
elif (isinstance(value, PIL.Image.Image) and
np.ndarray is not FakeObject and
PIL.Image is not FakeObject and
not object_explorer):
# Sometimes the ArrayEditor import above is not seen (don't know
# why), so we need to reimport it here.
# Fixes spyder-ide/spyder#16731
from .arrayeditor import ArrayEditor
arr = np.array(value)
editor = ArrayEditor(parent=parent)
if not editor.setup_and_check(arr, title=key, readonly=readonly):
return
conv_func = lambda arr: PIL.Image.fromarray(arr, mode=value.mode)
self.create_dialog(editor, dict(model=index.model(), editor=editor,
key=key, readonly=readonly,
conv=conv_func))
return None
# DataFrameEditor for a pandas dataframe, series or index
elif (isinstance(value, (pd.DataFrame, pd.Index, pd.Series))
and pd.DataFrame is not FakeObject and not object_explorer):
# We need to leave this import here for tests to pass.
from .dataframeeditor import DataFrameEditor
editor = DataFrameEditor(parent=parent)
if not editor.setup_and_check(value, title=key):
self.sig_editor_shown.emit()
return
self.create_dialog(editor, dict(model=index.model(), editor=editor,
key=key, readonly=readonly))
return None
# QDateEdit and QDateTimeEdit for a dates or datetime respectively
elif isinstance(value, datetime.date) and not object_explorer:
if readonly:
self.sig_editor_shown.emit()
return None
else:
if isinstance(value, datetime.datetime):
editor = QDateTimeEdit(value, parent=parent)
# Needed to handle NaT values
# See spyder-ide/spyder#8329
try:
value.time()
except ValueError:
self.sig_editor_shown.emit()
return None
else:
editor = QDateEdit(value, parent=parent)
editor.setCalendarPopup(True)
editor.setFont(get_font(font_size_delta=DEFAULT_SMALL_DELTA))
self.sig_editor_shown.emit()
return editor
# TextEditor for a long string
elif is_text_string(value) and len(value) > 40 and not object_explorer:
te = TextEditor(None, parent=parent)
if te.setup_and_check(value):
editor = TextEditor(value, key,
readonly=readonly, parent=parent)
self.create_dialog(editor, dict(model=index.model(),
editor=editor, key=key,
readonly=readonly))
return None
# QLineEdit for an individual value (int, float, short string, etc)
elif is_editable_type(value) and not object_explorer:
if readonly:
self.sig_editor_shown.emit()
return None
else:
editor = QLineEdit(parent=parent)
editor.setFont(get_font(font_size_delta=DEFAULT_SMALL_DELTA))
editor.setAlignment(Qt.AlignLeft)
# This is making Spyder crash because the QLineEdit that it's
# been modified is removed and a new one is created after
# evaluation. So the object on which this method is trying to
# act doesn't exist anymore.
# editor.returnPressed.connect(self.commitAndCloseEditor)
self.sig_editor_shown.emit()
return editor
# ObjectExplorer for an arbitrary Python object
else:
from spyder.plugins.variableexplorer.widgets.objectexplorer \
import ObjectExplorer
editor = ObjectExplorer(
value,
name=key,
parent=parent,
readonly=readonly)
self.create_dialog(editor, dict(model=index.model(),
editor=editor,
key=key, readonly=readonly))
return None
