o
0io @ s d Z g dZddlZddlZddlZddlZddlmZ ddlZddl Z ddl
Z
ddl Z ddl m
Z
ejddedZe ej d ZG d
d d Zd Ze
d
Zd?ddZdd Ze
de
jZ dd Z dd Z dd Z G dd dZ G d d d Z!G d d d e!Z"d d! Z#G d"d# d#e$Z%d$d%d&d'd(Z&e' Z(G d)d* d*Z)d+d, Z*e+e,e-eje.fZ/G d-d. d.e'Z0d/d0 Z1e2e3e#e e"d1e4e3e1e)e0d1iZ5de3d2d3d4Z6de3d2d5d6Z7e2d7d8d9d:d;Z8e2d8d7d<d=d>Z9dS )@a> plistlib.py -- a tool to generate and parse MacOSX .plist files.
The property list (.plist) file format is a simple XML pickle supporting
basic object types, like dictionaries, lists, numbers and strings.
Usually the top level object is a dictionary.
To write out a plist file, use the dump(value, file)
function. 'value' is the top level object, 'file' is
a (writable) file object.
To parse a plist from a file, use the load(file) function,
with a (readable) file object as the only argument. It
returns the top level object (again, usually a dictionary).
To work with plist data in bytes objects, you can use loads()
and dumps().
Values can be strings, integers, floats, booleans, tuples, lists,
dictionaries (but only with string keys), Data, bytes, bytearray, or
datetime.datetime objects.
Generate Plist example:
import datetime
import plistlib
pl = dict(
aString = "Doodah",
aList = ["A", "B", 12, 32.1, [1, 2, 3]],
aFloat = 0.1,
anInt = 728,
aDict = dict(
anotherString = "",
aThirdString = "M\xe4ssig, Ma\xdf",
aTrueValue = True,
aFalseValue = False,
),
someData = b"",
someMoreData = b"" * 10,
aDate = datetime.datetime.now()
)
print(plistlib.dumps(pl).decode())
Parse Plist example:
import plistlib
plist = b'''
foo
bar
'''
pl = plistlib.loads(plist)
print(pl["foo"])
)InvalidFileExceptionFMT_XML
FMT_BINARYloaddumploadsdumpsUID N)BytesIO) ParserCreate PlistFormatzFMT_XML FMT_BINARY)modulei c @ < e Zd Zdd Zdd Zdd Zdd Zd d
Zd d Zd
S )r c C s< t |ts td|dkrtd|dk rtd|| _d S )Nzdata must be an int zUIDs cannot be >= 2**64r UIDs must be positive)
isinstanceint TypeError
ValueErrordataselfr r //opt/alt/python310/lib64/python3.10/plistlib.py__init__Q s
z UID.__init__c C s | j S N)r r r r r __index__Z s z
UID.__index__c C s d| j jt| jf S )Nz%s(%s)) __class____name__reprr r r r r __repr__] z UID.__repr__c C s | j | jffS r )r r r r r r
__reduce__` zUID.__reduce__c C s t |tstS | j|jkS r )r r NotImplementedr )r otherr r r __eq__c s
z
UID.__eq__c C s
t | jS r )hashr r r r r __hash__h
z UID.__hash__N) r
__module__ __qualname__r r r! r# r' r) r r r r r P s r s
zv[\x00\x01\x02\x03\x04\x05\x06\x07\x08\x0b\x0c\x0e\x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f]L c C sP |d d }g }t dt| |D ]}| ||| }|t| qd|S )N r )rangelenappendbinasciiZ
b2a_base64join)s
maxlinelengthZ
maxbinsizepiecesichunkr r r _encode_base64| s
r; c C s$ t | tr
t| dS t| S )Nutf-8)r strr4 Z
a2b_base64encode)r6 r r r _decode_base64 s
r? z{(?P\d\d\d\d)(?:-(?P\d\d)(?:-(?P\d\d)(?:T(?P\d\d)(?::(?P\d\d)(?::(?P\d\d))?)?)?)?)?Zc C sL d}t | }g }|D ]}|| }|d u r n|t| q
tj| S )NZyearZmonthZdayZhourZminutesecond) _dateParsermatch groupdictr3 r datetime)r6 ZorderZgdZlstkeyvalr r r _date_from_string s
rH c C s d| j | j| j| j| j| jf S )Nz %04d-%02d-%02dT%02d:%02d:%02dZr@ )dr r r _date_to_string s rJ c C sZ t | }|d ur
td| dd} | dd} | dd} | dd} | d d
} | S ) Nz;strings can't contain control characters; use bytes insteadz
&z&z>)_controlCharPatsearchr replace)textmr r r _escape s
rU c @ s e Zd Zdd Zdd Zdd Zdd Zd d
Zd d Zd
d Z dd Z
dd Z dd Z dd Z
dd Zdd Zdd Zd d Zd d Zd!d" Zd#d$ Zd%d& Zd'd( Zd)S )* _PlistParserc C s g | _ d | _d | _|| _d S r )stack current_keyroot
_dict_typer dict_typer r r r
z_PlistParser.__init__c C sB t | _| j| j_| j| j_| j| j_| j| j_ | j
| | j S r ) r parserhandle_begin_elementZStartElementHandlerhandle_end_elementZEndElementHandler handle_dataZCharacterDataHandlerhandle_entity_declZEntityDeclHandlerZ ParseFilerY )r Zfileobjr r r parse s
z_PlistParser.parsec C s t d)Nz8XML entity declarations are not supported in plist files)r )r Z entity_nameZis_parameter_entityvaluebaseZ system_idZ public_idZ
notation_namer r r rb s z _PlistParser.handle_entity_declc C s. g | _ t| d| d }|d ur|| d S d S )NZbegin_)r getattr)r elementattrshandlerr r r r_ s
z!_PlistParser.handle_begin_elementc C s& t | d| d }|d ur| d S d S )NZend_)rf )r rg ri r r r r` s
z _PlistParser.handle_end_elementc C s | j | d S r )r r3 r r r r ra z_PlistParser.handle_datac C s | j d ur$t| jd ti std| jj || jd | j < d | _ d S | js,|| _d S t| jd tg s>td| jj | jd | d S )Nz unexpected element at line %d) rX r rW typer r^ CurrentLineNumberrY r3 r rd r r r
add_object s
z_PlistParser.add_objectc C s d | j}g | _|S )N )r5 r r r r r get_data s z_PlistParser.get_datac C s" | }| | | j| d S r )rZ ro rW r3 )r rh rI r r r
begin_dict s
z_PlistParser.begin_dictc C s* | j rtd| j | jjf | j d S )Nz%missing value for key '%s' at line %d)rX r r^ rm rW popr r r r end_dict s
z_PlistParser.end_dictc C s8 | j s
t| jd ti std| jj | | _ d S )Nrk zunexpected key at line %d)rX r rW rl r r^ rm rq r r r r end_key s
z_PlistParser.end_keyc C s g }| | | j| d S r )ro rW r3 )r rh ar r r begin_array s
z_PlistParser.begin_arrayc C s | j d S r )rW rs r r r r end_array r$ z_PlistParser.end_arrayc C | d d S )NTro r r r r end_true r$ z_PlistParser.end_truec C ry )NFrz r r r r end_false r$ z_PlistParser.end_falsec C sB | }|ds|dr| t|d d S | t| d S )NZ0xZ0X )rq
startswithro r )r rawr r r end_integer
s z_PlistParser.end_integerc C | t| d S r )ro floatrq r r r r end_real r" z_PlistParser.end_realc C s | | d S r )ro rq r r r r
end_string s z_PlistParser.end_stringc C r r )ro r? rq r r r r end_data r" z_PlistParser.end_datac C r r )ro rH rq r r r r end_date r" z_PlistParser.end_dateN)r r+ r, r rc rb r_ r` ra ro rq rr rt ru rw rx r{ r| r r r r r r r r r rV s* rV c @ s8 e Zd ZdddZdd Zdd Zdd
d Zd d
Zd S )_DumbXMLWriterr c C s || _ g | _|| _|| _d S r )filerW
_indent_levelindent)r r indent_levelr r r r r r] z_DumbXMLWriter.__init__c C s, | j | | d| | jd7 _d S )Nz<%s> )rW r3 writelnr r rg r r r
begin_element% s z _DumbXMLWriter.begin_elementc C s | j d8 _ | d| d S )Nr z)r r r r r r end_element* s z_DumbXMLWriter.end_elementNc C s: |d urt |}| d|||f d S | d| d S )Nz <%s>%sz<%s/>)rU r )r rg rd r r r simple_element0 s z _DumbXMLWriter.simple_elementc C sH |r t |tr |d}| j| j| j | j| | jd d S )Nr<
)r r= r> r writer r )r liner r r r 8 s
z_DumbXMLWriter.writeln)r r r )r r+ r, r r r r r r r r r r s
r c @ sB e Zd Z dddZdd Zd
d Zd d
Zdd Zdd ZdS ) _PlistWriterr r TFc C s. |r| t t| ||| || _|| _d S r )r PLISTHEADERr r
_sort_keys _skipkeys)r r r r Z writeHeader sort_keysskipkeysr r r r E s
z_PlistWriter.__init__c C s" | d | | | d d S )Nzz)r write_valuern r r r r O s
z_PlistWriter.writec C s( t |tr
| d| d S |du r| d d S |du r#| d d S t |trEd| kr2dk rAn t|| dd | d S t|t |trT| d
t| d S t |tr`| | d S t |t t
frn| | d S t |t j r~| d t
| d S t |ttfr| | d S td t| )
NstringTtrueFZfalsel r Zintegerz%drealdatezunsupported type: %s)r r= r r
OverflowErrorr r dict
write_dictbytes bytearray write_bytesrE rJ tuplelist write_arrayr rl rn r r r r T s,
z_PlistWriter.write_valuec C sz | d | jd8 _tddt| jdd| j }t||dD ] }|r.| | q%| jd7 _| d d S )Nr r r} r- r s r )
r r maxr2 r rR r; splitr r )r r r7 r r r r r v s
z_PlistWriter.write_bytesc C s |r;| d | jrt| }n| }|D ] \}}t|ts(| jr$qtd| d| | | q|
d d S | d d S )Nr keys must be stringsrF ) r r sorteditemsr r= r r r r r )r rI r rF rd r r r r s
z_PlistWriter.write_dictc C s> |r| d |D ]}| | q | d d S | d d S )Narray)r r r r )r r rd r r r r s
z_PlistWriter.write_arrayN)r r r TF) r r+ r, r r r r r r r r r r r D s
"
r c C s d}|D ]
}| |r dS qtjdftjdftjdffD ]'\}}| |s'q |D ]}||d| }| d t| |krC dS q)q dS )N)s r2 )headerprefixesZpfxZbomencodingstartprefixr r r _is_fmt_xml s$
r c @ s e Zd ZdddZdS )r Invalid filec C s t | | d S r )r r )r messager r r r rj z InvalidFileException.__init__N)r )r r+ r, r r r r r r s r BHLQ)r r. c @ sH e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd d
Z dd Z
dS )_BinaryPlistParsera
Read or write a binary plist file, following the description of the binary
format. Raise InvalidFileException in case of error, otherwise return the
root object.
see also: http://opensource.apple.com/source/CF/CF-744.18/CFBinaryPList.c
c C s
|| _ d S r )rZ r[ r r r r r* z_BinaryPlistParser.__init__c C s z?|| _ | j dtj | j d}t|dkrt td|\}| _ }}}| j | |
||| _ t g| | _
| |W S tttjttfyO t w )Ni z>6xBBQQQ)_fpseekosSEEK_ENDreadr2 r structunpack _ref_size
_read_ints_object_offsets
_undefined_objects _read_objectOSError
IndexErrorerrorr r )r fptrailer offset_size num_objects
top_objectoffset_table_offsetr r r rc s&
z_BinaryPlistParser.parsec C sL |dkr$| j dd d@ }d|> }dt| }t|| j |d S |S )z$ return the size of the next object. r r r/ rO )r r _BINARY_FORMATr r )r tokenLrT r6 fr r r _get_size s z _BinaryPlistParser._get_sizec C s\ t |t}| j|} t||krt||kr|S t ||| }|| j|7 }||7 }q r )min_MIN_READ_BUF_SIZEr r r2 r )r sizeZcursizer Zdeltar r r _read s
z_BinaryPlistParser._readc s^ | | tv rtd| t S s t t fddtd| D S )NrO c 3 s( | ]}t || d V qdS )bigN)r
from_bytes).0r9 r r r r s z0_BinaryPlistParser._read_ints..r )r r r r r r r1 )r nr r r r r s z _BinaryPlistParser._read_intsc C s | || jS r )r r )r r r r r
_read_refs r$ z _BinaryPlistParser._read_refsc s j | }|tur |S j| } j| jdd }|d@ |d@ }}|dkr/d}n |dkr7d}n|dkr?d }n|dkrGd
}n|d kr\tj jd|> d |d
kd}n|dkrmt d jdd }n|dkr~t d jdd }n|dkrt d jdd }t
dddt
j |d }n|dkr |}
|}n|dkr |}
|} | d}n|dkrՈ |d }
|} | d }ny|d krtt jd| d }nf|d kr |} |}
g }| j |< | fd d |
D nC|d!krK |} |} |}
}| j |< zt| |
D ]\} }
|
| | < q.W n tyJ t w t | j |< |S )"zx
read the object by reference.
May recursively read sub-objects (content of an array/dict/set)
r r r Nr F Tr0 r} r r/ Zsigned" z>fr. # z>d3 )Zseconds@ P r ` r utf-16be c 3 s | ]} |V qd S r )r )r xr r r r X s z2_BinaryPlistParser._read_object.. )r r r r r r r r r r rE Z timedeltar r r r r extendrZ zipr r r )r refresultoffsettokenZtokenHr r r6 r Zobj_refsZkey_refskor r r r s~
z _BinaryPlistParser._read_objectN) r r+ r, __doc__r rc r r r r r r r r r r s
r c C s( | dk rdS | dk r dS | dk rdS dS )N r r r. r r )countr r r _count_to_sizeq s r c @ r )_BinaryPlistWriterc C s || _ || _|| _d S r )r r r )r r r r r r r r s
z_BinaryPlistWriter.__init__c
C s g | _ i | _i | _| | t| j }dg| | _t|| _t| j | _ | j
d | j D ]}| | q-|
|}| j
}t|}dt| | }| j
tj|g| jR d}||| j|||f} | j
tjdg| R d S )Nr bplist00rO z >5xBBBQQQ)_objlist _objtable _objidtable_flattenr2 r r r r _ref_formatr r
_write_object
_getrefnumtellr pack)
r rd r objr r r Z
offset_formatZ sort_versionr r r r r s*
z_BinaryPlistWriter.writec C s$ t |trt||f| jv rd S n t|| jv rd S t| j}| j| t |tr4|| jt||f< n|| jt|< t |t r}g }g }|
}| j rOt |}|D ]\}}t |t
sb| jr^qQtd|| || qQt||D ]}| | qsd S t |ttfr|D ] }| | qd S d S )Nr )r _scalarsrl r
idr r2 r r3 r r r r r= r r itertoolschainr r r ) r rd Zrefnumkeysvaluesr r vr r r r r s@
z_BinaryPlistWriter._flattenc C s* t |tr| jt||f S | jt| S r )r r r
rl r r rn r r r r s
z _BinaryPlistWriter._getrefnumc C s |dk r| j td||B d S |dk r&| j td|dB d| d S |dk r:| j td|dB d| d S |d k rN| j td
|dB d | d S | j td |dB d
| d S )Nr z>Br z>BBBr} r z>BBH r z>BBL z>BBQ )r r r r )r r r r r r _write_size s z _BinaryPlistWriter._write_sizec sj |} j j|< |d u r jd d S |du r% jd d S |du r1 jd d S t|tr|dk rVz jtdd| W d S tj yU t
|d w |d k rg jtd
d | d S |d k rx jtd
d| d S |dk r jtdd| d S |dk r jtdd| d S |dk r jd|j d ddd d S t
|t|t rĈ jtdd| d S t|t
j
r|t
ddd } jtdd | d S t|ttfr d t| j| d S t|tr0z|d } d t| W n ty' |d } d!t|d" Y nw j| d S t|tr|jdk r@td#|jd k rS jtd
d$| d S |jd k rf jtd
d%| d S |jdk ry jtdd&| d S |jdk r jtdd'| d S t
|t|ttfr fd(d)|D }t|} d*| jtjd+ j| g|R d S t|t r1g g }} j rt | } n| } | D ]%\}
} t|
ts j rqt!d,|" |
|" | qt|} d-| jtjd+ j| g|R jtjd+ j| g|R d S t!|).N F Tr r z>Bqr r z>BBr} r z>BHr r z>BLr l z>BQr r r z>Bdr r r r r r r r r r r r c s g | ]} |qS r )r )r r r r r
6 s z4_BinaryPlistWriter._write_object..r rO r r )#r r r r r r r r r r r to_bytesr rE Z
total_secondsr r r r2 r= r> UnicodeEncodeErrorr r r r r r r r r r r r r3 ) r rd r r tZrefsr6 ZkeyRefsZvalRefsZ rootItemsr r r r r r s
(
$(z _BinaryPlistWriter._write_objectN) r r+ r, r r r r r r r r r r r
s -* r
c C s | d d dkS )Nr r r )r r r r _is_fmt_binaryT rj r+ )detectr^ writerfmtr\ c C sj |du r%| d}| d t D ]}|d |r |d } nqt nt| d }||d}|| S )zRead a .plist file. 'fp' should be a readable and binary file object.
Return the unpacked root object (which usually is a dictionary).
Nr r r, r^ )r\ )r r _FORMATSr r rc )r r/ r\ r infoPpr r r r j s
r c C s t | }t|||dS )zqRead a .plist file from a bytes object.
Return the unpacked root object (which usually is a dictionary).
r. )r
r )rd r/ r\ r r r r r s r TF)r/ r r c C s: |t vr td|f t | d |||d}|| dS )zWWrite 'value' to a .plist file. 'fp' should be a writable,
binary file object.
zUnsupported format: %rr- )r r N)r0 r r )rd r r/ r r r- r r r r s r r/ r r c C s t }t| ||||d | S )z?Return a bytes object with the contents for a .plist file.
r4 )r
r getvalue)rd r/ r r r r r r r s r )r- ):r __all__r4 r rE enumior
r r rer Zxml.parsers.expatr Enumr r globalsupdate __members__r r r compilerP r; r? ASCIIrB rH rJ rU rV r r r r r r objectr r r r= r r r r r
r+ r r r r0 r r r r r r r r sn 8 !
n&^! '
U