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

Store dependency table as parquet on backend #398

Merged
merged 5 commits into from
May 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 11 additions & 42 deletions audb/core/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
from audb.core.cache import default_cache_root
from audb.core.config import config
from audb.core.dependencies import Dependencies
from audb.core.dependencies import download_dependencies
from audb.core.dependencies import upload_dependencies
from audb.core.flavor import Flavor
from audb.core.lock import FolderLock
from audb.core.repository import Repository
Expand Down Expand Up @@ -262,34 +264,18 @@ def dependencies(
version,
cache_root=cache_root,
)
cached_path = os.path.join(db_root, define.CACHED_DEPENDENCIES_FILE)

deps = Dependencies()
cached_deps_file = os.path.join(db_root, define.CACHED_DEPENDENCIES_FILE)

with FolderLock(db_root):
try:
deps.load(cached_path)
deps = Dependencies()
deps.load(cached_deps_file)
except (AttributeError, FileNotFoundError, ValueError, EOFError):
# If loading cached file fails, load again from backend
backend = utils.lookup_backend(name, version)
with tempfile.TemporaryDirectory() as tmp_root:
archive = backend.join("/", name, define.DB + ".zip")
backend.get_archive(
archive,
tmp_root,
version,
verbose=verbose,
)
# Load parquet or csv from tmp dir
# and store as pickle in cache
deps_path = os.path.join(tmp_root, define.DEPENDENCIES_FILE)
legacy_path = os.path.join(tmp_root, define.LEGACY_DEPENDENCIES_FILE)
if os.path.exists(deps_path):
deps.load(deps_path)
else:
deps.load(legacy_path)
# Store as pickle in cache
deps.save(cached_path)
deps = download_dependencies(backend, name, version, verbose)
# Store as pickle in cache
deps.save(cached_deps_file)

return deps

Expand Down Expand Up @@ -488,19 +474,10 @@ def remove_media(

for version in versions(name):
backend = utils.lookup_backend(name, version)
deps = download_dependencies(backend, name, version, verbose)

with tempfile.TemporaryDirectory() as db_root:
# download dependencies
archive = backend.join("/", name, define.DB + ".zip")
deps_path = backend.get_archive(
archive,
db_root,
version,
verbose=verbose,
)[0]
deps_path = os.path.join(db_root, deps_path)
deps = Dependencies()
deps.load(deps_path)
# Track if we need to upload the dependency table again
upload = False

for file in audeer.progress_bar(
Expand Down Expand Up @@ -549,15 +526,7 @@ def remove_media(

# upload dependencies
if upload:
deps.save(deps_path)
remote_archive = backend.join("/", name, define.DB + ".zip")
backend.put_archive(
db_root,
remote_archive,
version,
files=define.DEPENDENCIES_FILE,
verbose=verbose,
)
upload_dependencies(backend, deps, db_root, name, version)


def repository(
Expand Down
84 changes: 84 additions & 0 deletions audb/core/dependencies.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
import errno
import os
import re
import tempfile
import typing

import pandas as pd
import pyarrow as pa
import pyarrow.csv as csv
import pyarrow.parquet as parquet

import audbackend
import audeer

from audb.core import define
Expand Down Expand Up @@ -752,3 +754,85 @@ def filter_deps(
raise ValueError(msg)

return requested_deps


def download_dependencies(
backend: typing.Type[audbackend.Backend],
name: str,
version: str,
verbose: bool,
) -> Dependencies:
r"""Load dependency file from backend.

Download dependency file
for requested database
to a temporary folder,
and return an dependency object
loaded from that file.

Args:
backend: backend interface
name: database name
version: database version
verbose: if ``True`` a message is shown during download

Returns:
dependency object

"""
with tempfile.TemporaryDirectory() as tmp_root:
# Load `db.parquet` file,
# or if non-existent `db.zip`
# from backend
remote_deps_file = backend.join("/", name, define.DEPENDENCIES_FILE)
if backend.exists(remote_deps_file, version):
local_deps_file = os.path.join(tmp_root, define.DEPENDENCIES_FILE)
backend.get_file(
remote_deps_file,
local_deps_file,
version,
verbose=verbose,
)
else:
remote_deps_file = backend.join("/", name, define.DB + ".zip")
local_deps_file = os.path.join(
tmp_root,
define.LEGACY_DEPENDENCIES_FILE,
)
backend.get_archive(
remote_deps_file,
tmp_root,
version,
verbose=verbose,
)
# Create deps object from downloaded file
deps = Dependencies()
deps.load(local_deps_file)
return deps


def upload_dependencies(
backend: typing.Type[audbackend.Backend],
deps: Dependencies,
db_root: str,
name: str,
version: str,
):
r"""Upload dependency file to backend.

Store a dependency file
in the local database root folder,
and upload it to the backend.

Args:
backend: backend interface
deps: dependency object
db_root: database root folder
name: database name
version: database version

"""
local_deps_file = os.path.join(db_root, define.DEPENDENCIES_FILE)
remote_deps_file = backend.join("/", name, define.DEPENDENCIES_FILE)
deps.save(local_deps_file)
backend.put_file(local_deps_file, remote_deps_file, version)
11 changes: 2 additions & 9 deletions audb/core/publish.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
from audb.core import utils
from audb.core.api import dependencies
from audb.core.dependencies import Dependencies
from audb.core.dependencies import upload_dependencies
from audb.core.repository import Repository


Expand Down Expand Up @@ -748,15 +749,7 @@ def publish(
)

# publish dependencies and header
deps_path = os.path.join(db_root, define.DEPENDENCIES_FILE)
deps.save(deps_path)
archive_file = backend.join("/", db.name, define.DB + ".zip")
backend.put_archive(
db_root,
archive_file,
version,
files=define.DEPENDENCIES_FILE,
)
upload_dependencies(backend, deps, db_root, db.name, version)
try:
local_header = os.path.join(db_root, define.HEADER_FILE)
remote_header = backend.join("/", db.name, define.HEADER_FILE)
Expand Down
Loading