Make cosmetic changes for higher pylint-score

Author: aradi

docs/conf.py

@@ -12,6 +12,8 @@
 #
 import os
 import sys
+import doctest
+
 sys.path.insert(0, os.path.abspath('../src'))
 
 # -- Project information -----------------------------------------------------
@@ -37,6 +39,8 @@
 
 autodoc_member_order = 'bysource'
 
+doctest_default_flags = doctest.NORMALIZE_WHITESPACE
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

src/hsd/__init__.py

@@ -7,10 +7,10 @@
 """
 Toolbox for reading, writing and manipulating HSD-data.
 """
-from .common import HSD_ATTRIB_LINE, HSD_ATTRIB_EQUAL, HSD_ATTRIB_SUFFIX,\
+from hsd.common import HSD_ATTRIB_LINE, HSD_ATTRIB_EQUAL, HSD_ATTRIB_SUFFIX,\
      HSD_ATTRIB_NAME, HsdError
-from .dict import HsdDictBuilder, HsdDictWalker
-from .eventhandler import HsdEventHandler, HsdEventPrinter
-from .formatter import HsdFormatter
-from .io import load, load_string, dump, dump_string
-from .parser import HsdParser
+from hsd.dict import HsdDictBuilder, HsdDictWalker
+from hsd.eventhandler import HsdEventHandler, HsdEventPrinter
+from hsd.formatter import HsdFormatter
+from hsd.io import load, load_string, dump, dump_string
+from hsd.parser import HsdParser

src/hsd/dict.py

@@ -9,9 +9,9 @@
 """
 import re
 from typing import List, Tuple, Union
-from .common import np, ATTRIB_SUFFIX, HSD_ATTRIB_SUFFIX, HsdError,\
+from hsd.common import np, ATTRIB_SUFFIX, HSD_ATTRIB_SUFFIX, HsdError,\
     QUOTING_CHARS, SPECIAL_CHARS
-from .eventhandler import HsdEventHandler, HsdEventPrinter
+from hsd.eventhandler import HsdEventHandler, HsdEventPrinter
 
 _ItemType = Union[float, int, bool, str]
 
@@ -106,7 +106,7 @@ def close_tag(self, tagname):
 
     def add_text(self, text):
         if self._curblock or self._data is not None:
-            msg = f"Data appeared in an invalid context"
+            msg = "Data appeared in an invalid context"
             raise HsdError(msg)
         self._data = self._text_to_data(text)
 
@@ -215,14 +215,13 @@ def _item_to_hsd(item):
 
     if isinstance(item, bool):
         return "Yes" if item else "No"
-    elif isinstance(item, (int, float)):
+    if isinstance(item, (int, float)):
         return str(item)
-    elif isinstance(item, str):
+    if isinstance(item, str):
         return _str_to_hsd(item)
-    else:
-        msg = "Data type {} can not be converted to HSD string"\
-              .format(type(item))
-        raise TypeError(msg)
+    msg = "Data type {} can not be converted to HSD string"\
+            .format(type(item))
+    raise TypeError(msg)
 
 
 def _str_to_hsd(string):

src/hsd/io.py

@@ -8,9 +8,9 @@
 """
 import io
 from typing import Union, TextIO
-from .dict import HsdDictWalker, HsdDictBuilder
-from .formatter import HsdFormatter
-from .parser import HsdParser
+from hsd.dict import HsdDictWalker, HsdDictBuilder
+from hsd.formatter import HsdFormatter
+from hsd.parser import HsdParser
 
 
 _INDENT_STR = "  "
@@ -48,8 +48,8 @@ def load(hsdfile: Union[TextIO, str], lower_tag_names: bool = False,
     parser = HsdParser(eventhandler=dictbuilder,
                        lower_tag_names=lower_tag_names)
     if isinstance(hsdfile, str):
-        with open(hsdfile, "r") as hsdfile:
-            parser.parse(hsdfile)
+        with open(hsdfile, "r") as hsddescr:
+            parser.parse(hsddescr)
     else:
         parser.parse(hsdfile)
     return dictbuilder.hsddict
@@ -92,20 +92,23 @@ def load_string(
         ... }
         ... \"\"\"
         >>> hsd.load_string(hsdstr)
-        {'Dftb': {'Scc': True, 'Filling': {'Fermi': {'Temperature': 100, 'Temperature.attrib': 'Kelvin'}}}}
+        {'Dftb': {'Scc': True, 'Filling': {'Fermi': {'Temperature': 100,
+        'Temperature.attrib': 'Kelvin'}}}}
 
         In order to ease the case-insensitive handling of the input, the tag
         names can be converted to lower case during reading using the
         ``lower_tag_names`` option.
 
         >>> hsd.load_string(hsdstr, lower_tag_names=True)
-        {'dftb': {'scc': True, 'filling': {'fermi': {'temperature': 100, 'temperature.attrib': 'Kelvin'}}}}
+        {'dftb': {'scc': True, 'filling': {'fermi': {'temperature': 100,
+        'temperature.attrib': 'Kelvin'}}}}
 
         The original tag names (together with additional information like the
         line number of a tag) can be recorded, if the ``include_hsd_attribs``
         option is set:
 
-        >>> data = hsd.load_string(hsdstr, lower_tag_names=True, include_hsd_attribs=True)
+        >>> data = hsd.load_string(hsdstr, lower_tag_names=True,
+        ... include_hsd_attribs=True)
 
         Each tag in the dictionary will have a corresponding ".hsdattrib" entry
         with the recorded data:
@@ -117,12 +120,14 @@ def load_string(
         original style, when writing the data in HSD-format again. Compare:
 
         >>> hsd.dump_string(data)
-        'dftb {\\n  scc = Yes\\n  filling {\\n    fermi {\\n      temperature [Kelvin] = 100\\n    }\\n  }\\n}\\n'
+        'dftb {\\n  scc = Yes\\n  filling {\\n    fermi {\\n
+        temperature [Kelvin] = 100\\n    }\\n  }\\n}\\n'
 
         versus
 
         >>> hsd.dump_string(data, use_hsd_attribs=True)
-        'Dftb {\\n  Scc = Yes\\n  Filling {\\n    Fermi {\\n      Temperature [Kelvin] = 100\\n    }\\n  }\\n}\\n'
+        'Dftb {\\n  Scc = Yes\\n  Filling {\\n    Fermi {\\n
+        Temperature [Kelvin] = 100\\n    }\\n  }\\n}\\n'
 
     """
     fobj = io.StringIO(hsdstr)
@@ -155,8 +160,8 @@ def dump(data: dict, hsdfile: Union[TextIO, str],
         msg = "Invalid object type"
         raise TypeError(msg)
     if isinstance(hsdfile, str):
-        with open(hsdfile, "w") as hsdfile:
-            _dump_dict(data, hsdfile, use_hsd_attribs)
+        with open(hsdfile, "w") as hsddescr:
+            _dump_dict(data, hsddescr, use_hsd_attribs)
     else:
         _dump_dict(data, hsdfile, use_hsd_attribs)
 
@@ -186,7 +191,8 @@ def dump_string(data: dict, use_hsd_attribs: bool = False) -> str:
         ...     }
         ... }
         >>> hsd.dump_string(hsdtree)
-        'Dftb {\\n  Scc = Yes\\n  Filling {\\n    Fermi {\\n      Temperature [Kelvin] = 100\\n    }\\n  }\\n}\\n'
+        'Dftb {\\n  Scc = Yes\\n  Filling {\\n    Fermi {\\n
+        Temperature [Kelvin] = 100\\n    }\\n  }\\n}\\n'
 
         See also :func:`hsd.load_string` for an example.
 

src/hsd/parser.py

@@ -8,8 +8,8 @@
 Contains the event-generating HSD-parser.
 """
 from typing import Optional, TextIO, Union
-import hsd.common as common
-from .eventhandler import HsdEventHandler, HsdEventPrinter
+from hsd import common
+from hsd.eventhandler import HsdEventHandler, HsdEventPrinter
 
 
 SYNTAX_ERROR = 1
@@ -49,7 +49,8 @@ class HsdParser:
         ... \"\"\")
         >>> parser.parse(hsdfile)
         >>> dictbuilder.hsddict
-        {'Hamiltonian': {'Dftb': {'Scc': True, 'Filling': {'Fermi': {'Temperature': 100, 'Temperature.attrib': 'Kelvin'}}}}}
+        {'Hamiltonian': {'Dftb': {'Scc': True, 'Filling': {'Fermi':
+        {'Temperature': 100, 'Temperature.attrib': 'Kelvin'}}}}}
     """
 
     def __init__(self, eventhandler: Optional[HsdEventHandler] = None,
@@ -291,9 +292,8 @@ def _include_hsd(self, fname):
     @staticmethod
     def _include_txt(fname):
         fname = common.unquote(fname.strip())
-        fp = open(fname, "r")
-        txt = fp.read()
-        fp.close()
+        with open(fname, "r") as fp:
+            txt = fp.read()
         return txt