Cleanup flake8 warnings related to file comments

The following flake8 errors are no longer suppressed:
 E116 unexpected indentation (comment)
 E261 at least two spaces before inline comment
 E265 block comment should start with '# '

Story: 2003499
Task: 26408
Change-Id: I17d8bbf9c1511a58a7322606f41bfbb01a841953
Signed-off-by: Al Bailey <Al.Bailey@windriver.com>

nfv/nfv-debug-tools/histogram_analysis/Histogram.py

@@ -59,17 +59,17 @@ call("gunzip logs/nfv-vim.log.[0-9].gz logs/nfv-vim.log.[0-9][0-9].gz", shell=Tr
 
 class Parser(object):
     def __init__(self):
-        self.proc = "" # Name of process being read
+        self.proc = ""  # Name of process being read
-        self.timestamp = "" # Timestamp found on line stating process name
+        self.timestamp = ""  # Timestamp found on line stating process name
-        self.write = False # Flag indicating data has yet to be written
+        self.write = False  # Flag indicating data has yet to be written
-        self.stored = False # Flag indicating that there is new data stored
+        self.stored = False  # Flag indicating that there is new data stored
-        self.length = 0 # Time duration of process
+        self.length = 0  # Time duration of process
-        self.instanceCount = 0 # Number of hits for the particular duration
+        self.instanceCount = 0  # Number of hits for the particular duration
-        self.rollingCount = 0 # Sum of the hits for each duration parsed within the sample
+        self.rollingCount = 0  # Sum of the hits for each duration parsed within the sample
-        self.total = 0 # Specific duration multiplied by number of hits for that duration
+        self.total = 0  # Specific duration multiplied by number of hits for that duration
-        self.avg = 0 # Average execution time of process
+        self.avg = 0  # Average execution time of process
-        self.unit = "" # Unit execution time was recorded in
+        self.unit = ""  # Unit execution time was recorded in
-        self.csvs = defaultdict(list) # Stores unique processes in a dict of lists
+        self.csvs = defaultdict(list)  # Stores unique processes in a dict of lists
 
     # Resets variables when a new process begins to be read in logs
     def reset(self):

nfv/nfv-debug-tools/histogram_analysis/plotter.py

@@ -55,11 +55,11 @@ dir = os.path.dirname(__file__)
 fig = plotly.graph_objs.graph_objs.Figure
 pth = os.path.join(dir, 'csv/')
 
-execTime = False # Indicates if average execution time is to be graphed or not
+execTime = False  # Indicates if average execution time is to be graphed or not
-default = False # Indicates no commands were entered and to run with default settings (run config with -t option)
+default = False  # Indicates no commands were entered and to run with default settings (run config with -t option)
-oneAxis = False # Causes the generated graph to have two y-axes sharing an x-axis with both avg execution time and hits being graphed
+oneAxis = False  # Causes the generated graph to have two y-axes sharing an x-axis with both avg execution time and hits being graphed
-config = False # Indicates whether to pull process names from logplot.cfg or not
+config = False  # Indicates whether to pull process names from logplot.cfg or not
-hits = False # Indicates if the delta of hits between samples is to be graphed
+hits = False  # Indicates if the delta of hits between samples is to be graphed
 markers = False
 lines = False
 timestamp = []
@@ -139,7 +139,7 @@ def updater(configExists=True):
     procs = []
     existingProcs = []
     newProcs = []
-    position = 0 # Tracks position of the end of the master process list so new processes can be added above it.
+    position = 0  # Tracks position of the end of the master process list so new processes can be added above it.
 
     os.chdir(pth)
     for name in iglob("*.csv"):
@@ -375,32 +375,32 @@ if not os.path.isdir('./csv'):
     print("\n\tWARNING: ./csv directory is missing. Please run Histogram.sh or make sure directory has not been renamed.\n")
     sys.exit()
 
-command = sys.argv # Takes arguments from the command line
+command = sys.argv  # Takes arguments from the command line
 
 if len(command) == 1:
     print("Running with default settings.")
     default = True
 else:
     for i in range(1, len(command)):
-        if command[i] == "-c": # Use config file
+        if command[i] == "-c":  # Use config file
             config = True
-        elif command[i] == "--g": # Groups
+        elif command[i] == "--g":  # Groups
             for j in range(i + 1, len(command)):
                 group.append(command[j])
             procs = gCommand(group)
             break
-        elif command[i] == "-t": # Average execution time
+        elif command[i] == "-t":  # Average execution time
             execTime = True
-        elif command[i] == "-h": # Delta hits between samples
+        elif command[i] == "-h":  # Delta hits between samples
             hits = True
-        elif command[i] == "-l": # Graph with lines
+        elif command[i] == "-l":  # Graph with lines
             lines = True
-        elif command[i] == "-m": # Graph with markers (scatter)
+        elif command[i] == "-m":  # Graph with markers (scatter)
             markers = True
-        elif command[i] == "-lm": # Graph with lines and markers
+        elif command[i] == "-lm":  # Graph with lines and markers
             lines = True
             markers = True
-        elif command[i] == "-d": # Date range
+        elif command[i] == "-d":  # Date range
             dateRange = command[i + 1].split('-')
             if dateRange[0]:
                 lower = dateRange[0].split("/")
@@ -413,15 +413,15 @@ else:
             else:
                 dateRange[1] = "9" * 8
             i += 1
-        elif command[i] == "-n": # Name of file to be generated
+        elif command[i] == "-n":  # Name of file to be generated
             graphName = command[i + 1]
             i += 1
-        elif command[i] == "-oneaxis": # Have hit and time data displayed on same graph
+        elif command[i] == "-oneaxis":  # Have hit and time data displayed on same graph
             oneAxis = True
-        elif (command[i] == "--help") or (command[i] == "--h"): # Print help message and exit script
+        elif (command[i] == "--help") or (command[i] == "--h"):  # Print help message and exit script
             helpMessage()
             sys.exit()
-        elif command[i] == "--p": # User-specified processes
+        elif command[i] == "--p":  # User-specified processes
             for j in range(i + 1, len(command)):
                 procs.append(command[j])
             procs = pCommand(procs)

nfv/nfv-docs/html_layout/conf.py

@@ -19,12 +19,12 @@ import shlex
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+# sys.path.insert(0, os.path.abspath('.'))
 
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -40,7 +40,7 @@ templates_path = ['_templates']
 source_suffix = '.rst'
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
 master_doc = 'index'
@@ -68,9 +68,9 @@ language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -78,27 +78,27 @@ exclude_patterns = []
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 # If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
+# keep_warnings = False
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -113,26 +113,26 @@ html_theme = 'alabaster'
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+# html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -142,62 +142,62 @@ html_static_path = ['_static']
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.
-#html_extra_path = []
+# html_extra_path = []
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Language to be used for generating the HTML full-text search index.
 # Sphinx supports the following languages:
 #   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
 #   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
-#html_search_language = 'en'
+# html_search_language = 'en'
 
 # A dictionary with options for the search language support, empty by default.
 # Now only 'ja' uses this config value
-#html_search_options = {'type': 'default'}
+# html_search_options = {'type': 'default'}
 
 # The name of a javascript file (relative to the configuration directory) that
 # implements a search results scorer. If empty, the default will be used.
-#html_search_scorer = 'scorer.js'
+# html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'VIMdoc'
@@ -206,16 +206,16 @@ htmlhelp_basename = 'VIMdoc'
 
 latex_elements = {
 # The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+# 'papersize': 'letterpaper',
 
 # The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
+# 'pointsize': '10pt',
 
 # Additional stuff for the LaTeX preamble.
-#'preamble': '',
+# 'preamble': '',
 
 # Latex figure (float) alignment
-#'figure_align': 'htbp',
+# 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
@@ -228,23 +228,23 @@ latex_documents = [
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output ---------------------------------------
@@ -257,7 +257,7 @@ man_pages = [
 ]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -272,16 +272,16 @@ texinfo_documents = [
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
+# texinfo_no_detailmenu = False
 
 
 # -- Options for Epub output ----------------------------------------------
@@ -293,62 +293,62 @@ epub_publisher = author
 epub_copyright = copyright
 
 # The basename for the epub file. It defaults to the project name.
-#epub_basename = project
+# epub_basename = project
 
 # The HTML theme for the epub output. Since the default themes are not optimized
 # for small screen space, using the same theme for HTML and epub output is
 # usually not wise. This defaults to 'epub', a theme designed to save visual
 # space.
-#epub_theme = 'epub'
+# epub_theme = 'epub'
 
 # The language of the text. It defaults to the language option
 # or 'en' if the language is not set.
-#epub_language = ''
+# epub_language = ''
 
 # The scheme of the identifier. Typical schemes are ISBN or URL.
-#epub_scheme = ''
+# epub_scheme = ''
 
 # The unique identifier of the text. This can be a ISBN number
 # or the project homepage.
-#epub_identifier = ''
+# epub_identifier = ''
 
 # A unique identification for the text.
-#epub_uid = ''
+# epub_uid = ''
 
 # A tuple containing the cover image and cover page html template filenames.
-#epub_cover = ()
+# epub_cover = ()
 
 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
-#epub_guide = ()
+# epub_guide = ()
 
 # HTML files that should be inserted before the pages created by sphinx.
 # The format is a list of tuples containing the path and title.
-#epub_pre_files = []
+# epub_pre_files = []
 
 # HTML files shat should be inserted after the pages created by sphinx.
 # The format is a list of tuples containing the path and title.
-#epub_post_files = []
+# epub_post_files = []
 
 # A list of files that should not be packed into the epub file.
 epub_exclude_files = ['search.html']
 
 # The depth of the table of contents in toc.ncx.
-#epub_tocdepth = 3
+# epub_tocdepth = 3
 
 # Allow duplicate toc entries.
-#epub_tocdup = True
+# epub_tocdup = True
 
 # Choose between 'default' and 'includehidden'.
-#epub_tocscope = 'default'
+# epub_tocscope = 'default'
 
 # Fix unsupported image types using the Pillow.
-#epub_fix_images = False
+# epub_fix_images = False
 
 # Scale large images.
-#epub_max_image_width = 0
+# epub_max_image_width = 0
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#epub_show_urls = 'inline'
+# epub_show_urls = 'inline'
 
 # If false, no index is generated.
-#epub_use_index = True
+# epub_use_index = True

tox.ini

@@ -26,7 +26,6 @@ commands =
 
 [flake8]
 # Temporarily ignoring these warnings
-# E116 unexpected indentation (comment)
 # E121 continuation line under-indented for hanging indent
 # E122 continuation line missing indentation or outdented
 # E123 closing bracket does not match indentation of opening bracket
@@ -35,8 +34,6 @@ commands =
 # E127 continuation line over-indented for visual indent
 # E128 continuation line under-indented for visual indent
 # E129 visually indented line with same indent as next logical line
-# E261 at least two spaces before inline comment
-# E265 block comment should start with '# '
 # E501 line too long
 # E712 comparison to bool should be reworded
 # - hacking codes -
@@ -51,7 +48,7 @@ commands =
 # - flake8 codes -
 # F401 '<module>' imported but unused
 # F821 undefined name 'unicode' (python3 specific)
-ignore = E116,E121,E122,E123,E124,E126,E127,E128,E129,E261,E265,E501,E712,
+ignore = E121,E122,E123,E124,E126,E127,E128,E129,E501,E712,
          H102,H104,H301,H306,H401,H404,H405,H501,
          F401,F821,
 # H106 Don’t put vim configuration in source files (off by default).