Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add development flag to scripts/configure.py #511

Merged
merged 4 commits into from
Nov 1, 2023
Merged

feat: add development flag to scripts/configure.py #511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
367ffdf
feat: add development flag to scripts/configure.py
rtertiaer Sep 6, 2023
b7d18ff
failed configure.py now returns error exit code
rtertiaer Oct 31, 2023
45d66e6
unpin numpy version
rtertiaer Oct 31, 2023
be26cb2
pass in development flag to install()
rtertiaer Oct 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ share/python-wheels/
.installed.cfg
*.egg
MANIFEST
node_modules/

# PyInstaller
# Usually these files are written by a python script from a template
Expand Down Expand Up @@ -134,6 +135,9 @@ dmypy.json
# Pyre type checker
.pyre/

# vi
*.swp

# emacs
*~
\#*\#
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Jinja2==3.1.2
loguru==0.6.0
mypy==1.0.0
netifaces==0.11.0
numpy==1.21.6
numpy
Copy link
Contributor Author

@rtertiaer rtertiaer Oct 31, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to self: numpy is imported to speed up rendering on the TFT display, as recommended by https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display . it's only used a small handful of places here and without a version bound; validate all potential versions of numpy haven't substantially changed the functions used here: https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display/blob/main/adafruit_rgb_display/rgb.py and also that the TFT display works well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only code that uses numpy in the Adafruit library is here: https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display/blob/8cfb0db7d36eb46ef1e2a575b03f5e630bfc2c94/adafruit_rgb_display/rgb.py#L68

The functions & methods in question are:

numpy.array()
numpy.dstack().flatten().tolist()

On first brush with the documentation, these seem well supported (indeed, foundational) from 1.21 thru 1.26, the latest numpy release.

This still probably deserves a run on a box with a TFT display to validate.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I validated this functions on a box with a TFT display.

Pillow==9.4.0
psutil==5.9.4
pydantic==1.10.4
Expand Down
12 changes: 8 additions & 4 deletions scripts/configure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -882,7 +882,7 @@ def add_tests(env, progress) -> List[Task]:

def install(os_deps=True, python_deps=True, web=True, restart_updater=False,
display=True, audiodetector=True, firmware=True, password=True,
progress=print_task_results) -> bool:
progress=print_task_results, development=False) -> bool:
""" Install and configure AmpliPi's dependencies """
# pylint: disable=too-many-return-statements
tasks = [Task('setup')]
Expand All @@ -893,7 +893,7 @@ def failed():
return False

env = _check_and_setup_platform()
if not env['platform_supported']:
if not env['platform_supported'] and not development:
tasks[0].output = f'untested platform: {platform.platform()}. Please fix this script and make a PR to github.com/micro-nova/AmpliPi'
else:
tasks[0].output = str(env)
Expand Down Expand Up @@ -980,14 +980,18 @@ def failed():
help="Flash the latest firmware")
parser.add_argument('--password', action='store_true', default=False,
help="Generate and set a new default password for the pi user.")
parser.add_argument('--development', action='store_true', default=False,
help="Enable development mode.")
flags = parser.parse_args()
print('Configuring AmpliPi installation')
has_args = flags.python_deps or flags.os_deps or flags.web or flags.restart_updater or flags.display or flags.firmware
if not has_args:
print(' WARNING: expected some arguments, check --help for more information')
if sys.version_info.major < 3 or sys.version_info.minor < 7:
print(' WARNING: minimum python version is 3.7')
install(os_deps=flags.os_deps, python_deps=flags.python_deps, web=flags.web,
result = install(os_deps=flags.os_deps, python_deps=flags.python_deps, web=flags.web,
display=flags.display, audiodetector=flags.audiodetector,
firmware=flags.firmware, password=flags.password,
restart_updater=flags.restart_updater)
restart_updater=flags.restart_updater, development=flags.development)
if not result:
sys.exit(1)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to self: test that updater successfully restarts after this change, cuz it uses subprocess.Popen to call this and may care about exit status.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Subprocess only exceptions on non-zero exit when check_call()/check_output() are used: https://docs.python.org/3/library/subprocess.html#exceptions

since our use of the Popen constructor is basically throwaway ("send the reboot command and return without waiting"), this seems safe. this also functioned correctly when I tested.

Loading