mirror of
https://github.com/beetbox/beets.git
synced 2026-01-30 20:13:37 +01:00
52951bf719
Background
The `_legalize_stage` function was causing issues with Mypy due to
inconsistent type usage between the `path` and `extension` parameters.
This inconsistency stemmed from the `fragment` parameter influencing the
types of these variables.
Key issues
1. `path` was defined as `str`, while `extension` was `bytes`.
2. Depending on `fragment`, `extension` could be either `str` or `bytes`.
3. `path` was sometimes converted to `bytes` within `_legalize_stage`.
Item.destination` method
- The `fragment` parameter determined the output format:
- `False`: Returned absolute path as bytes (default)
- `True`: Returned path relative to library directory as str
Thus
- Rename `fragment` parameter to `relative_to_libdir` for clarity
- Ensure `Item.destination` returns `bytes` in all cases
- Code expecting strings now converts the output to `str`
- Use only `str` type in `_legalize_stage` and `_legalize_path`
functions
- These functions are no longer dependent on `relative_to_libdir`
55 lines
1.8 KiB
Python
55 lines
1.8 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 typing import Any, NamedTuple
|
|
|
|
from beets import util
|
|
|
|
|
|
class Node(NamedTuple):
|
|
files: dict[str, Any]
|
|
dirs: dict[str, Any]
|
|
|
|
|
|
def _insert(node, path, itemid):
|
|
"""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):
|
|
"""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
|