Rename byname -> entity_byname, class_name -> entity_class_name

soininen commented 5 months ago

This PR contains two renamings for consistency:

entity_byname is no longer shortened to byname in entities.
entity_class_name is no longer shortened to class_name except in legacy object_sq and relationship_sq, and their variants which were kept as-is for backwards compatibility.

It was suggested in #318 that we choose class_name over entity_class_name instead. I tried this first, but was not happy with the result. We do not shorten any other name so it did not feel right for entity_class_name either. Plus, the long name is consistent with table headers in Spine database editor.

Resolves #318

Checklist before merging

[x] Documentation (also in Toolbox repo) is up-to-date
[x] Release notes in Toolbox repo have been updated
[x] Unit tests have been added/updated accordingly
[x] Code has been formatted by black
[x] Unit tests pass

DillonJ commented 5 months ago

@manuelma is off till 19th Jan.

Do we have tests to ensure that SpineInterface continues to work with these changes?

soininen commented 5 months ago

Do we have tests to ensure that SpineInterface continues to work with these changes?

Those tests would be in SpineInterface repository, right? I can check them out.

In any case, this is 0.8-dev change and does not affect users of master branch.

soininen commented 5 months ago

Looks like the SpineInterface tests have not been passing for a while now so they do not really help here.

spine-tools / Spine-Database-API

Rename byname -> entity_byname, class_name -> entity_class_name #334

Checklist before merging