Issue tracker

Using the issue tracker

If you think you have found a bug in Python, you can report it to the issue tracker. The issue tracker is now hosted on GitHub, alongside the codebase and pull requests. Documentation bugs can also be reported there.

If you would like to file an issue about this devguide, please do so in the devguide repository.

Note

Prior to moving the issue tracker to GitHub, Python used to use a dedicated Roundup instance as its issue tracker. That old bug tracker was hosted under the domain bugs.python.org (sometimes called bpo for short). A read-only version is available on that domain for historical purposes. All bpo data has been migrated to the current issue tracker on GitHub.

If you’re familiar with bpo and would like to learn more about GitHub issues, please read this page, and the Triaging an issue page as they provide good introductory material.

Checking if a bug already exists

The first step before filing an issue report is to see whether the problem has already been reported. Checking if the problem is an existing issue will:

  • help you see if the problem has already been resolved or has been fixed for the next release

  • save time for you and the developers

  • help you learn what needs to be done to fix it

  • determine if additional information, such as how to replicate the issue, is needed

To see if an issue already exists, search the bug database using the search box above the list of bugs on the issues page. See How to search issues? for more information.

How to search issues?

Use the GitHub search syntax or the interactive advanced search form that generates search queries for you.

Reporting an issue

If the problem you’re reporting is not already in the issue tracker, you can report it using the green New issue button on the right of the search box above the list of bugs. If you’re not already signed in to GitHub, it will ask you to do so now.

First you need to select what kind of problem you want to report. The available choices include, for example:

  • Bug report: an existing feature isn’t working as expected.

  • Documentation: there is missing, invalid, or misleading documentation.

  • Feature or enhancement: suggest a new feature for Python.

  • Report a security vulnerability: privately report a security vulnerability.

Depending on your choice, a dedicated form template will appear. In particular, you’ll notice that the last button actually takes you to the Python Discourse (discuss.python.org), where many Python-related discussions take place.

The submission form has only two fields that you need to fill:

  • in the Title field, enter a very short description of the problem; less than ten words is good;

  • in the Write field, describe the problem in detail using hints from the template that was put in that field for you. Be sure to include what you expected to happen, what did happen, and how to replicate the problem. Be sure to include whether any extension modules were involved, and what hardware and software platform you were using (including version information as appropriate). In particular, what version of Python you were using.

You can tag someone, with @username in a comment, if you think the issue should be brought to their attention. Use the Experts index to know who wants to be tagged or assigned for specific areas.

There are a number of additional fields like Assignees, Labels, and Projects. Those are filled by triagers and core developers and are covered in the Triaging an issue page. You don’t need to worry about those when reporting issues as a Python user.

Formatting issues and comments

There is a wonderful beginner guide to writing and formatting on GitHub. Highly recommended.

One pro-tip we can sell you right here is that if you want to paste some longer log as a comment, attach a file instead (see how below). If you still insist on pasting it in your comment, do it like this:

<details>
<summary>This is the summary text, click me to expand</summary>

Here goes the long, long text.
It will be collapsed by default!
</details>

How to attach files to an issue?

Drag them into the comment field, wait until the file uploads, and GitHub will automatically put a link to your file in your comment text.

Following issues

If you want to subscribe yourself to an issue, click the 🔔 Subscribe button in the sidebar. Similarly, if you were tagged by somebody else but decided this issue is not for you, click the 🔕 Unsubscribe button in the sidebar. Note that you are automatically subscribed to issues you create or comment on.

Subscribe another person to the issue by tagging them in the comment with @username.

Tracking dependencies and duplicates

It is possible to use checklists to track dependencies or, in case of meta-issues, to link to the other related issues.

By writing Duplicate of #NNN in a comment, you can mark issues and PRs as duplicates.

What on earth is a “mannequin”?

For issues migrated to GitHub from `bpo`_ where the authors or commenters are not core team members, we opted not to link to their GitHub accounts directly. Users not in the python organization on GitHub might not like comments to appear under their name from an automated import. Others never linked GitHub on `bpo`_ in the first place so linking their account, if any, would be impossible.

In those cases a “mannequin” account is present to help follow the conversation that happened in the issue. In case the user did share their GitHub account name in their `bpo`_ profile, we use that. Otherwise, their classic `bpo`_ username is used instead.

Disagreement with a resolution on the issue tracker

As humans, we will have differences of opinions from time to time. First and foremost, please be respectful that care, thought, and volunteer time went into the resolution. Keep in mind that contributors come from many different cultural and linguistic backgrounds; see Communicating across cultures and languages.

With this in mind, take some time to consider any comments made in association with the resolution of the issue. On reflection, the resolution steps may seem more reasonable than you initially thought.

If you still feel the resolution is incorrect, then raise a thoughtful question on the Core Development Discourse category. Further argument and disrespectful responses after a consensus has been reached amongst the core developers is unlikely to win any converts.

As a reminder, issues closed by a core developer have already been carefully considered. Please do not reopen a closed issue. An issue can be closed with reason either as complete or not planned.