import reporters in __init__.py for ease of use w/@isidore

TODO.md

@@ -1,4 +1,3 @@
 * import reporter etc in approvaltests/__init__.py to make api easier to use.
 * assert_equal_with_reporter(expected, actual, reporter).
-* Fix LaunchReceivedFileReporter.
 * Add documentation.

approvaltests/approvals.py

@@ -5,7 +5,7 @@
 
 from approvaltests.approval_exception import ApprovalException
 from approvaltests.file_approver import FileApprover
-from approvaltests.namer import Namer
+from approvaltests.core.namer import Namer
 from approvaltests.reporters.received_file_launcher_reporter import ReceivedFileLauncherReporter
 from approvaltests.string_writer import StringWriter
 from approvaltests.reporters.diff_reporter import DiffReporter

approvaltests/core/__init__.py

@@ -0,0 +1,3 @@
+from .namer import *
+from .reporter import *
+from .writer import *

approvaltests/core/writer.py

@@ -0,0 +1,5 @@
+class Writer(object):
+    # interface
+
+    def write_received_file(self, received_file):
+        raise Exception("Interface member not implemented")

approvaltests/reporters/__init__.py

@@ -0,0 +1,5 @@
+from .clipboard_reporter import *
+from .diff_reporter import *
+from .first_working_reporter import *
+from .multi_reporter import *
+from .received_file_launcher_reporter import *

approvaltests/reporters/clipboard_reporter.py

@@ -1,6 +1,6 @@
 import pyperclip
 
-from ..reporter import Reporter
+from approvaltests.core.reporter import Reporter
 
 
 def get_command_text(received_path, approved_path):

approvaltests/reporters/diff_reporter.py

@@ -1,6 +1,6 @@
 from .first_working_reporter import FirstWorkingReporter
 from .clipboard_reporter import CommandLineReporter
-from ..generic_diff_reporter_factory import GenericDiffReporterFactory
+from approvaltests.reporters.generic_diff_reporter_factory import GenericDiffReporterFactory
 
 
 class DiffReporter(FirstWorkingReporter):

approvaltests/reporters/first_working_reporter.py

@@ -1,4 +1,4 @@
-from ..reporter import Reporter
+from approvaltests.core.reporter import Reporter
 
 
 class FirstWorkingReporter(Reporter):

approvaltests/generic_diff_reporter.py → approvaltests/reporters/generic_diff_reporter.py

@@ -3,7 +3,7 @@
 import subprocess
 
 from approvaltests.command import Command
-from approvaltests.reporter import Reporter
+from approvaltests.core.reporter import Reporter
 
 
 class GenericDiffReporter(Reporter):

approvaltests/generic_diff_reporter_factory.py → approvaltests/reporters/generic_diff_reporter_factory.py

@@ -1,8 +1,8 @@
 import inspect
 import json
 import os
-from approvaltests.generic_diff_reporter import GenericDiffReporter
-from approvaltests.namer import Namer
+from approvaltests.reporters.generic_diff_reporter import GenericDiffReporter
+from approvaltests.core.namer import Namer
 from approvaltests.utils import get_adjacent_file
 
 

approvaltests/reporters/multi_reporter.py

@@ -1,4 +1,4 @@
-from ..reporter import Reporter
+from approvaltests.core.reporter import Reporter
 
 
 class MultiReporter(Reporter):

approvaltests/reporters/received_file_launcher_reporter.py

@@ -1,5 +1,6 @@
 from subprocess import call
-from approvaltests.reporter import Reporter
+
+from approvaltests.core.reporter import Reporter
 
 
 class ReceivedFileLauncherReporter(Reporter):

approvaltests/testing_reporter.py → approvaltests/reporters/testing_reporter.py

@@ -1,4 +1,4 @@
-from approvaltests.reporter import Reporter
+from approvaltests.core.reporter import Reporter
 
 
 class TestingReporter(Reporter):

approvaltests/string_writer.py

@@ -1,4 +1,7 @@
-class StringWriter(object):
+from approvaltests.core.writer import Writer
+
+
+class StringWriter(Writer):
     contents = ''
 
     def __init__(self, contents, extension='.txt'):

examples/getting_started.py

@@ -1,7 +1,7 @@
 import unittest
 
 from approvaltests.approvals import verify
-from approvaltests.generic_diff_reporter_factory import GenericDiffReporterFactory
+from approvaltests.reporters.generic_diff_reporter_factory import GenericDiffReporterFactory
 
 
 class GettingStartedTest(unittest.TestCase):

tests/reporters/test_first_working_reporter.py

@@ -1,6 +1,6 @@
 import unittest
 
-from approvaltests.reporter import Reporter
+from approvaltests.core.reporter import Reporter
 from approvaltests.reporters.first_working_reporter import FirstWorkingReporter
 
 

tests/test_combinations.py

@@ -2,7 +2,7 @@
 
 from approvaltests.approval_exception import ApprovalException
 from approvaltests.approvals import verify_all_combinations
-from approvaltests.testing_reporter import TestingReporter
+from approvaltests.reporters.testing_reporter import TestingReporter
 
 
 class VerifyAllCombinationsTests(unittest.TestCase):

tests/test_fileapprover.py

@@ -1,11 +1,11 @@
 import shutil
 import unittest
 
+from approvaltests.core.namer import Namer
 from approvaltests.file_approver import FileApprover
-from approvaltests.generic_diff_reporter_factory import GenericDiffReporterFactory
-from approvaltests.namer import Namer
+from approvaltests.reporters.generic_diff_reporter_factory import GenericDiffReporterFactory
+from approvaltests.reporters.testing_reporter import TestingReporter
 from approvaltests.string_writer import StringWriter
-from approvaltests.testing_reporter import TestingReporter
 
 
 class FileApproverTests(unittest.TestCase):

tests/test_genericdiffreporter.py

@@ -4,9 +4,9 @@
 import unittest
 
 from approvaltests.approvals import verify
-from approvaltests.generic_diff_reporter import GenericDiffReporter
-from approvaltests.generic_diff_reporter_factory import GenericDiffReporterFactory
-from approvaltests.namer import Namer
+from approvaltests.reporters.generic_diff_reporter import GenericDiffReporter
+from approvaltests.reporters.generic_diff_reporter_factory import GenericDiffReporterFactory
+from approvaltests.core.namer import Namer
 
 
 class GenericDiffReporterTests(unittest.TestCase):

tests/test_list.py

@@ -5,7 +5,7 @@
 from approvaltests.reporters.clipboard_reporter import CommandLineReporter 
 from approvaltests.reporters.multi_reporter import MultiReporter 
 from approvaltests.reporters.diff_reporter import DiffReporter 
-from approvaltests.generic_diff_reporter import GenericDiffReporter
+from approvaltests.reporters.generic_diff_reporter import GenericDiffReporter
 
 
 class TestList(TestCase):

tests/test_namer.py

@@ -1,7 +1,7 @@
 import os
 import unittest
 
-from approvaltests.namer import Namer
+from approvaltests.core.namer import Namer
 
 
 class NamerTests(unittest.TestCase):

tests/test_verify.py

@@ -2,8 +2,8 @@
 
 from approvaltests.approval_exception import ApprovalException
 from approvaltests.approvals import verify, verify_as_json, verify_file
-from approvaltests.generic_diff_reporter_factory import GenericDiffReporterFactory
-from approvaltests.testing_reporter import TestingReporter
+from approvaltests.reporters.generic_diff_reporter_factory import GenericDiffReporterFactory
+from approvaltests.reporters.testing_reporter import TestingReporter
 from approvaltests.utils import get_adjacent_file