Global variables SPECIAL_PROPERTIES

Summary

Are we sure that both of the following are needed?

caoscrawler/converters.py:SPECIAL_PROPERTIES = ("description", "name", "id", "path",
caoscrawler/crawl.py:SPECIAL_PROPERTIES_STRICT = ("description", "name", "id", "path")

It should be clarified:

• What exactly (e.g. which one) are special properties?
• Are there different categories of special properties (id vs. name vs. path vs. description)?
• Shouldn't there be a unified way of finding out whether a property is a special property, and, preferably, in caosdb-pylib?

DoD:

• Add definition and explanation of special properties to documentation (where... pylib? crawler? both?)
• Provide API function (either in crawler utilities or in pylib) for determining whether a property with a given name is a special property (and maybe also determine its category).
• Update all occurrences (pylib, advanced-user-tools -> yaml interface, crawler) of special properties and unify its treatment in the code.

added Question label

assigned to @salexan

changed the description

I'm very much in favor of having something like this in pylib directly. But let's first collect the different usages of "special properties" to see whether there are some specific cases that can't be unified.

Crawler

src/caoscrawler/crawl.py

62:SPECIAL_PROPERTIES_STRICT = ("description", "name", "id", "path")
63:SPECIAL_PROPERTIES_NOT_STRICT = ("file", "checksum", "size")

src/caoscrawler/converters.py

49:SPECIAL_PROPERTIES = ("description", "name", "id", "path", "file", "checksum", "size")

Keine gefunden in caosdadvancedtools

In pylib:

test_apiutils.py:

def test_compare_special_properties():
    # Test for all known special properties:
    SPECIAL_PROPERTIES = ("description", "name",
                          "checksum", "size", "path", "id")
    INTS = ("size", "id")
    HIDDEN = ("checksum", "size")

In models.py

SPECIAL_ATTRIBUTES = ["name", "role", "datatype", "description",
                      "id", "path", "checksum", "size"]

apiutils:

def compare_entities(old_entity: Entity, new_entity: Entity):

added Statusnext label

changed iteration to Sprint Jan 20, 2025 - Feb 2, 2025

removed iteration Sprint Jan 20, 2025 - Feb 2, 2025

changed iteration to Sprint Feb 3, 2025 - Feb 16, 2025

removed iteration Sprint Feb 3, 2025 - Feb 16, 2025

changed iteration to Sprint Feb 17, 2025 - Mar 2, 2025

removed iteration Sprint Feb 17, 2025 - Mar 2, 2025

changed iteration to Sprint Mar 3, 2025 - Mar 16, 2025

added Statustodo label and removed Statusnext label

added P3 label

added (B EnhancementProposed labels

set weight to 2

removed iteration Sprint Mar 3, 2025 - Mar 16, 2025

changed iteration to Sprint Mar 17, 2025 - Mar 30, 2025

added Statusnext label and removed Statustodo label

changed iteration to Sprint Apr 14, 2025 - Apr 27, 2025