kubernetes-client/python

Windows contributors face multiple issues: symlink folders not portable, permission errors, and missing imports in tests

Open

#2,427 创建于 2025年7月28日

在 GitHub 查看
 (6 评论) (0 反应) (0 负责人)Python (6,225 star) (3,323 fork)batch import
help wantedkind/bug

描述

Summary

Trying to contribute as a Windows developer to this repo turned up several significant issues:

  1. Several folders (e.g., kubernetes/config, kubernetes/watch) are symlinks to base/ subdirectories in the repo. On Windows and when using ZIP downloads from GitHub, these appear as plain text files and break both pip install -e . and running tests, since setuptools expects actual directories.

  2. At least one test file (watch_test.py under kubernetes/base/watch and duplicated under kubernetes/watch) is missing import json. This causes test failures with NameError: name 'json' is not defined.

  3. Several tests (for example, test_oidc_with_refresh inside kube_config_test.py) fail on Windows with PermissionError when trying to create/write temp files.

Steps to Reproduce

  • Clone or download the repo on Windows.
  • Try pip install -e . or run python -m pytest.
  • Observe errors related to config/watch packages not being directories, import errors in test files, and permission errors for temp files.

Proposed Fixes

  • Replace symlinks (kubernetes/config, kubernetes/watch, etc.) with real directories or use another structure to support Windows and ZIP-based contributors.
  • Ensure all test modules have necessary imports (e.g., import json).
  • Refactor or skip the failing temp file tests on Windows, or improve documentation about required permissions.

Environment

  • OS: Windows 10/11, Python 3.13
  • (Include pip list or pip freeze if desired)

Thank you! I’m happy to give more details or to help test solutions.

贡献者指南

技术栈
python
领域
backenddevops
议题类型
bug
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
PythonpytestGitWindows
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
The issue identifies three problems: 1) symlinks in kubernetes/config and kubernetes/watch are not supported on Windows; they should be replaced with real directories or handled in setup.py. 2) Missing 'import json' in watch test.py under kubernetes/base/watch and possibly duplicated under kubernetes/watch. 3) Permission errors on Windows in kube config test.py, specifically in test oidc with refresh. The first requires deciding on a replacement strategy (e.g., copying directories or conditional symlink support), the second is a straightforward import addition, and the third may need temporary file handling adjustments or conditional skipping. The reporter has offered to help test solutions. No maintainer response yet, so scope is clear but may need clarification on preferred symlink resolution.
Windows contributors face multiple issues: symlink folders not portable, permission errors, and missing imports in tests · kubernetes-client/python#2427 | Good First Issue