Loading...
Searching...
No Matches
database.py
Go to the documentation of this file.
''' Read-only configuration database. '''
import glob
import os
import os.path
import subprocess
import sys
try:
import yaml
try:
from yaml import CLoader as Loader, CDumper as Dumper
except ImportError:
from yaml import Loader, Dumper
except ImportError:
_YAML_MSG = '''
"Cannot import the yaml library. Please install the python3
yaml package, on many distributions known as python3-PyYAML. It is also
available as a pypi package at https://pypi.python.org/pypi/PyYAML.'''
print(_YAML_MSG)
sys.exit(1)
import config
def _here(path):
''' Return path added to current dir for __file__. '''
return os.path.join(os.path.dirname(os.path.abspath(__file__)), path)
def _load_kerneldrivers(configdir):
''' Parse the kerneldrivers.yaml file, discard unavailable
drivers.
'''
with open(os.path.join(configdir, "kernel-drivers.yaml")) as f:
cf = yaml.load(f.read(), Loader = Loader)
drivers = cf['drivers'].copy()
for driver in cf['drivers']:
if driver == 'default':
continue
with open('/dev/null', 'w') as f:
try:
subprocess.check_output([config.MODINFO, driver],
stderr=f)
except subprocess.CalledProcessError:
del drivers[driver]
return drivers
class ItemLookupError(Exception):
"""A lookup failed, either too namy or no matches found. """
pass
class Config(object):
''' The configuration selected, and it's sources. '''
# pylint: disable=too-many-instance-attributes
def __init__(self, cf=None):
self.device = None
self.driver = {}
self.config = {}
self.modinit = ""
self.modprobe = ""
self.lircd_conf = ""
self.lircmd_conf = ""
self.label = ""
if cf:
for key, value in cf.items():
setattr(self, key, value)
@property
def note(self):
''' The possible note to display when selected. '''
if 'note' in self.config:
return self.config['note']
else:
return None
class Database(object):
''' Reflects the *.yaml files in the configs/ directory. '''
def __init__(self, path=None, yamlpath=None):
devel_path = _here('../../configs')
installed_path = os.path.join(config.DATADIR, 'lirc','configs')
if path and os.path.exists(path):
configdir = path
elif path:
raise FileNotFoundError(path)
elif os.path.exists(devel_path):
configdir = devel_path
elif os.path.exists(installed_path):
configdir = installed_path
else:
raise FileNotFoundError(devel_path + ':' + installed_path)
if not yamlpath:
yamlpath = configdir
db = {}
with open(os.path.join(yamlpath, "confs_by_driver.yaml")) as f:
cf = yaml.load(f.read(), Loader = Loader)
db['lircd_by_driver'] = cf['lircd_by_driver'].copy()
db['lircmd_by_driver'] = cf['lircmd_by_driver'].copy()
db['kernel-drivers'] = _load_kerneldrivers(configdir)
db['drivers'] = db['kernel-drivers'].copy()
with open(os.path.join(yamlpath, "drivers.yaml")) as f:
cf = yaml.load(f.read(), Loader = Loader)
db['drivers'].update(cf['drivers'].copy())
for key, d in db['drivers'].items():
d['id'] = key
hint = d['device_hint']
if not hint:
continue
hint = hint.strip()
if hint.startswith('"') and hint.endswith('"'):
hint = hint[1:-1]
hint = hint.replace(r'\"', "@$#!")
hint = hint.replace('"', '')
hint = hint.replace("@$#!", '"')
hint = hint.replace("\\\\", "\\")
d['device_hint'] = hint
configs = {}
for path in glob.glob(configdir + '/*.conf'):
with open(path) as f:
cf = yaml.load(f.read(), Loader = Loader)
configs[cf['config']['id']] = cf['config']
db['configs'] = configs
self.db = db
@property
def kernel_drivers(self):
''' The kernel-drivers dictionary, drivers.yaml + kernel-drivers.yaml.
'''
return self.db['kernel-drivers']
@property
def drivers(self):
''' The drivers dictionary, drivers.yaml + kernel-drivers.yaml. '''
return self.db['drivers']
@property
def configs(self):
''' Return dict of parsed config/*.conf files, keyd by id. '''
return self.db['configs']
def remotes_by_driver(self, driver):
''' Return the list of remotes suggested for a given driver. '''
if isinstance(driver, dict):
driver = driver['id']
try:
return self.db['lircd_by_driver'][driver]
except KeyError:
return []
def lircmd_by_driver(self, driver):
''' Return list of lircmd.conf file for given driver or None. '''
if isinstance(driver, dict):
driver = driver['id']
try:
return self.db['lircmd_by_driver'][driver]
except KeyError:
return []
def driver_by_remote(self, remote):
''' Return the driver (possibly None) suggested for a remote. '''
for driver, files in self.db['lircd_by_driver'].items():
if remote in files:
return self.db['drivers'][driver]
return None
def find_config(self, key, value):
''' Return item (a config) in configs where config[key] == value. '''
found = [c for c in self.db['configs'].values()
if key in c and c[key] == value]
if len(found) > 1:
raise ItemLookupError(
"find_config: Too many matches for %s, %s): " % (key, value)
+ ', '.join([c['id'] for c in found]))
elif not found:
raise ItemLookupError(
"find_config: Nothing found for %s, %s): " % (key, value))
found = dict(found[0])
if 'device_hint' not in found:
try:
found['device_hint'] = \
self.db['drivers'][found['driver']]['device_hint']
except KeyError:
found['device_hint'] = \
self.db['kernel-drivers'][found['driver']]['device_hint']
return found
# vim: set expandtab ts=4 sw=4:
lirc.database.Config.config
config
Definition database.py:119
lirc.database.Config.note
note(self)
The possible note to display when selected.
Definition database.py:118
lirc.database.Database
Reflects the *.yaml files in the configs/ directory.
Definition database.py:126
lirc.database.Database.lircmd_by_driver
lircmd_by_driver(self, driver)
Return list of lircmd.conf file for given driver or None.
Definition database.py:203
lirc.database.Database.remotes_by_driver
remotes_by_driver(self, driver)
Return the list of remotes suggested for a given driver.
Definition database.py:194
lirc.database.Database.configs
configs(self)
Return dict of parsed config/*.conf files, keyd by id.
Definition database.py:190
lirc.database.Database.kernel_drivers
kernel_drivers(self)
The kernel-drivers dictionary, drivers.yaml + kernel-drivers.yaml.
Definition database.py:180
lirc.database.Database.db
db
Definition database.py:175
lirc.database.Database.drivers
drivers(self)
The drivers dictionary, drivers.yaml + kernel-drivers.yaml.
Definition database.py:185
lirc.database.Database.driver_by_remote
driver_by_remote(self, remote)
Return the driver (possibly None) suggested for a remote.
Definition database.py:212
lirc.database.Database.find_config
find_config(self, key, value)
Return item (a config) in configs where config[key] == value.
Definition database.py:219
lirc.database.ItemLookupError
A lookup failed, either too namy or no matches found.
Definition database.py:95
lirc.database._load_kerneldrivers
_load_kerneldrivers(configdir)
Parse the kerneldrivers.yaml file, discard unavailable drivers.
Definition database.py:77
lirc.database._here
_here(path)
Return path added to current dir for file.
Definition database.py:68