Skip to content

sorting dictionary before hashing data #17

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.

Sign up for GitHub

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

Merged
tjacovich merged 2 commits into from
Aug 11, 2025
Merged

sorting dictionary before hashing data #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ffc93f
sorting dictionary before hashing data
mugdhapolimera Aug 9, 2025
f000c84
corrected test cases)
mugdhapolimera Aug 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions SciXPipelineUtils/scix_id.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,8 +244,12 @@ def generate_scix_id(
if type(hash_data) != dict:
try:
hash_data = json.loads(hash_data)

except ValueError as e:
raise e

# Use json.dumps with sort_keys=True to sort all nested dictionary keys
hash_data = json.loads(json.dumps(hash_data, sort_keys=True))
hashed_data = generate_bib_data_hash(
hash_data, strip_characters=strip_characters, user_fields=user_fields
)
Expand Down
12 changes: 6 additions & 6 deletions tests/test_scix_id.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ def test_generate_scix_id(self):
}
scix_id = scixid.generate_scix_id(test_bib_data)
scix_id_2 = scixid.generate_scix_id(json.dumps(test_bib_data))
self.assertEqual(scix_id, "7SNR-3N03-VSD6")
self.assertEqual(scix_id, "9153-JA78-G9SG")
self.assertEqual(scix_id, scix_id_2)

def test_generate_scix_id_user_fields(self):
Expand All @@ -81,7 +81,7 @@ def test_generate_scix_id_user_fields(self):
user_fields = ["id"]
scix_id = scixid.generate_scix_id(test_bib_data, user_fields=user_fields)
scix_id_2 = scixid.generate_scix_id(test_bib_data)
self.assertEqual(scix_id, "1NMC-KCFG-RVH8")
self.assertEqual(scix_id, "3YG1-418S-68AF")
self.assertNotEqual(scix_id, scix_id_2)

def test_generate_scix_id_special_characters_true(self):
Expand All @@ -93,7 +93,7 @@ def test_generate_scix_id_special_characters_true(self):
}
scix_id = scixid.generate_scix_id(test_bib_data)
scix_id_2 = scixid.generate_scix_id(json.dumps(test_bib_data))
self.assertEqual(scix_id, "7SNR-3N03-VSD6")
self.assertEqual(scix_id, "9153-JA78-G9SG")
self.assertEqual(scix_id, scix_id_2)

def test_generate_scix_id_special_characters_true_comparison(self):
Expand All @@ -113,7 +113,7 @@ def test_generate_scix_id_special_characters_true_comparison(self):

scix_id = scixid.generate_scix_id(test_bib_data)
scix_id_2 = scixid.generate_scix_id(test_bib_data_2)
self.assertEqual(scix_id, "7SNR-3N03-VSD6")
self.assertEqual(scix_id, "9153-JA78-G9SG")
self.assertEqual(scix_id, scix_id_2)

def test_generate_scix_id_special_characters_false(self):
Expand All @@ -125,7 +125,7 @@ def test_generate_scix_id_special_characters_false(self):
}
scix_id = scixid.generate_scix_id(test_bib_data, strip_characters=False)
scix_id_2 = scixid.generate_scix_id(test_bib_data)
self.assertEqual(scix_id, "APGB-1BCS-SAG1")
self.assertEqual(scix_id, "8Z91-4S23-1KJX")
self.assertNotEqual(scix_id, scix_id_2)

def test_generate_scix_id_other(self):
Expand All @@ -136,5 +136,5 @@ def test_generate_scix_id_other(self):
"abs": ["words"],
}
scix_id = scixid.generate_scix_id(json.dumps(test_bib_data), hash_data_type="other")
self.assertNotEqual(scix_id, "7SNR-3N03-VSD6")
self.assertNotEqual(scix_id, "9153-JA78-G9SG")
self.assertEqual(scix_id, "6N22-EN04-7GHF")