stevearc / dql / 395

pending completion

Build # 395

Build Type

push

travis-ci

Committed by

web-flow

Commit Message

Merge pull request #41 from jspreddy/sai/save_history

Feature: Retain query history across sessions.

Run Details

739 of 1262 branches covered (58.56%)

44 of 44 new or added lines in 3 files covered. (100.0%)

2232 of 3095 relevant lines covered (72.12%)

0.72 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

83.33

/dql/history.py

import os
from pathlib import Path
from typing import Optional


class HistoryManager(object):
    _initial_history_length = 0

    def _create_file_if_not_exists(self, path: str) -> None:
        with open(path, "a"):
            pass

    def _prep_history_file(self, history_dir: Optional[str] = None) -> str:
        """
        Will return the path to the prepared hisory file.
        Prepping involves creating the dirs and the file itself.

        Returns
        -------
            str The path to the history file.
        """
        default_history_dir = os.path.join(Path.home(), ".dql")
        actual_history_dir = history_dir or default_history_dir
        os.makedirs(actual_history_dir, exist_ok=True)
        history_file = os.path.join(actual_history_dir, "history")
        self._create_file_if_not_exists(history_file)
        return history_file

    def try_to_load_history(self, history_dir: Optional[str] = None) -> None:
        history_file = self._prep_history_file(history_dir)
        try:
            import readline
        except ImportError:
            # Windows doesn't have readline, so gracefully ignore.
            pass
        else:
            readline.read_history_file(history_file)
            self._initial_history_length = readline.get_current_history_length()

    def try_to_write_history(self, history_dir: Optional[str] = None) -> None:
        history_file = self._prep_history_file(history_dir)
        try:
            import readline
        except ImportError:
            # Windows doesn't have readline, so gracefully ignore.
            pass
        else:
            current_history_length = readline.get_current_history_length()
            new_history_length = current_history_length - self._initial_history_length
            if new_history_length < 0:
                raise Exception(
                    f"Unable to write new history. Length is less than 0. ({current_history_length} - {self._initial_history_length})"
                )
            else:
                # append will fail if the file does not exist.
                readline.append_history_file(new_history_length, history_file)

1	import os	1✔
2	from pathlib import Path	1✔
3	from typing import Optional	1✔
4
5
6	class HistoryManager(object):	1✔
7	_initial_history_length = 0	1✔
8
9	def _create_file_if_not_exists(self, path: str) -> None:	1✔
10	with open(path, "a"):	1✔
11	pass	1✔
12
13	def _prep_history_file(self, history_dir: Optional[str] = None) -> str:	1✔
14	"""
15	Will return the path to the prepared hisory file.
16	Prepping involves creating the dirs and the file itself.
17
18	Returns
19	-------
20	str The path to the history file.
21	"""
22	default_history_dir = os.path.join(Path.home(), ".dql")	1✔
23	actual_history_dir = history_dir or default_history_dir	1✔
24	os.makedirs(actual_history_dir, exist_ok=True)	1✔
25	history_file = os.path.join(actual_history_dir, "history")	1✔
26	self._create_file_if_not_exists(history_file)	1✔
27	return history_file	1✔
28
29	def try_to_load_history(self, history_dir: Optional[str] = None) -> None:	1✔
30	history_file = self._prep_history_file(history_dir)	1✔
31	try:	1✔
32	import readline	1✔
33	except ImportError:	×
34	# Windows doesn't have readline, so gracefully ignore.
35	pass	×
36	else:
37	readline.read_history_file(history_file)	1✔
38	self._initial_history_length = readline.get_current_history_length()	1✔
39
40	def try_to_write_history(self, history_dir: Optional[str] = None) -> None:	1✔
41	history_file = self._prep_history_file(history_dir)	1✔
42	try:	1✔
43	import readline	1✔
44	except ImportError:	×
45	# Windows doesn't have readline, so gracefully ignore.
46	pass	×
47	else:
48	current_history_length = readline.get_current_history_length()	1✔
49	new_history_length = current_history_length - self._initial_history_length	1✔
50	if new_history_length < 0:	1!
51	raise Exception(	×
52	f"Unable to write new history. Length is less than 0. ({current_history_length} - {self._initial_history_length})"
53	)
54	else:
55	# append will fail if the file does not exist.
56	readline.append_history_file(new_history_length, history_file)	1✔

stevearc / dql / 395

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous