pypa / pypa/setuptools

How to turn off setup.py egg_info warnings?

Open
#1,508 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Needs Triage
Dominant language
Python
Stars
2.9k
Forks
1.4k
Avg merge
1d 1h
Merged PRs (30d)
1

Description

Hi, what can I do to turn these warnings off?

warning: no files found matching 'HISTORY.md'
warning: no previously-included files matching '__pycache__' found under directory '*'
warning: no files found matching '*.md' under directory 'docs'
warning: no files found matching 'conf.py' under directory 'docs'
warning: no files found matching 'Makefile' under directory 'docs'
warning: no files found matching 'make.bat' under directory 'docs'
warning: no files found matching '*.jpg' under directory 'docs'
warning: no files found matching '*.png' under directory 'docs'
warning: no files found matching '*.gif' under directory 'docs'

These come from python setup.py egg_info but are always run in python setup.py test, so every 'make test' creates a lot of noise. It be nice to have an option to not get these warnings.

And I already use:

python setup.py --quiet test

but it doesn't eliminate the warnings.

So perhaps a --no-warnings option, in addition to --quiet

Alternatively, I'd imagine something like a section in setup.cfg:

[egg_info]
show_warnings = false

I don't even have a folder docs, of course it can't match any of the above.

If you believe that these warning are actually useful and help the developer to improve things, then at the very least I need to be able to tell python setup.py egg_info to not look for things that I'm aware are not there. (since we have the documentation implemented in a different way).

[egg_info]
warn_on_no_docs = true
warn_on_no_HISTORY = true
warn_on_no___pycache__ = true

But I can't find any documentation at how to do that.

And if this leads to nothing, at the very least is it possible to fix this broken warning:

warning: no files found matching 'Makefile' under directory 'docs'

since there is no directory docs in first place. So instead of issueing 7 of these, just say one:

warning: no directory 'docs' found

Thank you.

Contributor guide

No contributing guide indexed for this repository

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 reproducing the warnings with python setup.py egg_info and python setup.py --quiet test, using the packaging configuration in setup.py and any [egg_info] section in setup.cfg. Compare the requested warning suppression and missing-directory behavior, then verify the chosen behavior through the existing make test workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.