mirror of
https://github.com/home-assistant/core.git
synced 2025-04-26 02:07:54 +00:00
ac72dea09a
Prometheus (https://prometheus.io/) is an open source metric and alerting system. This adds support for exporting some metrics to Prometheus, using its Python client library.
290 lines
7.4 KiB
Python
Executable File
290 lines
7.4 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
"""Generate an updated requirements_all.txt."""
|
|
import importlib
|
|
import os
|
|
import pkgutil
|
|
import re
|
|
import sys
|
|
|
|
COMMENT_REQUIREMENTS = (
|
|
'RPi.GPIO',
|
|
'raspihats',
|
|
'rpi-rf',
|
|
'Adafruit_Python_DHT',
|
|
'Adafruit_BBIO',
|
|
'fritzconnection',
|
|
'pybluez',
|
|
'beacontools',
|
|
'bluepy',
|
|
'opencv-python',
|
|
'python-lirc',
|
|
'gattlib',
|
|
'pyuserinput',
|
|
'evdev',
|
|
'pycups',
|
|
'python-eq3bt',
|
|
'avion',
|
|
'decora',
|
|
'face_recognition',
|
|
'blinkt',
|
|
'smbus-cffi',
|
|
'envirophat',
|
|
'i2csense'
|
|
)
|
|
|
|
TEST_REQUIREMENTS = (
|
|
'pydispatch',
|
|
'influxdb',
|
|
'nx584',
|
|
'uvcclient',
|
|
'somecomfort',
|
|
'aioautomatic',
|
|
'SoCo',
|
|
'libsoundtouch',
|
|
'libpurecoollink',
|
|
'rxv',
|
|
'apns2',
|
|
'sqlalchemy',
|
|
'forecastio',
|
|
'aiohttp_cors',
|
|
'pilight',
|
|
'fuzzywuzzy',
|
|
'rflink',
|
|
'ring_doorbell',
|
|
'sleepyq',
|
|
'statsd',
|
|
'pylitejet',
|
|
'holidays',
|
|
'evohomeclient',
|
|
'pexpect',
|
|
'hbmqtt',
|
|
'paho',
|
|
'dsmr_parser',
|
|
'mficlient',
|
|
'pmsensor',
|
|
'yahoo-finance',
|
|
'ha-ffmpeg',
|
|
'gTTS-token',
|
|
'pywebpush',
|
|
'PyJWT',
|
|
'restrictedpython',
|
|
'pyunifi',
|
|
'prometheus_client',
|
|
)
|
|
|
|
IGNORE_PACKAGES = (
|
|
'homeassistant.components.recorder.models',
|
|
)
|
|
|
|
IGNORE_PIN = ('colorlog>2.1,<3', 'keyring>=9.3,<10.0', 'urllib3')
|
|
|
|
IGNORE_REQ = (
|
|
'colorama<=1', # Windows only requirement in check_config
|
|
)
|
|
|
|
URL_PIN = ('https://home-assistant.io/developers/code_review_platform/'
|
|
'#1-requirements')
|
|
|
|
|
|
CONSTRAINT_PATH = os.path.join(os.path.dirname(__file__),
|
|
'../homeassistant/package_constraints.txt')
|
|
|
|
|
|
def explore_module(package, explore_children):
|
|
"""Explore the modules."""
|
|
module = importlib.import_module(package)
|
|
|
|
found = []
|
|
|
|
if not hasattr(module, '__path__'):
|
|
return found
|
|
|
|
for _, name, _ in pkgutil.iter_modules(module.__path__, package + '.'):
|
|
found.append(name)
|
|
|
|
if explore_children:
|
|
found.extend(explore_module(name, False))
|
|
|
|
return found
|
|
|
|
|
|
def core_requirements():
|
|
"""Gather core requirements out of setup.py."""
|
|
with open('setup.py') as inp:
|
|
reqs_raw = re.search(
|
|
r'REQUIRES = \[(.*?)\]', inp.read(), re.S).group(1)
|
|
return re.findall(r"'(.*?)'", reqs_raw)
|
|
|
|
|
|
def comment_requirement(req):
|
|
"""Some requirements don't install on all systems."""
|
|
return any(ign in req for ign in COMMENT_REQUIREMENTS)
|
|
|
|
|
|
def gather_modules():
|
|
"""Collect the information."""
|
|
reqs = {}
|
|
|
|
errors = []
|
|
|
|
for package in sorted(explore_module('homeassistant.components', True) +
|
|
explore_module('homeassistant.scripts', True)):
|
|
try:
|
|
module = importlib.import_module(package)
|
|
except ImportError:
|
|
if package not in IGNORE_PACKAGES:
|
|
errors.append(package)
|
|
continue
|
|
|
|
if not getattr(module, 'REQUIREMENTS', None):
|
|
continue
|
|
|
|
for req in module.REQUIREMENTS:
|
|
if req in IGNORE_REQ:
|
|
continue
|
|
if req.partition('==')[1] == '' and req not in IGNORE_PIN:
|
|
errors.append(
|
|
"{}[Please pin requirement {}, see {}]".format(
|
|
package, req, URL_PIN))
|
|
reqs.setdefault(req, []).append(package)
|
|
|
|
for key in reqs:
|
|
reqs[key] = sorted(reqs[key],
|
|
key=lambda name: (len(name.split('.')), name))
|
|
|
|
if errors:
|
|
print("******* ERROR")
|
|
print("Errors while importing: ", ', '.join(errors))
|
|
print("Make sure you import 3rd party libraries inside methods.")
|
|
return None
|
|
|
|
return reqs
|
|
|
|
|
|
def generate_requirements_list(reqs):
|
|
"""Generate a pip file based on requirements."""
|
|
output = []
|
|
for pkg, requirements in sorted(reqs.items(), key=lambda item: item[0]):
|
|
for req in sorted(requirements,
|
|
key=lambda name: (len(name.split('.')), name)):
|
|
output.append('\n# {}'.format(req))
|
|
|
|
if comment_requirement(pkg):
|
|
output.append('\n# {}\n'.format(pkg))
|
|
else:
|
|
output.append('\n{}\n'.format(pkg))
|
|
return ''.join(output)
|
|
|
|
|
|
def requirements_all_output(reqs):
|
|
"""Generate output for requirements_all."""
|
|
output = []
|
|
output.append('# Home Assistant core')
|
|
output.append('\n')
|
|
output.append('\n'.join(core_requirements()))
|
|
output.append('\n')
|
|
output.append(generate_requirements_list(reqs))
|
|
|
|
return ''.join(output)
|
|
|
|
|
|
def requirements_test_output(reqs):
|
|
"""Generate output for test_requirements."""
|
|
output = []
|
|
output.append('# Home Assistant test')
|
|
output.append('\n')
|
|
with open('requirements_test.txt') as fp:
|
|
output.append(fp.read())
|
|
output.append('\n')
|
|
filtered = {key: value for key, value in reqs.items()
|
|
if any(ign in key for ign in TEST_REQUIREMENTS)}
|
|
output.append(generate_requirements_list(filtered))
|
|
|
|
return ''.join(output)
|
|
|
|
|
|
def gather_constraints():
|
|
"""Construct output for constraint file."""
|
|
return '\n'.join(core_requirements() + [''])
|
|
|
|
|
|
def write_requirements_file(data):
|
|
"""Write the modules to the requirements_all.txt."""
|
|
with open('requirements_all.txt', 'w+', newline="\n") as req_file:
|
|
req_file.write(data)
|
|
|
|
|
|
def write_test_requirements_file(data):
|
|
"""Write the modules to the requirements_all.txt."""
|
|
with open('requirements_test_all.txt', 'w+', newline="\n") as req_file:
|
|
req_file.write(data)
|
|
|
|
|
|
def write_constraints_file(data):
|
|
"""Write constraints to a file."""
|
|
with open(CONSTRAINT_PATH, 'w+', newline="\n") as req_file:
|
|
req_file.write(data)
|
|
|
|
|
|
def validate_requirements_file(data):
|
|
"""Validate if requirements_all.txt is up to date."""
|
|
with open('requirements_all.txt', 'r') as req_file:
|
|
return data == ''.join(req_file)
|
|
|
|
|
|
def validate_requirements_test_file(data):
|
|
"""Validate if requirements_all.txt is up to date."""
|
|
with open('requirements_test_all.txt', 'r') as req_file:
|
|
return data == ''.join(req_file)
|
|
|
|
|
|
def validate_constraints_file(data):
|
|
"""Validate if constraints is up to date."""
|
|
with open(CONSTRAINT_PATH, 'r') as req_file:
|
|
return data == ''.join(req_file)
|
|
|
|
|
|
def main():
|
|
"""Main section of the script."""
|
|
if not os.path.isfile('requirements_all.txt'):
|
|
print('Run this from HA root dir')
|
|
return
|
|
|
|
data = gather_modules()
|
|
|
|
if data is None:
|
|
sys.exit(1)
|
|
|
|
constraints = gather_constraints()
|
|
|
|
reqs_file = requirements_all_output(data)
|
|
reqs_test_file = requirements_test_output(data)
|
|
|
|
if sys.argv[-1] == 'validate':
|
|
errors = []
|
|
if not validate_requirements_file(reqs_file):
|
|
errors.append("requirements_all.txt is not up to date")
|
|
|
|
if not validate_requirements_test_file(reqs_test_file):
|
|
errors.append("requirements_test_all.txt is not up to date")
|
|
|
|
if not validate_constraints_file(constraints):
|
|
errors.append(
|
|
"home-assistant/package_constraints.txt is not up to date")
|
|
|
|
if errors:
|
|
print("******* ERROR")
|
|
print('\n'.join(errors))
|
|
print("Please run script/gen_requirements_all.py")
|
|
sys.exit(1)
|
|
|
|
sys.exit(0)
|
|
|
|
write_requirements_file(reqs_file)
|
|
write_test_requirements_file(reqs_test_file)
|
|
write_constraints_file(constraints)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|