Sort outputs

Open
#43 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
cli

Research direction

Start at the CLI entry point that handles --archive-dive and --no-archive-dive, then trace how os.walk results are emitted and how archives are deferred. Define and implement one consistent, predictable ordering for both modes, while checking the coordination concerns in issues #3 and #33 before considering the work done.

Written by the indexing model from the issue text.

Description

Based on conversation in #41, outputs in --archive-dive and --no-archive-dive modes should come out in a consistent and predictable order.

Current behavior is to follow os.walk with files first then subfolders and not alphabetically. With archive-dive ON, archives are written last so an archive ends up separated from its sibling files.

Conceivably, a user would want outputs sorted on the hash to see identical files grouped together regardless of their location in a collection, but that type of sorting seems more appropriate for downstream use.

This could have implications for parallel hashing (#3), so this should probably be done in coordination with a PR that implements that. The upfront size reporting (part of #33) could also feed the parallel worker task planning so each worker would receive bins of equal 'weight' to hash through.

Dominant language
Python
Stars
3
Forks
0
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from Imageomics/sum-buddy

All issues in Imageomics/sum-buddy

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.