+
icV c s ^ RI t ^ RIt^ RI Ht ^ RIHt ^ RIHt ^ RIHt ^ RI H
t
H t ^ RI H
t
HtHtHt ^ RIHt . ROtR
tR tR tR
tR tR t ! R R ]4 tRR lt R t R t ! R R]4 t R# )i N) Parameter)get_type_hints)
get_dbus_name)Signal)DBusSpecificationErrorDBusSpecification)
get_dbus_type is_base_typeget_type_argumentsTuple) XMLGenerator dbus_signalZ __dbus_xml__Z*__dbus_method_returns_multiple_arguments__Z-__dbus_handler_accepts_additional_arguments__c ( \ V \ R4 V # )aP Decorator for returning multiple arguments from a DBus method.
The decorator allows to generate multiple output arguments in the
XML specification of the decorated DBus method. Otherwise, there
will be only one output argument in the specification.
Define a DBus method with multiple output arguments:
.. code-block:: python
@returns_multiple_arguments
def Method(self) -> Tuple[Int, Bool]:
return 0, False
The generated XML specification of the example:
.. code-block:: xml
If the XML specification is not generated by the dbus_interface
decorator, the returns_multiple_arguments decorator has no effect.
:param method: a DBus method
:return: a DBus method with a flag
T)setattr$RETURNS_MULTIPLE_ARGUMENTS_ATTRIBUTEmethod & F:DA Mr c s$ \ V \ R4 # )zmDoes the given DBus method accept additional arguments?
:param method: a DBus method
:return: True or False
F)getattrr r r r "are_additional_arguments_supportedr s 6A5 IIr c sD a ] tR t^t o RtR]3R ltR tR tR t Rt
V t R# )r a DBus signal.
Can be used as:
.. code-block:: python
Signal = dbus_signal()
Or as a method decorator:
.. code-block:: python
@dbus_signal
def Signal(x: Int, y: Double):
pass
Signal is defined by the type hints of a decorated method.
This method is accessible as: signal.definition
If the signal is not defined by a method, it is expected to
have no arguments and signal.definition is equal to None.
Nc s, Wn W n RV n R# )zsCreate a signal descriptor.
:param definition: a definition of the emit function
:param factory: a signal factory
N
definitionfactoryname)selfr r &&&r __init__Zdbus_signal.__init__ s % r c s V P e R# RP \ V 4 P P 4 VP 4 4 V n R# )a Set a name of the descriptor
The descriptor has been assigned to the specified name.
Generate a name of a private attribute that will be set
to a signal in the ``__get__`` method.
For example: ``__dbus_signal_my_name``
:param owner: the owning class
:param name: the descriptor name
Nz__{}_{})r formatZtype__name__Zlower)r ownerr r r __set_name__Zdbus_signal.__set_name__ sB 99 $$ J % % ' JJL
r c s Vf V # \ WP R4 pVf' V P 4 p\ WP V4 V# )aE Get a value of the descriptor.
If the descriptor is accessed as a class attribute,
return the descriptor.
If the descriptor is accessed as an instance attribute,
return a signal created by the signal factory.
:param instance: an instance of the owning class
:param owner: an owning class
:return: a value of the attribute
N)r r r r
)r instancer" Zsignals &&& r __get__Zdbus_signal.__get__ sB K99d3 >\\^F Hii 0
r c s \ R4 h)z Set a value of the descriptor.zCan't set DBus signal.)ZAttributeError)r r$ Zvaluer r __set__Zdbus_signal.__set__ s 566r r ) r!
__module__ __qualname____firstlineno____doc__r r r# r% r& __static_attributes____classdictcell__Z
__classdict__ @r r r s* , #'
(07 7r c s a a V V3R lpV# )a DBus interface.
A new DBus interface can be defined as:
.. code-block:: python
@dbus_interface
class Interface():
...
The interface will be generated from the given class cls
with a name interface_name and added to the DBus XML
specification of the class.
The XML specification is accessible as:
.. code-block:: python
Interface.__dbus_xml__
It is conventional for member names on DBus to consist
of capitalized words with no punctuation. The generator
of the XML specification enforces this convention to
prevent unintended changes in the specification. You can
provide the XML specification yourself, or override the
generator class to work around these constraints.
:param interface_name: a DBus name of the interface
:param namespace: a sequence of strings
c sp < \ . SOSN5! p\ P W4 p\ V \ V4 V # N)r DBusSpecificationGeneratorgenerate_specificationr
DBUS_XML_ATTRIBUTE)clsr xmlinterface_name namespaces & r decoratedZ!dbus_interface..decorated s7 8i8 8(??J'-
r )r5 r6 r7 s ff r dbus_interfacer9 s < r c sR \ P V 4 p\ V \ V4 V # )ax DBus class.
A new DBus class can be defined as:
.. code-block:: python
@dbus_class
class Class(Interface):
...
DBus class can implement DBus interfaces, but it cannot
define a new interface.
The DBus XML specification will be generated from
implemented interfaces (inherited) and it will be
accessible as:
.. code-block:: python
Class.__dbus_xml__
)r0 r1 r
r2 )r3 r4 & r
dbus_classr; s& . %
;
;C
@C C#S) Jr c sl \ V \ R4 pVf \ RP \ 4 4 hV# )zReturn XML specification of an object.
:param obj: an object decorated with @dbus_interface or @dbus_class
:return: a string with XML specification
Nz)XML specification is not defined at '{}'.)r r2 r r )ZobjZxml_specificationr: r get_xmlr< s@ %7> $ 7 > >"
r c sP a ] tR tRt o Rt]t]P ! R4 t ]
RR l4 t ]
R 4 t ]
R 4 t
]
R 4 t]
R 4 t]
R
4 t]
R 4 t]
R 4 t]
R
4 t]
R 4 t]
R 4 t]
R 4 t]
R 4 t]
R 4 t]
R 4 t]
R 4 tRtV t R# )r0 i/ z,Class for generating DBus XML specification.z[A-Z][A-Za-z0-9]*Nc s V P V4 pV' d9 V P 4 pVP V4 V P VVV4 pWSV& V P W4 pV P
P
V4 # )a Generates DBus XML specification for given class.
If class defines a new interface, it will be added to
the specification.
:param interface_cls: class object to decorate
:param str interface_name: name of the interface defined by class
:return str: DBus specification in XML
)_collect_interfaces _collect_standard_interfacesupdate_generate_interface_generate_node
xml_generatorZelement_to_xml)r3
interface_clsr5
interfacesZall_interfaces interfacenode &&& r r1 Z1DBusSpecificationGenerator.generate_specification8 s ,,];
= = ?N ! !* -// I
*3~ & !!-< //55r c s V P P \ P 4 pV P P V4 # )z|Collect standard interfaces.
Standard interfaces are implemented by default.
:return: a dictionary of standard interfaces
)rB xml_to_elementr ZSTANDARD_INTERFACESget_interfaces_from_node)r3 rF r: r r> Z7DBusSpecificationGenerator._collect_standard_interfacesU s< // 1 1
99$??r c s / p\ \ P ! V4 4 Fe p\ V\ R4 pV' g K V P
P
V4 pV P
P V4 pVP V4 Kg V# )zCollect interfaces implemented by the class.
Returns a dictionary that maps interface names
to interface elements.
:param interface_cls: a class object
:return: a dictionary of implemented interfaces
N) ZreversedinspectZgetmror r2 rB rH rI r? )r3 rC rD memberZ
member_xmlrF Znode_interfacess && r r= Z.DBusSpecificationGenerator._collect_interfacesb s|
w~~m <=F );TBJ $$33J?D ! / / H H NO o . > r c s> V P P V4 p\ P ! V4 F w rVV P V4 ' g K V P W%4 ' d K7 V P
V4 ' d V P We4 pMlV P V4 ' d V P We4 pMCV P V4 ' d V P We4 pM\ RP V4 4 hV P P WG4 K V# )a@ Generate interface defined by given class.
:param interface_cls: a class object that defines the interface
:param interfaces: a dictionary of implemented interfaces
:param interface_name: a name of the new interface
:return: a new interface element
:raises DBusSpecificationError: if a class member cannot be exported
z+Unsupported definition of DBus member '{}'.)rB Zcreate_interfacerJ Z
getmembers_is_exportable _is_defined
_is_signal_generate_signal _is_property_generate_property
_is_method_generate_methodr r add_child)r3 rC rD r5 rE member_namerK elements &&&& r r@ Z.DBusSpecificationGenerator._generate_interface| s %%66~F $+#5#5m#D K%%k22 z77 ~~f%% ..vC!!&)) 00E '' ..vC,AHH#
' ' ;1 $E4 r c sJ \ V P P V4 4 # )zIs the name of a class member exportable?
The name is exportable if it follows the DBus specification.
Only CamelCase names are allowed.
)Zbool NAME_PATTERNZ fullmatch)r3 rU &&r rL Z)DBusSpecificationGenerator._is_exportable s C$$..{;<""N*-*A*A&*I &DY - ; ;;, "F; / *77I)):: i(I
' ' ;! +J$ r c # s " \ P ! V4 pV P W4 Rj xL
V P W4 Rj xL
R# L L5i)zIterate over method parameters.
For every parameter returns its name, a type hint and a direction.
:param member: a method object
:return: an iterator
raises DBusSpecificationError: if parameters are invalid
N)rJ signature_iterate_in_parameters_iterate_out_parameters)r3 rK rd s && r r] Z.DBusSpecificationGenerator._iterate_parameters sH %%f- --f@@@..vAAA AAs! +AA
AAAAc # s " \ P p\ V4 p\ VP 4 R, F pVP V, P
pV\ P \ P 39 d \ V4 ' d KX V\ P 8w d \ R4 hWT9 d \ RP V4 4 hWTV, V3x K R# 5i)z Iterate over input parameters.:i NNz1Only positional or keyword arguments are allowed.z!Undefined type of parameter '{}'.N)
r Z DIRECTION_INr ZlistZ
parameterskindr Z VAR_KEYWORDZ KEYWORD_ONLYr ZPOSITIONAL_OR_KEYWORDr r )r3 rK rd ra Z
type_hintsr rg rG r re Z1DBusSpecificationGenerator._iterate_in_parameters s &22 #F+
--.r22D ''-22D --y/E/EFF:6BBy666,G
%,7>>tD 4()3 3+ 3s C#C%c # s " \ P p\ P pVP pWRP J d R# Vf R# \ V\ R4 ' ds \ V\ 4 ' g \ R4 h\ V4 p\ V4 ^8 d \ R4 h\ V4 F w rxRP W74 W3x K R# W5V3x R# 5i)z Iterate over output parameters.NFz'Expected a tuple of multiple arguments.z+Expected a tuple of more than one argument.z{}_{})r ZRETURN_PARAMETERr^ Zreturn_annotationZemptyr r r r r r ZlenZ enumerater ) r3 rK rd r ra r` Z type_argsZiZtype_argrc r rf Z2DBusSpecificationGenerator._iterate_out_parameters s !11%33 // ' 6? G G 511,=
+95I9~!,A
) 3 nnT-xBB 4
y((s CCc rZ )z$Is the class member a DBus property?)r[ Zpropertyr\ rX r rP Z'DBusSpecificationGenerator._is_propertyC s &(++r c sX RpRp VP ' d1 V P VP 4 w w rTp\ P pVP ' d1 V P VP 4 w w rTp\ P
pTP ' d# TP ' d \ P pTf \ RP T4 4 hT P P T\ T4 T4 # \ d \ RP T4 4 Rhi ; i)zGenerate DBus property defined by class member.
:param member: a property object
:param member_name: a property name
:return: a property element
raises DBusSpecificationError: if the property is invalid
Nz%Undefined type of DBus property '{}'.z%DBus property '{}' is not accessible.)
Zfsetr] r Z ACCESS_WRITEZfgetZ ACCESS_READZ
ValueErrorr r ZACCESS_READWRITErB Zcreate_propertyr )r3 rK rU Zaccessr` Z_s &&& r rQ Z-DBusSpecificationGenerator._generate_propertyH s {{{&)&=&=fkk&J#"!*77 {{{&)&=&=fkk&J#"!*66 ;;;6;;;&77F >(7>>{K
00 ) $
(7>>{K
s D AD 0D 'D)c sj \ P ! V4 ;' g \ P ! V4 # )a Is the class member a DBus method?
Ignore the difference between instance method and class method.
For example:
.. code-block:: python
class Foo(object):
def bar(cls, x):
pass
inspect.isfunction(Foo.bar) # True
inspect.isfunction(Foo().bar) # False
inspect.ismethod(Foo.bar) # False
inspect.ismethod(Foo().bar) # True
_is_method(Foo.bar) # True
_is_method(Foo().bar) # True
)rJ ZismethodZ
isfunctionr\ rX r rR Z%DBusSpecificationGenerator._is_methodt s( 0 'EE7+=+=f+EEr c s V P P V4 pV P V4 FG w rEpV P P V\ V4 V4 pV P P W74 KI V# )zGenerate method defined by given class member.
:param member: a method object
:param member_name: a name of the method
:return: a method element
)rB Z
create_methodr] r_ r rT )r3 rK rU r r r` ra rb s &&& r rS Z+DBusSpecificationGenerator._generate_method sv ""00= +.*A*A&*I &DY))::mI. I
' ' :
+J
r c s( V P P 4 pV P P VRP VP 4 4 \ VP
4 4 F% pV P P W2V, 4 K' V# )zGenerate node element that specifies the given class.
:param interface_cls: a class object
:param interfaces: a dictionary of interfaces
:return: a node element
z Specifies {})rB Z create_nodeZ add_commentr r! ZsortedZkeysrT )r3 rC rD rF r5 rY r rA Z)DBusSpecificationGenerator._generate_node s| ,,. %% .''
(>(>?
%Z__%6 7N ' ' .H I 8 r r8 r/ ) r! r' r( r) r* r
rB reZcompilerW Z classmethodr1 r> r= r@ rL rM rN rO r] re rf rP rQ rR rS rA r+ r, r- r. r r0 r0 / sh 6 !M :: 23L6 68
@
@ 2 ' 'R = = ( / / ! !F B B 4 4< %) %)N , , )
)
V F F2 ( r r0 )r; r9 r r< r r )r8 ) rJ rh r Ztypingr Zdasbus.namespacer Z
dasbus.signalr Zdasbus.specificationr r Z
dasbus.typingr r r r Z
dasbus.xmlr
Z__all__r2 r r r r r Zobjectr r9 r; r< r0 r8 r r ri s 0 ! * J
# $ 1 %
4 ' D FJO7& O7d$N8 $G Gr