Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove version from implementation #165

Merged
merged 11 commits into from
Jan 18, 2024
Merged

Conversation

frankenjoe
Copy link
Collaborator

@frankenjoe frankenjoe commented Jan 17, 2024

Relates to #155

This removes the version argument from the backend implementation.

Instead of forwarding path and version to the implementation, Backend integrates the version into the path now. This simplifies the implementation of a backend, since a developer does not have to care about storing the version (especially the implementation of _ls() becomes way simpler). Also the support for legacy file structure is now handled directly by Backend (and as a side-effect supported by any backend).

The suggested changes will allow us to implement audbackend in a way that it can be used without versioning as requested in #155 (not implemented here).

@frankenjoe frankenjoe marked this pull request as draft January 17, 2024 15:55
Copy link

codecov bot commented Jan 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (21a6cce) 100.0% compared to head (249a7c5) 100.0%.

Additional details and impacted files
Files Coverage Δ
audbackend/core/artifactory.py 100.0% <100.0%> (ø)
audbackend/core/backend.py 100.0% <100.0%> (ø)
audbackend/core/conftest.py 100.0% <ø> (ø)
audbackend/core/filesystem.py 100.0% <100.0%> (ø)

@frankenjoe frankenjoe marked this pull request as ready for review January 17, 2024 16:19
@frankenjoe frankenjoe requested a review from hagenw January 17, 2024 16:19
Copy link
Member

@hagenw hagenw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, it's indeed very cool that you don't have to handle version at all when adding a new backend.

@hagenw hagenw merged commit a64eba6 into main Jan 18, 2024
9 checks passed
@hagenw hagenw deleted the remove-version-from-implementation branch January 18, 2024 10:35
hagenw pushed a commit that referenced this pull request May 3, 2024
* Backend: expand path with version

* remove version handling

* remove version handling

* TST: fix test

* TST: fix test of docstring examples

* DOC: fix SQL example

* fix linter errors

* TST: fix use backend path separator when expanding path

* Backend: check path and version in _path_with_version()

* Backend.latest_version(): remove path check

* Backend._ls(): improve docstring
hagenw pushed a commit that referenced this pull request May 3, 2024
* Backend: expand path with version

* remove version handling

* remove version handling

* TST: fix test

* TST: fix test of docstring examples

* DOC: fix SQL example

* fix linter errors

* TST: fix use backend path separator when expanding path

* Backend: check path and version in _path_with_version()

* Backend.latest_version(): remove path check

* Backend._ls(): improve docstring
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants