looking through the examples. I think I'll just let them stay - but they should be tested

Author: tobixen

caldav/davclient.py

@@ -524,9 +524,9 @@ def __enter__(self) -> Self:
 
     def __exit__(
         self,
-        exc_type: Optional[BaseException],
-        exc_value: Optional[BaseException],
-        traceback: Optional[TracebackType],
+        exc_type: Optional[BaseException] = None,
+        exc_value: Optional[BaseException] = None,
+        traceback: Optional[TracebackType] = None,
     ) -> None:
         self.close()
         ## Used for tests, to tear down a temporarily test server
@@ -966,7 +966,7 @@ def get_davclient(
     if environment:
         conf = {}
         for conf_key in (x for x in os.environ if x.startswith("CALDAV_")):
-            conf[conf_key[7:]] = os.environ[conf_key].lower()
+            conf[conf_key[7:].lower()] = os.environ[conf_key]
         if conf:
             return DAVClient(**conf)
         config_file = os.environ.get("CALDAV_CONFIG_FILE")

examples/get_events_example.py

@@ -1,52 +1,48 @@
 #!/usr/bin/env python3
 import json
-from os import environ as env
 
-import caldav
+## Code contributed by Крылов Александр.  Minor changes and quite some
+## comments by Tobias Brox.
 
-username = env["CALDAV_USERNAME"]
-password = env["CALDAV_PASSWORD"]
-url = env["CALDAV_URL"]
-caldav_url = f"https://{url}/{username}/"
-headers = {}
+## Set CALDAV_USERNAME, CALDAV_URL and CALDAV_PASSWORD through
+## environment variables before running this example
 
+from caldav.davclient import get_davclient
 
 def fetch_and_print():
-    with caldav.DAVClient(
-        url=caldav_url,
-        username=username,
-        password=password,
-        # Optional parameter to set HTTP headers on each request if needed
-        headers=headers,
-    ) as client:
+    with get_davclient() as client:
         print_calendars_demo(client.principal().calendars())
 
-
 def print_calendars_demo(calendars):
     if not calendars:
         return
     events = []
     for calendar in calendars:
         for event in calendar.events():
+            ## Most calendar events will have only one component,
+            ## and it can be accessed simply as event.component
+            ## The exception is special recurrences, to handle those
+            ## we may need to do the walk:
             for component in event.icalendar_instance.walk():
                 if component.name != "VEVENT":
                     continue
                 events.append(fill_event(component, calendar))
     print(json.dumps(events, indent=2, ensure_ascii=False))
 
-
 def fill_event(component, calendar) -> dict[str, str]:
+    ## quite some data is tossed away here - like, the recurring rule.
     cur = {}
     cur["calendar"] = f"{calendar}"
     cur["summary"] = component.get("summary")
     cur["description"] = component.get("description")
-    cur["start"] = component.get("dtstart").dt.strftime("%m/%d/%Y %H:%M")
-    endDate = component.get("dtend")
-    if endDate and endDate.dt:
-        cur["end"] = endDate.dt.strftime("%m/%d/%Y %H:%M")
+    cur["start"] = component.start.strftime("%m/%d/%Y %H:%M")
+    endDate = component.end
+    if endDate:
+        cur["end"] = endDate.strftime("%m/%d/%Y %H:%M")
+    ## For me the following line breaks because some imported calendar events
+    ## came without dtstamp.  But dtstamp is mandatory according to the RFC
     cur["datestamp"] = component.get("dtstamp").dt.strftime("%m/%d/%Y %H:%M")
     return cur
 
-
 if __name__ == "__main__":
     fetch_and_print()

tests/test_caldav.py

@@ -456,6 +456,7 @@ def testEnvironment(self):
         os.environ["PYTHON_CALDAV_USE_TEST_SERVER"] = "1"
         with get_davclient(environment=True, config_file=False, name="-1") as conn:
             assert conn.principal()
+            del os.environ["PYTHON_CALDAV_USE_TEST_SERVER"]
             for key in ("url", "username", "password", "proxy"):
                 if key in caldav_servers[-1]:
                     os.environ[f"CALDAV_{key.upper()}"] = caldav_servers[-1][key]

tests/test_examples.py

@@ -0,0 +1,19 @@
+import os
+import sys
+from caldav.davclient import get_davclient
+from datetime import datetime
+
+class TestExamples:
+    def setup_method(self):
+        os.environ['PYTHON_CALDAV_USE_TEST_SERVER'] = '1'
+        sys.path.insert(0,'.')
+        sys.path.insert(1,'..')
+    def teardown_method(self):
+        sys.path = sys.path[2:]
+        del os.environ['PYTHON_CALDAV_USE_TEST_SERVER']
+    def test_get_events_example(self):
+        with get_davclient() as client:
+            mycal = client.principal().make_calendar(name="Test calendar")
+            mycal.save_event(dtstart=datetime(2025,5,3,10), dtend=datetime(2025,5,3,11),summary="testevent")
+            from examples import get_events_example
+            get_events_example.fetch_and_print()