Skip to content
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

fix: Correct the AutogenContext.metadata typing to include Sequence[MetaData]. #1547

Closed

Conversation

DanCardin
Copy link
Contributor

Description

The type annotation for AutogenContext.metadata is currently Optional[MetaData], but target_metadata is Union[MetaData, Sequence[MetaData], None]. Seems like setting target_metadata to [] directly translates into the list that AutogenContext receives, and that the code is already coercing the potential single/sequence to always be a list.

My alembic plugin wasn't aware that this could be a list, and as such wasn't handling the possibility properly.

Checklist

This pull request is:

  • A documentation / typographical error fix
    • Good to go, no issue or tests are needed
  • A short code fix
    • please include the issue number, and create an issue if none exists, which
      must include a complete example of the issue. one line code fixes without an
      issue and demonstration will not be accepted.
    • Please include: Fixes: #<issue number> in the commit message
    • please include tests. one line code fixes without tests will not be accepted.
  • A new feature implementation
    • please include the issue number, and create an issue if none exists, which must
      include a complete example of how the feature would look.
    • Please include: Fixes: #<issue number> in the commit message
    • please include tests.

Have a nice day!

@zzzeek zzzeek requested a review from sqla-tester November 6, 2024 17:10
Copy link
Collaborator

@sqla-tester sqla-tester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, this is sqla-tester setting up my work on behalf of zzzeek to try to get revision 1bdfa18 of this pull request into gerrit so we can run tests and reviews and stuff

@sqla-tester
Copy link
Collaborator

New Gerrit review created for change 1bdfa18: https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/5585

@sqla-tester
Copy link
Collaborator

Gerrit review https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/5585 has been merged. Congratulations! :)

@DanCardin DanCardin deleted the autogen-context-metadata-typing branch November 7, 2024 02:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants