Skip to content

Add ical_value property to vRecur#1382

Closed
xxiaoxiong wants to merge 1 commit into
collective:mainfrom
xxiaoxiong:add-ical-value-vrecur
Closed

Add ical_value property to vRecur#1382
xxiaoxiong wants to merge 1 commit into
collective:mainfrom
xxiaoxiong:add-ical-value-vrecur

Conversation

@xxiaoxiong
Copy link
Copy Markdown

This PR adds the ical_value property to vRecur, contributing to Issue #876.

Changes

  • Added ical_value property to vRecur (src/icalendar/prop/recur/recur.py)
    • Returns: dict[str, list[Any]] - The recurrence rule dictionary
    • Type hint: dict[str, list[Any]]
    • RFC reference: :rfc:5545#section-3.3.10
    • Includes comprehensive docstring with examples
    • Each key represents a rule part (FREQ, COUNT, INTERVAL, BYDAY, etc.)
    • Each value is a list of the corresponding values

Tests

  • Created test_vRecur.py with 8 comprehensive test cases:
    • test_ical_value_basic - Tests basic structure
    • test_ical_value_daily_count - Tests DAILY with COUNT
    • test_ical_value_weekly_byday - Tests WEEKLY with BYDAY
    • test_ical_value_monthly_interval - Tests MONTHLY with INTERVAL
    • test_ical_value_yearly_bymonth - Tests YEARLY with BYMONTH
    • test_ical_value_complex_rule - Tests complex multi-part rule
    • test_ical_value_from_constructor - Tests constructor-created vRecur
    • test_ical_value_wkst - Tests WKST parameter
  • All tests pass: 8 passed

Quality Checks

  • Add type hint
  • Add docstring with RFC reference
  • Add tests for all code paths
  • Pass ruff format check
  • Pass ruff lint check
  • All tests pass

Relates to #876

- Add ical_value property with type hints and docstring
- Returns the underlying dict value (recurrence rule)
- Each key is a rule part, each value is a list
- Add comprehensive tests for ical_value (8 test cases)
- All tests pass
- Code formatted with ruff

Relates to collective#876
@read-the-docs-community
Copy link
Copy Markdown

Documentation build overview

📚 icalendar | 🛠️ Build #32600764 | 📁 Comparing 8bd6130 against latest (7357cec)

  🔍 Preview build  

5 files changed · ± 5 modified

± Modified

@stevepiercy stevepiercy added the ai-suspicion This contribution is possibly created with lots of AI help without enough human understanding. label May 20, 2026
@stevepiercy
Copy link
Copy Markdown
Member

@xxiaoxiong thank you for opening this PR. Because you haven't responded to the reviews and CI failures, I'm closing all of your PRs to let other contributors know that they are free to work on it. You're welcome to address our comments, resolve the matters, and reopen your pull request at any time, specifically to address the question of AI usage and add a change log, per Contribute. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-suspicion This contribution is possibly created with lots of AI help without enough human understanding.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants