"""
Various functions to install `SciTE <http://www.scintilla.org/SciTE.html>`_.
:githublink:`%|py|5`
"""
from __future__ import print_function
import sys
import re
import os
from ..installhelper.install_cmd_helper import unzip_files
from .install_custom import download_page, download_from_sourceforge, download_file
from ..installhelper.link_shortcuts import add_shortcut_to_desktop, suffix
if sys.version_info[0] == 2:
from codecs import open
[docs]def IsSciteInstalled(dest_folder):
"""
check if Scite was already installed
:param dest_folder: where it was installed
:return: boolean
:githublink:`%|py|24`
"""
if sys.platform.startswith("win"):
file = os.path.join(dest_folder, "wscite", "SciTE.exe")
return os.path.exists(file)
else:
raise NotImplementedError("not available on platform " + sys.platform)
[docs]def install_scite(dest_folder=".", fLOG=print, install=True, change_python_path=False, version=None):
"""
install `SciTE <http://www.scintilla.org/SciTE.html>`_ (only on Windows)
:param dest_folder: where to download the setup
:param fLOG: logging function
:param install: install (otherwise only download)
:param change_python_path: update python path as well (if *install* is True)
:param version: version to install (unused)
:return: temporary file
.. exref::
:title: install SciTE
The function downloads the latest version of SciTE.
It also changes some settings for Python (no tabs, Courier New as a police).
::
install_scite("my_folder_for_scite")
.. versionchanged:: 1.1
Parameter *change_python_path* was added.
:githublink:`%|py|55`
"""
if version is not None:
raise ValueError("cannot specify a version")
if IsSciteInstalled(dest_folder):
return os.path.join(
os.path.abspath(dest_folder), "wscite", "SciTE.exe")
if not sys.platform.startswith("win"):
raise NotImplementedError(
"SciTE can only be installed on Windows at the moment")
url = "http://www.scintilla.org/SciTEDownload.html"
page = download_page(url)
rel = re.compile("Release ([0-9.]+)")
rel = rel.findall(page)
if len(rel) == 0:
raise Exception("unable to find the release version")
rel = rel[0]
fLOG("[pymy] SciTE, release version ", rel)
reg = re.compile("<a href=\\\"(.*zip.*)\\\">full download</a>")
find = reg.findall(page)
if len(find) != 1:
raise Exception("unable to find the file to download at " +
url + "\nfound: " + str(len(find)) + "\n" + "\n".join(find))
# should be something like http://www.scintilla.org/wscite356.zip
newurl = find[0]
outfile = os.path.join(dest_folder, "scite.zip")
if not os.path.exists(outfile):
download_file(newurl, outfile)
if os.path.exists(outfile):
file = outfile
else:
newurl = "http://sourceforge.net/projects/scintilla/files/SciTE/{0}/wscite{1}.zip/download?use_mirror=autoselect".format(
rel,
rel.replace(
".",
""))
fLOG("[pymy] SciTE, download from ", newurl)
file = download_from_sourceforge(
newurl,
outfile,
fLOG=fLOG,
temp_folder=dest_folder)
if install:
unzip_files(file, whereTo=dest_folder, fLOG=fLOG)
modify_scite_properties(sys.executable if change_python_path else None,
os.path.join(dest_folder, "wscite"))
return os.path.join(os.path.abspath(dest_folder), "wscite", "SciTE.exe")
else:
return outfile
[docs]def modify_scite_properties(python_path, scite_path):
"""
modifies the scite properties
:param python_path: python path
:param scite_path: scrite path
Avoid tabulations, change the path to the interpreter.
.. versionchanged:: 1.1
If *python_path* is None, the function does not change it.
:githublink:`%|py|123`
"""
if python_path is not None:
# we change the path
config = os.path.join(scite_path, "python.properties")
with open(config, "r") as f:
content = f.read()
# we change the executable
lines = content.split("\n")
for i, line in enumerate(lines):
if "command.go.*.py=" in line:
lines[
i] = ' command.go.*.py={0} -u "$(FileNameExt)"'.format(python_path)
elif "command.go.*.pyw=" in line:
lines[
i] = ' command.go.*.pyw={0} -u "$(FileNameExt)"'.format(python_path)
content = "\n".join(lines)
with open(config, "w") as f:
f.write(content)
# we change the options
config = os.path.join(scite_path, "SciTEGlobal.properties")
with open(config, "r", encoding="utf8", errors="ignore") as f:
content = f.read()
content = content.replace("tabsize=8", "tabsize=4")
content = content.replace("indent.size=8", "indent.size=4")
content = content.replace("use.tabs=1", "use.tabs=0")
content = content.replace("font:Verdana,", "font:Consolas,")
with open(config, "w", encoding="utf8") as f:
f.write(content)
[docs]def add_shortcut_to_desktop_for_scite(scite):
"""
create a shortcut on your desktop
:param scite: scite location (SciTE.exe
:return: filename
:githublink:`%|py|161`
"""
ver = suffix()
return add_shortcut_to_desktop(scite, "SciTE." + ver, "SciTE." + ver)
