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 bug so that add_type updates forward references in new type added #92

Merged
merged 8 commits into from
Oct 4, 2023

Conversation

huong-li-nguyen
Copy link
Contributor

@huong-li-nguyen huong-li-nguyen commented Oct 4, 2023

Description

  • Fix bug on ChildWithForwardRef.update_forward_refs having to be called
  • Add unit tests to capture new test case
  • Update docs

Screenshot

Without the fix, the unit tests will fail on this:
Screenshot 2023-10-04 at 13 04 27

Checklist

  • I have not referenced individuals, products or companies in any commits, directly or indirectly
  • I have not added data or restricted code in any commits, directly or indirectly
  • I have updated the docstring of any public function/class/model changed
  • I have added the PR number to the change description in the changelog fragment, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1)) (if applicable)
  • I have added tests to cover my changes (if applicable)

Types of changes

  • Docs/refactoring (non-breaking change which improves codebase)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Notice

  • I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

    • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
    • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorised to submit this contribution on behalf of the original creator(s) or their licensees.
    • I certify that the use of this contribution as authorised by the Apache 2.0 license does not violate the intellectual property rights of anyone else.

@huong-li-nguyen huong-li-nguyen changed the title Fix bug on Child.update_forward_refs having to be called Fix bug on ChildWithForwardRef.update_forward_refs having to be called Oct 4, 2023
@huong-li-nguyen huong-li-nguyen self-assigned this Oct 4, 2023
@huong-li-nguyen huong-li-nguyen added Issue: Bug Report 🐛 Issue/PR that report/fix a bug Component: Docs 🗒️ Issue/PR for markdown and API documentation Status: Ready for Review ☑️ Issue/PR is ready for review - all tests have passed labels Oct 4, 2023
@huong-li-nguyen huong-li-nguyen marked this pull request as ready for review October 4, 2023 11:41
Copy link
Contributor

@antonymilne antonymilne left a comment

Choose a reason for hiding this comment

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

Thank you for finishing this off! 💯 Just some minor suggestions.

vizro-core/tests/unit/vizro/models/test_base.py Outdated Show resolved Hide resolved
vizro-core/tests/unit/vizro/models/test_base.py Outdated Show resolved Hide resolved
vizro-core/tests/unit/vizro/models/test_base.py Outdated Show resolved Hide resolved
vizro-core/tests/unit/vizro/models/test_base.py Outdated Show resolved Hide resolved
vizro-core/tests/unit/vizro/models/test_base.py Outdated Show resolved Hide resolved
@huong-li-nguyen huong-li-nguyen changed the title Fix bug on ChildWithForwardRef.update_forward_refs having to be called Fix bug so that add_type updates forward references in new type added Oct 4, 2023
Copy link
Contributor

@maxschulz-COL maxschulz-COL left a comment

Choose a reason for hiding this comment

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

Lgtm! Great fix

@huong-li-nguyen huong-li-nguyen merged commit 006fc28 into main Oct 4, 2023
25 checks passed
@huong-li-nguyen huong-li-nguyen deleted the bug/fix_child_forwardref branch October 4, 2023 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Docs 🗒️ Issue/PR for markdown and API documentation Issue: Bug Report 🐛 Issue/PR that report/fix a bug Status: Ready for Review ☑️ Issue/PR is ready for review - all tests have passed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants