enhance code coherence

Author: juangpc

tools/python/demo_recursive_folder_process.py

@@ -14,5 +14,5 @@
                                                                         else None )
 listOfFiles.sort(reverse=True, key=lambda f:f[1])
 for f in listOfFiles:
-    print('File: ' + f[0].path + ' - (' + mne_cpp.core.size_human_readable(f[1]) + ')')
+    print('File: ' + f[0].path + ' - (' + mne_cpp.core.sizeHumanReadable(f[1]) + ')')
 

tools/python/mne_cpp/core.py

@@ -42,18 +42,15 @@ def version():
     print('MNE-CPP Project python module. - Version: 0.1.9')
     print('Copyright (C) 2021, Juan Garcia-Prieto. All rights reserved.')
 
-def __currentPath():
+def __pathToThisFile():
     return path.abspath(path.dirname(sys.argv[0]))
 
 def baseFolder():
-    this_script_path = __currentPath().split(path.sep)
+    this_script_path = __pathToThisFile().split(path.sep)
     project_path = ''
     for f in this_script_path[:-2]:
         project_path += f + '/'
     return project_path
-class File_ext_separator(Enum):
-    FIRST = 1
-    LAST = 2
 
 def extractFilePaths(text: str, **inputArgs):
 
@@ -90,10 +87,10 @@ def extractFilePaths(text: str, **inputArgs):
     pattern = re.compile(expression)
     fileMatches = pattern.finditer(text)
     for f in fileMatches:
-        deviceLabel = none_if_empty(f.group('deviceLabel'))    #f.string[f.start('deviceLabel'):f.end('deviceLabel')]
-        filePath = none_if_empty(f.group('filePath'))          #f.string[f.start('filePath'):f.end('filePath')-1]
-        fileName = none_if_empty(f.group('fileName'))          #f.string[f.start('fileName'):f.end('fileName')]
-        fileExt = none_if_empty(f.group('fileExtension'))      #f.string[f.start('fileExtension'):f.end('fileExtension')]
+        deviceLabel = noneIfEmpty(f.group('deviceLabel'))    #f.string[f.start('deviceLabel'):f.end('deviceLabel')]
+        filePath = noneIfEmpty(f.group('filePath'))          #f.string[f.start('filePath'):f.end('filePath')-1]
+        fileName = noneIfEmpty(f.group('fileName'))          #f.string[f.start('fileName'):f.end('fileName')]
+        fileExt = noneIfEmpty(f.group('fileExtension'))      #f.string[f.start('fileExtension'):f.end('fileExtension')]
         absFilePath = deviceLabel + filePath + fileName + '.' + fileExt
         print(absFilePath)
     return (deviceLabel, filePath, fileName, fileExt, absFilePath)
@@ -105,7 +102,7 @@ def recursiveFolderProcess(folderPath, func):
         if file.is_file():
             func(file)
 
-def none_if_empty(s):
+def noneIfEmpty(s):
     return '' if s is None else s
 
 def parseFilePathNameExt(inText):
@@ -124,11 +121,11 @@ def parseFilePathNameExt(inText):
     fileName = ''
     fileExt = ''
     if match:
-        deviceLabel = none_if_empty(match.group('deviceLabel'))
-        filePath = none_if_empty(match.group('filePath'))
-        lastFolder = none_if_empty(match.group('lastFolder'))
-        fileName = none_if_empty(match.group('fileName'))
-        fileExt = none_if_empty(match.group('fileExt'))
+        deviceLabel = noneIfEmpty(match.group('deviceLabel'))
+        filePath = noneIfEmpty(match.group('filePath'))
+        lastFolder = noneIfEmpty(match.group('lastFolder'))
+        fileName = noneIfEmpty(match.group('fileName'))
+        fileExt = noneIfEmpty(match.group('fileExt'))
     return (deviceLabel, filePath, lastFolder, fileName, fileExt)
 
 def parseInputArguments(argsToParse, **opts):
@@ -162,7 +159,7 @@ def parseInputArguments(argsToParse, **opts):
     return (v for k, v in options.items())
 
 _suffixes = ['bytes', 'KiB', 'MiB', 'GiB', 'TiB', 'PiB', 'EiB', 'ZiB', 'YiB']
-def size_human_readable(size):
+def sizeHumanReadable(size):
     # determine binary order in steps of size 10 
     # (coerce to int, // still returns a float)
     order = int(log2(size) / 10) if size else 0
@@ -171,7 +168,7 @@ def size_human_readable(size):
     # should never resort to exponent values)
     return '{:.4g} {}'.format(size / (1 << (order * 10)), _suffixes[order])
 
-def get_list_of_files(folder):
+def getListOfFiles(folder):
     """Retrieve a list of files inside (recursive) a folder.
 
     Args:

tools/python/mne_cpp/pdf_doc.py

@@ -202,15 +202,14 @@ def parseMarkDownFile(file, **inputArgs):
             inText = parseHeaders(inText)
             inText = parseLinks(inText)
 
+def deleteJustTheDocsHeader(inText):
+    return re.sub(r'\n*\s*---\s*\n(.*\n)*---\n','',inText)
 
-def deleteJustTheDocsHeader(text):
-    return re.sub(r'\n*\s*---\s*\n(.*\n)*---\n','',text)
+def parseInlineItalicText(inText):
+    return re.sub(r'(?<=\W)((?P<star>\*)|_)(?P<itext>\w+)(?(star)\*|_)(?=\W)',r'\\textit{\g<itext>}', inText)
 
-def parseInlineItalicText(text):
-    return re.sub(r'(?<=\W)((?P<star>\*)|_)(?P<itext>\w+)(?(star)\*|_)(?=\W)',r'\\textit{\g<itext>}', text)
-
-def parseInlineBoldText(text):
-    return re.sub(r'(?<=\W)((?P<dstar>\*\*)|__)(?P<btext>[\w ]+)((?(dstar)\*\*)|__)(?=\W)',r'\\textbf{\g<btext>}', text)
+def parseInlineBoldText(inText):
+    return re.sub(r'(?<=\W)((?P<dstar>\*\*)|__)(?P<btext>[\w ]+)((?(dstar)\*\*)|__)(?=\W)',r'\\textbf{\g<btext>}', inText)
 
 def parseUnorderedList(inText):
     match = re.search(r'(\n\s?\*\s?.+)(\n\s?\*\s?(.+))*', inText)
@@ -313,11 +312,12 @@ def parseHeaders(inText):
     else:
         return inText
 
+def parseHorizontalLine(inText):
+    return re.sub(r'(?<=\n)\*\s\*\s\*(?=\n)','\\noindent\\rule{15cm}{0.5pt}', inText)
+
 # parse horizontal line 
 # \n\* \* \*
 
-mne_cpp.core.get_list_of_files
-
 # parse all lists with (\n((\s*[-*]\s*)|(\s*\d+\.\s*)).+)+
 # see https://regex101.com/r/2uKqPB/1/
 
@@ -338,11 +338,10 @@ def parseHeaders(inText):
 
 
 # still missing: 
-# ordered lists parsing
+# ordered and unordered lists parsing
 # inbound links vs outbound links
 # parse inline code
 # preamble and ending file
-# parse horizontal lines
 # parse multiple terms description/definition