1 # Copyright (C) 2010 W. Trevor King <wking@drexel.edu>
3 # This file is part of Hooke.
5 # Hooke is free software: you can redistribute it and/or modify it
6 # under the terms of the GNU Lesser General Public License as
7 # published by the Free Software Foundation, either version 3 of the
8 # License, or (at your option) any later version.
10 # Hooke is distributed in the hope that it will be useful, but WITHOUT
11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
13 # Public License for more details.
15 # You should have received a copy of the GNU Lesser General Public
16 # License along with Hooke. If not, see
17 # <http://www.gnu.org/licenses/>.
19 """The driver module provides :class:`Driver`\s for identifying and
22 This allows Hooke to be data-file agnostic. Drivers for various
23 commercial force spectroscopy microscopes are provided, and it's easy
24 to write your own to handle your lab's specific format.
30 from ..config import Setting
31 from ..util.pluggable import IsSubclass, construct_graph
35 # ('csvdriver', True),
40 # ('mfp1dexport', True),
46 """List of driver modules and whether they should be included by
47 default. TODO: autodiscovery
50 DRIVER_SETTING_SECTION = 'drivers'
51 """Name of the config section which controls driver selection.
55 class Driver (object):
56 """Base class for file format drivers.
58 :attr:`name` identifies your driver and should match the module
61 def __init__(self, name):
63 self.setting_section = '%s driver' % self.name
65 def dependencies(self):
66 """Return a list of :class:`Driver`\s we require."""
69 def default_settings(self):
70 """Return a list of :class:`hooke.config.Setting`\s for any
71 configurable driver settings.
73 The suggested section setting is::
75 Setting(section=self.setting_section, help=self.__doc__)
79 def is_me(self, path):
80 """Read the file and return True if the filetype can be
81 managed by the driver. Otherwise return False.
85 def read(self, path, info=None):
86 """Read data from `path` and return a
87 ([:class:`hooke.curve.Data`, ...], `info`) tuple.
89 The input `info` :class:`dict` may contain attributes read
90 from the :class:`~hooke.playlist.FilePlaylist`.
92 The `info` :class:`dict` must contain values for the keys:
93 'filetype' and 'experiment'. See :class:`hooke.curve.Curve`
96 raise NotImplementedError
99 return logging.getLogger('hooke')
101 # Construct driver dependency graph and load default drivers.
103 DRIVER_GRAPH = construct_graph(
104 this_modname=__name__,
105 submodnames=[name for name,include in DRIVER_MODULES],
106 class_selector=IsSubclass(Driver, blacklist=[Driver]))
107 """Topologically sorted list of all possible :class:`Driver`\s.
110 def default_settings():
111 settings = [Setting(DRIVER_SETTING_SECTION,
112 help='Enable/disable default drivers.')]
113 for dnode in DRIVER_GRAPH:
115 default_include = [di for mod_name,di in DRIVER_MODULES
116 if mod_name == driver.name][0]
117 help = driver.__doc__.split('\n', 1)[0]
118 settings.append(Setting(
119 section=DRIVER_SETTING_SECTION,
121 value=default_include,
125 for dnode in DRIVER_GRAPH:
127 settings.extend(driver.default_settings())