forked from platformio/platformio-core
871 lines
25 KiB
Python
871 lines
25 KiB
Python
# Copyright (c) 2014-present PlatformIO <contact@platformio.org>
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import json
|
|
import os
|
|
import platform
|
|
import re
|
|
import socket
|
|
import stat
|
|
import subprocess
|
|
import sys
|
|
import time
|
|
from functools import wraps
|
|
from glob import glob
|
|
from hashlib import sha1
|
|
from os.path import (abspath, basename, dirname, expanduser, isdir, isfile,
|
|
join, normpath, splitdrive)
|
|
from shutil import rmtree
|
|
from threading import Thread
|
|
|
|
import click
|
|
import requests
|
|
|
|
from platformio import __apiurl__, __version__, exception
|
|
|
|
# pylint: disable=wrong-import-order, too-many-ancestors
|
|
|
|
try:
|
|
import configparser as ConfigParser
|
|
except ImportError:
|
|
import ConfigParser as ConfigParser
|
|
|
|
|
|
class ProjectConfig(ConfigParser.ConfigParser):
|
|
|
|
VARTPL_RE = re.compile(r"\$\{([^\.\}]+)\.([^\}]+)\}")
|
|
|
|
def items(self, section, **_): # pylint: disable=arguments-differ
|
|
items = []
|
|
for option in ConfigParser.ConfigParser.options(self, section):
|
|
items.append((option, self.get(section, option)))
|
|
return items
|
|
|
|
def get(self, section, option, **kwargs):
|
|
try:
|
|
value = ConfigParser.ConfigParser.get(self, section, option,
|
|
**kwargs)
|
|
except ConfigParser.Error as e:
|
|
raise exception.InvalidProjectConf(str(e))
|
|
if "${" not in value or "}" not in value:
|
|
return value
|
|
return self.VARTPL_RE.sub(self._re_sub_handler, value)
|
|
|
|
def _re_sub_handler(self, match):
|
|
section, option = match.group(1), match.group(2)
|
|
if section in ("env", "sysenv") and not self.has_section(section):
|
|
if section == "env":
|
|
click.secho(
|
|
"Warning! Access to system environment variable via "
|
|
"`${{env.{0}}}` is deprecated. Please use "
|
|
"`${{sysenv.{0}}}` instead".format(option),
|
|
fg="yellow")
|
|
return os.getenv(option)
|
|
return self.get(section, option)
|
|
|
|
|
|
class AsyncPipe(Thread):
|
|
|
|
def __init__(self, outcallback=None):
|
|
super(AsyncPipe, self).__init__()
|
|
self.outcallback = outcallback
|
|
|
|
self._fd_read, self._fd_write = os.pipe()
|
|
self._pipe_reader = os.fdopen(self._fd_read)
|
|
self._buffer = []
|
|
|
|
self.start()
|
|
|
|
def get_buffer(self):
|
|
return self._buffer
|
|
|
|
def fileno(self):
|
|
return self._fd_write
|
|
|
|
def run(self):
|
|
for line in iter(self._pipe_reader.readline, ""):
|
|
line = line.strip()
|
|
self._buffer.append(line)
|
|
if self.outcallback:
|
|
self.outcallback(line)
|
|
else:
|
|
print(line)
|
|
self._pipe_reader.close()
|
|
|
|
def close(self):
|
|
os.close(self._fd_write)
|
|
self.join()
|
|
|
|
|
|
class cd(object):
|
|
|
|
def __init__(self, new_path):
|
|
self.new_path = new_path
|
|
self.prev_path = os.getcwd()
|
|
|
|
def __enter__(self):
|
|
os.chdir(self.new_path)
|
|
|
|
def __exit__(self, etype, value, traceback):
|
|
os.chdir(self.prev_path)
|
|
|
|
|
|
class memoized(object):
|
|
|
|
def __init__(self, expire=0):
|
|
self.expire = expire / 1000 # milliseconds
|
|
self.cache = {}
|
|
|
|
def __call__(self, func):
|
|
|
|
@wraps(func)
|
|
def wrapper(*args, **kwargs):
|
|
key = str(args) + str(kwargs)
|
|
if (key not in self.cache
|
|
or (self.expire > 0
|
|
and self.cache[key][0] < time.time() - self.expire)):
|
|
self.cache[key] = (time.time(), func(*args, **kwargs))
|
|
return self.cache[key][1]
|
|
|
|
wrapper.reset = self._reset
|
|
return wrapper
|
|
|
|
def _reset(self):
|
|
self.cache = {}
|
|
|
|
|
|
class throttle(object):
|
|
|
|
def __init__(self, threshhold):
|
|
self.threshhold = threshhold # milliseconds
|
|
self.last = 0
|
|
|
|
def __call__(self, func):
|
|
|
|
@wraps(func)
|
|
def wrapper(*args, **kwargs):
|
|
diff = int(round((time.time() - self.last) * 1000))
|
|
if diff < self.threshhold:
|
|
time.sleep((self.threshhold - diff) * 0.001)
|
|
self.last = time.time()
|
|
return func(*args, **kwargs)
|
|
|
|
return wrapper
|
|
|
|
|
|
def singleton(cls):
|
|
""" From PEP-318 http://www.python.org/dev/peps/pep-0318/#examples """
|
|
_instances = {}
|
|
|
|
def get_instance(*args, **kwargs):
|
|
if cls not in _instances:
|
|
_instances[cls] = cls(*args, **kwargs)
|
|
return _instances[cls]
|
|
|
|
return get_instance
|
|
|
|
|
|
def path_to_unicode(path):
|
|
return path.decode(sys.getfilesystemencoding()).encode("utf-8")
|
|
|
|
|
|
def load_json(file_path):
|
|
try:
|
|
with open(file_path, "r") as f:
|
|
return json.load(f)
|
|
except ValueError:
|
|
raise exception.InvalidJSONFile(file_path)
|
|
|
|
|
|
def get_systype():
|
|
type_ = platform.system().lower()
|
|
arch = platform.machine().lower()
|
|
if type_ == "windows":
|
|
arch = "amd64" if platform.architecture()[0] == "64bit" else "x86"
|
|
return "%s_%s" % (type_, arch) if arch else type_
|
|
|
|
|
|
def pioversion_to_intstr():
|
|
vermatch = re.match(r"^([\d\.]+)", __version__)
|
|
assert vermatch
|
|
return [int(i) for i in vermatch.group(1).split(".")[:3]]
|
|
|
|
|
|
def get_project_optional_dir(name, default=None):
|
|
data = None
|
|
var_name = "PLATFORMIO_%s" % name.upper()
|
|
if var_name in os.environ:
|
|
data = os.getenv(var_name)
|
|
else:
|
|
try:
|
|
config = load_project_config()
|
|
if (config.has_section("platformio")
|
|
and config.has_option("platformio", name)):
|
|
data = config.get("platformio", name)
|
|
except exception.NotPlatformIOProject:
|
|
pass
|
|
|
|
if not data:
|
|
return default
|
|
|
|
items = []
|
|
for item in data.split(", "):
|
|
if item.startswith("~"):
|
|
item = expanduser(item)
|
|
items.append(abspath(item))
|
|
return ", ".join(items)
|
|
|
|
|
|
def get_home_dir():
|
|
home_dir = get_project_optional_dir("home_dir",
|
|
join(expanduser("~"), ".platformio"))
|
|
win_home_dir = None
|
|
if "windows" in get_systype():
|
|
win_home_dir = splitdrive(home_dir)[0] + "\\.platformio"
|
|
if isdir(win_home_dir):
|
|
home_dir = win_home_dir
|
|
|
|
if not isdir(home_dir):
|
|
try:
|
|
os.makedirs(home_dir)
|
|
except: # pylint: disable=bare-except
|
|
if win_home_dir:
|
|
os.makedirs(win_home_dir)
|
|
home_dir = win_home_dir
|
|
|
|
assert isdir(home_dir)
|
|
return home_dir
|
|
|
|
|
|
def get_cache_dir():
|
|
return get_project_optional_dir("cache_dir", join(get_home_dir(),
|
|
".cache"))
|
|
|
|
|
|
def get_source_dir():
|
|
curpath = abspath(__file__)
|
|
if not isfile(curpath):
|
|
for p in sys.path:
|
|
if isfile(join(p, __file__)):
|
|
curpath = join(p, __file__)
|
|
break
|
|
return dirname(curpath)
|
|
|
|
|
|
def get_project_dir():
|
|
return os.getcwd()
|
|
|
|
|
|
def find_project_dir_above(path):
|
|
if isfile(path):
|
|
path = dirname(path)
|
|
if is_platformio_project(path):
|
|
return path
|
|
if isdir(dirname(path)):
|
|
return find_project_dir_above(dirname(path))
|
|
return None
|
|
|
|
|
|
def is_platformio_project(project_dir=None):
|
|
if not project_dir:
|
|
project_dir = get_project_dir()
|
|
return isfile(join(project_dir, "platformio.ini"))
|
|
|
|
|
|
def get_projectlib_dir():
|
|
return get_project_optional_dir("lib_dir", join(get_project_dir(), "lib"))
|
|
|
|
|
|
def get_projectlibdeps_dir():
|
|
return get_project_optional_dir("libdeps_dir",
|
|
join(get_project_dir(), ".piolibdeps"))
|
|
|
|
|
|
def get_projectsrc_dir():
|
|
return get_project_optional_dir("src_dir", join(get_project_dir(), "src"))
|
|
|
|
|
|
def get_projectinclude_dir():
|
|
return get_project_optional_dir("include_dir",
|
|
join(get_project_dir(), "include"))
|
|
|
|
|
|
def get_projecttest_dir():
|
|
return get_project_optional_dir("test_dir", join(get_project_dir(),
|
|
"test"))
|
|
|
|
|
|
def get_projectboards_dir():
|
|
return get_project_optional_dir("boards_dir",
|
|
join(get_project_dir(), "boards"))
|
|
|
|
|
|
def get_projectbuild_dir(force=False):
|
|
path = get_project_optional_dir("build_dir",
|
|
join(get_project_dir(), ".pioenvs"))
|
|
if "$PROJECT_HASH" in path:
|
|
path = path.replace("$PROJECT_HASH",
|
|
sha1(get_project_dir()).hexdigest()[:10])
|
|
try:
|
|
if not isdir(path):
|
|
os.makedirs(path)
|
|
dontmod_path = join(path, "do-not-modify-files-here.url")
|
|
if not isfile(dontmod_path):
|
|
with open(dontmod_path, "w") as fp:
|
|
fp.write("""
|
|
[InternetShortcut]
|
|
URL=https://docs.platformio.org/page/projectconf/section_platformio.html#build-dir
|
|
""")
|
|
except Exception as e: # pylint: disable=broad-except
|
|
if not force:
|
|
raise Exception(e)
|
|
return path
|
|
|
|
|
|
# compatibility with PIO Core+
|
|
get_projectpioenvs_dir = get_projectbuild_dir
|
|
|
|
|
|
def get_projectdata_dir():
|
|
return get_project_optional_dir("data_dir", join(get_project_dir(),
|
|
"data"))
|
|
|
|
|
|
def load_project_config(path=None):
|
|
if not path or isdir(path):
|
|
path = join(path or get_project_dir(), "platformio.ini")
|
|
if not isfile(path):
|
|
raise exception.NotPlatformIOProject(
|
|
dirname(path) if path.endswith("platformio.ini") else path)
|
|
cp = ProjectConfig()
|
|
try:
|
|
cp.read(path)
|
|
except ConfigParser.Error as e:
|
|
raise exception.InvalidProjectConf(str(e))
|
|
return cp
|
|
|
|
|
|
def parse_conf_multi_values(items):
|
|
result = []
|
|
if not items:
|
|
return result
|
|
inline_comment_re = re.compile(r"\s+;.*$")
|
|
for item in items.split("\n" if "\n" in items else ", "):
|
|
item = item.strip()
|
|
# comment
|
|
if not item or item.startswith((";", "#")):
|
|
continue
|
|
if ";" in item:
|
|
item = inline_comment_re.sub("", item).strip()
|
|
result.append(item)
|
|
return result
|
|
|
|
|
|
def change_filemtime(path, mtime):
|
|
os.utime(path, (mtime, mtime))
|
|
|
|
|
|
def is_ci():
|
|
return os.getenv("CI", "").lower() == "true"
|
|
|
|
|
|
def is_container():
|
|
if not isfile("/proc/1/cgroup"):
|
|
return False
|
|
with open("/proc/1/cgroup") as fp:
|
|
for line in fp:
|
|
line = line.strip()
|
|
if ":" in line and not line.endswith(":/"):
|
|
return True
|
|
return False
|
|
|
|
|
|
def exec_command(*args, **kwargs):
|
|
result = {"out": None, "err": None, "returncode": None}
|
|
|
|
default = dict(stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
|
default.update(kwargs)
|
|
kwargs = default
|
|
|
|
p = subprocess.Popen(*args, **kwargs)
|
|
try:
|
|
result['out'], result['err'] = p.communicate()
|
|
result['returncode'] = p.returncode
|
|
except KeyboardInterrupt:
|
|
raise exception.AbortedByUser()
|
|
finally:
|
|
for s in ("stdout", "stderr"):
|
|
if isinstance(kwargs[s], AsyncPipe):
|
|
kwargs[s].close()
|
|
|
|
for s in ("stdout", "stderr"):
|
|
if isinstance(kwargs[s], AsyncPipe):
|
|
result[s[3:]] = "\n".join(kwargs[s].get_buffer())
|
|
|
|
for k, v in result.iteritems():
|
|
if v and isinstance(v, basestring):
|
|
result[k].strip()
|
|
|
|
return result
|
|
|
|
|
|
def copy_pythonpath_to_osenv():
|
|
_PYTHONPATH = []
|
|
if "PYTHONPATH" in os.environ:
|
|
_PYTHONPATH = os.environ.get("PYTHONPATH").split(os.pathsep)
|
|
for p in os.sys.path:
|
|
conditions = [p not in _PYTHONPATH]
|
|
if "windows" not in get_systype():
|
|
conditions.append(
|
|
isdir(join(p, "click")) or isdir(join(p, "platformio")))
|
|
if all(conditions):
|
|
_PYTHONPATH.append(p)
|
|
os.environ['PYTHONPATH'] = os.pathsep.join(_PYTHONPATH)
|
|
|
|
|
|
def get_serial_ports(filter_hwid=False):
|
|
try:
|
|
from serial.tools.list_ports import comports
|
|
except ImportError:
|
|
raise exception.GetSerialPortsError(os.name)
|
|
|
|
result = []
|
|
for p, d, h in comports():
|
|
if not p:
|
|
continue
|
|
if "windows" in get_systype():
|
|
try:
|
|
d = unicode(d, errors="ignore")
|
|
except TypeError:
|
|
pass
|
|
if not filter_hwid or "VID:PID" in h:
|
|
result.append({"port": p, "description": d, "hwid": h})
|
|
|
|
if filter_hwid:
|
|
return result
|
|
|
|
# fix for PySerial
|
|
if not result and "darwin" in get_systype():
|
|
for p in glob("/dev/tty.*"):
|
|
result.append({"port": p, "description": "n/a", "hwid": "n/a"})
|
|
return result
|
|
|
|
|
|
# Backward compatibility for PIO Core <3.5
|
|
get_serialports = get_serial_ports
|
|
|
|
|
|
def get_logical_devices():
|
|
items = []
|
|
if "windows" in get_systype():
|
|
try:
|
|
result = exec_command(
|
|
["wmic", "logicaldisk", "get", "name,VolumeName"]).get(
|
|
"out", "")
|
|
devicenamere = re.compile(r"^([A-Z]{1}\:)\s*(\S+)?")
|
|
for line in result.split("\n"):
|
|
match = devicenamere.match(line.strip())
|
|
if not match:
|
|
continue
|
|
items.append({
|
|
"path": match.group(1) + "\\",
|
|
"name": match.group(2)
|
|
})
|
|
return items
|
|
except WindowsError: # pylint: disable=undefined-variable
|
|
pass
|
|
# try "fsutil"
|
|
result = exec_command(["fsutil", "fsinfo", "drives"]).get("out", "")
|
|
for device in re.findall(r"[A-Z]:\\", result):
|
|
items.append({"path": device, "name": None})
|
|
return items
|
|
else:
|
|
result = exec_command(["df"]).get("out")
|
|
devicenamere = re.compile(r"^/.+\d+\%\s+([a-z\d\-_/]+)$", flags=re.I)
|
|
for line in result.split("\n"):
|
|
match = devicenamere.match(line.strip())
|
|
if not match:
|
|
continue
|
|
items.append({
|
|
"path": match.group(1),
|
|
"name": basename(match.group(1))
|
|
})
|
|
return items
|
|
|
|
|
|
def get_mdns_services():
|
|
try:
|
|
import zeroconf
|
|
except ImportError:
|
|
from site import addsitedir
|
|
from platformio.managers.core import get_core_package_dir
|
|
contrib_pysite_dir = get_core_package_dir("contrib-pysite")
|
|
addsitedir(contrib_pysite_dir)
|
|
sys.path.insert(0, contrib_pysite_dir)
|
|
import zeroconf
|
|
|
|
class mDNSListener(object):
|
|
|
|
def __init__(self):
|
|
self._zc = zeroconf.Zeroconf(
|
|
interfaces=zeroconf.InterfaceChoice.All)
|
|
self._found_types = []
|
|
self._found_services = []
|
|
|
|
def __enter__(self):
|
|
zeroconf.ServiceBrowser(self._zc, "_services._dns-sd._udp.local.",
|
|
self)
|
|
return self
|
|
|
|
def __exit__(self, etype, value, traceback):
|
|
self._zc.close()
|
|
|
|
def remove_service(self, zc, type_, name):
|
|
pass
|
|
|
|
def add_service(self, zc, type_, name):
|
|
try:
|
|
assert zeroconf.service_type_name(name)
|
|
assert str(name)
|
|
except (AssertionError, UnicodeError,
|
|
zeroconf.BadTypeInNameException):
|
|
return
|
|
if name not in self._found_types:
|
|
self._found_types.append(name)
|
|
zeroconf.ServiceBrowser(self._zc, name, self)
|
|
if type_ in self._found_types:
|
|
s = zc.get_service_info(type_, name)
|
|
if s:
|
|
self._found_services.append(s)
|
|
|
|
def get_services(self):
|
|
return self._found_services
|
|
|
|
items = []
|
|
with mDNSListener() as mdns:
|
|
time.sleep(3)
|
|
for service in mdns.get_services():
|
|
properties = None
|
|
try:
|
|
if service.properties:
|
|
json.dumps(service.properties)
|
|
properties = service.properties
|
|
except UnicodeDecodeError:
|
|
pass
|
|
|
|
items.append({
|
|
"type":
|
|
service.type,
|
|
"name":
|
|
service.name,
|
|
"ip":
|
|
".".join([str(ord(c)) for c in service.address]),
|
|
"port":
|
|
service.port,
|
|
"properties":
|
|
properties
|
|
})
|
|
return items
|
|
|
|
|
|
def get_request_defheaders():
|
|
data = (__version__, int(is_ci()), requests.utils.default_user_agent())
|
|
return {"User-Agent": "PlatformIO/%s CI/%d %s" % data}
|
|
|
|
|
|
@memoized(expire=10000)
|
|
def _api_request_session():
|
|
return requests.Session()
|
|
|
|
|
|
@throttle(500)
|
|
def _get_api_result(
|
|
url, # pylint: disable=too-many-branches
|
|
params=None,
|
|
data=None,
|
|
auth=None):
|
|
from platformio.app import get_setting
|
|
|
|
result = None
|
|
r = None
|
|
verify_ssl = sys.version_info >= (2, 7, 9)
|
|
|
|
headers = get_request_defheaders()
|
|
if not url.startswith("http"):
|
|
url = __apiurl__ + url
|
|
if not get_setting("enable_ssl"):
|
|
url = url.replace("https://", "http://")
|
|
|
|
try:
|
|
if data:
|
|
r = _api_request_session().post(
|
|
url,
|
|
params=params,
|
|
data=data,
|
|
headers=headers,
|
|
auth=auth,
|
|
verify=verify_ssl)
|
|
else:
|
|
r = _api_request_session().get(
|
|
url,
|
|
params=params,
|
|
headers=headers,
|
|
auth=auth,
|
|
verify=verify_ssl)
|
|
result = r.json()
|
|
r.raise_for_status()
|
|
return r.text
|
|
except requests.exceptions.HTTPError as e:
|
|
if result and "message" in result:
|
|
raise exception.APIRequestError(result['message'])
|
|
elif result and "errors" in result:
|
|
raise exception.APIRequestError(result['errors'][0]['title'])
|
|
else:
|
|
raise exception.APIRequestError(e)
|
|
except ValueError:
|
|
raise exception.APIRequestError(
|
|
"Invalid response: %s" % r.text.encode("utf-8"))
|
|
finally:
|
|
if r:
|
|
r.close()
|
|
return None
|
|
|
|
|
|
def get_api_result(url, params=None, data=None, auth=None, cache_valid=None):
|
|
from platformio.app import ContentCache
|
|
total = 0
|
|
max_retries = 5
|
|
cache_key = (ContentCache.key_from_args(url, params, data, auth)
|
|
if cache_valid else None)
|
|
while total < max_retries:
|
|
try:
|
|
with ContentCache() as cc:
|
|
if cache_key:
|
|
result = cc.get(cache_key)
|
|
if result is not None:
|
|
return json.loads(result)
|
|
|
|
# check internet before and resolve issue with 60 seconds timeout
|
|
internet_on(raise_exception=True)
|
|
|
|
result = _get_api_result(url, params, data)
|
|
if cache_valid:
|
|
with ContentCache() as cc:
|
|
cc.set(cache_key, result, cache_valid)
|
|
return json.loads(result)
|
|
except (requests.exceptions.ConnectionError,
|
|
requests.exceptions.Timeout) as e:
|
|
from platformio.maintenance import in_silence
|
|
total += 1
|
|
if not in_silence():
|
|
click.secho(
|
|
"[API] ConnectionError: {0} (incremented retry: max={1}, "
|
|
"total={2})".format(e, max_retries, total),
|
|
fg="yellow")
|
|
time.sleep(2 * total)
|
|
|
|
raise exception.APIRequestError(
|
|
"Could not connect to PlatformIO API Service. "
|
|
"Please try later.")
|
|
|
|
|
|
PING_INTERNET_IPS = [
|
|
"192.30.253.113", # github.com
|
|
"159.122.18.156", # dl.bintray.com
|
|
"193.222.52.25" # dl.platformio.org
|
|
]
|
|
|
|
|
|
@memoized(expire=5000)
|
|
def _internet_on():
|
|
timeout = 2
|
|
socket.setdefaulttimeout(timeout)
|
|
for ip in PING_INTERNET_IPS:
|
|
try:
|
|
if os.getenv("HTTP_PROXY", os.getenv("HTTPS_PROXY")):
|
|
requests.get(
|
|
"http://%s" % ip, allow_redirects=False, timeout=timeout)
|
|
else:
|
|
socket.socket(socket.AF_INET, socket.SOCK_STREAM).connect((ip,
|
|
80))
|
|
return True
|
|
except: # pylint: disable=bare-except
|
|
pass
|
|
return False
|
|
|
|
|
|
def internet_on(raise_exception=False):
|
|
result = _internet_on()
|
|
if raise_exception and not result:
|
|
raise exception.InternetIsOffline()
|
|
return result
|
|
|
|
|
|
def get_pythonexe_path():
|
|
return os.environ.get("PYTHONEXEPATH", normpath(sys.executable))
|
|
|
|
|
|
def where_is_program(program, envpath=None):
|
|
env = os.environ
|
|
if envpath:
|
|
env['PATH'] = envpath
|
|
|
|
# try OS's built-in commands
|
|
try:
|
|
result = exec_command(
|
|
["where" if "windows" in get_systype() else "which", program],
|
|
env=env)
|
|
if result['returncode'] == 0 and isfile(result['out'].strip()):
|
|
return result['out'].strip()
|
|
except OSError:
|
|
pass
|
|
|
|
# look up in $PATH
|
|
for bin_dir in env.get("PATH", "").split(os.pathsep):
|
|
if isfile(join(bin_dir, program)):
|
|
return join(bin_dir, program)
|
|
elif isfile(join(bin_dir, "%s.exe" % program)):
|
|
return join(bin_dir, "%s.exe" % program)
|
|
|
|
return program
|
|
|
|
|
|
def pepver_to_semver(pepver):
|
|
return re.sub(r"(\.\d+)\.?(dev|a|b|rc|post)", r"\1-\2.", pepver, 1)
|
|
|
|
|
|
def items_to_list(items):
|
|
if not isinstance(items, list):
|
|
items = [i.strip() for i in items.split(",")]
|
|
return [i.lower() for i in items if i]
|
|
|
|
|
|
def items_in_list(needle, haystack):
|
|
needle = items_to_list(needle)
|
|
haystack = items_to_list(haystack)
|
|
if "*" in needle or "*" in haystack:
|
|
return True
|
|
return set(needle) & set(haystack)
|
|
|
|
|
|
def parse_date(datestr):
|
|
if "T" in datestr and "Z" in datestr:
|
|
return time.strptime(datestr, "%Y-%m-%dT%H:%M:%SZ")
|
|
return time.strptime(datestr)
|
|
|
|
|
|
def format_filesize(filesize):
|
|
base = 1024
|
|
unit = 0
|
|
suffix = "B"
|
|
filesize = float(filesize)
|
|
if filesize < base:
|
|
return "%d%s" % (filesize, suffix)
|
|
for i, suffix in enumerate("KMGTPEZY"):
|
|
unit = base**(i + 2)
|
|
if filesize >= unit:
|
|
continue
|
|
if filesize % (base**(i + 1)):
|
|
return "%.2f%sB" % ((base * filesize / unit), suffix)
|
|
break
|
|
return "%d%sB" % ((base * filesize / unit), suffix)
|
|
|
|
|
|
def merge_dicts(d1, d2, path=None):
|
|
if path is None:
|
|
path = []
|
|
for key in d2:
|
|
if (key in d1 and isinstance(d1[key], dict)
|
|
and isinstance(d2[key], dict)):
|
|
merge_dicts(d1[key], d2[key], path + [str(key)])
|
|
else:
|
|
d1[key] = d2[key]
|
|
return d1
|
|
|
|
|
|
def ensure_udev_rules():
|
|
|
|
def _rules_to_set(rules_path):
|
|
result = set([])
|
|
with open(rules_path, "rb") as fp:
|
|
for line in fp.readlines():
|
|
line = line.strip()
|
|
if not line or line.startswith("#"):
|
|
continue
|
|
result.add(line)
|
|
return result
|
|
|
|
if "linux" not in get_systype():
|
|
return None
|
|
installed_rules = [
|
|
"/etc/udev/rules.d/99-platformio-udev.rules",
|
|
"/lib/udev/rules.d/99-platformio-udev.rules"
|
|
]
|
|
if not any(isfile(p) for p in installed_rules):
|
|
raise exception.MissedUdevRules
|
|
|
|
origin_path = abspath(
|
|
join(get_source_dir(), "..", "scripts", "99-platformio-udev.rules"))
|
|
if not isfile(origin_path):
|
|
return None
|
|
|
|
origin_rules = _rules_to_set(origin_path)
|
|
for rules_path in installed_rules:
|
|
if not isfile(rules_path):
|
|
continue
|
|
current_rules = _rules_to_set(rules_path)
|
|
if not origin_rules <= current_rules:
|
|
raise exception.OutdatedUdevRules(rules_path)
|
|
|
|
return True
|
|
|
|
|
|
def rmtree_(path):
|
|
|
|
def _onerror(_, name, __):
|
|
try:
|
|
os.chmod(name, stat.S_IWRITE)
|
|
os.remove(name)
|
|
except Exception as e: # pylint: disable=broad-except
|
|
click.secho(
|
|
"%s \nPlease manually remove the file `%s`" % (str(e), name),
|
|
fg="red",
|
|
err=True)
|
|
|
|
return rmtree(path, onerror=_onerror)
|
|
|
|
|
|
#
|
|
# Glob.Escape from Python 3.4
|
|
# https://github.com/python/cpython/blob/master/Lib/glob.py#L161
|
|
#
|
|
|
|
try:
|
|
from glob import escape as glob_escape # pylint: disable=unused-import
|
|
except ImportError:
|
|
magic_check = re.compile('([*?[])')
|
|
magic_check_bytes = re.compile(b'([*?[])')
|
|
|
|
def glob_escape(pathname):
|
|
"""Escape all special characters."""
|
|
# Escaping is done by wrapping any of "*?[" between square brackets.
|
|
# Metacharacters do not work in the drive part and shouldn't be
|
|
# escaped.
|
|
drive, pathname = os.path.splitdrive(pathname)
|
|
if isinstance(pathname, bytes):
|
|
pathname = magic_check_bytes.sub(br'[\1]', pathname)
|
|
else:
|
|
pathname = magic_check.sub(r'[\1]', pathname)
|
|
return drive + pathname
|