Repository navigation
New API: Add a constants module #1241
Description
Activity
For the specific case mentioned, could it not be
Snapshot.filenamein metadata.py as the filename seems to be a specified feature of snapshot metadata? That Snapshot.filename could be a "getter-only" property to underline how it's not supposed to be changed...EDIT: actually the property might not be a good idea as you can't have class properties...
Snapshot.filename(not instantiating Snapshot) only works if filename is a plain class variable. But that's Python: could make itSnapshot.FILENAMEto make it look more constantThe Metadata API and the updater implementation have evolved sufficiently that we don't need one central place for constants.
Currently, we write the constants directly in the metadata API module itself and we have a separate one inside the updater here.
If in the future we decide we need one central place or to minimize the length of Metadata API we will create other issues for that.
Description of issue or feature request:
I think it will be useful to have a constant module in the new API.
This will help us to minimize the errors when writing hardcoded strings.
For example, the "snapshot.json" string is used often in the
Timestampclass intuf/api/metadata.py.@joshuagl raised awareness for that in this comment:
#1223 (comment)
Current behavior:
Harcoded strings.
Expected behavior:
Use constant containing the string.