Fix warnings (#3)

* Show help when no args passed
* Fix landscape warnings & errors
* Fix lint warnings & add make target for publishing
* Possible conflict with variable name

Author: jia3ep

.pylintrc

@@ -0,0 +1,11 @@
+[TYPECHECK]
+ignored-classes=Header
+
+[SIMILARITIES]
+
+# Minimum lines number of a similarity.
+min-similarity-lines=7
+
+[MISCELLANEOUS]
+# List of note tags to take in consideration, separated by a comma.
+notes=FIXME,XXX

Makefile

@@ -1,19 +1,24 @@
-.PHONY: init test clean coverage lint
+.PHONY: test clean coverage lint distclean release
+
+PYTHON ?= python3
 
 test:
-	python3 -m unittest discover -v -b
+	$(PYTHON) -m unittest discover -v -b
 
 clean:
-	rm -rf test/*.pyc
-	rm -rf zxtools/*.pyc
-	rm -rf test/__pycache__
-	rm -rf zxtools/__pycache__
-	rm -rf zxtools.egg-info
+	rm -rf dist/ build/ *.egg-info
 	rm -rf coverage.xml
+	find . -name '__pycache__' | xargs rm -rf
+
+distclean: clean
 
 coverage:
 	coverage run --source zxtools setup.py test
-	coverage report -m
+	coverage report -m --fail-under=80
 
 lint:
 	pylint zxtools -f parseable -r n
+
+release: clean lint coverage clean
+	$(PYTHON) setup.py sdist bdist_wheel upload
+

setup.py

@@ -30,6 +30,7 @@
     url='http://www.codeatcpp.com',
     license='BSD-3-Clause',
     packages=find_packages(exclude=('test', 'docs')),
+    tests_require=['mock'],
     extras_require={
         'test': dev_requires,
     },

test/test_hobeta.py

@@ -17,26 +17,36 @@
 import tempfile
 from collections import namedtuple
 from zxtools import hobeta
+from zxtools import safe_parse_args
+from mock import patch
 
 
 class TestHobeta(unittest.TestCase):
     def test_args_parser(self):
         with self.assertRaises(SystemExit):
-            hobeta.parse_args(("-h", "-v"))
+            with patch('sys.argv', ["hobeta.py", "-h", "-v"]):
+                hobeta.main()
 
         with self.assertRaises(SystemExit):
-            hobeta.parse_args(())
+            with patch('sys.argv', ["hobeta.py"]):
+                hobeta.main()
+
+        with patch('sys.argv', ["hobeta.py", "hobeta-help"]):
+            hobeta.main()
+
+        args_parser = hobeta.create_parser()
 
         temp_in_file = tempfile.mkstemp()[1]
         input_file = open(temp_in_file, "w")
         input_file.close()
         temp_out_file = tempfile.mkstemp()[1]
         try:
-            args = hobeta.parse_args(("info", temp_in_file))
+            args = safe_parse_args(args_parser, ["info", temp_in_file])
             self.assertEqual(args.func, hobeta.show_info)
             args.hobeta_file.close()
 
-            args = hobeta.parse_args(("strip", temp_in_file, temp_out_file))
+            args = safe_parse_args(args_parser,
+                                   ["strip", temp_in_file, temp_out_file])
             self.assertEqual(args.func, hobeta.strip_header)
             args.hobeta_file.close()
             args.output_file.close()

test/test_zeus2txt.py

@@ -16,29 +16,36 @@
 import unittest
 from collections import namedtuple
 import logging
+from mock import patch
 
 from zxtools import zeus2txt
+from zxtools import safe_parse_args
+
 
 
 class TestZeus2Txt(unittest.TestCase):
     def test_args_parser(self):
+        args_parser = zeus2txt.create_parser()
+
         with self.assertRaises(SystemExit):
-            zeus2txt.parse_args(("-h", "-v"))
+            with patch('sys.argv', ["zeus2txt.py", "-h", "-v"]):
+                zeus2txt.main()
 
         with self.assertRaises(SystemExit):
-            zeus2txt.parse_args(())
+            with patch('sys.argv', ["zeus2txt.py"]):
+                zeus2txt.main()
 
         temp_in_file = tempfile.mkstemp()[1]
         input_file = open(temp_in_file, "w")
         input_file.close()
         temp_out_file = tempfile.mkstemp()[1]
         try:
-            args = zeus2txt.parse_args(("info", temp_in_file))
+            args = safe_parse_args(args_parser, ["info", temp_in_file])
             self.assertEqual(args.func, zeus2txt.show_info)
             args.zeus_file.close()
 
-            args = zeus2txt.parse_args(("convert",
-                                        temp_in_file, temp_out_file))
+            args = safe_parse_args(args_parser,
+                                   ["convert", temp_in_file, temp_out_file])
             self.assertEqual(args.func, zeus2txt.convert_file)
             args.zeus_file.close()
             args.output_file.close()

zxtools/__init__.py

@@ -7,6 +7,35 @@
 # Licensed under the BSD 3-Clause license.
 # See LICENSE file in the project root for full license information.
 #
+"""Global constants and templates are here"""
 
-__version__ = '1.0.22'
+import sys
+import logging
+
+__version__ = '1.0.23'
 CHUNK_SIZE = 512 * 1024  # 512 KBytes
+
+
+def safe_parse_args(parser, args):
+    """Safely parse arguments"""
+    try:
+        options = parser.parse_args(args)
+        if len(args) == 0:
+            raise ValueError
+    except ValueError:
+        parser.print_help()
+        sys.exit(0)
+
+    return options
+
+
+def default_main(parser):
+    """ Default entry point implementation """
+    args = safe_parse_args(parser, sys.argv[1:])
+    if args.verbose:
+        logging.basicConfig(level=logging.DEBUG)
+
+    if hasattr(args, 'func'):
+        args.func(args)
+
+    return args

zxtools/hobeta.py

@@ -10,13 +10,13 @@
 """ Hobeta file utils """
 
 import os
-import sys
 import logging
 import struct
 from collections import namedtuple
 import argparse
 
 from zxtools import CHUNK_SIZE
+from zxtools import default_main
 
 HEADER_FMT = '<8sBHHBBH'
 Header = namedtuple(
@@ -25,6 +25,7 @@
 
 
 def hobeta_help(*parsed_args):
+    """Shows help"""
     print(
         "Hobeta file has the following format:\n"
         "(this is according to http://speccy.info/Hobeta)\n"
@@ -120,7 +121,7 @@ def strip_header(parsed_args):
     return bytes_to_copy-length
 
 
-def parse_args(args):
+def create_parser():
     """ Parse command line arguments """
     parser = argparse.ArgumentParser(description="Hobeta files converter")
     parser.add_argument(
@@ -154,25 +155,12 @@ def parse_args(args):
         help="Show Hobeta header format description")
     help_parser.set_defaults(func=hobeta_help)
 
-    try:
-        options = parser.parse_args(args)
-        if len(args) == 0:
-            raise ValueError
-    except ValueError:
-        parser.print_help()
-        sys.exit(0)
-
-    return options
+    return parser
 
 
 def main():
-    """ Entry point """
-    args = parse_args(sys.argv[1:])
-    if args.verbose:
-        logging.basicConfig(level=logging.DEBUG)
-
-    if hasattr(args, 'func'):
-        args.func(args)
+    """Entry point"""
+    return default_main(create_parser())
 
 
 if __name__ == '__main__':

zxtools/zeus2txt.py

@@ -11,25 +11,28 @@
 
 import argparse
 import logging
-import sys
 import io
 
 from zxtools import CHUNK_SIZE
+from zxtools import default_main
 
 CODE_ALIGN_WIDTH = 35
 
 
 def show_info(*parsed_args):
+    """Show some statistic about Zeus file"""
+    # TODO Implement this function
     return parsed_args
 
 
 def read_file(src_file):
+    """Read source file for future processing"""
     with src_file:
         while True:
             chunk = src_file.read(CHUNK_SIZE)
             if chunk:
-                for b in chunk:
-                    yield b
+                for cur_char in chunk:
+                    yield cur_char
             else:
                 break
 
@@ -61,10 +64,10 @@ def convert_file(parsed_args):
     strnum = 0
     cur_buffer = ""
     cur_line = io.StringIO()
-    for b in read_file(parsed_args.zeus_file):
+    for cur_char in read_file(parsed_args.zeus_file):
         if process_string:
-            cur_buffer += "0x%02X " % b
-            if not b:  # End of string
+            cur_buffer += "0x%02X " % cur_char
+            if not cur_char:  # End of string
                 process_string = False
                 strnum_lo = False, 0
                 cur_str = cur_line.getvalue()
@@ -76,25 +79,25 @@ def convert_file(parsed_args):
                     print(file=output)
                 continue
             if tab:
-                print(" "*b, end="", file=cur_line)
+                print(" "*cur_char, end="", file=cur_line)
                 tab = False
                 continue
-            if b == 0x0A:
+            if cur_char == 0x0A:
                 tab = True
                 continue
-            if b < ASM_FIRST_TOKEN:  # Printable character
-                print(chr(b), end="", file=cur_line)
+            if cur_char < ASM_FIRST_TOKEN:  # Printable character
+                print(chr(cur_char), end="", file=cur_line)
                 continue
             try:
-                print(ASM_META[b-ASM_FIRST_TOKEN], end="", file=cur_line)
+                print(ASM_META[cur_char-ASM_FIRST_TOKEN], end="", file=cur_line)
             except IndexError:
                 logger.warning("Token not defined: 0x%02X (%d), at line %05d. "
-                               "Skipped.", b, b, strnum)
+                               "Skipped.", cur_char, cur_char, strnum)
         else:
             if not strnum_lo[0]:
-                strnum_lo = True, b
+                strnum_lo = True, cur_char
             else:
-                strnum = strnum_lo[1] + b*256
+                strnum = strnum_lo[1] + cur_char*256
                 if strnum == 0xFFFF:  # End of file
                     print(file=output)
                     break
@@ -106,7 +109,7 @@ def convert_file(parsed_args):
     output.close()
 
 
-def parse_args(args):
+def create_parser():
     """ Parse command line arguments """
     parser = argparse.ArgumentParser(
         description="Zeus Z80 assembler files converter")
@@ -137,25 +140,12 @@ def parse_args(args):
         action='store_true', help="Include original code in the output file")
     convert_parser.set_defaults(func=convert_file)
 
-    try:
-        options = parser.parse_args(args)
-        if len(args) == 0:
-            raise ValueError
-    except ValueError:
-        parser.print_help()
-        sys.exit(0)
-
-    return options
+    return parser
 
 
 def main():
-    """ Entry point """
-    args = parse_args(sys.argv[1:])
-    if args.verbose:
-        logging.basicConfig(level=logging.DEBUG)
-
-    if hasattr(args, 'func'):
-        args.func(args)
+    """Entry point"""
+    default_main(create_parser())
 
 
 if __name__ == '__main__':