i*dZddlmZddlmZmZmZddlmZmZddl m Z m Z m Z m Z mZmZmZmZmZmZmZmZmZmZddlmZddlmZer ddlZdd lmZGd d eZd gZ dS) z:rfc:`5545` VALARM component.) annotations)datedatetime timedelta) TYPE_CHECKING NamedTuple)CONCEPTS_TYPE_SETTERLINKS_TYPE_SETTERRELATED_TO_TYPE_SETTERattendees_propertycreate_single_propertydescription_propertyproperty_del_durationproperty_get_durationproperty_set_durationsingle_int_propertysingle_string_propertysingle_utc_propertysummary_property uid_property) Component) get_exampleN) vCalAddressceZdZdZdZdZdZdZdZe ddd Z e e e ed Zed d Zed deefeezdzdZe d.dZejd/dZGddeZe dZedejdZeZe Z!e"Z#e$ d0d1fd* Z%e$d2d3d-Z&xZ'S)4Alarma A "VALARM" calendar component is a grouping of component properties that defines an alarm or reminder for an event or a to-do. For example, it may be used to define a reminder for a pending event or an overdue to-do. Example: The following example creates an alarm which uses an audio file from an FTP server. .. code-block:: pycon >>> from icalendar import Alarm >>> alarm = Alarm.example() >>> print(alarm.to_ical().decode()) BEGIN:VALARM ACTION:AUDIO ATTACH;FMTTYPE=audio/basic:ftp://example.com/pub/sounds/bell-01.aud DURATION:PT15M REPEAT:4 TRIGGER;VALUE=DATE-TIME:19970317T133000Z END:VALARM VALARM)ACTIONTRIGGER) ATTACHr DESCRIPTIONSUMMARYrDURATIONREPEATUID PROXIMITY ACKNOWLEDGED))r"r#)r!ATTENDEE)r'rz RELATED-TOr#ra!The REPEAT property of an alarm component. The alarm can be defined such that it triggers repeatedly. A definition of an alarm with a repeating trigger MUST include both the "DURATION" and "REPEAT" properties. The "DURATION" property specifies the delay period, after which the alarm will repeat. The "REPEAT" property specifies the number of additional repetitions that the alarm will be triggered. This repetition count is in addition to the initial triggering of the alarm. aBThe DURATION property of an alarm component. The alarm can be defined such that it triggers repeatedly. A definition of an alarm with a repeating trigger MUST include both the "DURATION" and "REPEAT" properties. The "DURATION" property specifies the delay period, after which the alarm will repeat. r&aThis is defined in RFC 9074: Purpose: This property specifies the UTC date and time at which the corresponding alarm was last sent or acknowledged. This property is used to specify when an alarm was last sent or acknowledged. This allows clients to determine when a pending alarm has been acknowledged by a calendar user so that any alerts can be dismissed across multiple devices. It also allows clients to track repeating alarms or alarms on recurring events or to-dos to ensure that the right number of missed alarms can be tracked. Clients SHOULD set this property to the current date-time value in UTC when a calendar user acknowledges a pending alarm. Certain kinds of alarms, such as email-based alerts, might not provide feedback as to when the calendar user sees them. For those kinds of alarms, the client SHOULD set this property when the alarm is triggered and the action is successfully carried out. When an alarm is triggered on a client, clients can check to see if an "ACKNOWLEDGED" property is present. If it is, and the value of that property is greater than or equal to the computed trigger time for the alarm, then the client SHOULD NOT trigger the alarm. Similarly, if an alarm has been triggered and an "alert" has been presented to a calendar user, clients can monitor the iCalendar data to determine whether an "ACKNOWLEDGED" property is added or changed in the alarm component. If the value of any "ACKNOWLEDGED" property in the alarm changes and is greater than or equal to the trigger time of the alarm, then clients SHOULD dismiss or cancel any "alert" presented to the calendar user. rdtNa2Purpose: This property specifies when an alarm will trigger. Value Type: The default value type is DURATION. The value type can be set to a DATE-TIME value type, in which case the value MUST specify a UTC-formatted DATE-TIME value. Either a positive or negative duration may be specified for the "TRIGGER" property. An alarm with a positive duration is triggered after the associated start or end of the event or to-do. An alarm with a negative duration is triggered before the associated start or end of the event or to-do.returnstrcj|d}|dS|jddS)aThe RELATED parameter of the TRIGGER property. Values are either "START" (default) or "END". A value of START will set the alarm to trigger off the start of the associated event or to-do. A value of END will set the alarm to trigger off the end of the associated event or to-do. In this example, we create an alarm that triggers two hours after the end of its parent component: >>> from icalendar import Alarm >>> from datetime import timedelta >>> alarm = Alarm() >>> alarm.TRIGGER = timedelta(hours=2) >>> alarm.TRIGGER_RELATED = "END" rNSTARTRELATED)getparams)selftriggers N/root/projects/butler/venv/lib/python3.11/site-packages/icalendar/cal/alarm.pyTRIGGER_RELATEDzAlarm.TRIGGER_RELATEDs7&((9%% ?7~!!)W555valuecf|d}|td||jd<dS)zSet "START" or "END".rNz>> from icalendar import Alarm >>> from datetime import timedelta >>> alarm = Alarm() >>> alarm.TRIGGER = timedelta(hours=-4) # trigger 4 hours before START >>> alarm.DURATION = timedelta(hours=1) # after 1 hour trigger again >>> alarm.REPEAT = 2 # trigger 2 more times >>> alarm.triggers.start == (timedelta(hours=-4), timedelta(hours=-3), timedelta(hours=-2)) True >>> alarm.triggers.end () >>> alarm.triggers.absolute () Nr,)r:r;r<) r isinstancerappendr3r"ranger#rCtuple)r0r:r;r<r1addduration_s r2triggerszAlarm.triggerss,,  '4(( (((%00 W%%% 7###}H#t{++33AJJs2w12222}},,E#JJx   r4r$z X-ALARMUID attendeeslist[vCalAddress] | Noneconceptsr description str | Nonelinksr refidslist[str] | str | None related_tor summaryuidstr | uuid.UUID | Nonec t||||} || _|| _|| _|| _| S)aCreate a new alarm with all required properties. This creates a new Alarm in accordance with :rfc:`5545`. Parameters: attendees: The :attr:`attendees` of the alarm. concepts: The :attr:`~icalendar.Component.concepts` of the alarm. description: The :attr:`description` of the alarm. links: The :attr:`~icalendar.Component.links` of the alarm. refids: :attr:`~icalendar.Component.refids` of the alarm. related_to: :attr:`~icalendar.Component.related_to` of the alarm. summary: The :attr:`summary` of the alarm. uid: The :attr:`uid` of the alarm. Returns: :class:`Alarm` Raises: ~error.InvalidCalendar: If the content is not valid according to :rfc:`5545`. .. warning:: As time progresses, we will be stricter with the validation. )rSrVrTrP)supernewrWrQrXrN) clsrNrPrQrSrTrVrWrXalarm __class__s r2r\z Alarm.new sRHww{{! #     ' # r4examplenamecH|td|S)z-Return the alarm example with the given name.alarms) from_icalr)r]ras r2r`z Alarm.example;s }}[488999r4)r)r*)r5r*)NNNNNNNN)rNrOrPr rQrRrSr rTrUrVr rWrRrXrY)r`)rar*r)r)(r=r>r?r@rarequired singletons inclusivemultiplerr#propertyrrrr"rr&r rrrr3setterrrCrMrrrXrrWrrQr rN classmethodr\r` __classcell__)r_s@r2rr!s2 DH J I4H     Fx   H'& L>%$ 9Ht# 6 G$666X6.**** " " " " ": " " ") ) X) V !    C G&K"I/3)-"&#')--1"&*------[-^::::[:::::r4r)!r@ __future__rrrrtypingrricalendar.attrr r r r r rrrrrrrrricalendar.cal.componentricalendar.cal.examplesruuidicalendar.proprr__all__rBr4r2rus|##""""""..........,,,,,,,, .-----......+KKK******]:]:]:]:]:I]:]:]:@ )r4