Repository navigation
Properly decode every value type (polymorphy, beginner) #876
Description
At the moment, each value type is different.
We have a method Component.decoded() which puts an incomplete if/else dispatch into place to get the decoded value.
It would be easier if all value types had a property such as ical_value which would result in the object used.
Examples
This would e.g. be
.tdfor timedelta.dtfor datestr(self)for vText
Places to edit
Classes to add ical_value to:
- vBinary 876/vBinary #1274
- vBoolean #876 vBoolean #1205
- vText
- vCalAddress
- vFloat #876 vFloat #1265
- vInt 876/vInt #1273
- vDDDLists
- vCategory
- vDDDTypes
- vDate Add ical_value property to vDate #1965
- vDatetime Add ical_value property to VDatetime #1991
- vDuration
- vPeriod #876 vPeriod #1359
- vWeekday Add
vWeekday.ical_valuefor theComponent.decoded()polymorphy #1360 - vFrequency
- vMonth
- vSkip
- vText
- vRecur
- vTime
- vUri
- vGeo Add vGeo.ical_value for the Component.decoded() polymorphyfeat: add ical_value property to vGeo (#876) #1422
- vUTCOffset
- vInline
Other places to touch when the list above is done:
-
Component.decoded()usesical_valueand nothing else (Polymorphy) - remove TODO in
Component.decoded() - Document how
Component.decoded()works, so that new value types are easy to implement.
Checklist for all ical_value
For each of the added functions:
- add a type hint
- add a doc string
- add a test for all possible code paths inside of
ical_value- create the object
- if needed add parameters
- return the value
- check the docstring turns up in the documentation and looks nice
Note: Corrected: it should be ical_value for consistency with to_ical and from_ical.
Activity
TejasR002 commentedon Oct 16, 2025
hey ! i would like to contribute to it. so can you assign this to me
niccokunzmann commentedon Oct 16, 2025
TejasR002 commentedon Oct 19, 2025
hello ! , i was going through the failed test cases and try to see which are failing then i found that the
test_798_freebusy, was failing after digging in , i feel that during parsing it's not able to parse or assign an attribute calledFBTYPE, because after parsing there is no attribute in the object named FBTYPE , meanwhile in the tests cases there are test cases for accessing theFBTYPEattribute for checking , so far i have understood this, so could you please check whether i'm right or wrong ,also i have tried over old and new decoded function which takes not effect at all.niccokunzmann commentedon Oct 20, 2025
@TejasR002, I commented. It is enough to focus on adding some new properties. This issue is quite big but most parts are alright for first-timers. Others require deep digging in and evaluation of possible mistakes that were made in the past years: these contributions are not straight forward.
Thank you for your tolerance! Let me know if I can help you anywhere else and if my suggestion actually works. I hope it does 😃
ijsbol commentedon Feb 11, 2026
Heya, myself and a couple of friends would love to give this issue a shot! We'll create a PR for it in a week or so.
niccokunzmann commentedon Feb 11, 2026
@ijsbol Welcome! This is a huge issue, so please take a small part, open a PR and let's chat, so that it can be merged quicker.
ijsbol commentedon Feb 11, 2026
Thank you! Will definitely do that!
ijsbol commentedon Feb 12, 2026
Heya @niccokunzmann, I've gone ahead and implemented the
ical_valuemethod forvBoolean, just want to check that I understand the way to implement it and that this is the kind of commit you are looking for?ijsbol@e7e7674
If so i'll go ahead and work on a few more and create a PR!
niccokunzmann commentedon Feb 13, 2026
@ijsbol Yes, that is what I am looking for. Thanks. Feel free to open a PR with the change!
Also, if you create several PRs for each change, that is easier to merge, review and adjust.
Oh. Please add a docstring.
Merge pull request #1205 from ijsbol/main
Merge pull request #1265 from ijsbol/ijsbol/876/vFloat
6 remaining items
chore(deps): bump icalendar from 7.1.0 to 7.1.1 (#201)
build(deps): Bump icalendar from 7.0.3 to 7.1.2 (#542)
feat: add ical_value property to vGeo (#876) (#1422)
feat: add ical_value property to vGeo (collective#876) (collective#1422)
chore(deps): bump icalendar from 7.1.3 to 7.2.0 (#323)
build(deps): Bump icalendar from 7.1.2 to 7.2.0 (#593)
HannaEpelboim commentedon Oct 16, 2026
Hi! I'd like to contribute to this issue. I implemented ical_value for vDate in #1965. Feedback is very welcome!
Add change log entry for vDate.ical_value
Mrbozz commentedon Oct 21, 2026
I tried to contribute with the implementation of ical_value property for vDatetime. Any feedbacks are welcome
Add ical_value property to vDate
wmortenson199 commentedon Nov 12, 2026
I will be taking vTime and add its ical_value property. ’ll open a small PR with the property, a docstring, a test, and a news entry. I’m working on this as part of a group for an open source project at my univeristy
Add ical_value property to vTime
Add ical_value property to vTime
jakkoyang commentedon Nov 13, 2026
i would like to take vSkip (ical_value bug) and vMonth for fun