From 55e66f5ad1fecb02bcb9782265303e20756b5cb9 Mon Sep 17 00:00:00 2001 From: Stefan Rado Date: Tue, 18 Feb 2014 22:07:42 +0100 Subject: Rename Scanner and Parser classes to SourceScanner and SourceParser to avoid naming conflicts. --- Tools/px4params/px_process_params.py | 10 +++++----- Tools/px4params/scanner.py | 30 ------------------------------ Tools/px4params/srcparser.py | 2 +- Tools/px4params/srcscanner.py | 30 ++++++++++++++++++++++++++++++ 4 files changed, 36 insertions(+), 36 deletions(-) delete mode 100644 Tools/px4params/scanner.py create mode 100644 Tools/px4params/srcscanner.py (limited to 'Tools') diff --git a/Tools/px4params/px_process_params.py b/Tools/px4params/px_process_params.py index 7799f6348..8503a2f4c 100755 --- a/Tools/px4params/px_process_params.py +++ b/Tools/px4params/px_process_params.py @@ -39,19 +39,19 @@ # definitions, and outputs list of parameters in XML and DokuWiki formats. # -import scanner +import srcscanner import srcparser import output_xml import output_dokuwiki_tables import output_dokuwiki_listings # Initialize parser -prs = srcparser.Parser() +parser = srcparser.SourceParser() # Scan directories, and parse the files -sc = scanner.Scanner() -sc.ScanDir("../../src", prs) -groups = prs.GetParamGroups() +scanner = srcscanner.SourceScanner() +scanner.ScanDir("../../src", parser) +groups = parser.GetParamGroups() # Output into XML out = output_xml.XMLOutput(groups) diff --git a/Tools/px4params/scanner.py b/Tools/px4params/scanner.py deleted file mode 100644 index 43fd35e60..000000000 --- a/Tools/px4params/scanner.py +++ /dev/null @@ -1,30 +0,0 @@ -import os -import re -import codecs - -class Scanner(object): - """ - Traverses directory tree, reads all source files, and passes their contents - to the Parser. - """ - - def ScanDir(self, srcdir, parser): - """ - Scans provided path and passes all found contents to the parser using - parser.Parse method. - """ - extensions = tuple(parser.GetSupportedExtensions()) - for dirname, dirnames, filenames in os.walk(srcdir): - for filename in filenames: - if filename.endswith(extensions): - path = os.path.join(dirname, filename) - self.ScanFile(path, parser) - - def ScanFile(self, path, parser): - """ - Scans provided file and passes its contents to the parser using - parser.Parse method. - """ - with codecs.open(path, 'r', 'utf-8') as f: - contents = f.read() - parser.Parse(contents) diff --git a/Tools/px4params/srcparser.py b/Tools/px4params/srcparser.py index 9e202d3b8..0a4d21d26 100644 --- a/Tools/px4params/srcparser.py +++ b/Tools/px4params/srcparser.py @@ -72,7 +72,7 @@ class Parameter(object): """ return self.fields.get(code) -class Parser(object): +class SourceParser(object): """ Parses provided data and stores all found parameters internally. """ diff --git a/Tools/px4params/srcscanner.py b/Tools/px4params/srcscanner.py new file mode 100644 index 000000000..d7eca72d7 --- /dev/null +++ b/Tools/px4params/srcscanner.py @@ -0,0 +1,30 @@ +import os +import re +import codecs + +class SourceScanner(object): + """ + Traverses directory tree, reads all source files, and passes their contents + to the Parser. + """ + + def ScanDir(self, srcdir, parser): + """ + Scans provided path and passes all found contents to the parser using + parser.Parse method. + """ + extensions = tuple(parser.GetSupportedExtensions()) + for dirname, dirnames, filenames in os.walk(srcdir): + for filename in filenames: + if filename.endswith(extensions): + path = os.path.join(dirname, filename) + self.ScanFile(path, parser) + + def ScanFile(self, path, parser): + """ + Scans provided file and passes its contents to the parser using + parser.Parse method. + """ + with codecs.open(path, 'r', 'utf-8') as f: + contents = f.read() + parser.Parse(contents) -- cgit v1.2.3