Make package simpler to use

This would allow ln2sql to be used as:

from ln2sql import Ln2sql

ln2obj = Ln2sql(<database>, <language>)
ln2obj.get_query('input sentence')

Author: shashank-smarkets

Makefile

@@ -2,4 +2,6 @@ clean:
 	rm -rf *.json *.pyc
 test:
 	pytest
-	rm -rf *.json *.pyc
+	rm -rf *.json *.pyc
+lint:
+	pep8 .

ln2sql/__init__.py

@@ -0,0 +1 @@
+from .ln2sql import Ln2sql

ln2sql/database.py

@@ -1,4 +1,5 @@
-import os, re
+import os
+import re
 
 from .constants import Color
 from .table import Table

ln2sql/langConfig.py

@@ -1,4 +1,5 @@
-import os, unicodedata
+import os
+import unicodedata
 
 
 class LangConfig:

ln2sql/ln2sql.py

@@ -14,46 +14,47 @@ def __init__(
             self,
             database_path,
             language_path,
-            input_sentence,
             json_output_path=None,
             thesaurus_path=None,
             stopwords_path=None,
     ):
 
         database = Database()
-        stopwordsFilter = None
+        self.stopwordsFilter = None
 
         if thesaurus_path:
             thesaurus = Thesaurus()
             thesaurus.load(thesaurus_path)
             database.set_thesaurus(thesaurus)
 
         if stopwords_path:
-            stopwordsFilter = StopwordFilter()
-            stopwordsFilter.load(stopwords_path)
+            self.stopwordsFilter = StopwordFilter()
+            self.stopwordsFilter.load(stopwords_path)
 
         database.load(database_path)
         # database.print_me()
 
         config = LangConfig()
         config.load(language_path)
 
-        parser = Parser(database, config)
+        self.parser = Parser(database, config)
+        self.json_output_path = json_output_path
 
-        queries = parser.parse_sentence(input_sentence, stopwordsFilter)
+    def get_query(self, input_sentence):
+        queries = self.parser.parse_sentence(input_sentence, self.stopwordsFilter)
 
-        if json_output_path:
+        if self.json_output_path:
             self.remove_json(json_output_path)
             for query in queries:
-                query.print_json(json_output_path)
+                query.print_json(self.json_output_path)
+
+        full_query = ''
 
-        self.full_query = ''
         for query in queries:
-            self.full_query += str(query)
+            full_query += str(query)
             print(query)
 
-    def get_query(self):
-        return self.full_query
+        return full_query
 
     def remove_json(self, filename="output.json"):
         if os.path.exists(filename):

ln2sql/ln2sql_gui.py

@@ -94,9 +94,9 @@ def lanch_parsing(self):
             if (str(self.database_path_label["text"]) != "No SQL dump selected...") and (
                         str(self.language_path_label["text"]) != "No configuration file selected...") and (
                         str(self.input_sentence_string.get()) != "Enter a sentence..."):
-                Ln2sql(self.database_path_label["text"], self.input_sentence_string.get(),
+                Ln2sql(self.database_path_label["text"],
                        self.language_path_label["text"], thesaurus_path=thesaurus_path,
-                       json_output_path='./output.json')
+                       json_output_path='./output.json').get_query(self.input_sentence_string.get())
                 showinfo('Result', 'Parsing done!')
             else:
                 showwarning('Warning', 'You must fill in all fields, please.')

ln2sql/main.py

@@ -2,6 +2,7 @@
 
 from .ln2sql import Ln2sql
 
+
 def main():
     arg_parser = argparse.ArgumentParser(description='A Utility to convert Natural Language to SQL query')
     arg_parser.add_argument('-d', '--database', help='Path to SQL dump file', required=True)
@@ -13,15 +14,13 @@ def main():
 
     args = arg_parser.parse_args()
 
-    Ln2sql(
+    ln2sql = Ln2sql(
         database_path=args.database,
         language_path=args.language,
-        input_sentence=args.sentence,
         json_output_path=args.json_output,
         thesaurus_path=args.thesaurus,
         stopwords_path=args.stopwords,
-    )
-
+    ).get_query(args.sentence)
 
 if __name__ == '__main__':
     main()

tests/test_thesaurus.py

@@ -1,4 +1,5 @@
-import os, re
+import os
+import re
 
 from ln2sql.ln2sql import Ln2sql
 
@@ -96,5 +97,5 @@ def test_main():
 
     for test in thesaurusTest:
         assert _clean_output(Ln2sql(
-            test['database'], test['language'], test['input'], thesaurus_path=test['thesaurus']
-        ).get_query()) == test['output']
+            test['database'], test['language'], thesaurus_path=test['thesaurus']
+        ).get_query(test['input'])) == test['output']

tests/test_unit.py

@@ -1,4 +1,5 @@
-import os, re
+import os
+import re
 
 import pytest
 
@@ -195,7 +196,7 @@ def test_main():
 
     for test in correctTest:
         assert _clean_output(
-            Ln2sql(test['database'], test['language'], test['input']).get_query()
+            Ln2sql(test['database'], test['language']).get_query(test['input'])
         ) == test['output']
 
 
@@ -231,4 +232,4 @@ def test_exception():
     ]
     for test in errorTest:
         with pytest.raises(Exception):
-            Ln2sql(test['database'], test['language'], test['input']).get_query()
+            Ln2sql(test['database'], test['language']).get_query(test['input'])