-
Notifications
You must be signed in to change notification settings - Fork 14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add parser level hooks support with Parser2 #108
Merged
Merged
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 @@
## main #108 +/- ##
==========================================
- Coverage 85.23% 84.48% -0.75%
==========================================
Files 126 154 +28
Lines 3765 5860 +2095
==========================================
+ Hits 3209 4951 +1742
- Misses 556 909 +353
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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 pull request introduces brand new Parser2 class which can be used in cooperation with old Tokenizer class and provides hooks interface based on visitor pattern.
Note
It was preferable to introduce new Parser class, as it was not possible to effectively implement hook interface for existing Parser class. Additionally this approach smooths transition between those two for any possible users, as they should be able to keep using old parser. When time will be right we will deprecate and remove old parser. Currently exisiting drawing backend interface is also not compatible with Parser2 and will have to be recreated following similar principles as parser.
We can customize parser hooks by creating new hook class inheriting from IHooks or Parser2Hooks and providing it to Parser2 constructor via Parser2Options. Difference between those two is that all IHooks hooks are NOOP while Parser2Hooks actually implement Gerber AST parser logic.
For example if we were to implement a parser only to print all comments from Gerber file we could do it following way:
All operations except visiting Comment tokens will be NOOP.
As you might notice we are creating class within a class body. This nesting mechanism allows us to reduce amount of boilderplate required to define hooks and simplify process of adding new hooks in the future.
All hooks specific to some particular token are defined as classes within a class inheriting from IHooks. They must follow particular naming scheme, for now please refer to source code in
pygerber.gerberx3.parser2.ihooks
module.There are also hooks which are not tied to tokens, eg. for error handling,
on_parser_error(self, context: Parser2Context, error: Parser2Error)
which are then defined directly within master hook class.It should be possible to extend hook interface in the future to add tokenizer level hooks and possibly others if needed.