docker / docker/docker-py

Windows: Client ping raises pywintypes.error if Docker pipe is not open

Open
#2,562 2 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

The DockerClient.ping() method raises a docker.errors.APIError if the daemon is not responsive, however, on Windows if Docker is not running at all or switching between Linux and Windows containers, the pipe is not open and subsequently results in

pywintypes.error: (2, 'CreateFile', 'The system cannot find the file specified.')

or

pywintypes.error: (232, 'WriteFile', 'The pipe is being closed.')
Steps to recreate:

Make sure Docker isn't running (System Tray > Quit Docker Desktop)

>>> import docker
>>> client = docker.from_env()
>>> client.ping()

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 at DockerClient.ping() and trace how Windows named-pipe failures are handled when Docker is stopped or switching container modes. Reproduce the reported pywintypes.error cases and verify that the method instead raises the documented docker.errors.APIError.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, python
Domain
api, operating-systems
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.