-
Notifications
You must be signed in to change notification settings - Fork 229
REF: Spin off tree -> code compilation into a separate module #136
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
import os.path | ||
|
||
try: | ||
# betterproto[compiler] specific dependencies | ||
import black | ||
import jinja2 | ||
except ImportError as err: | ||
missing_import = err.args[0][17:-1] | ||
print( | ||
"\033[31m" | ||
f"Unable to import `{missing_import}` from betterproto plugin! " | ||
"Please ensure that you've installed betterproto as " | ||
'`pip install "betterproto[compiler]"` so that compiler dependencies ' | ||
"are included." | ||
"\033[0m" | ||
) | ||
raise SystemExit(1) | ||
|
||
from betterproto.plugin.models import OutputTemplate | ||
|
||
|
||
def outputfile_compiler(output_file: OutputTemplate) -> str: | ||
|
||
templates_folder = os.path.abspath( | ||
os.path.join(os.path.dirname(__file__), "..", "templates") | ||
) | ||
|
||
env = jinja2.Environment( | ||
trim_blocks=True, | ||
lstrip_blocks=True, | ||
loader=jinja2.FileSystemLoader(templates_folder), | ||
) | ||
template = env.get_template("template.py.j2") | ||
|
||
res = black.format_str( | ||
template.render(output_file=output_file), | ||
mode=black.FileMode(target_versions={black.TargetVersion.PY37}), | ||
) | ||
|
||
return res |
This file contains hidden or 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
This file contains hidden or 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does anyone know how to encode an alternative template/compiler (i.e. to swap out
betterproto.plugin.compiler.py
) as part of the command line options?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The goal here is that at the very least someone could copy
compiler.py
tomy_compiler.py
and edit the template (or the rendering method altogether) and pass an option to protoc that would tellplugin.py
to importmy_compiler.outputfile_compiler
and use that instead of the default one. It's not a super clean API or anything but it should be powerful and a good starting place for other changes. This options parsing doesn't need to be part of this PR, just asking for future reference.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess you have in mind being able to do something like:
I like the idea of stuff being modular and potentially configurable in this way. But I wouldn't race to provide an API to support fully support this without a real use case.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this change stands on it's own, and I agree with you that more discussion is needed before providing an API to do the above, but I do want to make sure that this change is at least compatible with that approach.