pypa / pypa/setuptools

[Docs] Replacement for `distutils.filelist` ?

Open
#4,071 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Summary

I'm looking into progressively migrating distutil usage in pywin32 (https://github.com/mhammond/pywin32/issues/2119), where distutils.filelist.FileList is used.
https://setuptools.pypa.io/en/latest/deprecated/distutils-legacy.html#prefer-setuptools and https://peps.python.org/pep-0632/#migration-advice don't mention distutils.filelist at all. I searched the documentation for filelist and could not find any deprecation or migration mention.

OS / Environment

Windows 10
Python 3.9
setuptools 68.2.2

Additional Information

Document a migration path for distutils.filelist

Code of Conduct
  • I agree to follow the PSF Code of Conduct

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 with the setuptools deprecated distutils documentation and PEP 632 migration advice, then review the pywin32 issue linked in the report to understand how distutils.filelist.FileList is used. Document a supported migration path specifically for distutils.filelist and ensure the guidance addresses the reported use case.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.