Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Split the test-server framework out into its own distribution?

オープン
#823 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
リファクタリング
明瞭さ
おおむね明確
活発さ
活発
技術スタック
python

調査の方向性

Read the test-server framework under caldav.testing, caldav/config.py, and docs/design/TODO.md, then inspect how distributions and package data are built. Decide whether the testing feature can be split cleanly while staying in lockstep with caldav; the issue lists version skew, the config integration, and release upkeep as open design questions. Done means a settled distribution boundary and release plan.

索引モデルが issue の本文から書いたものです。

説明

Human-written issue text:

There is a legitimate need for testing other packages (like plann, calendar-cli, calendaring, calendaring-sync) towards a wide range of test servers. I'm currently working on exporting the test server registry logic out as a public part of the caldav package. Arguably it would better belong in a separate package. As for now the costs of spawning Yet Another Package have been considered bigger than the costs of adding some few kilobytes of pure-python-logic that ordinary users of the caldav package do not need, but I still think it's That's the Way.

Text below the line was generated by Claude Opus 5.5.


The fix for https://github.com/python-caldav/caldav/issues/817 moves the test-server framework into the installed package as caldav.testing. That covers the registry, the config loader, the session locks and the embedded, Docker and external server classes. Ordinary users of caldav never need any of it, so it could live in a dev-only distribution instead, say caldav-test-servers.

For a split:

  • The wheel carries only what library users need.
  • A separate wheel could ship tests/docker-test-servers/ as package data. That would remove the CALDAV_DOCKER_TEST_SERVERS_DIR workaround. It would also stop an installed caldav from looking for a checkout's tests/ directory inside site-packages (see docs/design/TODO.md).

Against, or at least things to settle first:

  • The split is not clean. get_davclient() with PYTHON_CALDAV_USE_TEST_SERVER=1 lives in caldav/config.py, and it uses the registry and the embedded servers. One option is to move that feature out too. The other is an optional import of the new package from caldav. config.py already has a TODO that calls this test tooling, not config.
  • Version skew. caldav/testing/docker.py imports caldav.compatibility_hints, and the server classes carry feature hints that change with most releases. A test-server package released on its own schedule would drift out of step, which is the breakage #817 was about.
  • The cost of keeping it is small. It is pure Python and imported lazily: import caldav does not load caldav.testing, and requests/yaml are only imported when it is used.
  • Upkeep. It means another PyPI project, another CI job and another release step.
  • An existing home. caldav-server-tester is already a separate, dev-only caldav package. It is a different tool, but it is a candidate home.

Suggested shape, if done: build a second distribution from this repository, released in lockstep with caldav (caldav-test-servers==X requiring caldav==X). It would hold today's caldav.testing plus the compose files as package data. caldav.testing would remain as a thin import shim with a deprecation warning, for one release cycle.

No rush: the in-package version works, and this can wait until there is a reason to touch it.

主要言語
Python
スター
412
フォーク
113
平均マージ
9時間 52分
マージ済み PR(30日)
64

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

python-caldav/caldav のほかの issue

python-caldav/caldav の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。