Source code for libcst.metadata.file_path_provider

# Copyright (c) Meta Platforms, Inc. and affiliates.
# This source code is licensed under the MIT license found in the
# LICENSE file in the root directory of this source tree.

from pathlib import Path
from typing import List, Mapping, Optional

import libcst as cst
from libcst.metadata.base_provider import BatchableMetadataProvider

[docs] class FilePathProvider(BatchableMetadataProvider[Path]): """ Provides the path to the current file on disk as metadata for the root :class:`~libcst.Module` node. Requires a :class:`~libcst.metadata.FullRepoManager`. The returned path will always be resolved to an absolute path using :func:`pathlib.Path.resolve`. Example usage: .. code:: python class CustomVisitor(CSTVisitor): METADATA_DEPENDENCIES = [FilePathProvider] path: pathlib.Path def visit_Module(self, node: libcst.Module) -> None: self.path = self.get_metadata(FilePathProvider, node) .. code:: >>> mgr = FullRepoManager(".", {"libcst/"}, {FilePathProvider}) >>> wrapper = mgr.get_metadata_wrapper_for_path("libcst/") >>> fqnames = wrapper.resolve(FilePathProvider) >>> {type(k): v for k, v in wrapper.resolve(FilePathProvider).items()} {<class 'libcst._nodes.module.Module'>: PosixPath('/home/user/libcst/')} """
[docs] @classmethod def gen_cache( cls, root_path: Path, paths: List[str], timeout: Optional[int] = None ) -> Mapping[str, Path]: cache = {path: (root_path / path).resolve() for path in paths} return cache
def __init__(self, cache: Path) -> None: super().__init__(cache) self.path: Path = cache def visit_Module(self, node: cst.Module) -> Optional[bool]: self.set_metadata(node, self.path) return False