# Copyright 2014-present PlatformIO # # 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 collections import functools import json import os import re import stat import subprocess import sys from glob import glob from os.path import (abspath, basename, dirname, expanduser, isdir, isfile, join, normpath, splitdrive) from platform import system, uname from shutil import rmtree from threading import Thread from time import sleep import click import requests from platformio import __apiurl__, __version__, exception # pylint: disable=wrong-import-order try: from configparser import ConfigParser except ImportError: from ConfigParser import ConfigParser class AsyncPipe(Thread): def __init__(self, outcallback=None): Thread.__init__(self) 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): ''' Decorator. Caches a function's return value each time it is called. If called later with the same arguments, the cached value is returned (not reevaluated). https://wiki.python.org/moin/PythonDecoratorLibrary#Memoize ''' def __init__(self, func): self.func = func self.cache = {} def __call__(self, *args): if not isinstance(args, collections.Hashable): # uncacheable. a list, for instance. # better to not cache than blow up. return self.func(*args) if args in self.cache: return self.cache[args] else: value = self.func(*args) self.cache[args] = value return value def __repr__(self): '''Return the function's docstring.''' return self.func.__doc__ def __get__(self, obj, objtype): '''Support instance methods.''' return functools.partial(self.__call__, obj) 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 load_json(file_path): with open(file_path, "r") as f: return json.load(f) def get_systype(): data = uname() type_ = data[0].lower() arch = data[4].lower() if data[4] else "" 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_projconf_option_dir(name, default=None): _env_name = "PLATFORMIO_%s" % name.upper() if _env_name in os.environ: return os.getenv(_env_name) try: config = load_project_config() if (config.has_section("platformio") and config.has_option("platformio", name)): option_dir = config.get("platformio", name) if option_dir.startswith("~"): option_dir = expanduser(option_dir) return abspath(option_dir) except exception.NotPlatformIOProject: pass return default def get_home_dir(): home_dir = _get_projconf_option_dir("home_dir", join(expanduser("~"), ".platformio")) if "windows" in get_systype(): try: home_dir.encode("utf8") except UnicodeDecodeError: home_dir = splitdrive(home_dir)[0] + "\\.platformio" if not isdir(home_dir): os.makedirs(home_dir) assert isdir(home_dir) return home_dir 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_projconf_option_dir("lib_dir", join(get_project_dir(), "lib")) def get_projectlibdeps_dir(): return _get_projconf_option_dir("libdeps_dir", join(get_project_dir(), ".piolibdeps")) def get_projectsrc_dir(): return _get_projconf_option_dir("src_dir", join(get_project_dir(), "src")) def get_projecttest_dir(): return _get_projconf_option_dir("test_dir", join(get_project_dir(), "test")) def get_projectpioenvs_dir(force=False): path = _get_projconf_option_dir("envs_dir", join(get_project_dir(), ".pioenvs")) 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=http://docs.platformio.org/en/stable/projectconf.html#envs-dir """) except Exception as e: # pylint: disable=broad-except if not force: raise Exception(e) return path def get_projectdata_dir(): return _get_projconf_option_dir("data_dir", join(get_project_dir(), "data")) def load_project_config(project_dir=None): if not project_dir: project_dir = get_project_dir() if not is_platformio_project(project_dir): raise exception.NotPlatformIOProject(project_dir) cp = ConfigParser() cp.read(join(project_dir, "platformio.ini")) return cp def change_filemtime(path, time): os.utime(path, (time, time)) def is_ci(): return os.getenv("CI", "").lower() == "true" 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: if p not in _PYTHONPATH: _PYTHONPATH.append(p) os.environ['PYTHONPATH'] = os.pathsep.join(_PYTHONPATH) def get_serialports(): 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 system() == "Windows": try: d = unicode(d, errors="ignore") except TypeError: pass result.append({"port": p, "description": d, "hwid": h}) # fix for PySerial if not result and system() == "Darwin": for p in glob("/dev/tty.*"): result.append({"port": p, "description": "n/a", "hwid": "n/a"}) return result def get_logicaldisks(): disks = [] if system() == "Windows": result = exec_command( ["wmic", "logicaldisk", "get", "name,VolumeName"]).get("out", "") disknamere = re.compile(r"^([A-Z]{1}\:)\s*(\S+)?") for line in result.split("\n"): match = disknamere.match(line.strip()) if not match: continue disks.append({"disk": match.group(1), "name": match.group(2)}) else: result = exec_command(["df"]).get("out") disknamere = re.compile(r"\d+\%\s+([a-z\d\-_/]+)$", flags=re.I) for line in result.split("\n"): match = disknamere.search(line.strip()) if not match: continue disks.append({"disk": match.group(1), "name": basename(match.group(1))}) return disks def get_request_defheaders(): data = (__version__, int(is_ci()), requests.utils.default_user_agent()) return {"User-Agent": "PlatformIO/%s CI/%d %s" % data} @memoized def _api_request_session(): return requests.Session() def _get_api_result( path, # pylint: disable=too-many-branches params=None, data=None): from platformio.app import get_setting result = None r = None headers = get_request_defheaders() url = __apiurl__ if not get_setting("enable_ssl"): url = url.replace("https://", "http://") try: if data: r = _api_request_session().post( url + path, params=params, data=data, headers=headers) else: r = _api_request_session().get(url + path, params=params, headers=headers) result = r.json() r.raise_for_status() except requests.exceptions.HTTPError as e: if 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 result def get_api_result(path, params=None, data=None): max_retries = 5 total = 0 while total < max_retries: try: return _get_api_result(path, params, data) 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") sleep(2 * total) raise exception.APIRequestError( "Could not connect to PlatformIO Registry Service. " "Please try later.") 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 rmtree_(path): def _onerror(_, name, __): os.chmod(name, stat.S_IWRITE) os.remove(name) return rmtree(path, onerror=_onerror)