Update `sync_from` and `sync_to` to return the diff and the status of the sync about diffsync HOT 7 CLOSED

This can be done here.

from diffsync.

This can be done here.

Is that issue a task wich can be handled by a new contributor?

from diffsync.

Yes absolutely @dakonr

In fact I had the hacktoberfest label on it until a couple of days ago. Feel free to submit a draft PR if you're unsure about something and you will get some feedback. Thanks!

from diffsync.

ok @Kircheneer I will try my best, you can assign that issue to me (I can't do that by myself)

First of all I need to understand the requirement and the intended behaviour.

• The easy way could be to retrun always true at the end of the function. The code looks like, that on some stop points an error will raise.
• An other solution is to return the diff. That can be used to check the sync and will interpret to true BUT also as false if there is no diff.
• The third solution can return a tuple with state of the sync as first value and the diff as second value.

I couldn't find any clear design principles about that. Wich one will rise the DX @dgarros ?

from diffsync.

I just went through the code and with the way the API is currently structured I am not sure how we can get useful information about a sync status. Like you said, for example here we raise an exception rather then defining some error message to be returned. Since this is a common Python pattern I would prefer that we stick with it rather then returning the result information from the methods. Therefore I vouch for just returning the diff with the successful return of the function signaling execution success. Any differing opinion @glennmatthews?

from diffsync.

I think that makes sense, yeah.

from diffsync.

I agree with you both, the diff will be the best solution and will return more implicit information to the calling procedure.
So, I will start with an implementation of that solution.

from diffsync.