i_8dZddlmZddlZddlmZddlmZddlm Z m Z m Z ddl m Z mZmZmZmZmZmZmZmZmZddlmZdd lmZdd lmZdd lmZdd lm Z e r.dd l!m"Z"m#Z#ddlm$Z$mZddl%m&Z&ddl'm(Z(ddl)m*Z*ddl+m,Z,ddl-m.Z.GddeZ/dgZ0dS)z :rfc:`5545` iCalendar component.) annotationsN) timedelta)Path) TYPE_CHECKINGLiteraloverload) CONCEPTS_TYPE_SETTERLINKS_TYPE_SETTERRELATED_TO_TYPE_SETTERcategories_propertyimages_propertymulti_language_text_propertysingle_string_propertysource_property uid_property url_property) Component) get_example)Timezone)IncompleteComponent) __version__)IterableSequence)datedatetime) Availability)Event)FreeBusy)Journal)TodoceZdZdZdZdZdZdZdZe ddded Z e e dfdgdZ e e dhdZ e dfdidZ e djdZe dkdZe dldZe dmdZe dnd!Zdod#Zdod$Ze dpd&Zejejfdqd*Zed+d,d-Zed.d/d0Zed1d2d3ZeZ e!Z"ed4d5Z#ed6d7Z$ed8d9d:;Z%ed>> from icalendar import Calendar >>> calendar = Calendar.new(name="My Calendar") >>> print(calendar.calendar_name) My Calendar VCALENDAR)VERSIONPRODIDCALSCALEMETHOD DESCRIPTION X-WR-CALDESCNAME X-WR-CALNAME)r%r$)r%r$r&r'COLOR) CATEGORIESr(r*examplenamestrreturncH|td|S)z0Return the calendar example with the given name. calendars) from_icalr)clsr/s Q/root/projects/butler/venv/lib/python3.11/site-packages/icalendar/cal/calendar.pyr.zCalendar.exampleTs }}[d;;<<<Fstbytes | str | PathmultipleLiteral[False]cdSNr5r8r:s r6r4zCalendar.from_icalYs 3r7 Literal[True]list[Calendar]cdSr=r>r?s r6r4zCalendar.from_ical_s r7boolCalendar | list[Calendar]ct|tr|}njt|trUd|vrQd|vrMt|} |}n#t $rd}YnwxYw|r|}t j|d}d}|D]5}|jD]+}|j dkr|st j||ccS)d},6|r|St|dkr#t| d|t|dkr#t| d ||d S) aParse iCalendar data into Calendar instances. Wraps :meth:`Component.from_ical() ` with timezone forward-reference resolution and VTIMEZONE caching. Parameters: st: iCalendar data as bytes or string, or a path to an iCalendar file as :class:`pathlib.Path` or string. multiple: If ``True``, returns list. If ``False``, returns single calendar. Returns: Calendar or list of Calendars   FT)r: VTIMEZONEz3Found multiple components where only one is allowedz1Found no components where exactly one is requiredr) isinstancer read_bytesr0is_fileOSErrorrr4 subcomponentsr/len ValueError _format_error) r5r8r:pathrLcompsall_timezones_so_farcomp components r6r4zCalendar.from_icales( b$   'BB C  'T^^B88D ,,..     '__&&#B666# 1 1D!/ 1 1 >[00/ A )22x@@@@@@@ A,1((! 1&  L u::>>!!I2  u::>>!!G  QxsA-- A<;A< list[Event]c,|dS)aAll event components in the calendar. This is a shortcut to get all events. Modifications do not change the calendar. Use :py:meth:`Component.add_component `. >>> from icalendar import Calendar >>> calendar = Calendar.example() >>> event = calendar.events[0] >>> event.start datetime.date(2022, 1, 1) >>> print(event["SUMMARY"]) New Year's Day VEVENTwalkselfs r6eventszCalendar.eventss yy"""r7 list[Todo]c,|dS)zAll todo components in the calendar. This is a shortcut to get all todos. Modifications do not change the calendar. Use :py:meth:`Component.add_component `. VTODOrZr\s r6todoszCalendar.todossyy!!!r7 list[Journal]c,|dS)zAll journal components in the calendar. This is a shortcut to get all journals. Modifications do not change the calendar. Use :py:meth:`Component.add_component `. VJOURNALrZr\s r6journalszCalendar.journalssyy$$$r7list[Availability]c,|dS)a All :class:`Availability` components in the calendar. This is a shortcut to get all availabilities. Modifications do not change the calendar. Use :py:meth:`Component.add_component `. VAVAILABILITYrZr\s r6availabilitieszCalendar.availabilitiessyy)))r7list[FreeBusy]c,|dS)zAll FreeBusy components in the calendar. This is a shortcut to get all FreeBusy. Modifications do not change the calendar. Use :py:meth:`Component.add_component `. VFREEBUSYrZr\s r6freebusyzCalendar.freebusysyy%%%r7set[str]ct}|dD]B\}}t|dr-||jdC|dhz S)aThe set of TZIDs in use. This goes through the whole calendar to find all occurrences of timezone information like the TZID parameter in all attributes. >>> from icalendar import Calendar >>> calendar = Calendar.example("timezone_rdate") >>> calendar.get_used_tzids() {'posix/Europe/Vaduz'} Even if you use UTC, this will not show up. F)sortedparamsTZIDN)setproperty_itemshasattraddrrget)r]result_namevalues r6get_used_tzidszCalendar.get_used_tzidssr //u/== 5 5LE5uh'' 5 5<++F33444r7c~|dhz }|jD]}||j|S)a)The set of missing timezone component tzids. To create a :rfc:`5545` compatible calendar, all of these timezones should be added. UTC is excluded: per :rfc:`5545#section-3.2.19`, UTC datetimes use the ``Z`` suffix and never require a VTIMEZONE component. UTC)r| timezonesdiscardtz_name)r]tzidstimezones r6get_missing_tzidszCalendar.get_missing_tzidssL##%%/ , ,H MM(* + + + + r7list[Timezone]c,|dS)a>Return the timezones components in this calendar. >>> from icalendar import Calendar >>> calendar = Calendar.example("pacific_fiji") >>> [timezone.tz_name for timezone in calendar.timezones] ['custom_Pacific/Fiji'] .. note:: This is a read-only property. rHrZr\s r6rzCalendar.timezonessyy%%%r7 first_dater last_datec|}|sdSt|j}|D]K} tj|||}n#t $rY'wxYw|j|||dz }LdS)aAdd all missing VTIMEZONE components. This adds all the timezone components that are required. VTIMEZONE components are inserted at the beginning of the calendar to ensure they appear before other components that reference them. .. note:: Timezones that are not known will not be added. :param first_date: earlier than anything that happens in the calendar :param last_date: later than anything happening in the calendar >>> from icalendar import Calendar, Event >>> from datetime import datetime >>> from zoneinfo import ZoneInfo >>> calendar = Calendar() >>> event = Event() >>> calendar.add_component(event) >>> event.start = datetime(1990, 10, 11, 12, tzinfo=ZoneInfo("Europe/Berlin")) >>> calendar.timezones [] >>> calendar.add_missing_timezones() >>> calendar.timezones[0].tz_name 'Europe/Berlin' >>> calendar.get_missing_tzids() # check that all are added set() N)rrrI)rrOrr from_tzidrPrNinsert)r]rr missing_tzidsexisting_timezone_counttzidrs r6add_missing_timezoneszCalendar.add_missing_timezonessB..00   F"%dn"5"5! ) )D #-Z9       % %&=x H H H #q ( # # ) )sA  AAr*r+aThis property specifies the name of the calendar. This implements :rfc:`7986` ``NAME`` and ``X-WR-CALNAME``. Property Parameters: IANA, non-standard, alternate text representation, and language property parameters can be specified on this property. Conformance: This property can be specified multiple times in an iCalendar object. However, each property MUST represent the name of the calendar in a different language. Description: This property is used to specify a name of the iCalendar object that can be used by calendar user agents when presenting the calendar data to a user. Whilst a calendar only has a single name, multiple language variants can be specified by including this property multiple times with different "LANGUAGE" parameter values on each. Example: Below, we set the name of the calendar. .. code-block:: pycon >>> from icalendar import Calendar >>> calendar = Calendar() >>> calendar.calendar_name = "My Calendar" >>> print(calendar.to_ical()) BEGIN:VCALENDAR NAME:My Calendar X-WR-CALNAME:My Calendar END:VCALENDAR r(r)aThis property specifies the description of the calendar. This implements :rfc:`7986` ``DESCRIPTION`` and ``X-WR-CALDESC``. Conformance: This property can be specified multiple times in an iCalendar object. However, each property MUST represent the description of the calendar in a different language. Description: This property is used to specify a lengthy textual description of the iCalendar object that can be used by calendar user agents when describing the nature of the calendar data to a user. Whilst a calendar only has a single description, multiple language variants can be specified by including this property multiple times with different "LANGUAGE" parameter values on each. Example: Below, we add a description to a calendar. .. code-block:: pycon >>> from icalendar import Calendar >>> calendar = Calendar() >>> calendar.description = "This is a calendar" >>> print(calendar.to_ical()) BEGIN:VCALENDAR DESCRIPTION:This is a calendar X-WR-CALDESC:This is a calendar END:VCALENDAR r,aThis property specifies a color used for displaying the calendar. This implements :rfc:`7986` ``COLOR`` and ``X-APPLE-CALENDAR-COLOR``. Please note that since :rfc:`7986`, subcomponents can have their own color. Property Parameters: IANA and non-standard property parameters can be specified on this property. Conformance: This property can be specified once in an iCalendar object or in ``VEVENT``, ``VTODO``, or ``VJOURNAL`` calendar components. Description: This property specifies a color that clients MAY use when presenting the relevant data to a user. Typically, this would appear as the "background" color of events or tasks. The value is a case-insensitive color name taken from the CSS3 set of names, defined in Section 4.3 of `W3C.REC-css3-color-20110607 `_. Example: ``"turquoise"``, ``"#ffffff"`` .. code-block:: pycon >>> from icalendar import Calendar >>> calendar = Calendar() >>> calendar.color = "black" >>> print(calendar.to_ical()) BEGIN:VCALENDAR COLOR:black END:VCALENDAR zX-APPLE-CALENDAR-COLORr%aPRODID specifies the identifier for the product that created the iCalendar object. Conformance: The property MUST be specified once in an iCalendar object. Description: The vendor of the implementation SHOULD assure that this is a globally unique identifier; using some technique such as an FPI value, as defined in [ISO.9070.1991]. This property SHOULD NOT be used to alter the interpretation of an iCalendar object beyond the semantics specified in this memo. For example, it is not to be used to further the understanding of non- standard properties. Example: The following is an example of this property. It does not imply that English is the default language. .. code-block:: text -//ABC Corporation//NONSGML My Product//EN r$aDVERSION of the calendar specification. The default is ``"2.0"`` for :rfc:`5545`. Purpose: This property specifies the identifier corresponding to the highest version number or the minimum and maximum range of the iCalendar specification that is required in order to interpret the iCalendar object. r&aCALSCALE defines the calendar scale used for the calendar information specified in the iCalendar object. Compatibility: :rfc:`7529` makes the case that GREGORIAN stays the default and other calendar scales are implemented on the RRULE. Conformance: This property can be specified once in an iCalendar object. The default value is "GREGORIAN". Description: This memo is based on the Gregorian calendar scale. The Gregorian calendar scale is assumed if this property is not specified in the iCalendar object. It is expected that other calendar scales will be defined in other specifications or by future versions of this memo. GREGORIAN)defaultr'agMETHOD defines the iCalendar object method associated with the calendar object. Description: When used in a MIME message entity, the value of this property MUST be the same as the Content-Type "method" parameter value. If either the "METHOD" property or the Content-Type "method" parameter is specified, then the other MUST also be specified. No methods are defined by this specification. This is the subject of other specifications, such as the iCalendar Transport- independent Interoperability Protocol (iTIP) defined by :rfc:`5546`. If this property is not present in the iCalendar object, then a scheduling transaction MUST NOT be assumed. In such cases, the iCalendar object is merely being used to transport a snapshot of some calendar information; without the intention of conveying a scheduling semantic. timedelta | NonecB|d}|r|jndS)aREFRESH-INTERVAL specifies a suggested minimum interval for polling for changes of the calendar data from the original source of that data. Conformance: This property can be specified once in an iCalendar object, consisting of a positive duration of time. Description: This property specifies a positive duration that gives a suggested minimum polling interval for checking for updates to the calendar data. The value of this property SHOULD be used by calendar user agents to limit the polling interval for calendar data updates to the minimum interval specified. Raises: ValueError: When setting a negative duration. REFRESH-INTERVALN)rxdt)r]refresh_intervals r6rzCalendar.refresh_intervals+( 88$677&6@""D@r7r{ct|ts|td|'|dkrt d||`|d|dS|`dS)zSet the REFRESH-INTERVAL.NzKREFRESH-INTERVAL must be either a positive timedelta, or None to delete it.rz.REFRESH-INTERVAL must be a positive timedelta.r)rJr TypeError total_secondsrPrrw)r]r{s r6rzCalendar.refresh_interval+s%++ 0A)   !4!4!6!6!!;!;MNN N  % HH' / / / / /%%%r7c0|ddS)zDelete REFRESH-INTERVAL.rN)popr\s r6rzCalendar.refresh_interval;s #$$$$$r7Nr>2.0calscale str | None categories Sequence[str]colorconceptsr descriptionlanguage last_modifieddate | datetime | Nonelinksr method organizationprodidrrefidslist[str] | str | None related_tor sourcerNIterable[Component] | Noneuidstr | uuid.UUID | Noneurlversionct|||||}| *| r(| pd}|r|nd}d| d|d|} n | dtd} | |_||_| |_||_||_| |_ ||_ ||_ ||ntj |_||_| |_||_|t%||_|S) aCreate a new Calendar with all required properties. This creates a new Calendar in accordance with :rfc:`5545` and :rfc:`7986`. Parameters: calscale: The :attr:`calscale` of the calendar. categories: The :attr:`categories` of the calendar. color: The :attr:`color` of the calendar. concepts: The :attr:`~icalendar.Component.concepts` of the calendar. description: The :attr:`description` of the calendar. language: The language for the calendar. Used to generate localized `prodid`. last_modified: The :attr:`~icalendar.Component.last_modified` of the calendar. links: The :attr:`~icalendar.Component.links` of the calendar. method: The :attr:`method` of the calendar. name: The :attr:`calendar_name` of the calendar. organization: The organization name. Used to generate `prodid` if not provided. prodid: The :attr:`prodid` of the component. If None and organization is provided, generates a `prodid` in format "-//organization//name//language". refresh_interval: The :attr:`refresh_interval` of the calendar. refids: :attr:`~icalendar.Component.refids` of the calendar. related_to: :attr:`~icalendar.Component.related_to` of the calendar. source: The :attr:`source` of the calendar. subcomponents: The subcomponents of the calendar. uid: The :attr:`uid` of the calendar. If None, this is set to a new :func:`uuid.uuid4`. url: The :attr:`url` of the calendar. version: The :attr:`version` of the calendar. Returns: :class:`Calendar` Raises: ~error.InvalidCalendar: If the content is not valid according to :rfc:`5545`. .. warning:: As time progresses, we will be stricter with the validation. )rrrrrNr"ENz-//z//z-//collective//icalendar//z//EN)supernewupperrrr calendar_namerrrrruuiduuid4rrrrlistrN)r5rrrrrrrrrr/rrrrrrrNrrrcalendarapp_namelang __class__s r6rz Calendar.newBsz#WW[['! )   >l>)zH'/98>>###TD=<==8==t==FF ^C+CCCF "!%* $(!oss4:<<  $4!   $%)-%8%8H "r7c|dstd|dstd|jstddS)a!Validate that the calendar has required properties and components. This method can be called explicitly to validate a calendar before output. Raises: ~error.IncompleteComponent: If the calendar lacks required properties or components. r%zCalendar must have a PRODIDr$zCalendar must have a VERSIONz@Calendar must contain at least one component (event, todo, etc.)N)rxrrNr\s r6validatezCalendar.validatesvxx!! E%&CDD Dxx "" F%&DEE E! %R   r7)r.)r/r0r1r")F)r8r9r:r;r1r")r8r9r:r@r1rA)r8r9r:rCr1rD)r1rW)r1r_)r1rc)r1rg)r1rk)r1ro)r1r)rrrr)r1r)r{r)Nr>NNNNNNNNNNNNNNNNNr)(rrrrrrrr rrrrrrrr rrr/rrrrrrrrrrr rrrNrrrrrrr0)3__name__ __module__ __qualname____doc__r/canonical_orderrequired singletonsr: classmethodr.rr4propertyr^rbrfrjrnr|rrrDEFAULT_FIRST_DATEDEFAULT_LAST_DATErrrrrrr rrrrrrrrrrrrsetterdeleterr imagesrr __classcell__)rs@r6r"r"'s D OHJH ====[=@E[X[XBBBB[BH###X#""""X"%%%X%***X*&&&X&&  & & &X & $6"4/)/)/)/)/)b10# ''MR/. ""KH # "! D !I% % EL%J C # # F4%$ G &% "'H*$ # F, C F AAAXA, & & & &%%%F $$& )-"&#04#'!#'!-1)--1!48&*-[[[[[[[[zr7r")1r __future__rrrrpathlibrtypingrrricalendar.attrr r r r r rrrrricalendar.cal.componentricalendar.cal.examplesricalendar.cal.timezonericalendar.errorricalendar.versionrcollections.abcrrricalendar.cal.availabilityricalendar.cal.eventricalendar.cal.free_busyricalendar.cal.journalricalendar.cal.todor r"__all__r>r7r6rs&&"""""" 3333333333                        .-----......++++++//////))))))(22222222''''''''777777))))))000000------''''''I I I I I yI I I X ,r7