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

Config: a single CALDAV_* variable makes the config file be ignored

オープン
  • 何か問題がありますか？
#780 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

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

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
55/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
活発
技術スタック
python
領域
developer-experience

調査の方向性

Start in caldav/config.py: get_connection_params() returns the CALDAV_* environment as soon as one connection key is present, and read_config() calls yaml.load with yaml.Loader near line 108. Then check get_calendars() in caldav/base_client.py near line 1069, which calls get_davclient(check_config_file=False). Done when env values override the selected file section key by key, an env URL still wins, the search order matches docs/source/configfile.rst, and yaml.safe_load is used. Item 2 needs a maintainer decision on which order to keep.

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

説明

Disclaimer: AI-generated text below the line, generated by Claude Opus 5.5 (Claude Code), from the prompts:

Please check how the caldav implementation works today. [the config-file handling, while working on https://github.com/pycalendar/calendaring/blob/main/docs/design/CONFIGURATION_PROPOSAL.md]
Please file an issue about the config inconsistencies in the caldav library

Found while specifying the shared config file for calendaring (CONFIGURATION_PROPOSAL.md), checked against master 0f2ee414.

1. Environment variables replace the config file instead of overriding it

get_connection_params() (caldav/config.py) returns the CALDAV_* environment as soon as there is one connection key in it, without merging it with the file. So a user who keeps the password out of the file:

# ~/.config/caldav/calendar.yaml
default:
  caldav_url: https://dav.example.com/
  caldav_username: alice

CALDAV_PASSWORD=secret python -c 'from caldav.config import get_connection_params; print(get_connection_params())'
# {'password': 'secret'}

gets no URL at all, and get_davclient() then returns a client with the URL https://.

get_calendars() does the same for a multi-section name: it calls get_davclient(check_config_file=False, …) first (caldav/base_client.py, around line 1069), so any CALDAV_* connection variable replaces a config_section="*" or contains: expansion with one env-only client.

calendaring-jmap does what one would expect: an env URL means the file is not read, otherwise the env values override the file key by key.

Suggested fix: if the environment holds a URL, keep today's behaviour; otherwise apply the env values on top of the selected section. For a name that expands to several sections, apply only an env URL (one connection replacing the expansion), and ignore the other env values.

2. The documented search order differs from the code

docs/source/configfile.rst lists /etc/caldav/calendar.conf before /etc/calendar.conf; read_config() tries /etc/calendar.conf first. One of them should change (the code order is probably what users have now).

3. YAML is parsed with yaml.Loader

read_config() uses yaml.load(config_file, yaml.Loader) (caldav/config.py line 108), which constructs arbitrary Python objects from tags. Config files are searched in /etc/ too, and will be shared with other pycalendar tools. yaml.safe_load would do; nothing in the documented format needs tags.

主要言語
Python
スター
412
フォーク
113
平均マージ
22時間 15分
マージ済み PR（30日）
44

環境構築

はじめの一歩

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

python-caldav/caldav のほかの issue

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

似ている issue

Python の issue をもっと見る

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

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