August 2017 - tor-commits - lists.torproject.org

[nyx/master] Only attempt to fetch manual information once
by atagar＠torproject.org 27 Aug '17

27 Aug '17

commit 61a2c4bd701802627ac3262b90342a9c07d3af66 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Aug 27 10:56:40 2017 -0700 Only attempt to fetch manual information once No reason to repeatedly fetch information that doesn't exist. --- nyx/panel/config.py | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/nyx/panel/config.py b/nyx/panel/config.py index db04dbb..5f09e66 100644 --- a/nyx/panel/config.py +++ b/nyx/panel/config.py @@ -54,6 +54,8 @@ class ConfigEntry(object): def __init__(self, name, value_type): self.name = name self.value_type = value_type + + self._is_fetched = False self._category = None self._usage = None self._summary = None @@ -133,27 +135,28 @@ class ConfigEntry(object): @property def summary(self): - if not self._summary: + if not self._is_fetched: self._fetch_attr() return self._summary @property def description(self): - if not self._description: + if not self._is_fetched: self._fetch_attr() return self._description @property def position(self): - if not self._position: + if not self._is_fetched: self._fetch_attr() - return self._position + return 99999 if self._position is None else self._position def _fetch_attr(self): result = stem.manual.query('SELECT category, usage, summary, description, position FROM torrc WHERE key=?', self.name.upper()).fetchone() + self._is_fetched = True if result: self._category, self._usage, self._summary, self._description, self._position = result

1 0

[nyx/master] Stacktrace when referring to data_directory()
by atagar＠torproject.org 27 Aug '17

27 Aug '17

commit 542bf2f91562167a4eed79271bed0d1d4bbf40e1 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Aug 26 16:06:39 2017 -0700 Stacktrace when referring to data_directory() Huh. Kinda unsure how this didn't come up earlier. Initializing the config panel is failing with... Traceback (most recent call last): File "/home/ubuntu/nyx/run_nyx", line 14, in <module> nyx.main() File "/home/ubuntu/nyx/nyx/__init__.py", line 105, in main nyx.starter.main() File "/home/ubuntu/nyx/stem/util/conf.py", line 289, in wrapped return func(*args, config = config, **kwargs) File "/home/ubuntu/nyx/nyx/starter.py", line 104, in main nyx.curses.start(nyx.draw_loop, acs_support = config.get('acs_support', True), transparent_background = True, cursor = False) File "/home/ubuntu/nyx/nyx/curses.py", line 216, in start curses.wrapper(_wrapper) File "/usr/lib/python2.7/curses/wrapper.py", line 43, in wrapper return func(stdscr, *args, **kwds) File "/home/ubuntu/nyx/nyx/curses.py", line 214, in _wrapper function() File "/home/ubuntu/nyx/nyx/__init__.py", line 123, in draw_loop interface = nyx_interface() File "/home/ubuntu/nyx/nyx/__init__.py", line 176, in nyx_interface Interface() # constructor sets NYX_INTERFACE File "/home/ubuntu/nyx/nyx/__init__.py", line 345, in __init__ self._page_panels.append([nyx.panel.config.ConfigPanel()]) File "/home/ubuntu/nyx/nyx/panel/config.py", line 133, in __init__ cached_manual_path = data_directory('manual') File "/home/ubuntu/nyx/stem/util/conf.py", line 289, in wrapped return func(*args, config = config, **kwargs) TypeError: data_directory() got multiple values for keyword argument 'config' --- nyx/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nyx/__init__.py b/nyx/__init__.py index 5cd0898..3cf3c85 100644 --- a/nyx/__init__.py +++ b/nyx/__init__.py @@ -232,7 +232,7 @@ def init_controller(*args, **kwargs): @uses_settings -def data_directory(config, filename): +def data_directory(filename, config): path = config.get('data_directory', '~/.nyx') if path == 'disabled':

1 0

[stem/master] Update manual cache
by atagar＠torproject.org 27 Aug '17

27 Aug '17

commit ec44c052f910699f0fad63bd7634aeb0950211fb Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Aug 27 11:23:02 2017 -0700 Update manual cache Oops, didn't recreate the manual cache after adding the new 'key' attribute. --- stem/cached_tor_manual.sqlite | Bin 204800 -> 217088 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/stem/cached_tor_manual.sqlite b/stem/cached_tor_manual.sqlite index 214abe3c..b35a3c5e 100644 Binary files a/stem/cached_tor_manual.sqlite and b/stem/cached_tor_manual.sqlite differ

1 0

[stem/master] Replace query's path with a parameter argument
by atagar＠torproject.org 27 Aug '17

27 Aug '17

commit de2f1be164337b145649c396d5ef9d387bc608af Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Aug 27 11:16:03 2017 -0700 Replace query's path with a parameter argument Parameterized queries are useful. Allowing folks to specify their own sqlite database really isn't. These are incompatable due to the '*params' syntax sugar, though I might re-introduce path as a '**kwargs' in the future if we develop a need for it. --- stem/manual.py | 22 ++++++++-------------- test/unit/manual.py | 4 +--- 2 files changed, 9 insertions(+), 17 deletions(-) diff --git a/stem/manual.py b/stem/manual.py index 7dd2be63..9537c740 100644 --- a/stem/manual.py +++ b/stem/manual.py @@ -83,7 +83,7 @@ except ImportError: Category = stem.util.enum.Enum('GENERAL', 'CLIENT', 'RELAY', 'DIRECTORY', 'AUTHORITY', 'HIDDEN_SERVICE', 'TESTING', 'UNKNOWN') GITWEB_MANUAL_URL = 'https://gitweb.torproject.org/tor.git/plain/doc/tor.1.txt' CACHE_PATH = os.path.join(os.path.dirname(__file__), 'cached_tor_manual.sqlite') -DATABASE = {} # read-only sqlite database connections +DATABASE = None # cache database connections CATEGORY_SECTIONS = OrderedDict(( ('GENERAL OPTIONS', Category.GENERAL), @@ -96,7 +96,7 @@ CATEGORY_SECTIONS = OrderedDict(( )) -def query(query, path = None): +def query(query, *param): """ Performs the given query on our sqlite manual cache. This database should be treated as being read-only. File permissions generally enforce this, and @@ -105,14 +105,11 @@ def query(query, path = None): .. versionadded:: 1.6.0 :param str query: query to run on the cache - :param str path: cached manual content to read, if not provided this uses - the bundled manual information + :param list param: query parameters :returns: :class:`sqlite3.Cursor` with the query results - :raises: - * **sqlite3.OperationalError** if query fails - * **IOError** if a **path** was provided and we were unable to read it + :raises: **sqlite3.OperationalError** if query fails """ # The only reason to explicitly close the sqlite connection is to ensure @@ -124,15 +121,12 @@ def query(query, path = None): # # https://docs.python.org/3/library/sqlite3.html#sqlite3.connect - if path is None: - path = CACHE_PATH - elif not os.path.exists(path): - raise IOError("%s doesn't exist" % path) + global DATABASE - if path not in DATABASE: - DATABASE[path] = sqlite3.connect(path) + if DATABASE is None: + DATABASE = sqlite3.connect(CACHE_PATH) - return DATABASE[path].execute(query) + return DATABASE.execute(query, param) class ConfigOption(object): diff --git a/test/unit/manual.py b/test/unit/manual.py index 20230e88..b7e0adfc 100644 --- a/test/unit/manual.py +++ b/test/unit/manual.py @@ -105,13 +105,11 @@ def _cached_manual(): class TestManual(unittest.TestCase): def test_query(self): self.assertEqual("If set, this option overrides the default location and file name for Tor's cookie file. (See CookieAuthentication above.)", stem.manual.query('SELECT description FROM torrc WHERE name="CookieAuthFile"').fetchone()[0]) + self.assertEqual("If set, this option overrides the default location and file name for Tor's cookie file. (See CookieAuthentication above.)", stem.manual.query('SELECT description FROM torrc WHERE name=?', 'CookieAuthFile').fetchone()[0]) def test_query_on_failure(self): self.assertRaisesRegexp(sqlite3.OperationalError, 'near "hello": syntax error', stem.manual.query, 'hello world') - def test_query_with_missing_database(self): - self.assertRaisesRegexp(IOError, "/no/such/path doesn't exist", stem.manual.query, 'SELECT * FROM torrc', '/no/such/path') - def test_has_all_summaries(self): """ Check that we have brief, human readable summaries for all of tor's

1 0

[stem/master] Replace database function with query
by atagar＠torproject.org 27 Aug '17

27 Aug '17

commit f075f94c7a7e7d3efa0104f1b8ba7e03ff4e4dd8 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Aug 27 10:46:57 2017 -0700 Replace database function with query On reflection what callers will find useful is an easy function to make sqlite queries - not a function to get a database connection. Initially I was wary of this due to being unable to know when to close the connection, but from the looks of it when accessed in a read-only fashion this doesn't really matter. --- stem/manual.py | 34 +++++++++++++++++++++++----------- test/unit/manual.py | 13 ++++++++----- 2 files changed, 31 insertions(+), 16 deletions(-) diff --git a/stem/manual.py b/stem/manual.py index 9b9c0252..7dd2be63 100644 --- a/stem/manual.py +++ b/stem/manual.py @@ -34,6 +34,7 @@ us what our torrc options do... :: + query - performs a query on our cached sqlite manual information is_important - Indicates if a configuration option is of particularly common importance. download_man_page - Downloads tor's latest man page. @@ -82,6 +83,7 @@ except ImportError: Category = stem.util.enum.Enum('GENERAL', 'CLIENT', 'RELAY', 'DIRECTORY', 'AUTHORITY', 'HIDDEN_SERVICE', 'TESTING', 'UNKNOWN') GITWEB_MANUAL_URL = 'https://gitweb.torproject.org/tor.git/plain/doc/tor.1.txt' CACHE_PATH = os.path.join(os.path.dirname(__file__), 'cached_tor_manual.sqlite') +DATABASE = {} # read-only sqlite database connections CATEGORY_SECTIONS = OrderedDict(( ('GENERAL OPTIONS', Category.GENERAL), @@ -94,33 +96,43 @@ CATEGORY_SECTIONS = OrderedDict(( )) -def database(path = None): +def query(query, path = None): """ - Provides database connection for our sqlite cache. This database should be - treated as being read-only, with this restriction being enforced in the - future. + Performs the given query on our sqlite manual cache. This database should + be treated as being read-only. File permissions generally enforce this, and + in the future will be enforced by this function as well. .. versionadded:: 1.6.0 + :param str query: query to run on the cache :param str path: cached manual content to read, if not provided this uses the bundled manual information - :returns: :class:`sqlite3.Connection` for the database cache + :returns: :class:`sqlite3.Cursor` with the query results - :raises: **IOError** if a **path** was provided and we were unable to read it + :raises: + * **sqlite3.OperationalError** if query fails + * **IOError** if a **path** was provided and we were unable to read it """ + # The only reason to explicitly close the sqlite connection is to ensure + # transactions are committed. Since we're only using read-only access this + # doesn't matter, and can allow interpreter shutdown to do the needful. + # + # TODO: When we only support python 3.4+ we can use sqlite's uri argument + # to enforce a read-only connection... + # + # https://docs.python.org/3/library/sqlite3.html#sqlite3.connect + if path is None: path = CACHE_PATH elif not os.path.exists(path): raise IOError("%s doesn't exist" % path) - # TODO: When we only support python 3.4+ we can use sqlite's uri argument to - # get a read-only connection... - # - # https://docs.python.org/3/library/sqlite3.html#sqlite3.connect + if path not in DATABASE: + DATABASE[path] = sqlite3.connect(path) - return sqlite3.connect(path) + return DATABASE[path].execute(query) class ConfigOption(object): diff --git a/test/unit/manual.py b/test/unit/manual.py index eaca3629..20230e88 100644 --- a/test/unit/manual.py +++ b/test/unit/manual.py @@ -5,6 +5,7 @@ Unit testing for the stem.manual module. import io import os import re +import sqlite3 import tempfile import unittest @@ -102,12 +103,14 @@ def _cached_manual(): class TestManual(unittest.TestCase): - def test_database(self): - with stem.manual.database() as conn: - self.assertEqual("If set, this option overrides the default location and file name for Tor's cookie file. (See CookieAuthentication above.)", conn.execute('SELECT description FROM torrc WHERE name="CookieAuthFile"').fetchone()[0]) + def test_query(self): + self.assertEqual("If set, this option overrides the default location and file name for Tor's cookie file. (See CookieAuthentication above.)", stem.manual.query('SELECT description FROM torrc WHERE name="CookieAuthFile"').fetchone()[0]) - def test_missing_database(self): - self.assertRaisesRegexp(IOError, "/no/such/path doesn't exist", stem.manual.database, '/no/such/path') + def test_query_on_failure(self): + self.assertRaisesRegexp(sqlite3.OperationalError, 'near "hello": syntax error', stem.manual.query, 'hello world') + + def test_query_with_missing_database(self): + self.assertRaisesRegexp(IOError, "/no/such/path doesn't exist", stem.manual.query, 'SELECT * FROM torrc', '/no/such/path') def test_has_all_summaries(self): """

1 0

[stem/master] Allow case insensitive torrc attribute lookups
by atagar＠torproject.org 27 Aug '17

27 Aug '17

commit 9a4688d6338fe20862fccc5dc63373f8c8c2eb82 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Aug 26 17:08:44 2017 -0700 Allow case insensitive torrc attribute lookups Making the primary key uppercase so we can do case insensitive lookups. --- stem/manual.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/stem/manual.py b/stem/manual.py index e78f917c..9b9c0252 100644 --- a/stem/manual.py +++ b/stem/manual.py @@ -526,7 +526,7 @@ class Manual(object): conn.execute('CREATE TABLE commandline(name TEXT PRIMARY KEY, description TEXT)') conn.execute('CREATE TABLE signals(name TEXT PRIMARY KEY, description TEXT)') conn.execute('CREATE TABLE files(name TEXT PRIMARY KEY, description TEXT)') - conn.execute('CREATE TABLE torrc(name TEXT PRIMARY KEY, category TEXT, usage TEXT, summary TEXT, description TEXT, position NUMBER)') + conn.execute('CREATE TABLE torrc(key TEXT PRIMARY KEY, name TEXT, category TEXT, usage TEXT, summary TEXT, description TEXT, position NUMBER)') conn.execute('INSERT INTO metadata(name, synopsis, description, man_commit, stem_commit) VALUES (?,?,?,?,?)', (self.name, self.synopsis, self.description, self.man_commit, self.stem_commit)) @@ -540,7 +540,7 @@ class Manual(object): conn.execute('INSERT INTO files(name, description) VALUES (?,?)', (k, v)) for i, v in enumerate(self.config_options.values()): - conn.execute('INSERT INTO torrc(name, category, usage, summary, description, position) VALUES (?,?,?,?,?,?)', (v.name, v.category, v.usage, v.summary, v.description, i)) + conn.execute('INSERT INTO torrc(key, name, category, usage, summary, description, position) VALUES (?,?,?,?,?,?,?)', (v.name.upper(), v.name, v.category, v.usage, v.summary, v.description, i)) if os.path.exists(path): os.remove(path)

1 0

[stem/master] Fetch sqlite results along with execute
by atagar＠torproject.org 27 Aug '17

27 Aug '17

commit 893365d98e42ae749e9a5efd8f0bb115d171a5b1 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Aug 26 14:08:23 2017 -0700 Fetch sqlite results along with execute Tutorials invoked execute then followed it with a fetch call, but turns out execute returns a cursor object. So no need to split them up or have a separate cursor. --- stem/manual.py | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/stem/manual.py b/stem/manual.py index b2f31a9e..0e2ea8d8 100644 --- a/stem/manual.py +++ b/stem/manual.py @@ -360,23 +360,16 @@ class Manual(object): @staticmethod def _from_sqlite_cache(path): - with database(path) as cursor: - cursor.execute('SELECT name, synopsis, description, man_commit, stem_commit FROM metadata') - name, synopsis, description, man_commit, stem_commit = cursor.fetchone() + with sqlite3.connect(path) as conn: + name, synopsis, description, man_commit, stem_commit = conn.execute('SELECT name, synopsis, description, man_commit, stem_commit FROM metadata').fetchone() - cursor.execute('SELECT name, description FROM commandline') - commandline = dict(cursor.fetchall()) + commandline = dict(conn.execute('SELECT name, description FROM commandline').fetchall()) + signals = dict(conn.execute('SELECT name, description FROM signals').fetchall()) + files = dict(conn.execute('SELECT name, description FROM files').fetchall()) - cursor.execute('SELECT name, description FROM signals') - signals = dict(cursor.fetchall()) - - cursor.execute('SELECT name, description FROM files') - files = dict(cursor.fetchall()) - - cursor.execute('SELECT name, category, usage, summary, description FROM torrc') config_options = OrderedDict() - for entry in cursor.fetchall(): + for entry in conn.execute('SELECT name, category, usage, summary, description FROM torrc').fetchall(): option, category, usage, summary, option_description = entry config_options[option] = ConfigOption(option, category, usage, summary, option_description)

1 0

[stem/master] Fix ordering of torrc entires
by atagar＠torproject.org 27 Aug '17

27 Aug '17

commit 85e6744e30ba6676996148407e56d38bbb4fb559 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Aug 26 14:34:36 2017 -0700 Fix ordering of torrc entires We procide torrc entries ordered by how they appeared in the manual. I thought sqlite would default to ordering them by insertion but I was wrong. Including the position as a field we can sort by. --- stem/cached_tor_manual.sqlite | Bin 202752 -> 204800 bytes stem/manual.py | 8 ++++---- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/stem/cached_tor_manual.sqlite b/stem/cached_tor_manual.sqlite index 90115e98..214abe3c 100644 Binary files a/stem/cached_tor_manual.sqlite and b/stem/cached_tor_manual.sqlite differ diff --git a/stem/manual.py b/stem/manual.py index a4590578..fc648cc9 100644 --- a/stem/manual.py +++ b/stem/manual.py @@ -372,7 +372,7 @@ class Manual(object): config_options = OrderedDict() - for entry in conn.execute('SELECT name, category, usage, summary, description FROM torrc').fetchall(): + for entry in conn.execute('SELECT name, category, usage, summary, description FROM torrc ORDER BY position').fetchall(): option, category, usage, summary, option_description = entry config_options[option] = ConfigOption(option, category, usage, summary, option_description) @@ -520,7 +520,7 @@ class Manual(object): conn.execute('CREATE TABLE commandline(name TEXT PRIMARY KEY, description TEXT)') conn.execute('CREATE TABLE signals(name TEXT PRIMARY KEY, description TEXT)') conn.execute('CREATE TABLE files(name TEXT PRIMARY KEY, description TEXT)') - conn.execute('CREATE TABLE torrc(name TEXT PRIMARY KEY, category TEXT, usage TEXT, summary TEXT, description TEXT)') + conn.execute('CREATE TABLE torrc(name TEXT PRIMARY KEY, category TEXT, usage TEXT, summary TEXT, description TEXT, position NUMBER)') conn.execute('INSERT INTO metadata(name, synopsis, description, man_commit, stem_commit) VALUES (?,?,?,?,?)', (self.name, self.synopsis, self.description, self.man_commit, self.stem_commit)) @@ -533,8 +533,8 @@ class Manual(object): for k, v in self.files.items(): conn.execute('INSERT INTO files(name, description) VALUES (?,?)', (k, v)) - for v in self.config_options.values(): - conn.execute('INSERT INTO torrc(name, category, usage, summary, description) VALUES (?,?,?,?,?)', (v.name, v.category, v.usage, v.summary, v.description)) + for i, v in enumerate(self.config_options.values()): + conn.execute('INSERT INTO torrc(name, category, usage, summary, description, position) VALUES (?,?,?,?,?,?)', (v.name, v.category, v.usage, v.summary, v.description, i)) if os.path.exists(path): os.remove(path)

1 0

[stem/master] Allow cached manual to be recreated when deleted
by atagar＠torproject.org 27 Aug '17

27 Aug '17

commit c09adaa744e7128b9281e1c70ace64207c8cfd35 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Aug 26 14:27:35 2017 -0700 Allow cached manual to be recreated when deleted Ensuring Manual.from_cache() raises an IOError rather than a sqlite error when loading a file that doesn't exist. This should never arise for users when loading our local copy, but it's handy for cache_manual.py to handle that so we can delete and recreate the cache more easily. --- cache_manual.py | 17 +++++++++++------ stem/manual.py | 3 +++ 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/cache_manual.py b/cache_manual.py index 7a4bd5c7..3112879a 100755 --- a/cache_manual.py +++ b/cache_manual.py @@ -39,15 +39,20 @@ if __name__ == '__main__': print('Current stem commit: %s' % stem_commit) print('') - cached_manual = stem.manual.Manual.from_cache() + try: + cached_manual = stem.manual.Manual.from_cache() + except IOError: + cached_manual = None # local copy has been deleted + latest_manual = stem.manual.Manual.from_remote() - if cached_manual == latest_manual: - print('Manual information is already up to date, nothing to do.') - sys.exit(0) + if cached_manual: + if cached_manual == latest_manual: + print('Manual information is already up to date, nothing to do.') + sys.exit(0) - print('Differences detected...\n') - print(stem.manual._manual_differences(cached_manual, latest_manual)) + print('Differences detected...\n') + print(stem.manual._manual_differences(cached_manual, latest_manual)) latest_manual.man_commit = man_commit latest_manual.stem_commit = stem_commit diff --git a/stem/manual.py b/stem/manual.py index 0e2ea8d8..a4590578 100644 --- a/stem/manual.py +++ b/stem/manual.py @@ -360,6 +360,9 @@ class Manual(object): @staticmethod def _from_sqlite_cache(path): + if not os.path.exists(path): + raise IOError("%s doesn't exist" % path) + with sqlite3.connect(path) as conn: name, synopsis, description, man_commit, stem_commit = conn.execute('SELECT name, synopsis, description, man_commit, stem_commit FROM metadata').fetchone()

1 0

[stem/master] Provide a connection with stem.manual.database
by atagar＠torproject.org 27 Aug '17

27 Aug '17

commit 17ab84ac5ebf896a77d1ce67bee54bb00d3c0bfd Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Aug 26 14:59:08 2017 -0700 Provide a connection with stem.manual.database In dabbling with this more I've been finding the context manager enforced by stem.manual.database() annoying. When on an interactive prompt I want a method to quickly get a no-hassle database connection - not a cursor that's only usable within a 'with' block. Reason I provided a cursor was to ensure callers had read-only access. However, just checked and when the database file is read-only (as our cached_tor_manual.sqlite should be when installed) attempting to write to it behaves how I'd expect... >>> import stem.manual >>> conn = stem.manual.database() >>> conn.execute('CREATE TABLE new_table(name TEXT PRIMARY KEY, description TEXT)') Traceback (most recent call last): File "<stdin>", line 1, in <module> sqlite3.OperationalError: attempt to write a readonly database --- stem/manual.py | 18 ++++++++++++------ test/unit/manual.py | 8 +++++--- 2 files changed, 17 insertions(+), 9 deletions(-) diff --git a/stem/manual.py b/stem/manual.py index fc648cc9..e78f917c 100644 --- a/stem/manual.py +++ b/stem/manual.py @@ -47,7 +47,6 @@ us what our torrc options do... .. versionadded:: 1.5.0 """ -import contextlib import os import shutil import sqlite3 @@ -95,26 +94,33 @@ CATEGORY_SECTIONS = OrderedDict(( )) -(a)contextlib.contextmanager def database(path = None): """ - Provides a database cursor for a sqlite cache. + Provides database connection for our sqlite cache. This database should be + treated as being read-only, with this restriction being enforced in the + future. .. versionadded:: 1.6.0 :param str path: cached manual content to read, if not provided this uses the bundled manual information - :returns: :class:`sqlite3.Cursor` for the database cache + :returns: :class:`sqlite3.Connection` for the database cache :raises: **IOError** if a **path** was provided and we were unable to read it """ if path is None: path = CACHE_PATH + elif not os.path.exists(path): + raise IOError("%s doesn't exist" % path) - with sqlite3.connect(path) as conn: - yield conn.cursor() + # TODO: When we only support python 3.4+ we can use sqlite's uri argument to + # get a read-only connection... + # + # https://docs.python.org/3/library/sqlite3.html#sqlite3.connect + + return sqlite3.connect(path) class ConfigOption(object): diff --git a/test/unit/manual.py b/test/unit/manual.py index eab9bdfc..eaca3629 100644 --- a/test/unit/manual.py +++ b/test/unit/manual.py @@ -103,9 +103,11 @@ def _cached_manual(): class TestManual(unittest.TestCase): def test_database(self): - with stem.manual.database() as cursor: - cursor.execute('SELECT description FROM torrc WHERE name="CookieAuthFile"') - self.assertEqual("If set, this option overrides the default location and file name for Tor's cookie file. (See CookieAuthentication above.)", cursor.fetchone()[0]) + with stem.manual.database() as conn: + self.assertEqual("If set, this option overrides the default location and file name for Tor's cookie file. (See CookieAuthentication above.)", conn.execute('SELECT description FROM torrc WHERE name="CookieAuthFile"').fetchone()[0]) + + def test_missing_database(self): + self.assertRaisesRegexp(IOError, "/no/such/path doesn't exist", stem.manual.database, '/no/such/path') def test_has_all_summaries(self): """

1 0