pyinstaller / pyinstaller/pyinstaller

Implement a "warning" mechanism for hooks

Open
#2,734 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area:hooks pull-request wanted
Dominant language
Python
Stars
13.1k
Forks
2k
Avg merge
1d 3h
Merged PRs (30d)
11

Description

It would be useful, if hooks would issue warnings, e.g.

  • multiprocessing (and others) pointing to the respective recipe in the wiki
  • ssl warning about certificates need to be included
  • … more ideas

For this we could

  1. implement a simple logger in utils.hooks having a different output-format
  2. think about not printing the the warnings of this hook immediately but collect them and print them at the end of the PyInstalelr run,
  3. suppress the output of this logger in while running the test-suite,
  4. add warnings to the resp. hooks (of course :-).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing hook mechanism in utils.hooks and how hooks run during the PyInstaller run and test suite. The issue proposes several possible warning designs, including collection and suppression, but does not select one. Done would require an agreed warning behavior, hook warnings, and corresponding handling in the test suite.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.