[BUG] Calendar.from_ical() issue

Question

[BUG] Calendar.from_ical() issue

vantro opened this issue 2 years ago · comments

Hello,
When I try to import an ics file (28Mb) with the following code, the calendar is displayed at the screen without any print() command.

To Reproduce

import icalendar
file="Calendar-2022-10-21-164146"
with open(f'{file}.ics', 'rb') as file:
    ics_text = file.read()
    cal = Calendar.from_ical(ics_text)

Output:

it's a dump of the file

Environment

OS: Mac OS Monterey
Python version: Python 3.10
icalendar version: 5.0.1

How to browse a large file ?

Thanks

Jaca · Answer 1 · Tue Oct 25 2022 00:04:27 GMT+0800 (China Standard Time)

Hi, could you attach said calendar? We can't reproduce this atm

vantro · Answer 2 · Tue Oct 25 2022 16:48:24 GMT+0800 (China Standard Time)

The ics file can be downloaded here: https://filesender.renater.fr/?s=download&token=c778975e-6fd1-4146-9426-e3db8e8c59d0

Jaca · Answer 3 · Wed Oct 26 2022 01:15:05 GMT+0800 (China Standard Time)

Grepping the file for END:VCALENDAR returns nothing, so the file you've attached is invalid. I appened END:VCALENDAR (e.g. echo 'END:VCALENDAR' >> Calendar-2022-10-21-164146) to it, and it was parsed correctly. The dump of the file results from the line 396 of cal.py, where __ repr() __ of a component is appened the error message.

Jaca · Answer 4 · Wed Oct 26 2022 01:16:09 GMT+0800 (China Standard Time)

For future notice, it's possible to attach files on Github -- just drag the file into the comment input box :)

Nicco Kunzmann · Answer 5 · Wed Oct 26 2022 07:15:28 GMT+0800 (China Standard Time)

I appened END:VCALENDAR

That might happen if a file is incomplete.

The dump of the file results from the line 396 of cal.py, where __ repr() __ of a component is appened the error message.

Hm, maybe it is safe to cut out a few megabytes in __repr__.

Jaca · Answer 6 · Wed Oct 26 2022 20:11:14 GMT+0800 (China Standard Time)

Hm, maybe it is safe to cut out a few megabytes in __repr__.

I created add_max_error_length with a test for error message trimming. If everyone likes it, I can make it green later this week.

Nicco Kunzmann · Answer 7 · Wed Oct 26 2022 21:43:00 GMT+0800 (China Standard Time)

That test adds value. I wonder: will people want to see the whole calendar? 100 is a bit more than one line. Will the calendar have the faulty in the message? I think, I would like to check `str` and `repr` and . message. BUT The most important thing is to solve the issue and have fun and not (my) perfectionism or concerns so much because the fun makes progress: fast releases, people complain, people get involved. Involvement keeps this project alive, vetos and demanding others to comply kill it.

Jaca · Answer 8 · Wed Oct 26 2022 21:53:50 GMT+0800 (China Standard Time)

I think 100 characters is fine, since more would obfuscate the fact that an exception was thrown (like we see in this issue). Nonetheless, adding a verbose argument to the Calendar.from_ics method shouldn't be difficult.

vantro · Answer 9 · Wed Oct 26 2022 23:06:10 GMT+0800 (China Standard Time)

as a user, I don't need to see all the events, but reason of the error is enough.
As this file was generated by an application (Zimbra) a notice the bad structure and the missing argument would be fine.

Nicco Kunzmann · Answer 10 · Wed Oct 26 2022 23:10:41 GMT+0800 (China Standard Time)

Yes. I would skip the verbose argument as string conversion is property of the exception and not the parsing for me. I am happy with an easy fix.

Jaca · Answer 11 · Wed Oct 26 2022 23:12:38 GMT+0800 (China Standard Time)

@vantro Since the file was produced by a third party program, you should report the bug to them. Feel free to link this issue to them :)