`Signature::name()` returns `filename()` and then `md5sum()` if `.name` is empty. #3441

ctb · 2024-12-17T00:11:45Z

When Signature::name is None, the accessor method returns filename() and then md5sum() instead of an empty string, "".

This causes problems because (e.g.) Record::from_sig uses name() to construct the Record, but then this causes PartialEq to fail to match records that have empty names and are built elsewhere. This is what is causing intersect_manifest to fail over in sourmash-bio/sourmash_plugin_branchwater#538 with standalone manifests built with empty names.

In #3434, I propose having an empty name return empty string instead.

Alternatives would be to provide a different accessor function (raw_name()?) or has_name() or something. But since no tests seem to depend on the current behavior, and nothing breaks, I think it's ok to change.

(The inspiration from this behavior was from the Python layer, where we provide a display name.)

The text was updated successfully, but these errors were encountered:

ctb · 2024-12-17T00:35:22Z

ooh, I was wrong ;). one of the tests fails! will fix.

… `filename()` and `md5sum()` (#3434) This PR adjusts `Signature::name()` to return `None` when no name is set, instead of returning first `filename()` or (if empty) `md5sum()`. It also adds `name_str()` which returns an empty string, to avoid too many `unwrap_or` scattered throughout the codebase. Fixes #3441

ctb mentioned this issue Dec 17, 2024

MRG: adjust Signature::name() to return Option<String> instead of filename() and md5sum() #3434

Merged

ctb closed this as completed in #3434 Dec 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`Signature::name()` returns `filename()` and then `md5sum()` if `.name` is empty. #3441

`Signature::name()` returns `filename()` and then `md5sum()` if `.name` is empty. #3441

ctb commented Dec 17, 2024

ctb commented Dec 17, 2024

Signature::name() returns filename() and then md5sum() if .name is empty. #3441

Signature::name() returns filename() and then md5sum() if .name is empty. #3441

Comments

ctb commented Dec 17, 2024

ctb commented Dec 17, 2024

`Signature::name()` returns `filename()` and then `md5sum()` if `.name` is empty. #3441

`Signature::name()` returns `filename()` and then `md5sum()` if `.name` is empty. #3441