evdev 1.6.1__tar.gz → 1.7.1__tar.gz

{evdev-1.6.1 → evdev-1.7.1}/MANIFEST.in

@@ -1,6 +1,3 @@
-include README.rst
-include LICENSE
-
 # The _ecodes extension module source file needs to be generated against the
 # evdev headers of the running kernel. Refer to the 'build_ecodes' distutils
 # command in setup.py.

evdev-1.7.1/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.1
+Name: evdev
+Version: 1.7.1
+Summary: Bindings to the Linux input handling subsystem
+Author-email: Georgi Valkov <georgi.t.valkov@gmail.com>
+Maintainer-email: Tobi <proxima@sezanzeb.de>
+License: Copyright (c) 2012-2023 Georgi Valkov. All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are
+        met:
+        
+          1. Redistributions of source code must retain the above copyright
+             notice, this list of conditions and the following disclaimer.
+        
+          2. Redistributions in binary form must reproduce the above copyright
+             notice, this list of conditions and the following disclaimer in
+             the documentation and/or other materials provided with the
+             distribution.
+        
+          3. Neither the name of author nor the names of its contributors may
+             be used to endorse or promote products derived from this software
+             without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+        "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+        LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+        A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
+        COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+        SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+        LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+        DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+        THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+        (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: Homepage, https://github.com/gvalkov/python-evdev
+Keywords: evdev,input,uinput
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# evdev
+
+<p>
+    <a href="https://pypi.python.org/pypi/evdev"><img alt="pypi version" src="https://img.shields.io/pypi/v/evdev.svg"></a>
+    <a href="https://github.com/gvalkov/python-evdev/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/pypi/l/evdev"></a>
+</p>
+
+This package provides bindings to the generic input event interface in Linux.
+The *evdev* interface serves the purpose of passing events generated in the
+kernel directly to userspace through character devices that are typically
+located in `/dev/input/`.
+
+This package also comes with bindings to *uinput*, the userspace input
+subsystem. *Uinput* allows userspace programs to create and handle input devices
+that can inject events directly into the input subsystem.
+
+***Documentation:***  
+https://python-evdev.readthedocs.io/en/latest/
+
+***Development:***  
+https://github.com/gvalkov/python-evdev
+
+***Package:***  
+https://pypi.python.org/pypi/evdev
+
+***Changelog:***  
+https://python-evdev.readthedocs.io/en/latest/changelog.html

evdev-1.7.1/README.md

@@ -0,0 +1,27 @@
+# evdev
+
+<p>
+    <a href="https://pypi.python.org/pypi/evdev"><img alt="pypi version" src="https://img.shields.io/pypi/v/evdev.svg"></a>
+    <a href="https://github.com/gvalkov/python-evdev/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/pypi/l/evdev"></a>
+</p>
+
+This package provides bindings to the generic input event interface in Linux.
+The *evdev* interface serves the purpose of passing events generated in the
+kernel directly to userspace through character devices that are typically
+located in `/dev/input/`.
+
+This package also comes with bindings to *uinput*, the userspace input
+subsystem. *Uinput* allows userspace programs to create and handle input devices
+that can inject events directly into the input subsystem.
+
+***Documentation:***  
+https://python-evdev.readthedocs.io/en/latest/
+
+***Development:***  
+https://github.com/gvalkov/python-evdev
+
+***Package:***  
+https://pypi.python.org/pypi/evdev
+
+***Changelog:***  
+https://python-evdev.readthedocs.io/en/latest/changelog.html

{evdev-1.6.1 → evdev-1.7.1}/evdev/__init__.py

@@ -1,6 +1,6 @@
-#--------------------------------------------------------------------------
+# --------------------------------------------------------------------------
 # Gather everything into a single, convenient namespace.
-#--------------------------------------------------------------------------
+# --------------------------------------------------------------------------
 
 from evdev.device import DeviceInfo, InputDevice, AbsInfo, EvdevError
 from evdev.events import InputEvent, KeyEvent, RelEvent, SynEvent, AbsEvent, event_factory

{evdev-1.6.1 → evdev-1.7.1}/evdev/device.py

@@ -14,19 +14,16 @@ except ImportError:
     from evdev.eventio import EventIO, EvdevError
 
 
-#--------------------------------------------------------------------------
-_AbsInfo = collections.namedtuple(
-    'AbsInfo', ['value', 'min', 'max', 'fuzz', 'flat', 'resolution'])
+# --------------------------------------------------------------------------
+_AbsInfo = collections.namedtuple("AbsInfo", ["value", "min", "max", "fuzz", "flat", "resolution"])
 
-_KbdInfo = collections.namedtuple(
-    'KbdInfo', ['repeat', 'delay'])
+_KbdInfo = collections.namedtuple("KbdInfo", ["repeat", "delay"])
 
-_DeviceInfo = collections.namedtuple(
-    'DeviceInfo', ['bustype', 'vendor', 'product', 'version'])
+_DeviceInfo = collections.namedtuple("DeviceInfo", ["bustype", "vendor", "product", "version"])
 
 
 class AbsInfo(_AbsInfo):
-    '''Absolute axis information.
+    """Absolute axis information.
 
     A ``namedtuple`` used for storing absolute axis information -
     corresponds to the ``input_absinfo`` struct:
@@ -62,14 +59,14 @@ class AbsInfo(_AbsInfo):
     The input core does not clamp reported values to the ``[minimum,
     maximum]`` limits, such task is left to userspace.
 
-    '''
+    """
 
     def __str__(self):
-        return 'val {}, min {}, max {}, fuzz {}, flat {}, res {}'.format(*self)
+        return "val {}, min {}, max {}, fuzz {}, flat {}, res {}".format(*self)
 
 
 class KbdInfo(_KbdInfo):
-    '''Keyboard repeat rate.
+    """Keyboard repeat rate.
 
     Attributes
     ----------
@@ -79,45 +76,44 @@ class KbdInfo(_KbdInfo):
     delay
       Amount of time that a key must be depressed before it will start
       to repeat (in milliseconds).
-    '''
+    """
 
     def __str__(self):
-        return 'repeat {}, delay {}'.format(*self)
+        return "repeat {}, delay {}".format(*self)
 
 
 class DeviceInfo(_DeviceInfo):
-    '''
+    """
     Attributes
     ----------
     bustype
     vendor
     product
     version
-    '''
+    """
 
     def __str__(self):
-        msg = 'bus: {:04x}, vendor {:04x}, product {:04x}, version {:04x}'
+        msg = "bus: {:04x}, vendor {:04x}, product {:04x}, version {:04x}"
         return msg.format(*self)
 
 
 class InputDevice(EventIO):
-    '''
+    """
     A linux input device from which input events can be read.
-    '''
+    """
 
-    __slots__ = ('path', 'fd', 'info', 'name', 'phys', 'uniq', '_rawcapabilities',
-                 'version', 'ff_effects_count')
+    __slots__ = ("path", "fd", "info", "name", "phys", "uniq", "_rawcapabilities", "version", "ff_effects_count")
 
     def __init__(self, dev):
-        '''
+        """
         Arguments
         ---------
         dev : str|bytes|PathLike
           Path to input device
-        '''
+        """
 
         #: Path to input device.
-        self.path = dev if not hasattr(dev, '__fspath__') else dev.__fspath__()
+        self.path = dev if not hasattr(dev, "__fspath__") else dev.__fspath__()
 
         # Certain operations are possible only when the device is opened in
         # read-write mode.
@@ -141,7 +137,7 @@ class InputDevice(EventIO):
         #: The physical topology of the device.
         self.phys = info_res[5]
 
-        #: The unique address of the device.
+        #: The unique identifier of the device.
         self.uniq = info_res[6]
 
         #: The evdev protocol version.
@@ -154,7 +150,7 @@ class InputDevice(EventIO):
         self.ff_effects_count = _input.ioctl_EVIOCGEFFECTS(self.fd)
 
     def __del__(self):
-        if hasattr(self, 'fd') and self.fd is not None:
+        if hasattr(self, "fd") and self.fd is not None:
             try:
                 self.close()
             except (OSError, ImportError, AttributeError):
@@ -163,8 +159,8 @@ class InputDevice(EventIO):
     def _capabilities(self, absinfo=True):
         res = {}
 
-        for etype, ecodes in self._rawcapabilities.items():
-            for code in ecodes:
+        for etype, _ecodes in self._rawcapabilities.items():
+            for code in _ecodes:
                 l = res.setdefault(etype, [])
                 if isinstance(code, tuple):
                     if absinfo:
@@ -179,7 +175,7 @@ class InputDevice(EventIO):
         return res
 
     def capabilities(self, verbose=False, absinfo=True):
-        '''
+        """
         Return the event types that this device supports as a mapping of
         supported event types to lists of handled event codes.
 
@@ -216,7 +212,7 @@ class InputDevice(EventIO):
           { ('EV_ABS', 3): [ (('ABS_X', 0), AbsInfo(min=0, max=255, fuzz=0, flat=0)),
                              (('ABS_Y', 1), AbsInfo(min=0, max=255, fuzz=0, flat=0)) ]}
 
-        '''
+        """
 
         if verbose:
             return dict(util.resolve_ecodes_dict(self._capabilities(absinfo)))
@@ -224,7 +220,7 @@ class InputDevice(EventIO):
             return self._capabilities(absinfo)
 
     def input_props(self, verbose=False):
-        '''
+        """
         Get device properties and quirks.
 
         Example
@@ -237,7 +233,7 @@ class InputDevice(EventIO):
 
         [('INPUT_PROP_POINTER', 0), ('INPUT_PROP_POINTING_STICK', 5)]
 
-        '''
+        """
         props = _input.ioctl_EVIOCGPROP(self.fd)
         if verbose:
             return util.resolve_ecodes(ecodes.INPUT_PROP, props)
@@ -245,7 +241,7 @@ class InputDevice(EventIO):
         return props
 
     def leds(self, verbose=False):
-        '''
+        """
         Return currently set LED keys.
 
         Example
@@ -258,7 +254,7 @@ class InputDevice(EventIO):
 
         [('LED_NUML', 0), ('LED_CAPSL', 1), ('LED_MISC', 8), ('LED_MAIL', 9)]
 
-        '''
+        """
         leds = _input.ioctl_EVIOCG_bits(self.fd, ecodes.EV_LED)
         if verbose:
             return util.resolve_ecodes(ecodes.LED, leds)
@@ -266,29 +262,28 @@ class InputDevice(EventIO):
         return leds
 
     def set_led(self, led_num, value):
-        '''
+        """
         Set the state of the selected LED.
 
         Example
         -------
         >>> device.set_led(ecodes.LED_NUML, 1)
-        '''
+        """
         self.write(ecodes.EV_LED, led_num, value)
 
     def __eq__(self, other):
-        '''
+        """
         Two devices are equal if their :data:`info` attributes are equal.
-        '''
-        return isinstance(other, self.__class__) and self.info == other.info \
-            and self.path == other.path
+        """
+        return isinstance(other, self.__class__) and self.info == other.info and self.path == other.path
 
     def __str__(self):
-        msg = 'device {}, name "{}", phys "{}"'
-        return msg.format(self.path, self.name, self.phys)
+        msg = 'device {}, name "{}", phys "{}", uniq "{}"'
+        return msg.format(self.path, self.name, self.phys, self.uniq or "")
 
     def __repr__(self):
         msg = (self.__class__.__name__, self.path)
-        return '{}({!r})'.format(*msg)
+        return "{}({!r})".format(*msg)
 
     def __fspath__(self):
         return self.path
@@ -302,63 +297,63 @@ class InputDevice(EventIO):
                 self.fd = -1
 
     def grab(self):
-        '''
+        """
         Grab input device using ``EVIOCGRAB`` - other applications will
         be unable to receive events until the device is released. Only
         one process can hold a ``EVIOCGRAB`` on a device.
 
         Warning
         -------
-        Grabbing an already grabbed device will raise an ``IOError``.
-        '''
+        Grabbing an already grabbed device will raise an ``OSError``.
+        """
 
         _input.ioctl_EVIOCGRAB(self.fd, 1)
 
     def ungrab(self):
-        '''
+        """
         Release device if it has been already grabbed (uses `EVIOCGRAB`).
 
         Warning
         -------
         Releasing an already released device will raise an
-        ``IOError('Invalid argument')``.
-        '''
+        ``OSError('Invalid argument')``.
+        """
 
         _input.ioctl_EVIOCGRAB(self.fd, 0)
 
     @contextlib.contextmanager
     def grab_context(self):
-        '''
+        """
         A context manager for the duration of which only the current
         process will be able to receive events from the device.
-        '''
+        """
         self.grab()
         yield
         self.ungrab()
 
     def upload_effect(self, effect):
-        '''
+        """
         Upload a force feedback effect to a force feedback device.
-        '''
+        """
 
         data = memoryview(effect).tobytes()
         ff_id = _input.upload_effect(self.fd, data)
         return ff_id
 
     def erase_effect(self, ff_id):
-        '''
+        """
         Erase a force effect from a force feedback device. This also
         stops the effect.
-        '''
+        """
 
         _input.erase_effect(self.fd, ff_id)
 
     @property
     def repeat(self):
-        '''
+        """
         Get or set the keyboard repeat rate (in characters per
         minute) and delay (in milliseconds).
-        '''
+        """
 
         return KbdInfo(*_input.ioctl_EVIOCGREP(self.fd))
 
@@ -367,7 +362,7 @@ class InputDevice(EventIO):
         return _input.ioctl_EVIOCSREP(self.fd, *value)
 
     def active_keys(self, verbose=False):
-        '''
+        """
         Return currently active keys.
 
         Example
@@ -382,7 +377,7 @@ class InputDevice(EventIO):
 
           [('KEY_ESC', 1), ('KEY_LEFTSHIFT', 42)]
 
-        '''
+        """
         active_keys = _input.ioctl_EVIOCG_bits(self.fd, ecodes.EV_KEY)
         if verbose:
             return util.resolve_ecodes(ecodes.KEY, active_keys)
@@ -391,12 +386,12 @@ class InputDevice(EventIO):
 
     @property
     def fn(self):
-        msg = 'Please use {0}.path instead of {0}.fn'.format(self.__class__.__name__)
+        msg = "Please use {0}.path instead of {0}.fn".format(self.__class__.__name__)
         warnings.warn(msg, DeprecationWarning, stacklevel=2)
         return self.path
 
     def absinfo(self, axis_num):
-        '''
+        """
         Return current :class:`AbsInfo` for input device axis
 
         Arguments
@@ -408,11 +403,11 @@ class InputDevice(EventIO):
         -------
         >>> device.absinfo(ecodes.ABS_X)
         AbsInfo(value=1501, min=-32768, max=32767, fuzz=0, flat=128, resolution=0)
-        '''
+        """
         return AbsInfo(*_input.ioctl_EVIOCGABS(self.fd, axis_num))
 
     def set_absinfo(self, axis_num, value=None, min=None, max=None, fuzz=None, flat=None, resolution=None):
-        '''
+        """
         Update :class:`AbsInfo` values. Only specified values will be overwritten.
 
         Arguments
@@ -427,13 +422,15 @@ class InputDevice(EventIO):
         You can also unpack AbsInfo tuple that will overwrite all values
 
         >>> device.set_absinfo(ecodes.ABS_Y, *AbsInfo(0, -2000, 2000, 0, 15, 0))
-        '''
+        """
 
         cur_absinfo = self.absinfo(axis_num)
-        new_absinfo = AbsInfo(value if value is not None else cur_absinfo.value,
-                              min if min is not None else cur_absinfo.min,
-                              max if max is not None else cur_absinfo.max,
-                              fuzz if fuzz is not None else cur_absinfo.fuzz,
-                              flat if flat is not None else cur_absinfo.flat,
-                              resolution if resolution is not None else cur_absinfo.resolution)
+        new_absinfo = AbsInfo(
+            value if value is not None else cur_absinfo.value,
+            min if min is not None else cur_absinfo.min,
+            max if max is not None else cur_absinfo.max,
+            fuzz if fuzz is not None else cur_absinfo.fuzz,
+            flat if flat is not None else cur_absinfo.flat,
+            resolution if resolution is not None else cur_absinfo.resolution,
+        )
         _input.ioctl_EVIOCSABS(self.fd, axis_num, new_absinfo)

{evdev-1.6.1 → evdev-1.7.1}/evdev/ecodes.py

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-'''
+"""
 This modules exposes the integer constants defined in ``linux/input.h`` and
 ``linux/input-event-codes.h``.
 
@@ -38,7 +36,7 @@ codes. For example::
 
     >>> evdev.ecodes.FF[81]
     'FF_PERIODIC'
-'''
+"""
 
 from inspect import getmembers
 from evdev import _ecodes
@@ -47,8 +45,8 @@ from evdev import _ecodes
 #: Mapping of names to values.
 ecodes = {}
 
-prefixes = 'KEY ABS REL SW MSC LED BTN REP SND ID EV BUS SYN FF_STATUS FF INPUT_PROP'
-prev_prefix = ''
+prefixes = "KEY ABS REL SW MSC LED BTN REP SND ID EV BUS SYN FF_STATUS FF INPUT_PROP"
+prev_prefix = ""
 g = globals()
 
 # eg. code: 'REL_Z', val: 2
@@ -87,13 +85,13 @@ bytype = {
     _ecodes.EV_KEY: keys,
     _ecodes.EV_ABS: ABS,
     _ecodes.EV_REL: REL,
-    _ecodes.EV_SW:  SW,
+    _ecodes.EV_SW: SW,
     _ecodes.EV_MSC: MSC,
     _ecodes.EV_LED: LED,
     _ecodes.EV_REP: REP,
     _ecodes.EV_SND: SND,
     _ecodes.EV_SYN: SYN,
-    _ecodes.EV_FF:  FF,
+    _ecodes.EV_FF: FF,
     _ecodes.EV_FF_STATUS: FF_STATUS,
 }
 

{evdev-1.6.1 → evdev-1.7.1}/evdev/eventio.py

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 import os
 import fcntl
 import select
@@ -8,13 +6,14 @@ import functools
 from evdev import _input, _uinput, ecodes, util
 from evdev.events import InputEvent
 
-#--------------------------------------------------------------------------
+
+# --------------------------------------------------------------------------
 class EvdevError(Exception):
     pass
 
 
 class EventIO:
-    '''
+    """
     Base class for reading and writing input events.
 
     This class is used by :class:`InputDevice` and :class:`UInput`.
@@ -26,20 +25,20 @@ class EventIO:
     - On, :class:`UInput` it used for writing user-generated events (e.g.
       key presses, mouse movements) and reading feedback events (e.g. leds,
       beeps).
-    '''
+    """
 
     def fileno(self):
-        '''
+        """
         Return the file descriptor to the open event device. This makes
         it possible to pass instances directly to :func:`select.select()` and
         :class:`asyncore.file_dispatcher`.
-        '''
+        """
         return self.fd
 
     def read_loop(self):
-        '''
+        """
         Enter an endless :func:`select.select()` loop that yields input events.
-        '''
+        """
 
         while True:
             r, w, x = select.select([self.fd], [], [])
@@ -47,12 +46,12 @@ class EventIO:
                 yield event
 
     def read_one(self):
-        '''
+        """
         Read and return a single input event as an instance of
         :class:`InputEvent <evdev.events.InputEvent>`.
 
         Return ``None`` if there are no pending input events.
-        '''
+        """
 
         # event -> (sec, usec, type, code, val)
         event = _input.device_read(self.fd)
@@ -61,11 +60,11 @@ class EventIO:
             return InputEvent(*event)
 
     def read(self):
-        '''
+        """
         Read multiple input events from device. Return a generator object that
         yields :class:`InputEvent <evdev.events.InputEvent>` instances. Raises
         `BlockingIOError` if there are no available events at the moment.
-        '''
+        """
 
         # events -> [(sec, usec, type, code, val), ...]
         events = _input.device_read_many(self.fd)
@@ -74,10 +73,11 @@ class EventIO:
             yield InputEvent(*event)
 
     def need_write(func):
-        '''
+        """
         Decorator that raises :class:`EvdevError` if there is no write access to the
         input device.
-        '''
+        """
+
         @functools.wraps(func)
         def wrapper(*args):
             fd = args[0].fd
@@ -85,10 +85,11 @@ class EventIO:
                 return func(*args)
             msg = 'no write access to device "%s"' % args[0].path
             raise EvdevError(msg)
+
         return wrapper
 
     def write_event(self, event):
-        '''
+        """
         Inject an input event into the input subsystem. Events are
         queued until a synchronization event is received.
 
@@ -103,16 +104,16 @@ class EventIO:
         -------
         >>> ev = InputEvent(1334414993, 274296, ecodes.EV_KEY, ecodes.KEY_A, 1)
         >>> ui.write_event(ev)
-        '''
+        """
 
-        if hasattr(event, 'event'):
+        if hasattr(event, "event"):
             event = event.event
 
         self.write(event.type, event.code, event.value)
 
     @need_write
     def write(self, etype, code, value):
-        '''
+        """
         Inject an input event into the input subsystem. Events are
         queued until a synchronization event is received.
 
@@ -131,7 +132,7 @@ class EventIO:
         ---------
         >>> ui.write(e.EV_KEY, e.KEY_A, 1) # key A - down
         >>> ui.write(e.EV_KEY, e.KEY_A, 0) # key A - up
-        '''
+        """
 
         _uinput.write(self.fd, etype, code, value)