sascha/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2025-09-03 11:52:20 +01:00
Code Issues Releases Wiki Activity

add-black (#1593)

Browse Source 
* Add black

Update pre commit

Update pre commit

add empty line

* Format with black
This commit is contained in:
Guillermo Ruffino
2021-03-07 16:03:16 -03:00
committed by GitHub
parent 2b60b0f1fa
commit 69879920eb
398 changed files with 21624 additions and 12644 deletions
Download Patch File Download Diff File Expand all files Collapse all files

233
esphome/writer.py
View File

@@ -3,30 +3,46 @@ import os
import re
from esphome.config import iter_components
from esphome.const import CONF_BOARD_FLASH_MODE, CONF_ESPHOME, CONF_PLATFORMIO_OPTIONS, \
HEADER_FILE_EXTENSIONS, SOURCE_FILE_EXTENSIONS, __version__, ARDUINO_VERSION_ESP8266, \
ENV_NOGITIGNORE
from esphome.const import (
CONF_BOARD_FLASH_MODE,
CONF_ESPHOME,
CONF_PLATFORMIO_OPTIONS,
HEADER_FILE_EXTENSIONS,
SOURCE_FILE_EXTENSIONS,
__version__,
ARDUINO_VERSION_ESP8266,
ENV_NOGITIGNORE,
)
from esphome.core import CORE, EsphomeError
from esphome.helpers import mkdir_p, read_file, write_file_if_changed, walk_files, \
copy_file_if_changed, get_bool_env
from esphome.helpers import (
mkdir_p,
read_file,
write_file_if_changed,
walk_files,
copy_file_if_changed,
get_bool_env,
)
from esphome.storage_json import StorageJSON, storage_path
from esphome.pins import ESP8266_FLASH_SIZES, ESP8266_LD_SCRIPTS
_LOGGER = logging.getLogger(__name__)
CPP_AUTO_GENERATE_BEGIN = '// ========== AUTO GENERATED CODE BEGIN ==========='
CPP_AUTO_GENERATE_END = '// =========== AUTO GENERATED CODE END ============'
CPP_INCLUDE_BEGIN = '// ========== AUTO GENERATED INCLUDE BLOCK BEGIN ==========='
CPP_INCLUDE_END = '// ========== AUTO GENERATED INCLUDE BLOCK END ==========='
INI_AUTO_GENERATE_BEGIN = '; ========== AUTO GENERATED CODE BEGIN ==========='
INI_AUTO_GENERATE_END = '; =========== AUTO GENERATED CODE END ============'
CPP_AUTO_GENERATE_BEGIN = "// ========== AUTO GENERATED CODE BEGIN ==========="
CPP_AUTO_GENERATE_END = "// =========== AUTO GENERATED CODE END ============"
CPP_INCLUDE_BEGIN = "// ========== AUTO GENERATED INCLUDE BLOCK BEGIN ==========="
CPP_INCLUDE_END = "// ========== AUTO GENERATED INCLUDE BLOCK END ==========="
INI_AUTO_GENERATE_BEGIN = "; ========== AUTO GENERATED CODE BEGIN ==========="
INI_AUTO_GENERATE_END = "; =========== AUTO GENERATED CODE END ============"
CPP_BASE_FORMAT = ("""// Auto generated code by esphome
""", """"
CPP_BASE_FORMAT = (
"""// Auto generated code by esphome
""",
""""
void setup() {
// ===== DO NOT EDIT ANYTHING BELOW THIS LINE =====
""", """
""",
"""
// ========= YOU CAN EDIT AFTER THIS LINE =========
App.setup();
}
@@ -34,9 +50,11 @@ void setup() {
void loop() {
App.loop();
}
""")
""",
)
INI_BASE_FORMAT = ("""; Auto generated code by esphome
INI_BASE_FORMAT = (
"""; Auto generated code by esphome
[common]
lib_deps =
@@ -44,13 +62,15 @@ build_flags =
upload_flags =
; ===== DO NOT EDIT ANYTHING BELOW THIS LINE =====
""", """
""",
"""
; ========= YOU CAN EDIT AFTER THIS LINE =========
""")
""",
)
UPLOAD_SPEED_OVERRIDE = {
'esp210': 57600,
"esp210": 57600,
}
@@ -62,10 +82,9 @@ def get_flags(key):
def get_include_text():
include_text = '#include "esphome.h"\n' \
'using namespace esphome;\n'
include_text = '#include "esphome.h"\nusing namespace esphome;\n'
for _, component, conf in iter_components(CORE.config):
if not hasattr(component, 'includes'):
if not hasattr(component, "includes"):
continue
includes = component.includes
if callable(includes):
@@ -73,10 +92,10 @@ def get_include_text():
if includes is None:
continue
if isinstance(includes, list):
includes = '\n'.join(includes)
includes = "\n".join(includes)
if not includes:
continue
include_text += includes + '\n'
include_text += includes + "\n"
return include_text
@@ -86,7 +105,7 @@ def replace_file_content(text, pattern, repl):
def migrate_src_version_0_to_1():
main_cpp = CORE.relative_build_path('src', 'main.cpp')
main_cpp = CORE.relative_build_path("src", "main.cpp")
if not os.path.isfile(main_cpp):
return
@@ -95,22 +114,35 @@ def migrate_src_version_0_to_1():
if CPP_INCLUDE_BEGIN in content:
return
content, count = replace_file_content(content, r'\s*delay\((?:16|20)\);', '')
content, count = replace_file_content(content, r"\s*delay\((?:16|20)\);", "")
if count != 0:
_LOGGER.info("Migration: Removed %s occurrence of 'delay(16);' in %s", count, main_cpp)
_LOGGER.info(
"Migration: Removed %s occurrence of 'delay(16);' in %s", count, main_cpp
)
content, count = replace_file_content(content, r'using namespace esphomelib;', '')
content, count = replace_file_content(content, r"using namespace esphomelib;", "")
if count != 0:
_LOGGER.info("Migration: Removed %s occurrence of 'using namespace esphomelib;' "
"in %s", count, main_cpp)
_LOGGER.info(
"Migration: Removed %s occurrence of 'using namespace esphomelib;' "
"in %s",
count,
main_cpp,
)
if CPP_INCLUDE_BEGIN not in content:
content, count = replace_file_content(content, r'#include "esphomelib/application.h"',
CPP_INCLUDE_BEGIN + '\n' + CPP_INCLUDE_END)
content, count = replace_file_content(
content,
r'#include "esphomelib/application.h"',
CPP_INCLUDE_BEGIN + "\n" + CPP_INCLUDE_END,
)
if count == 0:
_LOGGER.error("Migration failed. ESPHome 1.10.0 needs to have a new auto-generated "
"include section in the %s file. Please remove %s and let it be "
"auto-generated again.", main_cpp, main_cpp)
_LOGGER.error(
"Migration failed. ESPHome 1.10.0 needs to have a new auto-generated "
"include section in the %s file. Please remove %s and let it be "
"auto-generated again.",
main_cpp,
main_cpp,
)
_LOGGER.info("Migration: Added include section to %s", main_cpp)
write_file_if_changed(main_cpp, content)
@@ -160,14 +192,14 @@ def update_storage_json():
def format_ini(data):
content = ''
content = ""
for key, value in sorted(data.items()):
if isinstance(value, (list, set, tuple)):
content += f'{key} =\n'
content += f"{key} =\n"
for x in value:
content += f' {x}\n'
content += f" {x}\n"
else:
content += f'{key} = {value}\n'
content += f"{key} = {value}\n"
return content
@@ -197,23 +229,23 @@ def get_ini_content():
build_flags = gather_build_flags()
data = {
'platform': CORE.arduino_version,
'board': CORE.board,
'framework': 'arduino',
'lib_deps': lib_deps + ['${common.lib_deps}'],
'build_flags': build_flags + ['${common.build_flags}'],
'upload_speed': UPLOAD_SPEED_OVERRIDE.get(CORE.board, 115200),
"platform": CORE.arduino_version,
"board": CORE.board,
"framework": "arduino",
"lib_deps": lib_deps + ["${common.lib_deps}"],
"build_flags": build_flags + ["${common.build_flags}"],
"upload_speed": UPLOAD_SPEED_OVERRIDE.get(CORE.board, 115200),
}
if CORE.is_esp32:
data['board_build.partitions'] = "partitions.csv"
partitions_csv = CORE.relative_build_path('partitions.csv')
data["board_build.partitions"] = "partitions.csv"
partitions_csv = CORE.relative_build_path("partitions.csv")
write_file_if_changed(partitions_csv, ESP32_LARGE_PARTITIONS_CSV)
# pylint: disable=unsubscriptable-object
if CONF_BOARD_FLASH_MODE in CORE.config[CONF_ESPHOME]:
flash_mode = CORE.config[CONF_ESPHOME][CONF_BOARD_FLASH_MODE]
data['board_build.flash_mode'] = flash_mode
data["board_build.flash_mode"] = flash_mode
# Build flags
if CORE.is_esp8266 and CORE.board in ESP8266_FLASH_SIZES:
@@ -221,11 +253,11 @@ def get_ini_content():
ld_scripts = ESP8266_LD_SCRIPTS[flash_size]
versions_with_old_ldscripts = [
ARDUINO_VERSION_ESP8266['2.4.0'],
ARDUINO_VERSION_ESP8266['2.4.1'],
ARDUINO_VERSION_ESP8266['2.4.2'],
ARDUINO_VERSION_ESP8266["2.4.0"],
ARDUINO_VERSION_ESP8266["2.4.1"],
ARDUINO_VERSION_ESP8266["2.4.2"],
]
if CORE.arduino_version == ARDUINO_VERSION_ESP8266['2.3.0']:
if CORE.arduino_version == ARDUINO_VERSION_ESP8266["2.3.0"]:
# No ld script support
ld_script = None
if CORE.arduino_version in versions_with_old_ldscripts:
@@ -235,14 +267,14 @@ def get_ini_content():
ld_script = ld_scripts[1]
if ld_script is not None:
data['board_build.ldscript'] = ld_script
data["board_build.ldscript"] = ld_script
# Ignore libraries that are not explicitly used, but may
# be added by LDF
# data['lib_ldf_mode'] = 'chain'
data.update(CORE.config[CONF_ESPHOME].get(CONF_PLATFORMIO_OPTIONS, {}))
content = f'[env:{CORE.name}]\n'
content = f"[env:{CORE.name}]\n"
content += format_ini(data)
return content
@@ -251,32 +283,42 @@ def get_ini_content():
def find_begin_end(text, begin_s, end_s):
begin_index = text.find(begin_s)
if begin_index == -1:
raise EsphomeError("Could not find auto generated code begin in file, either "
"delete the main sketch file or insert the comment again.")
raise EsphomeError(
"Could not find auto generated code begin in file, either "
"delete the main sketch file or insert the comment again."
)
if text.find(begin_s, begin_index + 1) != -1:
raise EsphomeError("Found multiple auto generate code begins, don't know "
"which to chose, please remove one of them.")
raise EsphomeError(
"Found multiple auto generate code begins, don't know "
"which to chose, please remove one of them."
)
end_index = text.find(end_s)
if end_index == -1:
raise EsphomeError("Could not find auto generated code end in file, either "
"delete the main sketch file or insert the comment again.")
raise EsphomeError(
"Could not find auto generated code end in file, either "
"delete the main sketch file or insert the comment again."
)
if text.find(end_s, end_index + 1) != -1:
raise EsphomeError("Found multiple auto generate code endings, don't know "
"which to chose, please remove one of them.")
raise EsphomeError(
"Found multiple auto generate code endings, don't know "
"which to chose, please remove one of them."
)
return text[:begin_index], text[(end_index + len(end_s)):]
return text[:begin_index], text[(end_index + len(end_s)) :]
def write_platformio_ini(content):
update_storage_json()
path = CORE.relative_build_path('platformio.ini')
path = CORE.relative_build_path("platformio.ini")
if os.path.isfile(path):
text = read_file(path)
content_format = find_begin_end(text, INI_AUTO_GENERATE_BEGIN, INI_AUTO_GENERATE_END)
content_format = find_begin_end(
text, INI_AUTO_GENERATE_BEGIN, INI_AUTO_GENERATE_END
)
else:
content_format = INI_BASE_FORMAT
full_file = content_format[0] + INI_AUTO_GENERATE_BEGIN + '\n' + content
full_file = content_format[0] + INI_AUTO_GENERATE_BEGIN + "\n" + content
full_file += INI_AUTO_GENERATE_END + content_format[1]
write_file_if_changed(path, full_file)
@@ -298,8 +340,8 @@ VERSION_H_FORMAT = """\
#pragma once
#define ESPHOME_VERSION "{}"
"""
DEFINES_H_TARGET = 'esphome/core/defines.h'
VERSION_H_TARGET = 'esphome/core/version.h'
DEFINES_H_TARGET = "esphome/core/defines.h"
VERSION_H_TARGET = "esphome/core/version.h"
ESPHOME_README_TXT = """
THIS DIRECTORY IS AUTO-GENERATED, DO NOT MODIFY
@@ -326,18 +368,20 @@ def copy_src_tree():
for target, path in source_files_l:
if os.path.splitext(path)[1] in HEADER_FILE_EXTENSIONS:
include_l.append(f'#include "{target}"')
include_l.append('')
include_s = '\n'.join(include_l)
include_l.append("")
include_s = "\n".join(include_l)
source_files_copy = source_files.copy()
source_files_copy.pop(DEFINES_H_TARGET)
for path in walk_files(CORE.relative_src_path('esphome')):
for path in walk_files(CORE.relative_src_path("esphome")):
if os.path.splitext(path)[1] not in SOURCE_FILE_EXTENSIONS:
# Not a source file, ignore
continue
# Transform path to target path name
target = os.path.relpath(path, CORE.relative_src_path()).replace(os.path.sep, '/')
target = os.path.relpath(path, CORE.relative_src_path()).replace(
os.path.sep, "/"
)
if target in (DEFINES_H_TARGET, VERSION_H_TARGET):
# Ignore defines.h, will be dealt with later
continue
@@ -350,32 +394,41 @@ def copy_src_tree():
# Now copy new files
for target, src_path in source_files_copy.items():
dst_path = CORE.relative_src_path(*target.split('/'))
dst_path = CORE.relative_src_path(*target.split("/"))
copy_file_if_changed(src_path, dst_path)
# Finally copy defines
write_file_if_changed(CORE.relative_src_path('esphome', 'core', 'defines.h'),
generate_defines_h())
write_file_if_changed(CORE.relative_src_path('esphome', 'README.txt'),
ESPHOME_README_TXT)
write_file_if_changed(CORE.relative_src_path('esphome.h'),
ESPHOME_H_FORMAT.format(include_s))
write_file_if_changed(CORE.relative_src_path('esphome', 'core', 'version.h'),
VERSION_H_FORMAT.format(__version__))
write_file_if_changed(
CORE.relative_src_path("esphome", "core", "defines.h"), generate_defines_h()
)
write_file_if_changed(
CORE.relative_src_path("esphome", "README.txt"), ESPHOME_README_TXT
)
write_file_if_changed(
CORE.relative_src_path("esphome.h"), ESPHOME_H_FORMAT.format(include_s)
)
write_file_if_changed(
CORE.relative_src_path("esphome", "core", "version.h"),
VERSION_H_FORMAT.format(__version__),
)
def generate_defines_h():
define_content_l = [x.as_macro for x in CORE.defines]
define_content_l.sort()
return DEFINES_H_FORMAT.format('\n'.join(define_content_l))
return DEFINES_H_FORMAT.format("\n".join(define_content_l))
def write_cpp(code_s):
path = CORE.relative_src_path('main.cpp')
path = CORE.relative_src_path("main.cpp")
if os.path.isfile(path):
text = read_file(path)
code_format = find_begin_end(text, CPP_AUTO_GENERATE_BEGIN, CPP_AUTO_GENERATE_END)
code_format_ = find_begin_end(code_format[0], CPP_INCLUDE_BEGIN, CPP_INCLUDE_END)
code_format = find_begin_end(
text, CPP_AUTO_GENERATE_BEGIN, CPP_AUTO_GENERATE_END
)
code_format_ = find_begin_end(
code_format[0], CPP_INCLUDE_BEGIN, CPP_INCLUDE_END
)
code_format = (code_format_[0], code_format_[1], code_format[1])
else:
code_format = CPP_BASE_FORMAT
@@ -384,8 +437,10 @@ def write_cpp(code_s):
global_s = '#include "esphome.h"\n'
global_s += CORE.cpp_global_section
full_file = code_format[0] + CPP_INCLUDE_BEGIN + '\n' + global_s + CPP_INCLUDE_END
full_file += code_format[1] + CPP_AUTO_GENERATE_BEGIN + '\n' + code_s + CPP_AUTO_GENERATE_END
full_file = code_format[0] + CPP_INCLUDE_BEGIN + "\n" + global_s + CPP_INCLUDE_END
full_file += (
code_format[1] + CPP_AUTO_GENERATE_BEGIN + "\n" + code_s + CPP_AUTO_GENERATE_END
)
full_file += code_format[2]
write_file_if_changed(path, full_file)
@@ -417,7 +472,7 @@ GITIGNORE_CONTENT = """# Gitignore settings for ESPHome
def write_gitignore():
path = CORE.relative_config_path('.gitignore')
path = CORE.relative_config_path(".gitignore")
if not os.path.isfile(path):
with open(path, 'w') as f:
with open(path, "w") as f:
f.write(GITIGNORE_CONTENT)