base_parser: support relative path include files #399
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## master #399 +/- ##
==========================================
+ Coverage 81.19% 81.30% +0.11%
==========================================
Files 57 57
Lines 7358 7383 +25
==========================================
+ Hits 5974 6003 +29
+ Misses 1384 1380 -4 ☔ View full report in Codecov by Sentry. |
Javagedes
force-pushed
the
bugfix-base_parser
branch
from
9e33b51 to
e42a6ff
Compare
This commit adds support for including multiple relative paths from the same directory by storing a stack of all included files that have not finished being parsed, and the number of lines that still need to be parsed in each file. Previously, only includes of nested relative paths were supported as the currently parsed file was not reverted to the previous file when the parsing of an included file was completed. This led to further includes needing the be relative to the latest included file.
…etNextLine() recursively
Javagedes
force-pushed
the
bugfix-base_parser
branch
from
e42a6ff to
d15392b
Compare
Flickdm
approved these changes
Feb 14, 2024
| @@ -42,6 +42,8 @@ def __init__(self, log="BaseParser"): | |||
| self.PPs = [] | |||
| self._Edk2PathUtil = None | |||
| self.TargetFilePath = None # the abs path of the target file | |||
| self.FilePathStack = [] # a stack containing a list of size 2: [filepath, line_count] | |||
There was a problem hiding this comment.
NIT:
Since you're likely dealing with a large set of data, the following solution probably doesn't make a lot of sense performance wise but if you wanted to improve readability of the code you could do something like a namedtuple.
However the object instantiation might be too much for a large dataset
from collections import namedtuple
# Define the namedtuple type
FilePathRecord = namedtuple('FilePathRecord', ['filepath', 'line_count'])
self.FilePathStack = [] # a stack containing FilePathRecord instances
self.FilePathStack.append(FilePathRecord('my_file_path', 100))
self.FilePathStack[0].file_path| return False | ||
| line_count = self.FilePathStack[-1][1] | ||
| if line_count - 1 > 0: | ||
| self.FilePathStack[-1][1] -= 1 |
There was a problem hiding this comment.
NIT:
updated_line_count = self.FilePathStack[-1][1] - 1
if updated_line_count > 0:
self.FilePathStack[-1][1] -= updated_line_count| @@ -92,10 +92,10 @@ def __ParseLine(self, Line, file_name=None, lineno=None): | |||
| if sp is None: | |||
| raise FileNotFoundError(include_file) | |||
| self.Logger.debug("Opening Include File %s" % sp) | |||
| self._PushTargetFile(sp) | |||
| lf = open(sp, "r") | |||
There was a problem hiding this comment.
NIT: I know you didn't write this but if we switch to with we can drop lf.close()
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit adds support for including multiple relative paths from the same directory by storing a stack of all included files that have not finished being parsed, and the number of lines that still need to be parsed in each file.
Previously, only includes of nested relative paths were supported as the currently parsed file was not reverted to the previous file when the parsing of an included file was completed. This led to further includes needing the be relative to the latest included file.
closes #394