Remove deprecated functions #246
Conversation
Reviewer's Guide by SourceryThis PR removes four deprecated functions from the audbackend library that were marked for removal in version 2.2.0. To maintain code coverage, new test cases have been added that cover the functionality previously tested through the deprecated functions. The changes primarily focus on test file modifications and the removal of the deprecated API module. Class diagram for audbackend backend changesclassDiagram
class FileSystem {
+create(host, repository)
+delete(host, repository)
+open()
+close()
}
class Artifactory {
+create(host, repository)
+delete(host, repository)
+open()
+close()
}
class Minio {
+create(host, repository)
+delete(host, repository)
+open()
+close()
}
note for FileSystem "Removed deprecated access, create, delete, register functions"
note for Artifactory "Removed deprecated access, create, delete, register functions"
note for Minio "Removed deprecated access, create, delete, register functions"
File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @hagenw - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Review of #246
Afaics this completes a process that has been broader in scope than simplz removing deprecated functions:
together with previous pull requests, the design architecture has changed in that
there now is a division between interface and backend.
The now deleted audbackend/core/api.py had been implementing a kind of delegation design pattern. with public methods being mapped to subclasses' private method by means of a delegation design pattern.
This is now not needed any longer, simplifying the development process.
I sum, I have do not have low level technical comment beyond sourcery's, but
the change in design has left a few scars in the documentation:
I find that the depiction of the two components:
(i) a backend that implements file operations on a specific storing device (audbackend.backend) and (ii) an interface that passes user requests to a backend (audbackend.interface) is not optimally located at the beginning of the API doc.
I think it would make more sense to have such a high-level description more upfront, e.g., at the top of the developer guide or the usage guide, in order to get the documentation reader oriented as fast as possible.
The points that I have raised now do not really target the current Merge Request, rather might stimulate a follow-up issue if at all. As said, apart from that I do not want to get into low level details that looking are good, at least afaics.
Therefore I am approving right now.
|
Thanks for your points regarding how to improve the documentation. Would be cool, if you could create an issue for that, so we don't forget it. |
see #251 |
In the release 2.0.0 (2024-05-10) of
audbackendwe deprecated the functionsaudbackend.access(),audbackend.create(),audbackend.delete(), andaudbackend.register(), and marked them for removal in version 2.2.0. At the moment, we are at version 2.1.0, and the next release will be 2.2.0 as we added a new function in #245.To address it, this pull requests removes:
audbackend.access()audbackend.create()audbackend.delete()audbackend.register()It adds a few new tests in order to preserve code coverage, as before the tests for the deprecated functions were responsible to cover some parts.
Summary by Sourcery
Tests:
Summary by Sourcery
Tests: