Defuse sia title characters #557
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
msdemlei
force-pushed
the
defuse-sia-title-characters
branch
from
0afc840 to
036a789
Compare
This is intended to fix bug astropy#556.
|
Rebased to resolve conflicts, and also removed the commit from the other PR as it has been merged already. |
bsipocz
force-pushed
the
defuse-sia-title-characters
branch
from
036a789 to
12f6f63
Compare
bsipocz
approved these changes
Jun 27, 2024
|
Same as for #553, I change the milestone for the bugfix, if that comes out sooner than 1.6 |
andamian
reviewed
Jun 27, 2024
| @@ -894,6 +894,9 @@ def make_dataset_filename(self, *, dir=".", base=None, ext=None): | |||
| if not ext: | |||
| ext = self.suggest_extension(default="dat") | |||
|
|
|||
| base = base.replace("/", "_" | |||
| ).replace("\\", "_") | |||
|
|
|||
There was a problem hiding this comment.
- I would replace each
\with_to correctly keep track of the replacements. Single\might also create issues. - I've noticed that
suggest_dataset_basenamefixes empty spaces too but this is not the case ifbaseis present. Should we do this sanitization in one place (and potentially add more rules to it over time)?
There was a problem hiding this comment.
ahh, I'm sorry for the premature merge then.
|
On Thu, Jun 27, 2024 at 02:42:24PM -0700, Adrian wrote:
1. I would replace each `\` with `_` to correctly keep track of the
replacements. Single `\` might also create issues.
This is what already happens here; '\\' is the literal for a single
backslash.
2. I've noticed that `suggest_dataset_basename` fixes empty spaces
too but this is not the case if `base` is present. Should we do
this sanitization in one place (and potentially add more rules to
it over time)?
Hm... I'm not even sure whether I think replacing whitespace is a good
idea in the first place; I think even ancient FAT would support that,
and as to requiring quoting in common shells... Well, if we wanted to
make sure you get away without that, we'd have to do a lot more
mangling.
Anyway, I think that's a separate issue from repairing cachedataset()
for image titles with (back-)slashes. I give you that refactoring
suggest_dataset_basename (which has fairly parallel implementations
in ssap and sia on top) might be an improvement, and something that
produces filenames good across many platforms in a central place
sounds like a good idea, too (where we'd have to discuss whether we'd
want to limit the charset to ASCII printables...). What about filing
a bug?
|
|
Issue #573 - please feel free to add or change the details. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is intended as a fix for bug #556. To keep things simple, I'm basing this on the branch of PR #553, because this plays in the vicinity of its code.
As mentioned in the commit message, one might argue we should lock down the file names more strongly than that. I'd be open to that, but only if people actually feel there is a sufficient need for that.
fixes #556