Skip to content

Conversation

@thomashampson
Copy link
Contributor

@thomashampson thomashampson commented Sep 3, 2025

Description of work

A warning message is displayed whenever a workspace is created with a name that doesn't conformt Python variable naming conventions. This will allow us to move to enforcing this standard in the future.

In debug mode, an exception is raised. This will help avoid any new instances of bad workspace names entering the codebase.

To test:

  1. In debug mode, try loading some data using the UI with something invalid in the name field, e.g. with a space in or starting with a number. It should not allow you to load.
  2. In release mode, try the same. It should work, but with a warning message in the log. The warning message should appear only once per operation.

Reviewer

Your comments will be used as part of the gatekeeper process. Comment clearly on what you have checked and tested during your review. Provide an audit trail for any changes requested.

As per the review guidelines:

  • Is the code of an acceptable quality? (Code standards/GUI standards)
  • Has a thorough functional test been performed? Do the changes handle unexpected input/situations?
  • Are appropriately scoped unit and/or system tests provided?
  • Do the release notes conform to the guidelines and describe the changes appropriately?
  • Has the relevant (user and developer) documentation been added/updated?

Gatekeeper

As per the gatekeeping guidelines:

  • Has a thorough first line review been conducted, including functional testing?
  • At a high-level, is the code quality sufficient?
  • Are the base, milestone and labels correct?

@thomashampson thomashampson force-pushed the 39488-enforce-python-names-for-ws branch from aff6a90 to 14bf9e8 Compare September 18, 2025 18:47
@thomashampson thomashampson added this to the Release 6.15 milestone Sep 23, 2025
@thomashampson
Copy link
Contributor Author

I think if we run the tests in debug mode ~200 will fail. We should aim to fix all of that before this is merged to minimise the number of warning messages users will see when running algorithms that internally use bad workspace names.

@github-actions
Copy link
Contributor

This pull request has been automatically marked as stale because it has not had activity in 3 months. It will be closed in 7 days if no further activity occurs.
Allowing pull requests to close as stale helps us filter out old work that is no longer relevant and helps developers focus on reviewing current work.
All pull requests closed by this bot act like normal pull requests; they can be searched for, commented on or reopened at any point.
If these changes are still relevant then please comment and tag @mantidproject/gatekeepers to highlight that it needs to have a reviewer assigned.

@github-actions github-actions bot added the Stale This label is automatically applied to issues that are automatically closed by the stale bot label Jan 10, 2026
@thomashampson thomashampson removed the Stale This label is automatically applied to issues that are automatically closed by the stale bot label Jan 20, 2026
@sf1919
Copy link
Contributor

sf1919 commented Jan 22, 2026

What is happening with this one? It's still in draft. Should we change the milestone?

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