collective / icalendar / 25792534587

98%

push

github

Add `vWeekday.ical_value` for the `Component.decoded()` polymorphy (#1360)

* Add `vWeekday.ical_value` for the `Component.decoded()` polymorphy

Refs #876.

Adds the `ical_value` property to `vWeekday`, returning the weekday
string (e.g. ``MO``, ``+2TH``, ``-1SU``). This continues the polymorphy
work tracked in #876, matching the pattern already established for
`vText`, `vUri`, `vInt`, `vFloat`, `vBoolean`, `vBinary`, `vCalAddress`,
and friends -- each value class exposes its underlying Python value via
`ical_value` so `Component.decoded()` can stop dispatching on type.

Test added alongside the existing `test_vWeekday` cases:

  >>> vWeekday("MO").ical_value
  'MO'
  >>> vWeekday("+2TH").ical_value
  '+2TH'
  >>> vWeekday("-1SU").ical_value
  '-1SU'

`pytest src/icalendar/tests/prop/test_vWeekday.py` now passes 5 tests
(was 4).

* docs(weekday): apply review suggestions and add changelog entry

- Replace Latin abbreviation in vWeekday.ical_value docstring with
  explicit examples (MO, +2TH, -1SU) per @stevepiercy.
- Convert the RFC reference to a Sphinx Napolean See Also: section
  per @stevepiercy.
- Add a New features changelog entry for 7.1.1 (unreleased) mirroring
  the vBoolean.ical_value entry from 7.1.0.

---------

Co-authored-by: Matt Van Horn <455140+mvanhorn@users.noreply.github.com>
Co-authored-by: Steve Piercy <web@stevepiercy.com>

748 of 770 branches covered (97.14%)

Branch coverage included in aggregate %.

8 of 8 new or added lines in 2 files covered. (100.0%)

12348 of 12624 relevant lines covered (97.81%)

6.84 hits per line