docker / docker/docker-py

get_archive should return a file object

Open
#3,337 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
7.2k
Forks
1.7k
Avg merge
13d 8h
Merged PRs (30d)
2

Description

Currently, get_archive returns a generator of bytes. This means it cannot be directly provided to tarfile.open, as the latter expects a file object. This in turn means we need to write some custom glue in the middle that reads the whole archive into some temporary file or buffer first, which is wasteful.

Please add a parameter to get_archive to opt into it returning a file object instead of a generator.

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

Start by locating the Python client's get_archive entry point and reviewing how it currently yields bytes. Use tarfile.open as the compatibility target; done means an opt-in mode returns a file object while the existing generator behavior remains available.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, python
Domain
api, backend
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.