Fix showstopper bugs; misc tweaks

* Fix showstopper superhelp.this() bug
* Push settings named tuple changes throughout code
* Improve comment on constants
* Bump version

Author: grantps

README.md

@@ -2,7 +2,7 @@
 
 ![Example HTML output](https://github.com/grantps/superhelp/raw/master/superhelp_logo_padded_small.png)
 
-version number: 1.0.12
+version number: 1.1.0
 author: Grant Paton-Simpson
 
 ## Overview

setup.py

@@ -2,7 +2,7 @@
 from codecs import open
 from os import path
 
-__version__ = '1.0.12'
+__version__ = '1.1.0'
 
 here = path.abspath(path.dirname(__file__))
 

superhelp/__init__.py

@@ -0,0 +1 @@
+from .helper import this

superhelp/conf.py

@@ -26,11 +26,10 @@
 ## When testing user-supplied snippets watch out for the BOM MS inserts via Notepad. AST chokes on it.
 ## All snippets here should be raw strings (see https://stackoverflow.com/questions/53636723/python-parsing-code-with-new-line-character-in-them-using-ast)
 TEST_SNIPPET = r"""
-for i in range(2):
-    if var == 123:
-        print(var)
-    if var == 678:
-        print(var)
+class Product:
+
+    def set_id(self, id):
+        self.id = id
 """
 
 PY3_6 = '3.6'

superhelp/displayers/cli_displayer.py

@@ -1,4 +1,3 @@
-import logging
 from textwrap import dedent
 
 from .cli_extras import md2cli
@@ -12,6 +11,8 @@
 
 Lots in common with md displayer but risks of DRYing probably outweigh benefits
 at this stage.
+
+Probably should swap out for https://github.com/willmcgugan/rich
 """
 
 from .. import conf

superhelp/gen_utils.py

@@ -537,14 +537,14 @@ def _get_tidy_paragraph(raw_paragraph):
     lines are split to MAX_STD_LINE_LEN.
 
     Remove lead and trailing new-lines - at the end there will always be two
-    new-line characters added to the start. 
+    new-line characters added to the start.
 
     :rtype: str
     """
     ## strip external new-line characters
     paragraph = raw_paragraph.strip()
     ## remove supplied internal line-splitting
-    one_line_paragraph = paragraph.replace('\n', ' ')  ## 
+    one_line_paragraph = paragraph.replace('\n', ' ')
     needs_resplitting = _needs_resplitting_into_lines(one_line_paragraph)
     if needs_resplitting:
         wrapped_paragraph_lines = wrap(

superhelp/helper.py

@@ -110,9 +110,7 @@ def get_code_help(code, *, file_path=None,
         deferred_display = None
     return deferred_display
 
-def get_script_help(file_path, *,
-        output=conf.HTML, detail_level=conf.EXTRA, theme_name=None,
-        warnings_only=False, execute_code=True, run_context=None):
+def get_script_help(file_path, *, output_settings=None,run_context=None):
     with open(file_path) as f:
         code = f.read()
     code = code.strip('\n')
@@ -124,9 +122,7 @@ def get_script_help(file_path, *,
         .replace('\nthis(', '\n# this(')
     )
     get_code_help(code, file_path=file_path,
-        output=output, theme_name=theme_name, detail_level=detail_level,
-        warnings_only=warnings_only, execute_code=execute_code,
-        run_context=run_context)
+        output_settings=output_settings, run_context=run_context)
 
 def _get_file_paths(project_path, exclude_folders):
     """

superhelp/helpers/magic_num_help.py

@@ -45,7 +45,7 @@ def magic_number(block_dets, *, repeat=False, **_kwargs):
             +
             layout("""\
             or the snippet using "constant" SECONDS_IN_DAY, which has an obvious
-            meaning: 
+            meaning:
             """)
             +
             layout("""\
@@ -57,9 +57,11 @@ def magic_number(block_dets, *, repeat=False, **_kwargs):
             Named constants are much more semantic i.e. readable. They clearly
             express their meaning.
 
-            Note - Python doesn't really have constants as such but it is
-            conventional to use SCREAMING_SNAKE_CASE (capitals joined by
-            underscores) to indicate a variable should be treated as a constant.
+            A constant is a value which is fixed throughout the program e.g.
+            SCREEN_WIDTH, PI, or GRAVITY. Note - Python doesn't really have
+            constants as such but it is conventional to use SCREAMING_SNAKE_CASE
+            (capitals joined by underscores) to indicate a variable should be
+            treated as a constant.
 
             Magic numbers make it hard to understand the code. They certainly
             make it more difficult to maintain and develop in the future when