Properly decode every value type (polymorphy, beginner)

[niccokunzmann]

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

• .td for timedelta
• .dt for date
• str(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
• vDatetime
• vDuration
• vPeriod #876 vPeriod #1359
• vWeekday Add vWeekday.ical_value for the Component.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() uses ical_value and 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.

[TejasR002]

hey ! i would like to contribute to it. so can you assign this to me

[niccokunzmann]

No, you just need to start working and link the issue in the pull request.

[TejasR002]

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 called FBTYPE , because after parsing there is no attribute in the object named FBTYPE , meanwhile in the tests cases there are test cases for accessing the FBTYPE attribute 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]

@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]

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]

@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]

Thank you! Will definitely do that!

[ijsbol]

Heya @niccokunzmann, I've gone ahead and implemented the ical_value method for vBoolean, 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]

@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.