Skip to content

Commit 24b11b8

Browse files
bigfootjonronaldoussoren
authored andcommitted
bpo-38053 Update documentation for plistlib (GH-15727)
* Update documentation for plistlib - Update "Mac OS X" to "Apple" since plists are used more widely than just macOS - Re-add the UID class documentation (oops, removed in GH-15615)
1 parent c638521 commit 24b11b8

File tree

2 files changed

+19
-4
lines changed

2 files changed

+19
-4
lines changed

Doc/library/plistlib.rst

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
:mod:`plistlib` --- Generate and parse Mac OS X ``.plist`` files
2-
================================================================
1+
:mod:`plistlib` --- Generate and parse Apple ``.plist`` files
2+
=============================================================
33

44
.. module:: plistlib
5-
:synopsis: Generate and parse Mac OS X plist files.
5+
:synopsis: Generate and parse Apple plist files.
66

77
.. moduleauthor:: Jack Jansen
88
.. sectionauthor:: Georg Brandl <[email protected]>
@@ -17,7 +17,8 @@
1717
--------------
1818

1919
This module provides an interface for reading and writing the "property list"
20-
files used mainly by Mac OS X and supports both binary and XML plist files.
20+
files used by Apple, primarily on macOS and iOS. This module supports both binary
21+
and XML plist files.
2122

2223
The property list (``.plist``) file format is a simple serialization supporting
2324
basic object types, like dictionaries, lists, numbers and strings. Usually the
@@ -124,6 +125,19 @@ This module defines the following functions:
124125
.. versionadded:: 3.4
125126

126127

128+
The following classes are available:
129+
130+
.. class:: UID(data)
131+
132+
Wraps an :class:`int`. This is used when reading or writing NSKeyedArchiver
133+
encoded data, which contains UID (see PList manual).
134+
135+
It has one attribute, :attr:`data`, which can be used to retrieve the int value
136+
of the UID. :attr:`data` must be in the range `0 <= data <= 2**64`.
137+
138+
.. versionadded:: 3.8
139+
140+
127141
The following constants are available:
128142

129143
.. data:: FMT_XML
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Modernized the plistlib documentation

0 commit comments

Comments
 (0)