python / python/cpython

Add a .gitignore file to each __pycache__ folder

Open
#141,081 37 comments 12 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

stdlib topic-importlib type-feature
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Feature or enhancement

Proposal:

When creating a __pycache__ folder, add a .gitignore file with the content

# Created by CPython
*

I've seen this pattern appear in a few places (coverage.py's htmlcov folder, .venv, .pytest_cache) and it saves projects from having to add such things to their main .gitignore.

Has this already been discussed elsewhere?

This is a minor feature, which does not need previous discussion elsewhere

Links to previous discussion of this feature:

No response

Linked PRs
  • gh-141162
  • gh-142745
  • gh-142758

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

The issue names no files or tests; start by locating the code that creates pycache directories and the existing tests for cache creation. Verify the generated .gitignore content and ensure the behavior is covered by tests, while checking the linked PRs for work already underway.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 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.