refactor: module and package with same name is bad

Author: jacobdadams

src/auditor/cli.py

@@ -29,7 +29,7 @@
 from supervisor.models import MessageDetails, Supervisor
 from supervisor.message_handlers import SendGridHandler
 
-from .auditor import Auditor, credentials
+from auditor.models import Auditor, credentials
 
 
 def cli():

src/auditor/auditor.py renamed to src/auditor/models.py

@@ -1,5 +1,5 @@
 """
-auditor.py
+models.py
 
 See cli.py for usage
 """
@@ -14,7 +14,7 @@
 import arcgis
 import arcpy
 
-from . import checks, fixes, credentials, org_checker
+from auditor import checks, fixes, credentials, org_checker
 
 
 def retry(worker, verbose=True, tries=1):

tests/test_auditor.py

@@ -3,7 +3,7 @@
 
 from collections import namedtuple
 
-from auditor.auditor import Auditor, retry, Metatable
+from auditor.models import Auditor, retry, Metatable
 
 
 def test_retry():
@@ -29,7 +29,7 @@ def return_sgid_row(self, table, fields):
 
     sgid_fields = ['TABLENAME', 'AGOL_ITEM_ID', 'AGOL_PUBLISHED_NAME', 'Authoritative']
 
-    mocker.patch('auditor.auditor.Metatable._cursor_wrapper', return_sgid_row)
+    mocker.patch('auditor.models.Metatable._cursor_wrapper', return_sgid_row)
 
     test_table = Metatable()
     test_table.read_metatable('something', sgid_fields)
@@ -47,7 +47,7 @@ def return_agol_row(self, table, fields):
 
     agol_fields = ['TABLENAME', 'AGOL_ITEM_ID', 'AGOL_PUBLISHED_NAME', 'CATEGORY']
 
-    mocker.patch('auditor.auditor.Metatable._cursor_wrapper', return_agol_row)
+    mocker.patch('auditor.models.Metatable._cursor_wrapper', return_agol_row)
 
     test_table = Metatable()
     test_table.read_metatable('something', agol_fields)
@@ -64,7 +64,7 @@ def return_sgid_row(self, table, fields):
 
     sgid_fields = ['TABLENAME', 'AGOL_ITEM_ID', 'AGOL_PUBLISHED_NAME', 'Authoritative']
 
-    mocker.patch('auditor.auditor.Metatable._cursor_wrapper', return_sgid_row)
+    mocker.patch('auditor.models.Metatable._cursor_wrapper', return_sgid_row)
 
     test_table = Metatable()
     test_table.read_metatable('something', sgid_fields)
@@ -82,7 +82,7 @@ def return_sgid_row(self, table, fields):
 
     sgid_fields = ['TABLENAME', 'AGOL_ITEM_ID', 'AGOL_PUBLISHED_NAME', 'Authoritative']
 
-    mocker.patch('auditor.auditor.Metatable._cursor_wrapper', return_sgid_row)
+    mocker.patch('auditor.models.Metatable._cursor_wrapper', return_sgid_row)
 
     test_table = Metatable()
     test_table.read_metatable('something', sgid_fields)
@@ -101,7 +101,7 @@ def return_sgid_row(self, table, fields):
 
     sgid_fields = ['TABLENAME', 'AGOL_ITEM_ID', 'AGOL_PUBLISHED_NAME', 'Authoritative']
 
-    mocker.patch('auditor.auditor.Metatable._cursor_wrapper', return_sgid_row)
+    mocker.patch('auditor.models.Metatable._cursor_wrapper', return_sgid_row)
 
     test_table = Metatable()
     test_table.read_metatable('something', sgid_fields)
@@ -128,12 +128,12 @@ def return_agol_row(self, table, fields):
     sgid_fields = ['TABLENAME', 'AGOL_ITEM_ID', 'AGOL_PUBLISHED_NAME', 'Authoritative']
     agol_fields = ['TABLENAME', 'AGOL_ITEM_ID', 'AGOL_PUBLISHED_NAME', 'CATEGORY']
 
-    mocker.patch('auditor.auditor.Metatable._cursor_wrapper', return_sgid_row)
+    mocker.patch('auditor.models.Metatable._cursor_wrapper', return_sgid_row)
 
     test_table = Metatable()
     test_table.read_metatable('something', sgid_fields)
 
-    mocker.patch('auditor.auditor.Metatable._cursor_wrapper', return_agol_row)
+    mocker.patch('auditor.models.Metatable._cursor_wrapper', return_agol_row)
     test_table.read_metatable('agol something', agol_fields)
 
     #: Our duplicate id should be the only entry in .duplicate_keys and .metatable_dict should just have first item
@@ -150,7 +150,7 @@ def test_org_checker_completes_and_logs(mocker, caplog):
     agol_item = namedtuple('agol_item', ['title', 'itemid'])
     item_list = [agol_item('foo', 1), agol_item('foo', 2)]
 
-    mocker.patch('auditor.auditor.Auditor.setup')
+    mocker.patch('auditor.models.Auditor.setup')
 
     test_auditor = Auditor(cli_logger, verbose=True)
     test_auditor.items_to_check = item_list
@@ -168,7 +168,7 @@ def test_org_checker_reports_no_results(mocker, caplog):
     agol_item = namedtuple('agol_item', ['title', 'itemid'])
     item_list = [agol_item('foo', 1), agol_item('bar', 2)]
 
-    mocker.patch('auditor.auditor.Auditor.setup')
+    mocker.patch('auditor.models.Auditor.setup')
 
     test_auditor = Auditor(cli_logger, verbose=True)
     test_auditor.items_to_check = item_list

tests/test_checks.py

@@ -7,7 +7,7 @@
 
 from auditor import credentials
 from auditor import checks
-from auditor.auditor import Auditor
+from auditor.models import Auditor
 
 # @pytest.fixture
 # def agol_item():