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.

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

fix: close file gracefully in espsecure (ESPTOOL-804) #951

Merged

Conversation

gnought
Copy link
Contributor

@gnought gnought commented Jan 29, 2024

The espsecure.py script displays a ResourceWarning error regarding unclosed files when PYTHONWARNINGS="all" turns on. This issue arises because espsecure.py utilizes argparse.FileType, which opens a file handler but Python does not automatically handle the close() operation.

% PYTHONWARNINGS="all" espsecure.py sign_data --version 1 --keyfile keys.pem  --output signed.bin input.bin
espsecure.py v4.7.0
Signed 1032336 bytes of data from input.bin
/dev/.venv/lib/python3.11/site-packages/espsecure/__init__.py:1828: ResourceWarning: unclosed file <_io.BufferedReader name='keys.pem'>
  main()
ResourceWarning: Enable tracemalloc to get the object allocation traceback
/dev/.venv/lib/python3.11/site-packages/espsecure/__init__.py:1828: ResourceWarning: unclosed file <_io.BufferedReader name='input.bin'>
  main()
ResourceWarning: Enable tracemalloc to get the object allocation traceback

This fix is to handle the close() explicitly to have a gracefully exit and avoid memory leaks.

Copy link

github-actions bot commented Jan 29, 2024

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello gnought, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved, we synchronize it into our internal git repository.
4. In the internal git repository we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by 🚫 dangerJS against 2381711

@github-actions github-actions bot changed the title fix: close file gracefully in espsecure fix: close file gracefully in espsecure (ESPTOOL-804) Jan 29, 2024
@Honza0297
Copy link

Hello, @gnought, thank you for the contribution!

Everything looks good to me, just one nitpick: can you please squash your commits into one?

@gnought gnought force-pushed the fix/espsecure_unclosed_files branch from dc049c2 to 2381711 Compare January 29, 2024 16:05
@gnought
Copy link
Contributor Author

gnought commented Jan 29, 2024

@Honza0297 sure, here you go.

@Honza0297
Copy link

Thank you!
We will merge it once it goes through our pipeline.

@espressif-bot espressif-bot merged commit 2381711 into espressif:master Jan 30, 2024
13 of 14 checks passed
@radimkarnis
Copy link
Collaborator

Thank you for your contribution!

@gnought gnought deleted the fix/espsecure_unclosed_files branch February 3, 2024 06:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants