python / python/cpython

Provide a simple function interface for topological sort in graphlib

Open
#125,181 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Feature or enhancement

Proposal:

The graphlib interface requires 5 function calls in order to get the result of a topological sort.

I believe that the most common user will most likely only need a single function call, i.e.

def topological_sort(graph: dict) -> Iterable[set]: ...

I propose adding this small utility function to graphlib.

Note: there is static_order(), which reduces it to 2 function calls, but it flattens the result, which is a bad default.

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

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 concerns graphlib and its existing static_order() interface; start by locating that implementation and the surrounding graphlib tests. Done means adding the proposed single-call topological_sort(graph) interface with grouped-set output and coverage for its behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
developer-experience
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.