DE-699 | Update global server logs retrieval #299
Conversation
| """Read the global log from server. This method is deprecated | ||
| in ArangoDB 3.8 and will be removed in a future version | ||
| of the driver. Use :func:`arango.database.Database.read_log_entries` | ||
| instead. |
There was a problem hiding this comment.
Happy to adjust the way we address this for a better solution (I am following this precedent).
We could for example use the @deprecated decorator if we add the Deprecated package as a dependency.
There was a problem hiding this comment.
I think having the comment is great, but we should make it visible for users that are not going through the documentation. Or, for example, if they use another package that is built on top of python-arango, they should be able to figure out that there is a problem underneath (ok, this may be an exaggerated example, but you know what I mean).
Using the @deprecated decorator would do just fine. I'm not familiar with it, but a requirement that I find sensible is to allow to user to disable it the warning.
A slightly different approach that I used before is to emit a warning using the standard library, for example here. FutureWarning or DeprecatedWarning would be fit the bill (the latter is disabled by default).
There was a problem hiding this comment.
makes sense!
I've added a warn(..., DeprecationWarning) call in dd7383a
arango.database.Database.read_logarango.database.Database.read_log_entriesmethod