Sub-package for resolver classes

audeering / audobject

Generic Python interface for serializing objects to YAML

https://audeering.github.io/audobject/

Other

1 stars 0 forks source link

Sub-package for resolver classes #19

Closed frankenjoe closed 2 years ago

frankenjoe commented 2 years ago

Now that we already have four resolver classes (and there may be more in the future):

FilePathResolver
FunctionResolver
TupleResolver
TypeResolver

I wonder if it would improve the interface if we group them in an own subpackage:

resolver.FilePath
resolver.Function
resolver.Tuple
resolver.Type

And ValueResolver we could rename to resolver.Base to make it more explicit that this is the base class.

@hagenw what's your opinion?

hagenw commented 2 years ago

In principle I agree, but I'm not sure if it is worth the hassle we have when changing this as audobject is already used heavily and it would introduce lots of deprecated warnings popping up at every place.

frankenjoe commented 2 years ago

Yes, that were also my concerns. On the other hand now we are still pre 1.0.0 and could do such a change :)

hagenw commented 2 years ago

Another advantage would be that we could add a small section on top of the API documentation of audobject.resolver discussing what the purpose of resolvers are.

frankenjoe commented 2 years ago

Yep, good point. So I think we should go for it.