ENH: Add dunder accessors to Pydantic RootModels

[ErichSuter]

Resolves #687

[slangeveld]

Typo. I guess this heading should be Stratigraphy

[slangeveld]

You could consider implementing this as a fixture in pytest. Then you can take the fixture as input to your test. Example here:

fmu-dataio/tests/test_units/test_dictionary.py

Line 15 in b30c170

@pytest.fixture(name="direct_creation", scope="function")

More info here https://www.geeksforgeeks.org/fixtures-in-pytest/

[mferrera]

Agree, this would be nice to have as a fixture

[slangeveld]

You probably need the prefix "ENH" in the title of the PR as well since the squash merge will use the PR title as the commit message.

[slangeveld]

I see is also this class AnyData using the RootModel as base that might need to have the dunders

fmu-dataio/src/fmu/dataio/_model/data.py

Line 621 in b30c170

class AnyData(RootModel):

[slangeveld]

Nice work 👍 Added a few comments. Note the mypy check that is failing.

@mferrera should probably also take a look at this.

[mferrera]

This looks good. I think fixing the type annotations and using fixtures will make this good-to-go. There might be some more complaints from mypy; we had this experience with @slangeveld implementing __iter__ on another class if I recall

[mferrera]

Agree, this would be nice to have as a fixture

[mferrera]

Fixtures often go into a conftest.py if they are used in multiple places. There is always one in the root of the test structure, but we can also put them into nested directories. It will check the ones in nested directories first before walking down to the test root.

In this case, since the fixtures are so specific to these tests, it's best to just define them within the same test module file, not in a conftest.py

[mferrera]

This type annotation is not quite right. iter() creates an iterator over the Dict[str, Union[Parameters, int, float, str]] so it won't return the dict, and by default iterating over the dict iterates over the keys of the dict.

So it should be:

Suggested change

	def __iter__(self) -> Dict[str, Union[Parameters, int, float, str]]:
	return iter(self.root)
	def __iter__(self) -> Iterator[str]:
	return iter(self.root)

because we have the keys as strings: Dict[str, ...]

[ErichSuter]

Thanks, I was a little bit too quick ...

[mferrera]

Should be the same thing here with returning an Iterator. However, we may need to see if mypy likes this or not 😄

[ErichSuter]

Thanks for your comments, guys :-)
@slangeveld, I also considered the AnyData class. Not obvious at all, but it isn’t an iterable.

[mferrera]

🚀

Remember to squash merge or rebase into a single commit before merging

[slangeveld]

Looks good 😄