Skip to content

Only include default width if width isn't specified for MemoryViz SVG when calling snapshot - #1399

Open
chiually wants to merge 2 commits into
pyta-uoft:masterfrom
chiually:adjust-width-of-snapshot
Open

chiually wants to merge 2 commits into
pyta-uoft:masterfrom
chiually:adjust-width-of-snapshot

Conversation

@chiually

@chiually chiually commented Sep 26, 2026 •

Copy link
Copy Markdown
Contributor

Proposed Changes

Rather than always hard coding the width to 800 in the MemoryViz CLI command, only include the default width if no width is supplied.

Also made it explicit in the docstring of the snapshot function that the default width is 800 but can be changed using memory_viz_args

...

Screenshots of your changes (if applicable)

Type of Change

(Write an X or a brief description next to the type or types that best describe your changes.)

Type Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change)
✨ New feature (non-breaking change that adds functionality)
🐛 Bug fix (non-breaking change that fixes an issue)
♻️ Refactoring (internal change to codebase, without changing functionality) X
🚦 Test update (change that only adds or modifies tests)
📚 Documentation update (change that only updates documentation)
📦 Dependency update (change that updates a dependency)
🔧 Internal (change that only affects developers or continuous integration)

Checklist

(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the [ ] into a [x] in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)

Before opening your pull request:

  • I have performed a self-review of my changes.
    • Check that all changed files included in this pull request are intentional changes.
    • Check that all changes are relevant to the purpose of this pull request, as described above.
  • I have added tests for my changes, if applicable.
    • This is required for all bug fixes and new features.
  • I have updated the project documentation, if applicable.
    • This is required for new features.
  • I have updated the project Changelog (this is required for all changes).
  • If this is my first contribution, I have added myself to the list of contributors.

After opening your pull request:

  • I have verified that the CI tests have passed.
  • I have reviewed the test coverage changes reported by Coveralls.
  • I have requested a review from a project maintainer.

Questions and Comments

The width of the SVG could always be changed through memory_viz_args since the ordering of the command prioritizes the last specified width. This change ensures the command will only ever include one --width(unless the user explicitly puts multiple in memory_viz_args)

@coveralls

Copy link
Copy Markdown
Collaborator

Coverage Report for CI Build 36217611297

Coverage remained the same at 90.909%

Details

  • Coverage remained the same as the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 4081
Covered Lines: 3710
Line Coverage: 90.91%
Coverage Strength: 17.67 hits per line

💛 - Coveralls

@david-yz-liu david-yz-liu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@chiually nice work, I just left one inline comment. Additionally, please update the documentation website (under docs/) to mention this behaviour.

)

# check if default width is used when no width is specified in memory_viz_args
assert result.stdout.startswith('<svg width="800"')

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The overall idea for testing the correct width is good, but using string matching here is fairly brittle.

Instead, please parse the output as xml (see here) and then assert the top-level svg element has the correct value for its width attribute.

This branch has not been deployed

No deployments
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