Include attachments in TSV and JSON formatted output

Author: shanemcd

gcalcli/details.py

@@ -366,6 +366,52 @@ def _get(cls, event):
         return ACTION_DEFAULT
 
 
+class Attachments(Handler):
+    """Handler for event attachments."""
+
+    fieldnames = ['attachments']
+
+    ATTACHMENT_PROPS = OrderedDict([('attachment_title', 'title'),
+                                     ('attachment_url', 'fileUrl')])
+
+    @classmethod
+    def fieldnames_data(cls):
+        return list(cls.ATTACHMENT_PROPS.keys())
+
+    @classmethod
+    def get(cls, event):
+        if 'attachments' not in event:
+            return ['']
+
+        # For TSV output, use form feed (\f) to separate multiple attachments
+        # and pipe (|) to separate title from URL within each attachment.
+        # This follows the pattern suggested in issue #829 for handling
+        # list fields in TSV format.
+        # Format: "title1|url1\ftitle2|url2"
+        attachment_strs = []
+        for attachment in event['attachments']:
+            title = attachment.get('title', '').strip()
+            url = attachment.get('fileUrl', '').strip()
+            # Escape any existing form feeds in the data
+            title = title.replace('\f', r'\f')
+            url = url.replace('\f', r'\f')
+            attachment_strs.append(f"{title}|{url}")
+
+        return ['\f'.join(attachment_strs)]
+
+    @classmethod
+    def data(cls, event):
+        attachments = event.get('attachments', [])
+        return [dict(zip(cls.ATTACHMENT_PROPS.keys(),
+                        [attachment.get(prop, '') for prop in cls.ATTACHMENT_PROPS.values()]))
+                for attachment in attachments]
+
+    @classmethod
+    def patch(cls, cal, event, fieldname, value):
+        # Attachments are read-only for now
+        raise ReadonlyCheckError(fieldname, cls.get(event), value)
+
+
 HANDLERS = OrderedDict([('id', ID),
                         ('time', Time),
                         ('length', Length),
@@ -377,8 +423,9 @@ def _get(cls, event):
                         ('calendar', Calendar),
                         ('email', Email),
                         ('attendees', Attendees),
+                        ('attachments', Attachments),
                         ('action', Action)])
-HANDLERS_READONLY = {Url, Calendar}
+HANDLERS_READONLY = {Url, Calendar, Attachments}
 
 FIELD_HANDLERS = dict(chain.from_iterable(
     (((fieldname, handler)
@@ -390,7 +437,7 @@ def _get(cls, event):
                                 in FIELD_HANDLERS.items()
                                 if handler in HANDLERS_READONLY)
 
-_DETAILS_WITHOUT_HANDLERS = ['reminders', 'attachments', 'end']
+_DETAILS_WITHOUT_HANDLERS = ['reminders', 'end']
 
 DETAILS = list(HANDLERS.keys()) + _DETAILS_WITHOUT_HANDLERS
 DETAILS_DEFAULT = {'time', 'title'}

tests/test_details.py

@@ -0,0 +1,185 @@
+"""Tests for detail handlers."""
+
+import pytest
+from gcalcli.details import (
+    Attachments,
+    Attendees,
+    Title,
+    Conference,
+)
+
+
+class TestAttachmentsHandler:
+    """Tests for Attachments handler."""
+
+    def test_get_with_no_attachments(self):
+        """Test get() returns empty string for events without attachments."""
+        event = {}
+        result = Attachments.get(event)
+        assert result == ['']
+
+    def test_get_with_single_attachment(self):
+        """Test get() returns properly formatted string for single attachment."""
+        event = {
+            'attachments': [
+                {
+                    'title': 'Notes by Gemini',
+                    'fileUrl': 'https://docs.google.com/document/d/123/edit'
+                }
+            ]
+        }
+        result = Attachments.get(event)
+        assert result == ['Notes by Gemini|https://docs.google.com/document/d/123/edit']
+
+    def test_get_with_multiple_attachments(self):
+        """Test get() returns properly formatted string for multiple attachments."""
+        event = {
+            'attachments': [
+                {
+                    'title': 'Document 1',
+                    'fileUrl': 'https://docs.google.com/document/d/123/edit'
+                },
+                {
+                    'title': 'Document 2',
+                    'fileUrl': 'https://docs.google.com/document/d/456/edit'
+                }
+            ]
+        }
+        result = Attachments.get(event)
+        expected = 'Document 1|https://docs.google.com/document/d/123/edit\fDocument 2|https://docs.google.com/document/d/456/edit'
+        assert result == [expected]
+
+    def test_get_with_missing_fields(self):
+        """Test get() handles missing title/fileUrl fields gracefully."""
+        event = {
+            'attachments': [
+                {
+                    'title': 'Document 1'
+                    # missing fileUrl
+                },
+                {
+                    'fileUrl': 'https://docs.google.com/document/d/456/edit'
+                    # missing title
+                }
+            ]
+        }
+        result = Attachments.get(event)
+        expected = 'Document 1|\f|https://docs.google.com/document/d/456/edit'
+        assert result == [expected]
+
+    def test_data_with_no_attachments(self):
+        """Test data() returns empty list for events without attachments."""
+        event = {}
+        result = Attachments.data(event)
+        assert result == []
+
+    def test_data_with_single_attachment(self):
+        """Test data() returns properly formatted dict for single attachment."""
+        event = {
+            'attachments': [
+                {
+                    'title': 'Notes by Gemini',
+                    'fileUrl': 'https://docs.google.com/document/d/123/edit'
+                }
+            ]
+        }
+        result = Attachments.data(event)
+        expected = [
+            {
+                'attachment_title': 'Notes by Gemini',
+                'attachment_url': 'https://docs.google.com/document/d/123/edit'
+            }
+        ]
+        assert result == expected
+
+    def test_data_with_multiple_attachments(self):
+        """Test data() returns properly formatted dict list for multiple attachments."""
+        event = {
+            'attachments': [
+                {
+                    'title': 'Document 1',
+                    'fileUrl': 'https://docs.google.com/document/d/123/edit'
+                },
+                {
+                    'title': 'Document 2',
+                    'fileUrl': 'https://docs.google.com/document/d/456/edit'
+                }
+            ]
+        }
+        result = Attachments.data(event)
+        expected = [
+            {
+                'attachment_title': 'Document 1',
+                'attachment_url': 'https://docs.google.com/document/d/123/edit'
+            },
+            {
+                'attachment_title': 'Document 2',
+                'attachment_url': 'https://docs.google.com/document/d/456/edit'
+            }
+        ]
+        assert result == expected
+
+    def test_data_with_missing_fields(self):
+        """Test data() handles missing title/fileUrl fields gracefully."""
+        event = {
+            'attachments': [
+                {
+                    'title': 'Document 1'
+                    # missing fileUrl
+                },
+                {
+                    'fileUrl': 'https://docs.google.com/document/d/456/edit'
+                    # missing title
+                }
+            ]
+        }
+        result = Attachments.data(event)
+        expected = [
+            {
+                'attachment_title': 'Document 1',
+                'attachment_url': ''
+            },
+            {
+                'attachment_title': '',
+                'attachment_url': 'https://docs.google.com/document/d/456/edit'
+            }
+        ]
+        assert result == expected
+
+    def test_get_with_semicolons(self):
+        """Test get() handles semicolons in titles and URLs correctly."""
+        event = {
+            'attachments': [
+                {
+                    'title': 'Meeting Notes; Q4 2025',
+                    'fileUrl': 'https://example.com/doc;jsessionid=ABC123'
+                },
+                {
+                    'title': 'Agenda',
+                    'fileUrl': 'https://docs.google.com/document/d/456/edit'
+                }
+            ]
+        }
+        result = Attachments.get(event)
+        # Semicolons should be preserved, form feed used as separator
+        expected = 'Meeting Notes; Q4 2025|https://example.com/doc;jsessionid=ABC123\fAgenda|https://docs.google.com/document/d/456/edit'
+        assert result == [expected]
+
+    def test_get_with_form_feed_in_data(self):
+        """Test get() escapes existing form feed characters in data."""
+        event = {
+            'attachments': [
+                {
+                    'title': 'Document\fwith\fformfeeds',
+                    'fileUrl': 'https://example.com/doc'
+                }
+            ]
+        }
+        result = Attachments.get(event)
+        # Form feeds in data should be escaped as r'\f'
+        expected = r'Document\fwith\fformfeeds|https://example.com/doc'
+        assert result == [expected]
+
+    def test_fieldnames(self):
+        """Test fieldnames are correctly defined."""
+        assert Attachments.fieldnames == ['attachments']