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

Fixed issue within Snapshot.py where the memory_viz_version parameter was not respected #1083

Merged

Conversation

CulmoneY
Copy link
Contributor

@CulmoneY CulmoneY commented Sep 19, 2024

Proposed Changes

_The test_snapshot_save_create_svg test was failing due to an issue in snapshot_save_file.py. The script attempted to specify a version number for the Memory Viz library, but this argument was not being respected. This led to a file_path error because the tests were passing directories as the output path to the memory-viz CLI, which is no longer accepted in the new version.

To resolve this issue, I modified snapshot.py to ensure the correct handling of the output path and version specification._

...

The issue arose because memory_viz_version was not being correctly imported into the command line, resulting in the wrong version of the memory-viz tool being executed.After researching the NPX documentation, I made the necessary changes to specify the correct version in the command. **Previous Command:** ```command = ["npx", "memory-viz"]``` **New Command:** ```command = ["npx", f"memory-viz@{memory_viz_version}"]```

Type of Change

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) X
♻️ Refactoring (internal change to codebase, without changing functionality)
🚦 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 pre-commit.ci checks have passed.
  • 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

(Include any questions or comments you have regarding your changes.)

@CulmoneY CulmoneY marked this pull request as ready for review September 19, 2024 22:44
@CulmoneY CulmoneY marked this pull request as draft September 19, 2024 22:47
@CulmoneY CulmoneY marked this pull request as ready for review September 19, 2024 22:47
@CulmoneY CulmoneY marked this pull request as draft September 20, 2024 02:48
@CulmoneY CulmoneY marked this pull request as ready for review September 20, 2024 02:48
@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 10952310176

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 92.038%

Totals Coverage Status
Change from base Build 10858552239: 0.0%
Covered Lines: 3040
Relevant Lines: 3303

💛 - Coveralls

@david-yz-liu david-yz-liu merged commit 1078ec7 into pyta-uoft:master Sep 21, 2024
30 of 36 checks passed
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