# changes by dscherer@cmu.edu
# - IOBinding.open() replaces the current window with the opened file,
# if the current window is both unmodified and unnamed
# - IOBinding.loadfile() interprets Windows, UNIX, and Macintosh
# end-of-line conventions, instead of relying on the standard library,
# which will only understand the local convention.
from codecs import BOM_UTF8
from SimpleDialog import SimpleDialog
from idlelib.configHandler import idleConf
# Try setting the locale, so that we can find out
locale.setlocale(locale.LC_CTYPE, "")
except (ImportError, locale.Error):
# Encoding for file names
filesystemencoding = sys.getfilesystemencoding()
if sys.platform == 'win32':
# On Windows, we could use "mbcs". However, to give the user
# a portable encoding name, we need to find the code page
encoding = locale.getdefaultlocale()[1]
# Different things can fail here: the locale module may not be
# loaded, it may not offer nl_langinfo, or CODESET, or the
# resulting codeset may be unknown to Python. We ignore all
# these problems, falling back to ASCII
encoding = locale.nl_langinfo(locale.CODESET)
if encoding is None or encoding is '':
# situation occurs on Mac OS X
except (NameError, AttributeError, LookupError):
# Try getdefaultlocale well: it parses environment variables,
# which may give a clue. Unfortunately, getdefaultlocale has
# bugs that can cause ValueError.
encoding = locale.getdefaultlocale()[1]
if encoding is None or encoding is '':
# situation occurs on Mac OS X
except (ValueError, LookupError):
encoding = encoding.lower()
coding_re = re.compile(r'^[ \t\f]*#.*?coding[:=][ \t]*([-\w.]+)')
blank_re = re.compile(r'^[ \t\f]*(?:[#\r\n]|$)')
class EncodingMessage(SimpleDialog):
"Inform user that an encoding declaration is needed."
def __init__(self, master, enc):
self.root = top = Toplevel(master)
top.bind("<Return>", self.return_event)
top.bind("<Escape>", self.do_ok)
top.protocol("WM_DELETE_WINDOW", self.wm_delete_window)
top.wm_title("I/O Warning")
top.wm_iconname("I/O Warning")
text="Non-ASCII found, yet no encoding declared. Add a line like")
l1.pack(side=TOP, anchor=W)
l2 = Entry(top, font="courier")
l2.insert(0, "# -*- coding: %s -*-" % enc)
# For some reason, the text is not selectable anymore if the
l2.pack(side=TOP, anchor = W, fill=X)
l3 = Label(top, text="to your file\n"
"See Language Reference, 2.1.4 Encoding declarations.\n"
"Choose OK to save this file as %s\n"
"Edit your general options to silence this warning" % enc)
l3.pack(side=TOP, anchor = W)
buttons.pack(side=TOP, fill=X)
# Both return and cancel mean the same thing: do nothing
self.default = self.cancel = 0
b1 = Button(buttons, text="Ok", default="active",
b1.pack(side=LEFT, fill=BOTH, expand=1)
b2 = Button(buttons, text="Edit my file",
b2.pack(side=LEFT, fill=BOTH, expand=1)
self._set_transient(master)
"""Return the encoding declaration according to PEP 263.
Raise LookupError if the encoding is declared but unknown.
# Only consider the first two lines
lst = str.split("\n", 2)[:2]
match = coding_re.match(line)
if not blank_re.match(line):
# Check whether the encoding is known
# The standard encoding error does not indicate the encoding
raise LookupError, "Unknown encoding "+name
def __init__(self, editwin):
self.__id_open = self.text.bind("<<open-window-from-file>>", self.open)
self.__id_save = self.text.bind("<<save-window>>", self.save)
self.__id_saveas = self.text.bind("<<save-window-as-file>>",
self.__id_savecopy = self.text.bind("<<save-copy-of-window-as-file>>",
self.__id_print = self.text.bind("<<print-window>>", self.print_window)
self.text.unbind("<<open-window-from-file>>", self.__id_open)
self.text.unbind("<<save-window>>", self.__id_save)
self.text.unbind("<<save-window-as-file>>",self.__id_saveas)
self.text.unbind("<<save-copy-of-window-as-file>>", self.__id_savecopy)
self.text.unbind("<<print-window>>", self.__id_print)
self.filename_change_hook = None
return self.editwin.get_saved()
def set_saved(self, flag):
self.editwin.set_saved(flag)
self.editwin.reset_undo()
filename_change_hook = None
def set_filename_change_hook(self, hook):
self.filename_change_hook = hook
def set_filename(self, filename):
if filename and os.path.isdir(filename):
if self.filename_change_hook:
self.filename_change_hook()
def open(self, event=None, editFile=None):
flist = self.editwin.flist
# Save in case parent window is closed (ie, during askopenfile()).
filename = self.askopenfile()
# If editFile is valid and already open, flist.open will
# shift focus to its existing window.
# If the current window exists and is a fresh unnamed,
# unmodified editor window (not an interpreter shell),
# pass self.loadfile to flist.open so it will load the file
# in the current window (if the file is not already open)
# instead of a new window.
not getattr(self.editwin, 'interp', None) and
flist.open(filename, self.loadfile)
# Code for use outside IDLE:
filename = self.askopenfile()
eol = r"(\r\n)|\n|\r" # \r\n (Windows), \n (UNIX), or \r (Mac)
eol_convention = os.linesep # Default
def loadfile(self, filename):
# open the file in binary mode so that we can handle
# end-of-line convention ourselves.
with open(filename, 'rb') as f:
tkMessageBox.showerror("I/O Error", str(msg), parent=self.text)
chars = self.decode(chars)
# We now convert all end-of-lines to '\n's
firsteol = self.eol_re.search(chars)
self.eol_convention = firsteol.group(0)
if isinstance(self.eol_convention, unicode):
# Make sure it is an ASCII string
self.eol_convention = self.eol_convention.encode("ascii")
chars = self.eol_re.sub(r"\n", chars)
self.text.delete("1.0", "end")
self.text.insert("1.0", chars)
self.set_filename(filename)
self.text.mark_set("insert", "1.0")
self.text.yview("insert")
self.updaterecentfileslist(filename)
"""Create a Unicode string
If that fails, let Tcl try its best
# Check presence of a UTF-8 signature first
if chars.startswith(BOM_UTF8):
chars = chars[3:].decode("utf-8")
# has UTF-8 signature, but fails to decode...
# Indicates that this file originally had a BOM
self.fileencoding = BOM_UTF8
# Next look for coding specification
except LookupError as name:
title="Error loading the file",
message="The encoding '%s' is not known to this Python "\
"installation. The file may not display correctly" % name,
return unicode(chars, enc)
# If it is ASCII, we need not to record anything
return unicode(chars, 'ascii')
# Finally, try the locale's encoding. This is deprecated;
# the user should declare a non-ASCII encoding
chars = unicode(chars, encoding)
self.fileencoding = encoding
message = "Do you want to save %s before closing?" % (
self.filename or "this untitled document")
confirm = tkMessageBox.askyesnocancel(
default=tkMessageBox.YES,
if self.writefile(self.filename):
self.editwin.store_file_breaks()
except AttributeError: # may be a PyShell
def save_as(self, event):
filename = self.asksavefile()
if self.writefile(filename):
self.set_filename(filename)
self.editwin.store_file_breaks()
self.updaterecentfileslist(filename)
def save_a_copy(self, event):
filename = self.asksavefile()
self.updaterecentfileslist(filename)
def writefile(self, filename):
chars = self.encode(self.text.get("1.0", "end-1c"))
if self.eol_convention != "\n":
chars = chars.replace("\n", self.eol_convention)
with open(filename, "wb") as f:
tkMessageBox.showerror("I/O Error", str(msg),
if isinstance(chars, str):
# This is either plain ASCII, or Tk was returning mixed-encoding
# text to us. Don't try to guess further.
# See whether there is anything non-ASCII in it.
# If not, no need to figure out the encoding.
return chars.encode('ascii')
# If there is an encoding declared, try this first.
except LookupError as msg:
failed = "Invalid encoding '%s'" % enc
"%s. Saving as UTF-8" % failed,
# If there was a UTF-8 signature, use that. This should not fail
if self.fileencoding == BOM_UTF8 or failed:
return BOM_UTF8 + chars.encode("utf-8")
# Try the original file encoding next, if any
return chars.encode(self.fileencoding)
"Cannot save this as '%s' anymore. Saving as UTF-8" \
return BOM_UTF8 + chars.encode("utf-8")
# Nothing was declared, and we had not determined an encoding
# on loading. Recommend an encoding line.
config_encoding = idleConf.GetOption("main","EditorWindow",
if config_encoding == 'utf-8':
# User has requested that we save files as UTF-8
return BOM_UTF8 + chars.encode("utf-8")
chars = chars.encode(encoding)
if config_encoding == 'locale':
chars = BOM_UTF8 + chars.encode("utf-8")
dialog = EncodingMessage(self.editwin.top, enc)
# User asked us to edit the file
encline = "# -*- coding: %s -*-\n" % enc
firstline = self.text.get("1.0", "2.0")
if firstline.startswith("#!"):
# Insert encoding after #! line
self.text.insert("2.0", encline)
self.text.insert("1.0", encline)
return self.encode(self.text.get("1.0", "end-1c"))
c = self.text.get("end-2c")
self.text.insert("end-1c", "\n")
def print_window(self, event):
confirm = tkMessageBox.askokcancel(
message="Print to Default Printer",
# shell undo is reset after every prompt, looks saved, probably isn't
if not saved or filename is None:
(tfd, tempfilename) = tempfile.mkstemp(prefix='IDLE_tmp_')
if not self.writefile(tempfilename):
if platform == 'posix': #posix platform
command = idleConf.GetOption('main','General',
command = command + " 2>&1"
elif platform == 'nt': #win32 platform
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
