3
u1Wɭ @ sZ d Z ddlmZ ddlmZ ddlmZ ddlmZ ddlZddlZddlm Z ddlm
Z
dd lm Z dd
l m
Z
dd lmZ dd lmZ dd
lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ G dd de Z G dd de Z G dd d e Z G d d d e Z G d d d e
e Z!dS )!z
pyudev.device._device
=====================
Device class implementation of :mod:`pyudev`.
.. moduleauthor:: Sebastian Wiesner
)absolute_import)division)print_function)unicode_literalsN) Container)Iterable)Mapping) timedelta)DeviceNotFoundAtPathError)DeviceNotFoundByFileError)#DeviceNotFoundByInterfaceIndexError)!DeviceNotFoundByKernelDeviceError)DeviceNotFoundByNameError)DeviceNotFoundByNumberError) DeviceNotFoundInEnvironmentError)ensure_byte_string)ensure_unicode_string)get_device_type)string_to_bool)udev_list_iteratec @ s| e Zd ZdZedd Zedd Zedd Zedd Zed
d Z ed d
Z
edd Z edd Z edd Z
dS )DeviceszT
Class for constructing :class:`Device` objects from various kinds of data.
c C s0 |j |js$tjj|j|jtj}| j||S )a
Create a device from a device ``path``. The ``path`` may or may not
start with the ``sysfs`` mount point:
>>> from pyudev import Context, Device
>>> context = Context()
>>> Devices.from_path(context, '/devices/platform')
Device(u'/sys/devices/platform')
>>> Devices.from_path(context, '/sys/devices/platform')
Device(u'/sys/devices/platform')
``context`` is the :class:`Context` in which to search the device.
``path`` is a device path as unicode or byte string.
Return a :class:`Device` object for the device. Raise
:exc:`DeviceNotFoundAtPathError`, if no device was found for ``path``.
.. versionadded:: 0.18
)
startswithsys_pathospathjoinlstripsep
from_sys_path)clscontextr r! /usr/lib/python3.6/_device.py from_path< s zDevices.from_pathc C s( |j j|t|}|s t|t||S )a
Create a new device from a given ``sys_path``:
>>> from pyudev import Context, Device
>>> context = Context()
>>> Devices.from_sys_path(context, '/sys/devices/platform')
Device(u'/sys/devices/platform')
``context`` is the :class:`Context` in which to search the device.
``sys_path`` is a unicode or byte string containing the path of the
device inside ``sysfs`` with the mount point included.
Return a :class:`Device` object for the device. Raise
:exc:`DeviceNotFoundAtPathError`, if no device was found for
``sys_path``.
.. versionadded:: 0.18
)_libudevZ udev_device_new_from_syspathr r
Device)r r r devicer! r! r" r U s
zDevices.from_sys_pathc C s< |j dd}|jj|t|t|}|s2t||t||S )a.
Create a new device from a given ``subsystem`` and a given
``sys_name``:
>>> from pyudev import Context, Device
>>> context = Context()
>>> sda = Devices.from_name(context, 'block', 'sda')
>>> sda
Device(u'/sys/devices/pci0000:00/0000:00:1f.2/host0/target0:0:0/0:0:0:0/block/sda')
>>> sda == Devices.from_path(context, '/block/sda')
``context`` is the :class:`Context` in which to search the device.
``subsystem`` and ``sys_name`` are byte or unicode strings, which
denote the subsystem and the name of the device to create.
Return a :class:`Device` object for the device. Raise
:exc:`DeviceNotFoundByNameError`, if no device was found with the given
name.
.. versionadded:: 0.18
/!)replacer$ Z&udev_device_new_from_subsystem_sysnamer r r% )r r subsystemsys_namer& r! r! r" from_nameo s
zDevices.from_namec C s0 |j j|t|d |}|s&t||t||S )a
Create a new device from a device ``number`` with the given device
``type``:
>>> import os
>>> from pyudev import Context, Device
>>> ctx = Context()
>>> major, minor = 8, 0
>>> device = Devices.from_device_number(context, 'block',
... os.makedev(major, minor))
>>> device
Device(u'/sys/devices/pci0000:00/0000:00:11.0/host0/target0:0:0/0:0:0:0/block/sda')
>>> os.major(device.device_number), os.minor(device.device_number)
(8, 0)
Use :func:`os.makedev` to construct a device number from a major and a
minor device number, as shown in the example above.
.. warning::
Device numbers are not unique across different device types.
Passing a correct number with a wrong type may silently yield a
wrong device object, so make sure to pass the correct device type.
``context`` is the :class:`Context`, in which to search the device.
``type`` is either ``'char'`` or ``'block'``, according to whether the
device is a character or block device. ``number`` is the device number
as integer.
Return a :class:`Device` object for the device with the given device
``number``. Raise :exc:`DeviceNotFoundByNumberError`, if no device was
found with the given device type and number.
.. versionadded:: 0.18
r )r$ Zudev_device_new_from_devnumr r r% )r r typnumberr& r! r! r" from_device_number s
%
zDevices.from_device_numberc C sV yt |}tj|j}W n. ttfk
rF } zt|W Y dd}~X nX | j|||S )a
Create a new device from the given device file:
>>> from pyudev import Context, Device
>>> context = Context()
>>> device = Devices.from_device_file(context, '/dev/sda')
>>> device
Device(u'/sys/devices/pci0000:00/0000:00:0d.0/host2/target2:0:0/2:0:0:0/block/sda')
>>> device.device_node
u'/dev/sda'
.. warning::
Though the example seems to suggest that ``device.device_node ==
filename`` holds with ``device = Devices.from_device_file(context,
filename)``, this is only true in a majority of cases. There *can*
be devices, for which this relation is actually false! Thus, do
*not* expect :attr:`~Device.device_node` to be equal to the given
``filename`` for the returned :class:`Device`. Especially, use
:attr:`~Device.device_node` if you need the device file of a
:class:`Device` created with this method afterwards.
``context`` is the :class:`Context` in which to search the device.
``filename`` is a string containing the path of a device file.
Return a :class:`Device` representing the given device file. Raise
:exc:`DeviceNotFoundByFileError` if ``filename`` is no device file
at all or if ``filename`` does not exist or if its metadata was
inaccessible.
.. versionadded:: 0.18
N)r r statst_rdevEnvironmentError
ValueErrorr r/ )r r filename device_type
device_numbererrr! r! r" from_device_file s "zDevices.from_device_filec s< |j dd}t fdd|D d}|dk r0|S t dS )a?
Locate a device based on the interface index.
:param `Context` context: the libudev context
:param int ifindex: the interface index
:returns: the device corresponding to the interface index
:rtype: `Device`
This method is only appropriate for network devices.
Znet)r* c 3 s" | ]}|j jd kr|V qdS )ifindexN)
attributesget).0d)r9 r! r" s z/Devices.from_interface_index..N) list_devicesnextr )r r r9 Znetwork_devicesZdevr! )r9 r" from_interface_index s z Devices.from_interface_indexc C s |d }|dd }|d krlt jd}|j|}|rbtjt|jdt|jd}| j|||S t|nT|d kr| j ||S |d
kr|j
d \}} }
|
r|r| j |||
S t|nt|dS )
a
Locate a device based on the kernel device.
:param `Context` context: the libudev context
:param str kernel_device: the kernel device
:returns: the device corresponding to ``kernel_device``
:rtype: `Device`
r Nbcz ^(?P\d+):(?P\d+)$majorminorn+:)rC rD ) recompilematchr makedevintgroupr/ r
rA partitionr, ) r r Z
kernel_deviceZ switch_charrestZ number_rerL r. r* _Zkernel_device_namer! r! r" from_kernel_device s&
zDevices.from_kernel_devicec C s |j j|}|st t||S )a
Create a new device from the process environment (as in
:data:`os.environ`).
This only works reliable, if the current process is called from an
udev rule, and is usually used for tools executed from ``IMPORT=``
rules. Use this method to create device objects in Python scripts
called from udev rules.
``context`` is the library :class:`Context`.
Return a :class:`Device` object constructed from the environment.
Raise :exc:`DeviceNotFoundInEnvironmentError`, if no device could be
created from the environment.
.. udevversion:: 152
.. versionadded:: 0.18
)r$ Z udev_device_new_from_environmentr r% )r r r& r! r! r" from_environment s zDevices.from_environmentc C s | j | j| j| j| jgS )z
Return methods that obtain a :class:`Device` from a variety of
different data.
:return: a list of from_* methods.
:rtype: list of class methods
.. versionadded:: 0.18
)r8 r/ r, r# r )r r! r! r" METHODS9 s
zDevices.METHODSN)__name__
__module__ __qualname____doc__ classmethodr# r r, r/ r8 rA rS rT rU r! r! r! r" r 7 s + + # r c @ s e Zd ZdZedd Zedd Zedd Zedd Zed
d Z ed d
Z
dd Z dd Z dd Z
edd Zedd Zedd ZdYdd Zd d Zed d Zed!d" Zed#d$ Zed%d& Zed'd( Zed)d* Zed+d, Zed-d. Zed/d0 Z ed1d2 Z ed3d4 Z ed5d6 Z ed7d8 Z ed9d: Z!ed;d< Z"ed=d> Z#ed?d@ Z$dAdB Z%dCdD Z&dEdF Z'dGdH Z(dIdJ Z)dKdL Z*dMdN Z+dOdP Z,dQdR Z-dSdT Z.dUdV Z/dWdX Z0dS )Zr% a
A single device with attached attributes and properties.
This class subclasses the ``Mapping`` ABC, providing a read-only
dictionary mapping property names to the corresponding values.
Therefore all well-known dicitionary methods and operators
(e.g. ``.keys()``, ``.items()``, ``in``) are available to access device
properties.
Aside of the properties, a device also has a set of udev-specific
attributes like the path inside ``sysfs``.
:class:`Device` objects compare equal and unequal to other devices and
to strings (based on :attr:`device_path`). However, there is no
ordering on :class:`Device` objects, and the corresponding operators
``>``, ``<``, ``<=`` and ``>=`` raise :exc:`~exceptions.TypeError`.
.. warning::
**Never** use object identity (``is`` operator) to compare
:class:`Device` objects. :mod:`pyudev` may create multiple
:class:`Device` objects for the same device. Instead compare
devices by value using ``==`` or ``!=``.
:class:`Device` objects are hashable and can therefore be used as keys
in dictionaries and sets.
They can also be given directly as ``udev_device *`` to functions wrapped
through :mod:`ctypes`.
c C s$ ddl }|jdtdd tj||S )zw
.. versionadded:: 0.4
.. deprecated:: 0.18
Use :class:`Devices.from_path` instead.
r Nz>Will be removed in 1.0. Use equivalent Devices method instead. )
stacklevel)warningswarnDeprecationWarningr r# )r r r r] r! r! r" r# n s zDevice.from_pathc C s$ ddl }|jdtdd tj||S )a|
.. versionchanged:: 0.4
Raise :exc:`NoSuchDeviceError` instead of returning ``None``, if
no device was found for ``sys_path``.
.. versionchanged:: 0.5
Raise :exc:`DeviceNotFoundAtPathError` instead of
:exc:`NoSuchDeviceError`.
.. deprecated:: 0.18
Use :class:`Devices.from_sys_path` instead.
r Nz>Will be removed in 1.0. Use equivalent Devices method instead.r[ )r\ )r] r^ r_ r r )r r r r] r! r! r" r } s zDevice.from_sys_pathc C s& ddl }|jdtdd tj|||S )zw
.. versionadded:: 0.5
.. deprecated:: 0.18
Use :class:`Devices.from_name` instead.
r Nz>Will be removed in 1.0. Use equivalent Devices method instead.r[ )r\ )r] r^ r_ r r, )r r r* r+ r] r! r! r" r, s zDevice.from_namec C s& ddl }|jdtdd tj|||S )z
.. versionadded:: 0.11
.. deprecated:: 0.18
Use :class:`Devices.from_device_number` instead.
r Nz>Will be removed in 1.0. Use equivalent Devices method instead.r[ )r\ )r] r^ r_ r r/ )r r r- r. r] r! r! r" r/ s zDevice.from_device_numberc C s$ ddl }|jdtdd tj||S )z
.. versionadded:: 0.15
.. deprecated:: 0.18
Use :class:`Devices.from_device_file` instead.
r Nz>Will be removed in 1.0. Use equivalent Devices method instead.r[ )r\ )r] r^ r_ r r8 )r r r4 r] r! r! r" r8 s zDevice.from_device_filec C s" ddl }|jdtdd tj|S )z~
.. versionadded:: 0.6
.. deprecated:: 0.18
Use :class:`Devices.from_environment` instead.
r Nz>Will be removed in 1.0. Use equivalent Devices method instead.r[ )r\ )r] r^ r_ r rT )r r r] r! r! r" rT s zDevice.from_environmentc C s || _ || _|j| _d S )N)r Z_as_parameter_r$ )selfr Z_devicer! r! r" __init__ s zDevice.__init__c C s | j j| d S )N)r$ Zudev_device_unref)r` r! r! r" __del__ s zDevice.__del__c C s
dj | S )NzDevice({0.sys_path!r}))format)r` r! r! r" __repr__ s zDevice.__repr__c C s( | j j| }|sdS t| j| j j|S )z_
The parent :class:`Device` or ``None``, if there is no parent
device.
N)r$ Zudev_device_get_parentr% r udev_device_ref)r` parentr! r! r" rf s z
Device.parentc c s, x&| j j j| D ]}|| kr|V qW dS )a
Yield all direct children of this device.
.. note::
In udev, parent-child relationships are generally ambiguous, i.e.
a parent can have multiple children, *and* a child can have multiple
parents. Hence, `child.parent == parent` does generally *not* hold
for all `child` objects in `parent.children`. In other words,
the :attr:`parent` of a device in this property can be different
from this device!
.. note::
As the underlying library does not provide any means to directly
query the children of a device, this property performs a linear
search through all devices.
Return an iterable yielding a :class:`Device` object for each direct
child of this device.
.. udevversion:: 172
.. versionchanged:: 0.13
Requires udev version 172 now.
N)r r? Z match_parent)r` r& r! r! r" children s zDevice.childrenc c s$ | j }x|dk r |V |j }qW dS )z
Yield all ancestors of this device from bottom to top.
Return an iterator yielding a :class:`Device` object for each
ancestor of this device from bottom to top.
.. versionadded:: 0.16
N)rf )r` rf r! r! r" ancestors s
zDevice.ancestorsNc C sD t |}|dk rt |}| jj| ||}|s0dS t| j| jj|S )a
Find the parent device with the given ``subsystem`` and
``device_type``.
``subsystem`` is a byte or unicode string containing the name of the
subsystem, in which to search for the parent. ``device_type`` is a
byte or unicode string holding the expected device type of the parent.
It can be ``None`` (the default), which means, that no specific device
type is expected.
Return a parent :class:`Device` within the given ``subsystem`` and, if
``device_type`` is not ``None``, with the given ``device_type``, or
``None``, if this device has no parent device matching these
constraints.
.. versionadded:: 0.9
N)r r$ Z-udev_device_get_parent_with_subsystem_devtyper% r re )r` r* r5 rf r! r! r" find_parent s
zDevice.find_parentc C s ddl }|jdtdd | jS )a~
Traverse all parent devices of this device from bottom to top.
Return an iterable yielding all parent devices as :class:`Device`
objects, *not* including the current device. The last yielded
:class:`Device` is the top of the device hierarchy.
.. deprecated:: 0.16
Will be removed in 1.0. Use :attr:`ancestors` instead.
r Nz5Will be removed in 1.0. Use Device.ancestors instead.r[ )r\ )r] r^ r_ rh )r` r] r! r! r" traverse0 s zDevice.traversec C s t | jj| S )zz
Absolute path of this device in ``sysfs`` including the ``sysfs``
mount point as unicode string.
)r r$ Zudev_device_get_syspath)r` r! r! r" r C s zDevice.sys_pathc C s t | jj| S )a
Kernel device path as unicode string. This path uniquely identifies
a single device.
Unlike :attr:`sys_path`, this path does not contain the ``sysfs``
mount point. However, the path is absolute and starts with a slash
``'/'``.
)r r$ Zudev_device_get_devpath)r` r! r! r" device_pathL s
zDevice.device_pathc C s | j j| }|dkrdS t|S )z
Name of the subsystem this device is part of as unicode string.
:returns: name of subsystem if found, else None
:rtype: unicode string or NoneType
N)r$ Zudev_device_get_subsystemr )r` Zsubsysr! r! r" r* Y s zDevice.subsystemc C s t | jj| S )zF
Device file name inside ``sysfs`` as unicode string.
)r r$ Zudev_device_get_sysname)r` r! r! r" r+ d s zDevice.sys_namec C s | j j| }|dk r t|S dS )a
The trailing number of the :attr:`sys_name` as unicode string, or
``None``, if the device has no trailing number in its name.
.. note::
The number is returned as unicode string to preserve the exact
format of the number, especially any leading zeros:
>>> from pyudev import Context, Device
>>> context = Context()
>>> device = Devices.from_path(context, '/sys/devices/LNXSYSTM:00')
>>> device.sys_number
u'00'
To work with numbers, explicitly convert them to ints:
>>> int(device.sys_number)
0
.. versionadded:: 0.11
N)r$ Zudev_device_get_sysnumr )r` r. r! r! r"
sys_numberl s zDevice.sys_numberc C s$ | j j| }|dk r t|S |S dS )a
Device type as unicode string, or ``None``, if the device type is
unknown.
>>> from pyudev import Context
>>> context = Context()
>>> for device in context.list_devices(subsystem='net'):
... '{0} - {1}'.format(device.sys_name, device.device_type or 'ethernet')
...
u'eth0 - ethernet'
u'wlan0 - wlan'
u'lo - ethernet'
u'vboxnet0 - ethernet'
.. versionadded:: 0.10
N)r$ Zudev_device_get_devtyper )r` r5 r! r! r" r5 s zDevice.device_typec C s | j j| }|dk r t|S dS )z
The driver name as unicode string, or ``None``, if there is no
driver for this device.
.. versionadded:: 0.5
N)r$ Zudev_device_get_driverr )r` driverr! r! r" rm s z
Device.driverc C s | j j| }|dk r t|S dS )a
Absolute path to the device node of this device as unicode string or
``None``, if this device doesn't have a device node. The path
includes the device directory (see :attr:`Context.device_path`).
This path always points to the actual device node associated with
this device, and never to any symbolic links to this device node.
See :attr:`device_links` to get a list of symbolic links to this
device node.
.. warning::
For devices created with :meth:`from_device_file()`, the value of
this property is not necessary equal to the ``filename`` given to
:meth:`from_device_file()`.
N)r$ Zudev_device_get_devnoder )r` Znoder! r! r" device_node s zDevice.device_nodec C s | j j| S )a
The device number of the associated device as integer, or ``0``, if no
device number is associated.
Use :func:`os.major` and :func:`os.minor` to decompose the device
number into its major and minor number:
>>> import os
>>> from pyudev import Context, Device
>>> context = Context()
>>> sda = Devices.from_name(context, 'block', 'sda')
>>> sda.device_number
2048L
>>> (os.major(sda.device_number), os.minor(sda.device_number))
(8, 0)
For devices with an associated :attr:`device_node`, this is the same as
the ``st_rdev`` field of the stat result of the :attr:`device_node`:
>>> os.stat(sda.device_node).st_rdev
2048
.. versionadded:: 0.11
)r$ Zudev_device_get_devnum)r` r! r! r" r6 s zDevice.device_numberc C s t | jj| S )ai
``True``, if the device is initialized, ``False`` otherwise.
A device is initialized, if udev has already handled this device and
has set up device node permissions and context, or renamed a network
device.
Consequently, this property is only implemented for devices with a
device node or for network devices. On all other devices this property
is always ``True``.
It is *not* recommended, that you use uninitialized devices.
.. seealso:: :attr:`time_since_initialized`
.. udevversion:: 165
.. versionadded:: 0.8
)boolr$ Z udev_device_get_is_initialized)r` r! r! r" is_initialized s zDevice.is_initializedc C s | j j| }t|dS )a
The time elapsed since initialization as :class:`~datetime.timedelta`.
This property is only implemented on devices, which need to store
properties in the udev database. On all other devices this property is
simply zero :class:`~datetime.timedelta`.
.. seealso:: :attr:`is_initialized`
.. udevversion:: 165
.. versionadded:: 0.8
) microseconds)r$ Z&udev_device_get_usec_since_initializedr )r` rq r! r! r" time_since_initialized s z Device.time_since_initializedc c s4 | j j| }x"t| j |D ]\}}t|V qW dS )a
An iterator, which yields the absolute paths (including the device
directory, see :attr:`Context.device_path`) of all symbolic links
pointing to the :attr:`device_node` of this device. The paths are
unicode strings.
UDev can create symlinks to the original device node (see
:attr:`device_node`) inside the device directory. This is often
used to assign a constant, fixed device node to devices like
removeable media, which technically do not have a constant device
node, or to map a single device into multiple device hierarchies.
The property provides access to all such symbolic links, which were
created by UDev for this device.
.. warning::
Links are not necessarily resolved by
:meth:`Devices.from_device_file()`. Hence do *not* rely on
``Devices.from_device_file(context, link).device_path ==
device.device_path`` from any ``link`` in ``device.device_links``.
N)r$ Z#udev_device_get_devlinks_list_entryr r )r` ZdevlinksnamerR r! r! r" device_links s zDevice.device_linksc C s | j j| }|dk r t|S dS )a
The device event action as string, or ``None``, if this device was not
received from a :class:`Monitor`.
Usual actions are:
``'add'``
A device has been added (e.g. a USB device was plugged in)
``'remove'``
A device has been removed (e.g. a USB device was unplugged)
``'change'``
Something about the device changed (e.g. a device property)
``'online'``
The device is online now
``'offline'``
The device is offline now
.. warning::
Though the actions listed above are the most common, this property
*may* return other values, too, so be prepared to handle unknown
actions!
.. versionadded:: 0.16
N)r$ Zudev_device_get_actionr )r` actionr! r! r" ru s z
Device.actionc C s | j j| S )z
The device event sequence number as integer, or ``0`` if this device
has no sequence number, i.e. was not received from a :class:`Monitor`.
.. versionadded:: 0.16
)r$ Zudev_device_get_seqnum)r` r! r! r" sequence_number> s zDevice.sequence_numberc C s t | S )aT
The system attributes of this device as read-only
:class:`Attributes` mapping.
System attributes are basically normal files inside the the device
directory. These files contain all sorts of information about the
device, which may not be reflected by properties. These attributes
are commonly used for matching in udev rules, and can be printed
using ``udevadm info --attribute-walk``.
The values of these attributes are not always proper strings, and
can contain arbitrary bytes.
.. versionadded:: 0.5
)
Attributes)r` r! r! r" r: H s zDevice.attributesc C s t | S )zu
The udev properties of this object as read-only Properties mapping.
.. versionadded:: 0.21
)
Properties)r` r! r! r"
properties_ s zDevice.propertiesc C s t | S )a
A :class:`Tags` object representing the tags attached to this device.
The :class:`Tags` object supports a test for a single tag as well as
iteration over all tags:
>>> from pyudev import Context
>>> context = Context()
>>> device = next(iter(context.list_devices(tag='systemd')))
>>> 'systemd' in device.tags
True
>>> list(device.tags)
[u'seat', u'systemd', u'uaccess']
Tags are arbitrary classifiers that can be attached to devices by udev
scripts and daemons. For instance, systemd_ uses tags for multi-seat_
support.
.. _systemd: http://freedesktop.org/wiki/Software/systemd
.. _multi-seat: http://www.freedesktop.org/wiki/Software/systemd/multiseat
.. udevversion:: 154
.. versionadded:: 0.6
.. versionchanged:: 0.13
Return a :class:`Tags` object now.
)Tags)r` r! r! r" tagsh s z Device.tagsc C s" ddl }|jdtdd | jj S )a*
Iterate over the names of all properties defined for this device.
Return a generator yielding the names of all properties of this
device as unicode strings.
.. deprecated:: 0.21
Will be removed in 1.0. Access properties with Device.properties.
r NzAWill be removed in 1.0. Access properties with Device.properties.r[ )r\ )r] r^ r_ ry __iter__)r` r] r! r! r" r| s
zDevice.__iter__c C s" ddl }|jdtdd | jj S )z
Return the amount of properties defined for this device as integer.
.. deprecated:: 0.21
Will be removed in 1.0. Access properties with Device.properties.
r NzAWill be removed in 1.0. Access properties with Device.properties.r[ )r\ )r] r^ r_ ry __len__)r` r] r! r! r" r} s zDevice.__len__c C s$ ddl }|jdtdd | jj|S )a
Get the given property from this device.
``prop`` is a unicode or byte string containing the name of the
property.
Return the property value as unicode string, or raise a
:exc:`~exceptions.KeyError`, if the given property is not defined
for this device.
.. deprecated:: 0.21
Will be removed in 1.0. Access properties with Device.properties.
r NzAWill be removed in 1.0. Access properties with Device.properties.r[ )r\ )r] r^ r_ ry __getitem__)r` propr] r! r! r" r~ s zDevice.__getitem__c C s$ ddl }|jdtdd | jj|S )a
Get the given property from this device as integer.
``prop`` is a unicode or byte string containing the name of the
property.
Return the property value as integer. Raise a
:exc:`~exceptions.KeyError`, if the given property is not defined
for this device, or a :exc:`~exceptions.ValueError`, if the property
value cannot be converted to an integer.
.. deprecated:: 0.21
Will be removed in 1.0. Use Device.properties.asint() instead.
r Nz * s z%Properties.__len__..)r$ r r& sumr )r` ry r! r! r" r} $ s zProperties.__len__c C s, | j j| jt|}|dkr$t|t|S )a9
Get the given property from this device.
``prop`` is a unicode or byte string containing the name of the
property.
Return the property value as unicode string, or raise a
:exc:`~exceptions.KeyError`, if the given property is not defined
for this device.
N)r$ Z udev_device_get_property_valuer& r KeyErrorr )r` r valuer! r! r" r~ , s
zProperties.__getitem__c C s t | | S )a
Get the given property from this device as integer.
``prop`` is a unicode or byte string containing the name of the
property.
Return the property value as integer. Raise a
:exc:`~exceptions.KeyError`, if the given property is not defined
for this device, or a :exc:`~exceptions.ValueError`, if the property
value cannot be converted to an integer.
)rN )r` r r! r! r" r ? s zProperties.asintc C s t | | S )a
Get the given property from this device as boolean.
A boolean property has either a value of ``'1'`` or of ``'0'``,
where ``'1'`` stands for ``True``, and ``'0'`` for ``False``. Any
other value causes a :exc:`~exceptions.ValueError` to be raised.
``prop`` is a unicode or byte string containing the name of the
property.
Return ``True``, if the property value is ``'1'`` and ``False``, if
the property value is ``'0'``. Any other value raises a
:exc:`~exceptions.ValueError`. Raise a :exc:`~exceptions.KeyError`,
if the given property is not defined for this device.
)r )r` r r! r! r" r M s zProperties.asboolN)
rV rW rX rY ra r| r} r~ r r r! r! r! r" rx
s rx c @ sN e Zd ZdZdd Zedd Zdd Zdd d
Zd d Z d
d Z
dd Z dS )rw zQ
udev attributes for :class:`Device` objects.
.. versionadded:: 0.5
c C s || _ |j| _d S )N)r& r$ )r` r& r! r! r" ra g s zAttributes.__init__c c sF t | jdsdS | jj| j}x"t| j|D ]\}}t|V q,W dS )a
Yield the ``available`` attributes for the device.
It is not guaranteed that a key in this list will have a value.
It is not guaranteed that a key not in this list will not have a value.
It is guaranteed that the keys in this list are the keys that libudev
considers to be "available" attributes.
If libudev version does not define udev_device_get_sysattr_list_entry()
yields nothing.
See rhbz#1267584.
"udev_device_get_sysattr_list_entryN)hasattrr$ r r& r r )r` attrs attributerR r! r! r" available_attributesk s
z Attributes.available_attributesc C s( | j j| jt|}|dkr$t||S )aD
Get the given system ``attribute`` for the device.
:param attribute: the key for an attribute value
:type attribute: unicode or byte string
:returns: the value corresponding to ``attribute``
:rtype: an arbitrary sequence of bytes
:raises KeyError: if no value found
N)r$ Z udev_device_get_sysattr_valuer& r r )r` r r r! r! r" _get s
zAttributes._getNc C s$ y
| j |S tk
r |S X dS )a|
Get the given system ``attribute`` for the device.
:param attribute: the key for an attribute value
:type attribute: unicode or byte string
:param default: a default if no corresponding value found
:type default: a sequence of bytes
:returns: the value corresponding to ``attribute`` or ``default``
:rtype: object
N)r r )r` r defaultr! r! r" r; s
zAttributes.getc C s t | j|S )a
Get the given ``attribute`` for the device as unicode string.
:param attribute: the key for an attribute value
:type attribute: unicode or byte string
:returns: the value corresponding to ``attribute``, as unicode
:rtype: unicode
:raises KeyError: if no value found for ``attribute``
:raises UnicodeDecodeError: if value is not convertible
)r r )r` r r! r! r" asstring s zAttributes.asstringc C s t | j|S )a
Get the given ``attribute`` as an int.
:param attribute: the key for an attribute value
:type attribute: unicode or byte string
:returns: the value corresponding to ``attribute``, as an int
:rtype: int
:raises KeyError: if no value found for ``attribute``
:raises UnicodeDecodeError: if value is not convertible to unicode
:raises ValueError: if unicode value can not be converted to an int
)rN r )r` r r! r! r" r s zAttributes.asintc C s t | j|S )a
Get the given ``attribute`` from this device as a bool.
:param attribute: the key for an attribute value
:type attribute: unicode or byte string
:returns: the value corresponding to ``attribute``, as bool
:rtype: bool
:raises KeyError: if no value found for ``attribute``
:raises UnicodeDecodeError: if value is not convertible to unicode
:raises ValueError: if unicode value can not be converted to a bool
A boolean attribute has either a value of ``'1'`` or of ``'0'``,
where ``'1'`` stands for ``True``, and ``'0'`` for ``False``. Any
other value causes a :exc:`~exceptions.ValueError` to be raised.
)r r )r` r r! r! r" r s zAttributes.asbool)N) rV rW rX rY ra r r r r; r r r r! r! r! r" rw ` s
rw c @ s0 e Zd ZdZdd Zdd Zdd Zdd Zd
S ) rz zk
A iterable over :class:`Device` tags.
Subclasses the ``Container`` and the ``Iterable`` ABC.
c C s || _ |j| _d S )N)r& r$ )r` r& r! r! r" ra s z
Tags.__init__c s> t | jdr$t| jj| jt S t fdd| D S dS )z
Whether ``tag`` exists.
:param tag: unicode string with name of tag
:rtype: bool
udev_device_has_tagc 3 s | ]}| kV qd S )Nr! )r< t)tagr! r" r> s z Tags._has_tag..N)r r$ ro r r& r any)r` r r! )r r" _has_tag s z
Tags._has_tagc C s
| j |S )z
Check for existence of ``tag``.
``tag`` is a tag as unicode string.
Return ``True``, if ``tag`` is attached to the device, ``False``
otherwise.
)r )r` r r! r! r" __contains__ s zTags.__contains__c c s6 | j j| j}x"t| j |D ]\}}t|V q W dS )zS
Iterate over all tags.
Yield each tag as unicode string.
N)r$ Z udev_device_get_tags_list_entryr& r r )r` r{ r rR r! r! r" r| s z
Tags.__iter__N)rV rW rX rY ra r r r| r! r! r! r" rz s
rz )"rY Z
__future__r r r r r rJ collectionsr r r Zdatetimer Zpyudev.device._errorsr
r r r
r r r Z pyudev._utilr r r r r objectr r% rx rw rz r! r! r! r" sD ESq