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

Change supertype calculation when combining scatters #5101

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

stxue1
Copy link
Contributor

@stxue1 stxue1 commented Sep 20, 2024

#5055

Changelog Entry

To be copied to the draft changelog by merger:

  • Fixed a bug with conditional statements inside a WDL scatter

Reviewer Checklist

  • Make sure it is coming from issues/XXXX-fix-the-thing in the Toil repo, or from an external repo.
    • If it is coming from an external repo, make sure to pull it in for CI with:
      contrib/admin/test-pr otheruser theirbranchname issues/XXXX-fix-the-thing
      
    • If there is no associated issue, create one.
  • Read through the code changes. Make sure that it doesn't have:
    • Addition of trailing whitespace.
    • New variable or member names in camelCase that want to be in snake_case.
    • New functions without type hints.
    • New functions or classes without informative docstrings.
    • Changes to semantics not reflected in the relevant docstrings.
    • New or changed command line options for Toil workflows that are not reflected in docs/running/{cliOptions,cwl,wdl}.rst
    • New features without tests.
  • Comment on the lines of code where problems exist with a review comment. You can shift-click the line numbers in the diff to select multiple lines.
  • Finish the review with an overall description of your opinion.

Merger Checklist

  • Make sure the PR passes tests.
  • Make sure the PR has been reviewed since its last modification. If not, review it.
  • Merge with the Github "Squash and merge" feature.
    • If there are multiple authors' commits, add Co-authored-by to give credit to all contributing authors.
  • Copy its recommended changelog entry to the Draft Changelog.
  • Append the issue number in parentheses to the changelog entry.

optional = optional or typ.optional
else:
# We have conflicting types
raise RuntimeError(f"Cannot generate a supertype from conflicting types: {types}")
Copy link
Member

@DailyDreaming DailyDreaming Sep 20, 2024

Choose a reason for hiding this comment

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

This can be simplified... but I'm not sure that the logic still holds up? optional seems like it will be set to the previous typ in types, if True, and will remain True the entire loop thereafter.

Here's the simplification:

supertype = None
optional = False
for typ in types:
    if isinstance(typ, WDL.Type.Any):
        # ignore an Any type, as we represent a bottom type as Any. See https://miniwdl.readthedocs.io/en/latest/WDL.html#WDL.Type.Any
        # and https://github.com/openwdl/wdl/blob/e43e042104b728df1f1ad6e6145945d2b32331a6/SPEC.md?plain=1#L1484
        optional = optional or typ.optional
    else:
        if supertype is None:
            supertype = typ
            optional = optional or typ.optional
        else:
            # We have conflicting types
            raise RuntimeError(f"Cannot generate a supertype from conflicting types: {types}")

==>

supertype = None
optional = False
for typ in types:
    if isinstance(typ, WDL.Type.Any):
        # ignore an Any type, as we represent a bottom type as Any. See https://miniwdl.readthedocs.io/en/latest/WDL.html#WDL.Type.Any
        # and https://github.com/openwdl/wdl/blob/e43e042104b728df1f1ad6e6145945d2b32331a6/SPEC.md?plain=1#L1484
        optional = optional or typ.optional
    elif supertype is None:
        supertype = typ
        optional = optional or typ.optional
    else:
        # We have conflicting types
        raise RuntimeError(f"Cannot generate a supertype from conflicting types: {types}")

==>

supertype = None
optional = False
for typ in types:
    optional = optional or typ.optional
    if supertype is None and not isinstance(typ, WDL.Type.Any):
        supertype = typ
    elif not isinstance(typ, WDL.Type.Any):
        # We have conflicting types
        raise RuntimeError(f"Cannot generate a supertype from conflicting types: {types}")

Is this still what it needs to do?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think this should be functionally similar, I can adjust the comment to give some clarification about the Any type as that is pretty important to keep

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This will actually break when the types list has multiple types in them, so I'll keep it as is

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.

2 participants