sascha/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2025-09-27 07:32:22 +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

243
esphome/wizard.py
View File

@@ -7,6 +7,7 @@ import voluptuous as vol
import esphome.config_validation as cv
from esphome.helpers import color, get_bool_env, write_file
# pylint: disable=anomalous-backslash-in-string
from esphome.pins import ESP32_BOARD_PINS, ESP8266_BOARD_PINS
from esphome.storage_json import StorageJSON, ext_storage_path
@@ -67,22 +68,24 @@ api:
def sanitize_double_quotes(value):
return value.replace('\\', '\\\\').replace('"', '\\"')
return value.replace("\\", "\\\\").replace('"', '\\"')
def wizard_file(**kwargs):
letters = string.ascii_letters + string.digits
ap_name_base = kwargs['name'].replace('_', ' ').title()
ap_name_base = kwargs["name"].replace("_", " ").title()
ap_name = f"{ap_name_base} Fallback Hotspot"
if len(ap_name) > 32:
ap_name = ap_name_base
kwargs['fallback_name'] = ap_name
kwargs['fallback_psk'] = ''.join(random.choice(letters) for _ in range(12))
kwargs["fallback_name"] = ap_name
kwargs["fallback_psk"] = "".join(random.choice(letters) for _ in range(12))
config = BASE_CONFIG.format(**kwargs)
if kwargs['password']:
config += ' password: "{0}"\n\nota:\n password: "{0}"\n'.format(kwargs['password'])
if kwargs["password"]:
config += ' password: "{0}"\n\nota:\n password: "{0}"\n'.format(
kwargs["password"]
)
else:
config += "\nota:\n"
@@ -90,26 +93,29 @@ def wizard_file(**kwargs):
def wizard_write(path, **kwargs):
name = kwargs['name']
board = kwargs['board']
name = kwargs["name"]
board = kwargs["board"]
kwargs['ssid'] = sanitize_double_quotes(kwargs['ssid'])
kwargs['psk'] = sanitize_double_quotes(kwargs['psk'])
kwargs['password'] = sanitize_double_quotes(kwargs['password'])
kwargs["ssid"] = sanitize_double_quotes(kwargs["ssid"])
kwargs["psk"] = sanitize_double_quotes(kwargs["psk"])
kwargs["password"] = sanitize_double_quotes(kwargs["password"])
if 'platform' not in kwargs:
kwargs['platform'] = 'ESP8266' if board in ESP8266_BOARD_PINS else 'ESP32'
platform = kwargs['platform']
if "platform" not in kwargs:
kwargs["platform"] = "ESP8266" if board in ESP8266_BOARD_PINS else "ESP32"
platform = kwargs["platform"]
write_file(path, wizard_file(**kwargs))
storage = StorageJSON.from_wizard(name, name + '.local', platform, board)
storage = StorageJSON.from_wizard(name, name + ".local", platform, board)
storage_path = ext_storage_path(os.path.dirname(path), os.path.basename(path))
storage.save(storage_path)
if get_bool_env(ENV_QUICKWIZARD):
def sleep(time):
pass
else:
from time import sleep
@@ -131,18 +137,25 @@ def default_input(text, default):
# From https://stackoverflow.com/a/518232/8924614
def strip_accents(value):
return ''.join(c for c in unicodedata.normalize('NFD', str(value))
if unicodedata.category(c) != 'Mn')
return "".join(
c
for c in unicodedata.normalize("NFD", str(value))
if unicodedata.category(c) != "Mn"
)
def wizard(path):
if not path.endswith('.yaml') and not path.endswith('.yml'):
safe_print("Please make your configuration file {} have the extension .yaml or .yml"
"".format(color('cyan', path)))
if not path.endswith(".yaml") and not path.endswith(".yml"):
safe_print(
"Please make your configuration file {} have the extension .yaml or .yml"
"".format(color("cyan", path))
)
return 1
if os.path.exists(path):
safe_print("Uh oh, it seems like {} already exists, please delete that file first "
"or chose another configuration file.".format(color('cyan', path)))
safe_print(
"Uh oh, it seems like {} already exists, please delete that file first "
"or chose another configuration file.".format(color("cyan", path))
)
return 2
safe_print("Hi there!")
sleep(1.5)
@@ -150,16 +163,25 @@ def wizard(path):
sleep(1.25)
safe_print("And I'm here to help you get started with ESPHome.")
sleep(2.0)
safe_print("In 4 steps I'm going to guide you through creating a basic "
"configuration file for your custom ESP8266/ESP32 firmware. Yay!")
safe_print(
"In 4 steps I'm going to guide you through creating a basic "
"configuration file for your custom ESP8266/ESP32 firmware. Yay!"
)
sleep(3.0)
safe_print()
safe_print_step(1, CORE_BIG)
safe_print("First up, please choose a " + color('green', 'name') + " for your node.")
safe_print("It should be a unique name that can be used to identify the device later.")
safe_print(
"First up, please choose a " + color("green", "name") + " for your node."
)
safe_print(
"It should be a unique name that can be used to identify the device later."
)
sleep(1)
safe_print("For example, I like calling the node in my living room {}.".format(
color('bold_white', "livingroom")))
safe_print(
"For example, I like calling the node in my living room {}.".format(
color("bold_white", "livingroom")
)
)
safe_print()
sleep(1)
name = input(color("bold_white", "(name): "))
@@ -169,56 +191,80 @@ def wizard(path):
name = cv.valid_name(name)
break
except vol.Invalid:
safe_print(color("red", f"Oh noes, \"{name}\" isn't a valid name. Names can only "
f"include numbers, lower-case letters, underscores and "
f"hyphens."))
name = strip_accents(name).lower().replace(' ', '_')
name = ''.join(c for c in name if c in ALLOWED_NAME_CHARS)
safe_print("Shall I use \"{}\" as the name instead?".format(color('cyan', name)))
safe_print(
color(
"red",
f'Oh noes, "{name}" isn\'t a valid name. Names can only '
f"include numbers, lower-case letters, underscores and "
f"hyphens.",
)
)
name = strip_accents(name).lower().replace(" ", "_")
name = "".join(c for c in name if c in ALLOWED_NAME_CHARS)
safe_print(
'Shall I use "{}" as the name instead?'.format(color("cyan", name))
)
sleep(0.5)
name = default_input("(name [{}]): ", name)
safe_print("Great! Your node is now called \"{}\".".format(color('cyan', name)))
safe_print('Great! Your node is now called "{}".'.format(color("cyan", name)))
sleep(1)
safe_print_step(2, ESP_BIG)
safe_print("Now I'd like to know what microcontroller you're using so that I can compile "
"firmwares for it.")
safe_print("Are you using an " + color('green', 'ESP32') + " or " +
color('green', 'ESP8266') + " platform? (Choose ESP8266 for Sonoff devices)")
safe_print(
"Now I'd like to know what microcontroller you're using so that I can compile "
"firmwares for it."
)
safe_print(
"Are you using an "
+ color("green", "ESP32")
+ " or "
+ color("green", "ESP8266")
+ " platform? (Choose ESP8266 for Sonoff devices)"
)
while True:
sleep(0.5)
safe_print()
safe_print("Please enter either ESP32 or ESP8266.")
platform = input(color("bold_white", "(ESP32/ESP8266): "))
try:
platform = vol.All(vol.Upper, vol.Any('ESP32', 'ESP8266'))(platform)
platform = vol.All(vol.Upper, vol.Any("ESP32", "ESP8266"))(platform)
break
except vol.Invalid:
safe_print("Unfortunately, I can't find an espressif microcontroller called "
"\"{}\". Please try again.".format(platform))
safe_print("Thanks! You've chosen {} as your platform.".format(color('cyan', platform)))
safe_print(
"Unfortunately, I can't find an espressif microcontroller called "
'"{}". Please try again.'.format(platform)
)
safe_print(
"Thanks! You've chosen {} as your platform.".format(color("cyan", platform))
)
safe_print()
sleep(1)
if platform == 'ESP32':
board_link = 'http://docs.platformio.org/en/latest/platforms/espressif32.html#boards'
if platform == "ESP32":
board_link = (
"http://docs.platformio.org/en/latest/platforms/espressif32.html#boards"
)
else:
board_link = 'http://docs.platformio.org/en/latest/platforms/espressif8266.html#boards'
board_link = (
"http://docs.platformio.org/en/latest/platforms/espressif8266.html#boards"
)
safe_print("Next, I need to know what " + color('green', 'board') + " you're using.")
safe_print(
"Next, I need to know what " + color("green", "board") + " you're using."
)
sleep(0.5)
safe_print("Please go to {} and choose a board.".format(color('green', board_link)))
if platform == 'ESP32':
safe_print("(Type " + color('green', 'esp01_1m') + " for Sonoff devices)")
safe_print("Please go to {} and choose a board.".format(color("green", board_link)))
if platform == "ESP32":
safe_print("(Type " + color("green", "esp01_1m") + " for Sonoff devices)")
safe_print()
# Don't sleep because user needs to copy link
if platform == 'ESP32':
safe_print("For example \"{}\".".format(color("bold_white", 'nodemcu-32s')))
if platform == "ESP32":
safe_print('For example "{}".'.format(color("bold_white", "nodemcu-32s")))
boards = list(ESP32_BOARD_PINS.keys())
else:
safe_print("For example \"{}\".".format(color("bold_white", 'nodemcuv2')))
safe_print('For example "{}".'.format(color("bold_white", "nodemcuv2")))
boards = list(ESP8266_BOARD_PINS.keys())
safe_print("Options: {}".format(', '.join(sorted(boards))))
safe_print("Options: {}".format(", ".join(sorted(boards))))
while True:
board = input(color("bold_white", "(board): "))
@@ -226,69 +272,102 @@ def wizard(path):
board = vol.All(vol.Lower, vol.Any(*boards))(board)
break
except vol.Invalid:
safe_print(color('red', f"Sorry, I don't think the board \"{board}\" exists."))
safe_print(
color("red", f'Sorry, I don\'t think the board "{board}" exists.')
)
safe_print()
sleep(0.25)
safe_print()
safe_print("Way to go! You've chosen {} as your board.".format(color('cyan', board)))
safe_print(
"Way to go! You've chosen {} as your board.".format(color("cyan", board))
)
safe_print()
sleep(1)
safe_print_step(3, WIFI_BIG)
safe_print("In this step, I'm going to create the configuration for "
"WiFi.")
safe_print("In this step, I'm going to create the configuration for " "WiFi.")
safe_print()
sleep(1)
safe_print("First, what's the " + color('green', 'SSID') +
f" (the name) of the WiFi network {name} I should connect to?")
safe_print(
"First, what's the "
+ color("green", "SSID")
+ f" (the name) of the WiFi network {name} I should connect to?"
)
sleep(1.5)
safe_print("For example \"{}\".".format(color('bold_white', "Abraham Linksys")))
safe_print('For example "{}".'.format(color("bold_white", "Abraham Linksys")))
while True:
ssid = input(color('bold_white', "(ssid): "))
ssid = input(color("bold_white", "(ssid): "))
try:
ssid = cv.ssid(ssid)
break
except vol.Invalid:
safe_print(color('red', "Unfortunately, \"{}\" doesn't seem to be a valid SSID. "
"Please try again.".format(ssid)))
safe_print(
color(
"red",
'Unfortunately, "{}" doesn\'t seem to be a valid SSID. '
"Please try again.".format(ssid),
)
)
safe_print()
sleep(1)
safe_print("Thank you very much! You've just chosen \"{}\" as your SSID."
"".format(color('cyan', ssid)))
safe_print(
'Thank you very much! You\'ve just chosen "{}" as your SSID.'
"".format(color("cyan", ssid))
)
safe_print()
sleep(0.75)
safe_print("Now please state the " + color('green', 'password') +
" of the WiFi network so that I can connect to it (Leave empty for no password)")
safe_print(
"Now please state the "
+ color("green", "password")
+ " of the WiFi network so that I can connect to it (Leave empty for no password)"
)
safe_print()
safe_print("For example \"{}\"".format(color('bold_white', 'PASSWORD42')))
safe_print('For example "{}"'.format(color("bold_white", "PASSWORD42")))
sleep(0.5)
psk = input(color('bold_white', '(PSK): '))
safe_print("Perfect! WiFi is now set up (you can create static IPs and so on later).")
psk = input(color("bold_white", "(PSK): "))
safe_print(
"Perfect! WiFi is now set up (you can create static IPs and so on later)."
)
sleep(1.5)
safe_print_step(4, OTA_BIG)
safe_print("Almost there! ESPHome can automatically upload custom firmwares over WiFi "
"(over the air) and integrates into Home Assistant with a native API.")
safe_print("This can be insecure if you do not trust the WiFi network. Do you want to set "
"a " + color('green', 'password') + " for connecting to this ESP?")
safe_print(
"Almost there! ESPHome can automatically upload custom firmwares over WiFi "
"(over the air) and integrates into Home Assistant with a native API."
)
safe_print(
"This can be insecure if you do not trust the WiFi network. Do you want to set "
"a " + color("green", "password") + " for connecting to this ESP?"
)
safe_print()
sleep(0.25)
safe_print("Press ENTER for no password")
password = input(color('bold_white', '(password): '))
password = input(color("bold_white", "(password): "))
wizard_write(path=path, name=name, platform=platform, board=board,
ssid=ssid, psk=psk, password=password)
wizard_write(
path=path,
name=name,
platform=platform,
board=board,
ssid=ssid,
psk=psk,
password=password,
)
safe_print()
safe_print(color('cyan', "DONE! I've now written a new configuration file to ") +
color('bold_cyan', path))
safe_print(
color("cyan", "DONE! I've now written a new configuration file to ")
+ color("bold_cyan", path)
)
safe_print()
safe_print("Next steps:")
safe_print(" > Check your Home Assistant \"integrations\" screen. If all goes well, you "
"should see your ESP being discovered automatically.")
safe_print(
' > Check your Home Assistant "integrations" screen. If all goes well, you '
"should see your ESP being discovered automatically."
)
safe_print(" > Then follow the rest of the getting started guide:")
safe_print(" > https://esphome.io/guides/getting_started_command_line.html")
return 0