(Draft) New Data Model by SKernchen · Pull Request #480 · softwarepub/hermes

SKernchen · 2026-04-29T09:21:10Z

This pull request is not ready yet. It is only for showing the process

The conversion tests (`_to_python` and `_to_expanded_json`) are pretty long now...

This reverts commit 4fe4ffb.

This reverts commit df5b0ef.

This reverts commit d825217.

This reverts commit 8b4f9a3.

Pull in relevant changes from `develop`

Disable tests that fail due to data model

Resolve #383: Test `ld_context`

…or/381-test-ld_container # Conflicts: # poetry.lock

Update poetry.lock for added test dependencies.

Refactor/381 test ld container

Fix #454: Add end-to-end tests for the plugin-related `SoftwareMetadata` API

…c-api Refactor/423 implement public api

zyzzyxdonta

Some first very high-level comments. Will continue the review another day.

zyzzyxdonta · 2026-05-26T14:33:09Z

Should a top-level conftest exist? I think this belongs into test/ or test/hermes_test/

zyzzyxdonta · 2026-06-03T12:22:29Z

(Without having read any of the docs,) I find the jargon strange in this module. The module is called context_manager. It contains HermesCache which is a context manager, and HermesContext which is not a context manager but returns context managers. Maybe this could be cleared up by renaming the module. Maybe nothing with context in it as this term is already used for the context of the JSON-LD object.

zyzzyxdonta · 2026-06-03T12:27:17Z

+from .error import HermesContextError
+
+
+class HermesCache:


It seems this class is only ever instantiated in HermesContext. So it might be a good idea to add a docstring to the module that explains how to get such a cache object (i.e. via HermesContext).

zyzzyxdonta · 2026-06-03T12:45:45Z

+    """
+
+    @classmethod
+    def vocabulary(cls, base_url: str = "http://spam.eggs/") -> dict:


Only example.org and example.com are safe test domains

zyzzyxdonta · 2026-06-03T13:01:09Z

+    dict[str, Union["JSON_LD_VALUE", BASIC_TYPE, TIME_TYPE, "ld_dict", "ld_list"]],
+]
+""" Type description of valid JSON_LD objects that are partially represented by ld_containers """
+PYTHONIZED_LD_CONTAINER: TypeAlias = Union[


What does pythonized mean? 😅 The Python representation of the thing?

zyzzyxdonta · 2026-06-03T14:28:39Z

+        for mapping in active_ctx["mappings"].values():
+            if "@container" in mapping and long_iri:
+                value = {x: "none" for x in mapping["@container"]}


I don't understand what this is for.

The and long_iri I guess saves work if no IRI is given. But this could be expressed more clearly by doing if long_iri is None: return long_iri at the beginning of the function, just like _compact_iri() does it.

value overwritten in each new iteration in each iteration because it @container can only exist once? In that case, this would be clearer by breaking out of the loop.

But what does "none" do?

I think this whole module goes deep into pyld internals and a couple of comments would be helpful to understand what is going on.

zyzzyxdonta · 2026-06-04T09:36:16Z

With the given poetry.lock, the docs don't compile. A lot of our packages are old and incompatible with the ones that aren't pinned. I got it to work like this:

diff --git i/pyproject.toml w/pyproject.toml index 17ea508..932427b 100644 --- i/pyproject.toml +++ w/pyproject.toml @@ -92,13 +92,13 @@ pytest-httpserver = "^1.1.5" optional = true [tool.poetry.group.docs.dependencies] -Sphinx = "^6.2.1" +Sphinx = "^8.0.0" # Sphinx - Additional modules -myst-parser = "^2.0.0" +myst-parser = "^4.0.0" sphinx-book-theme = "^1.0.1" sphinx-favicon = "^0.2" sphinxcontrib-contentui = "^0.2.5" -sphinxcontrib-images = "^0.9.4" +sphinxcontrib-images = "^1.0.1" sphinx-icon = "^0.1.2" sphinx-autobuild = "^2021.3.14" sphinx-autoapi = "^3.0.0"

I had to remove 'sphinxemoji' too or constrain setuptools to <82 (the dependency pkg_resources (deprecated) was removed in setuptools version 82 but was necessary for 'sphinxemoji').

Also building the docs loally always (at least for me) results in errors from myst (failed linkings).
This has been an issue for longer though, but I haven't been able to fix it so far.

Yup, the setuptools change was exactly the same problem I had. I didn't have any problems with sphinxemoji though. Strange ... 🤔

Yes, the errors from myst have been there for a while. I think it's mostly unused or missing references/labels. I haven't looked into it.

zyzzyxdonta · 2026-06-09T07:15:07Z

+:caption: Injecting additional schemas
+from hermes.model import SoftwareMetadata
+
+# Contents served at https://bar.net/schema.jsonld:


Please only use reserved example domains! https://en.wikipedia.org/wiki/Example.com

zyzzyxdonta · 2026-06-09T07:17:18Z

+it will always be returned in a **list**-like object!
+```
+
+The reason for providing data in list-like objects is that JSON-LD treats all property values as arrays.


Link to the related section in the JSON-LD spec would be nice

zyzzyxdonta · 2026-06-09T07:26:43Z

+Python data:
+
+```{code-block} python
+:caption: Naive containment assertion that raises


It doesn't though. The mock output is from the path where the assertion holds.

zyzzyxdonta · 2026-06-09T11:20:14Z

+}
+```
+
+HERMES would use the {py:class}`~hermes.model.merge.action.Reject` strategy for merging values of the key `full_property_iri` in objects of type `full_type_iri`. (A key in strategies being `None` instead of a string indicates to HERMES that its value is to be used as a default [i.e. if no more specific entry exists].)


This feels hacky. Have you considered collections.defaultdict?

zyzzyxdonta · 2026-06-09T11:22:32Z

This whole file feels more like a reference than a tutorial. A tutorial should be "learning by doing". An example could be having the reader re-build the git-plugin from scratch.

See also: https://diataxis.fr/tutorials/

led02 and others added 30 commits August 1, 2025 21:16

Added more tests.

4b8c3b7

The conversion tests (`_to_python` and `_to_expanded_json`) are pretty long now...

Restructured tests for ld_container (type conversions).

3bceb49

Update poetry lock to get CI running.

ef2eb70

Fix linting errors.

af21ace

Delete tests for old data model.

8b4f9a3

Disable tests that fail due to missing old data model.

d825217

Fix test for mock document.

d9761ab

Fix mock document.

9113c7b

Silence flake8 on inactive tests.

df5b0ef

Silence flake8 on inactive tests more agressively.

4fe4ffb

Fix handling of identifier in compaction and expansion.

797ded3

Disable tests that fail due to missing old data model.

026b09f

Silence flake8 on inactive tests.

b347dc2

Silence flake8 on inactive tests more agressively.

7a2b0d6

Revert "Silence flake8 on inactive tests more agressively."

d577aab

This reverts commit 4fe4ffb.

Revert "Silence flake8 on inactive tests."

b432ccf

This reverts commit df5b0ef.

Revert "Disable tests that fail due to missing old data model."

6a10129

This reverts commit d825217.

Delete tests for old data model.

82b45e5

Revert "Delete tests for old data model."

de09fdb

This reverts commit 8b4f9a3.

Merge branch 'feature/347-update-build_backend' into refactor/data-model

158c8d3

Merge pull request #417 from softwarepub/refresh-based-on-develop

73df3ea

Pull in relevant changes from `develop`

Show skipped tests when running

6bcdbe9

Merge pull request #415 from softwarepub/refactor/411-disable-tests

80cade3

Disable tests that fail due to data model

Merge pull request #403 from softwarepub/refactor/383-test-ld_context

7b10cdc

Resolve #383: Test `ld_context`

Merge remote-tracking branch 'origin/refactor/data-model' into refact…

0edc582

…or/381-test-ld_container # Conflicts: # poetry.lock

Update poetry.lock for added test dependencies.

68aec7f

Add missing dependencies again.

ea08105

Update poetry.lock for added test dependencies.

Add test file for ld_dict

409b43a

Merge branch 'refactor/data-model' into refactor/384-test-ld_dict

6c7baf8

Merge pull request #398 from softwarepub/refactor/381-test-ld_container

2969b09

Refactor/381 test ld container

notactuallyfinn and others added 21 commits March 26, 2026 11:02

finished implementation of CodemetaProcessPlugin

c699ae2

implement more comments

d514c9f

add codemeta_doi postprocess plugin

ba8b549

reworked zenodo_sandbox_auth for cli testing

9b1c48a

fix post process and add license header to conftest.py

55e086d

improve error handling of commands

9d770a1

make process more verbose for errors while merging

180cc10

potentially fixed error where multiple record ids are halucinated.

0251cd1

flake8

73467f5

adjusted logging a bit

34877b9

fix tests that are affected by error handling update

a0c0005

added another process test and fixed small bug

279e672

flake8

65399be

Imporve first cli harvest tests

89191ec

add reject strategies for special properties

a42c315

Add good case tests for cli

9294d0a

Merge pull request #456 from softwarepub/feature/454-e2e-test-plugin-api

e40965d

Fix #454: Add end-to-end tests for the plugin-related `SoftwareMetadata` API

Ignore flake8 C901 (too complex)

5108696

Merge pull request #479 from softwarepub/refactor/423-implement-publi…

224d5b7

…c-api Refactor/423 implement public api

update dependencies

3e7c83d

add/ update comments and doc strings

23a11b3

zyzzyxdonta reviewed May 26, 2026

View reviewed changes

zyzzyxdonta reviewed Jun 3, 2026

View reviewed changes

zyzzyxdonta reviewed Jun 4, 2026

View reviewed changes

zyzzyxdonta reviewed Jun 9, 2026

View reviewed changes

notactuallyfinn added 4 commits June 11, 2026 14:22

removed toml dependency and pined setuptools to <82

ff00de5

rename donothingcurate to passcurate

7b8e89a

update dependencies for docs

4ca4450

fix typos and change some phrasing

42045b5

Conversation

SKernchen commented Apr 29, 2026

Uh oh!

zyzzyxdonta left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

zyzzyxdonta Jun 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zyzzyxdonta Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

zyzzyxdonta Jun 3, 2026 •

edited

Loading

zyzzyxdonta Jun 4, 2026 •

edited

Loading