-
Notifications
You must be signed in to change notification settings - Fork 269
add table comment to generated code #215
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
Open
PaleNeutron
wants to merge
9
commits into
agronholm:master
Choose a base branch
from
PaleNeutron:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
907030d
add table comment to generated code
PaleNeutron 1463c57
Merge branch 'master' of https://github.com/agronholm/sqlacodegen
PaleNeutron b7eb8b3
Change Connectable to Connection | Engine
PaleNeutron d7fbd92
Merge branch 'agronholm:master' into master
PaleNeutron c4a6832
Merge branch 'master' of https://github.com/PaleNeutron/sqlacodegen
PaleNeutron 19a0f41
Merge branch 'agronholm:master' into master
PaleNeutron 9e2afdd
Merge branch 'agronholm:master' into master
PaleNeutron 8037b1f
Merge branch 'master' into master
sheinbergon 4d94b87
Merge branch 'master' into master
sheinbergon 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 |
---|---|---|
|
@@ -1108,7 +1108,9 @@ def render_models(self, models: list[Model]) -> str: | |
|
||
def render_class(self, model: ModelClass) -> str: | ||
sections: list[str] = [] | ||
|
||
comments = self.render_table_comment(model) | ||
if comments: | ||
sections.append(comments) | ||
# Render class variables / special declarations | ||
class_vars: str = self.render_class_variables(model) | ||
if class_vars: | ||
|
@@ -1147,6 +1149,10 @@ def render_class_declaration(self, model: ModelClass) -> str: | |
) | ||
return f"class {model.name}({parent_class_name}):" | ||
|
||
def render_table_comment(self, model: ModelClass) -> str: | ||
if model.table.comment: | ||
return f'"""{model.table.comment}"""' | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No wrapping for long docstrings then...? |
||
|
||
def render_class_variables(self, model: ModelClass) -> str: | ||
variables = [f"__tablename__ = {model.table.name!r}"] | ||
|
||
|
Oops, something went wrong.
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.
Add a blank line after a control block ends.