Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

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

未关闭
  • 哪里不对？
#780 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
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
平均合并
11 小时 37 分钟
30 天内合并 PR
50

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

python-caldav/caldav 的其他 Issue

查看 python-caldav/caldav 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。