espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-07-31 19:24:33 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'feat/ksh_compatible_shells' into 'master'

Browse Source 
fix(tools): add support for shells compatible with ksh

Closes IDFGH-15389

See merge request espressif/esp-idf!39602
This commit is contained in:
Roland Dobai
2025-06-03 12:11:23 +02:00
parent 473f316906 28e3112cde
commit a2b7ce698b
1 changed files with 59 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
tools/export_utils/shell_types.py
View File

@@ -10,9 +10,9 @@ from datetime import datetime
from datetime import timedelta from datetime import timedelta
from pathlib import Path from pathlib import Path
from subprocess import run from subprocess import run
from tempfile import gettempdir
from tempfile import NamedTemporaryFile from tempfile import NamedTemporaryFile
from tempfile import TemporaryDirectory from tempfile import TemporaryDirectory
from tempfile import gettempdir
from typing import Dict from typing import Dict
from typing import List from typing import List
from typing import TextIO from typing import TextIO
@@ -26,7 +26,7 @@ from utils import conf
from utils import run_cmd from utils import run_cmd
class Shell(): class Shell:
def __init__(self, shell: str, deactivate_cmd: str, new_esp_idf_env: Dict[str, str]): def __init__(self, shell: str, deactivate_cmd: str, new_esp_idf_env: Dict[str, str]):
self.shell = shell self.shell = shell
self.deactivate_cmd = deactivate_cmd self.deactivate_cmd = deactivate_cmd
@@ -100,8 +100,12 @@ class UnixShell(Shell):
stdout = self.autocompletion() # type: ignore stdout = self.autocompletion() # type: ignore
if stdout is not None: if stdout is not None:
fd.write(f'{stdout}\n') fd.write(f'{stdout}\n')
fd.write((f'echo "\nDone! You can now compile ESP-IDF projects.\n' fd.write(
'Go to the project directory and run:\n\n idf.py build"\n')) (
'echo "\nDone! You can now compile ESP-IDF projects.\n'
'Go to the project directory and run:\n\n idf.py build"\n'
)
)
def export(self) -> None: def export(self) -> None:
with open(self.script_file_path, 'w', encoding='utf-8') as fd: with open(self.script_file_path, 'w', encoding='utf-8') as fd:
@@ -230,14 +234,16 @@ class PowerShell(Shell):
self.new_esp_idf_env['IDF_TOOLS_EXPORT_CMD'] = os.path.join(conf.IDF_PATH, 'export.ps1') self.new_esp_idf_env['IDF_TOOLS_EXPORT_CMD'] = os.path.join(conf.IDF_PATH, 'export.ps1')
def get_functions(self) -> str: def get_functions(self) -> str:
return '\n'.join([ return '\n'.join(
[
r'function idf.py { &python "$Env:IDF_PATH\tools\idf.py" $args }', r'function idf.py { &python "$Env:IDF_PATH\tools\idf.py" $args }',
r'function global:esptool.py { &python -m esptool $args }', r'function global:esptool.py { &python -m esptool $args }',
r'function global:espefuse.py { &python -m espefuse $args }', r'function global:espefuse.py { &python -m espefuse $args }',
r'function global:espsecure.py { &python -m espsecure $args }', r'function global:espsecure.py { &python -m espsecure $args }',
r'function global:otatool.py { &python "$Env:IDF_PATH\components\app_update\otatool.py" $args }', r'function global:otatool.py { &python "$Env:IDF_PATH\components\app_update\otatool.py" $args }',
r'function global:parttool.py { &python "$Env:IDF_PATH\components\partition_table\parttool.py" $args }', r'function global:parttool.py { &python "$Env:IDF_PATH\components\partition_table\parttool.py" $args }',
]) ]
)
def export(self) -> None: def export(self) -> None:
self.init_file() self.init_file()
@@ -254,8 +260,12 @@ class PowerShell(Shell):
fd.write(f'$Env:{var}="{value}"\n') fd.write(f'$Env:{var}="{value}"\n')
functions = self.get_functions() functions = self.get_functions()
fd.write(f'{functions}\n') fd.write(f'{functions}\n')
fd.write((f'echo "\nDone! You can now compile ESP-IDF projects.\n' fd.write(
'Go to the project directory and run:\n\n idf.py build\n"')) (
'echo "\nDone! You can now compile ESP-IDF projects.\n'
'Go to the project directory and run:\n\n idf.py build\n"'
)
)
def spawn(self) -> None: def spawn(self) -> None:
self.init_file() self.init_file()
@@ -279,14 +289,16 @@ class WinCmd(Shell):
self.new_esp_idf_env['IDF_TOOLS_PY_PATH'] = conf.IDF_TOOLS_PY self.new_esp_idf_env['IDF_TOOLS_PY_PATH'] = conf.IDF_TOOLS_PY
def get_functions(self) -> str: def get_functions(self) -> str:
return '\n'.join([ return '\n'.join(
[
r'DOSKEY idf.py=python.exe "%IDF_PATH%\tools\idf.py" $*', r'DOSKEY idf.py=python.exe "%IDF_PATH%\tools\idf.py" $*',
r'DOSKEY esptool.py=python.exe -m esptool $*', r'DOSKEY esptool.py=python.exe -m esptool $*',
r'DOSKEY espefuse.py=python.exe -m espefuse $*', r'DOSKEY espefuse.py=python.exe -m espefuse $*',
r'DOSKEY espsecure.py=python.exe -m espsecure $*', r'DOSKEY espsecure.py=python.exe -m espsecure $*',
r'DOSKEY otatool.py=python.exe "%IDF_PATH%\components\app_update\otatool.py" $*', r'DOSKEY otatool.py=python.exe "%IDF_PATH%\components\app_update\otatool.py" $*',
r'DOSKEY parttool.py=python.exe "%IDF_PATH%\components\partition_table\parttool.py" $*', r'DOSKEY parttool.py=python.exe "%IDF_PATH%\components\partition_table\parttool.py" $*',
]) ]
)
def export(self) -> None: def export(self) -> None:
self.init_file() self.init_file()
@@ -300,14 +312,18 @@ class WinCmd(Shell):
fd.write(f'set {var}={value}\n') fd.write(f'set {var}={value}\n')
functions = self.get_functions() functions = self.get_functions()
fd.write(f'{functions}\n') fd.write(f'{functions}\n')
fd.write('\n'.join([ fd.write(
'\n'.join(
[
'echo.', 'echo.',
'echo Done! You can now compile ESP-IDF projects.', 'echo Done! You can now compile ESP-IDF projects.',
'echo Go to the project directory and run:', 'echo Go to the project directory and run:',
'echo.', 'echo.',
'echo idf.py build', 'echo idf.py build',
'echo.', 'echo.',
])) ]
)
)
def spawn(self) -> None: def spawn(self) -> None:
self.init_file() self.init_file()
@@ -323,7 +339,14 @@ SHELL_CLASSES = {
'zsh': ZshShell, 'zsh': ZshShell,
'fish': FishShell, 'fish': FishShell,
'sh': UnixShell, 'sh': UnixShell,
# KornShell variants
'ksh': UnixShell, 'ksh': UnixShell,
'ksh93': UnixShell,
'mksh': UnixShell,
'lksh': UnixShell,
'pdksh': UnixShell,
'oksh': UnixShell,
'loksh': UnixShell,
'dash': UnixShell, 'dash': UnixShell,
'nu': UnixShell, 'nu': UnixShell,
'pwsh.exe': PowerShell, 'pwsh.exe': PowerShell,
@@ -331,7 +354,7 @@ SHELL_CLASSES = {
'powershell.exe': PowerShell, 'powershell.exe': PowerShell,
'powershell': PowerShell, 'powershell': PowerShell,
'cmd.exe': WinCmd, 'cmd.exe': WinCmd,
'cmd': WinCmd 'cmd': WinCmd,
} }
SUPPORTED_SHELLS = ' '.join(SHELL_CLASSES.keys()) SUPPORTED_SHELLS = ' '.join(SHELL_CLASSES.keys())