icalendar.prop.n module#

N property from RFC 6350.

class icalendar.prop.n.NFields(family: str, given: str, additional: str, prefix: str, suffix: str)[source]#

Bases: NamedTuple

Named fields for vCard N (Name) property per RFC 6350 Section 6.2.2.

Provides named access to the five name components.

additional: str#

Additional names.

family: str#

Family names (also known as surnames).

given: str#

Given names.

prefix: str#

Honorific prefixes.

suffix: str#

Honorific suffixes.

class icalendar.prop.n.vN(fields, /, params=None)[source]#

Bases: object

vCard N (Name) structured property per RFC 6350 Section 6.2.2.

The N property represents a person's name. It consists of a single structured text value. Each component in the structure may have multiple values, separated by commas.

The structured property value corresponds, in sequence, to the following fields:

  • family names (also known as surnames)

  • given names

  • additional names

  • honorific prefixes

  • honorific suffixes

Semicolons are field separators and are NOT escaped. Commas and backslashes within field values ARE escaped per RFC 6350.

Examples

>>> from icalendar.prop import vN
>>> n = vN(("Doe", "John", "M.", "Dr.", "Jr.,M.D.,A.C.P."))
>>> n.to_ical()
b'Doe;John;M.;Dr.;Jr.\\,M.D.\\,A.C.P.'
>>> vN.from_ical(r"Doe;John;M.;Dr.;Jr.\,M.D.\,A.C.P.")
NFields(family='Doe', given='John', additional='M.', prefix='Dr.', suffix='Jr.,M.D.,A.C.P.')
property VALUE: str#

The VALUE parameter or the default.

Purpose:

VALUE explicitly specify the value type format for a property value.

Description:

This parameter specifies the value type and format of the property value. The property values MUST be of a single value type. For example, a "RDATE" property cannot have a combination of DATE-TIME and TIME value types.

If the property's value is the default value type, then this parameter need not be specified. However, if the property's default value type is overridden by some other allowable value type, then this parameter MUST be specified.

Applications MUST preserve the value data for x-name and iana-token values that they don't recognize without attempting to interpret or parse the value data.

Returns:

The VALUE parameter or the default.

Examples

The VALUE defaults to the name of the property. Note that it is case-insensitive but always uppercase.

>>> from icalendar import vBoolean
>>> b = vBoolean(True)
>>> b.VALUE
'BOOLEAN'

Setting the VALUE parameter of a typed property usually does not make sense. For convenience, using this property, the value will be converted to an uppercase string. If you have some custom property, you might use it like this:

>>> from icalendar import vUnknown, Event
>>> v = vUnknown("Some property text.")
>>> v.VALUE = "x-type"  # lower case
>>> v.VALUE
'X-TYPE'
>>> event = Event()
>>> event.add("x-prop", v)
>>> print(event.to_ical())
BEGIN:VEVENT
X-PROP;VALUE=X-TYPE:Some property text.
END:VEVENT
__init__(fields, /, params=None)[source]#

Initialize N with five fields or parse from vCard format string.

Parameters:

  • fields (tuple[str, ...] | list[str] | str | NFields) -- Either an NFields, tuple, or list of five strings, one per field, or a vCard format string with semicolon-separated fields

  • params (dict[str, Any] | None) -- Optional property parameters

default_value: ClassVar[str] = 'TEXT'#
classmethod examples()[source]#

Examples of vN.

Return type:

list[None]

fields: NFields#
static from_ical(ical)[source]#

Parse vCard N format into an NFields named tuple.

Parameters:

ical (str | bytes) -- vCard format string with semicolon-separated fields

Return type:

NFields

Returns:

NFields named tuple with five field values.

classmethod from_jcal(jcal_property)[source]#

Parse jCal from RFC 7265.

Parameters:

jcal_property (list) -- The jCal property to parse.

Raises:

JCalParsingError -- If the provided jCal is invalid.

Return type:

None

property ical_value: NFields#

The name fields as a named tuple.

params: Parameters#
to_ical()[source]#

Generate vCard format with semicolon-separated fields.

Return type:

bytes

to_jcal(name)[source]#

The jCal representation of this property according to RFC 7265.

Return type:

list