mirror of
https://github.com/beetbox/beets.git
synced 2025-12-06 16:42:42 +01:00
4782e96599
This PR moves the `vfs.py` module, which is only used by plugins, to avoid polluting the main beets namespace. Also exposes the `vfs` and `art` module from beets with a deprecation warning.
63 lines
2 KiB
Python
63 lines
2 KiB
Python
# This file is part of beets.
|
|
# Copyright 2016, Adrian Sampson.
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining
|
|
# a copy of this software and associated documentation files (the
|
|
# "Software"), to deal in the Software without restriction, including
|
|
# without limitation the rights to use, copy, modify, merge, publish,
|
|
# distribute, sublicense, and/or sell copies of the Software, and to
|
|
# permit persons to whom the Software is furnished to do so, subject to
|
|
# the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be
|
|
# included in all copies or substantial portions of the Software.
|
|
|
|
"""A simple utility for constructing filesystem-like trees from beets
|
|
libraries.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, NamedTuple
|
|
|
|
from beets import util
|
|
|
|
if TYPE_CHECKING:
|
|
from beets.library import Library
|
|
|
|
|
|
class Node(NamedTuple):
|
|
files: dict[str, int]
|
|
# Maps filenames to Item ids.
|
|
|
|
dirs: dict[str, Node]
|
|
# Maps directory names to child nodes.
|
|
|
|
|
|
def _insert(node: Node, path: list[str], itemid: int):
|
|
"""Insert an item into a virtual filesystem node."""
|
|
if len(path) == 1:
|
|
# Last component. Insert file.
|
|
node.files[path[0]] = itemid
|
|
else:
|
|
# In a directory.
|
|
dirname = path[0]
|
|
rest = path[1:]
|
|
if dirname not in node.dirs:
|
|
node.dirs[dirname] = Node({}, {})
|
|
_insert(node.dirs[dirname], rest, itemid)
|
|
|
|
|
|
def libtree(lib: Library) -> Node:
|
|
"""Generates a filesystem-like directory tree for the files
|
|
contained in `lib`. Filesystem nodes are (files, dirs) named
|
|
tuples in which both components are dictionaries. The first
|
|
maps filenames to Item ids. The second maps directory names to
|
|
child node tuples.
|
|
"""
|
|
root = Node({}, {})
|
|
for item in lib.items():
|
|
dest = item.destination(relative_to_libdir=True)
|
|
parts = util.components(util.as_string(dest))
|
|
_insert(root, parts, item.id)
|
|
return root
|