Spaces:
Running
Running
File size: 2,574 Bytes
d631808 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
# This module contains collection-related classes,
# which are used throughout the API.
from __future__ import annotations
from typing import TYPE_CHECKING, Any
from _griffe.mixins import DelMembersMixin, GetMembersMixin, SetMembersMixin
if TYPE_CHECKING:
from collections.abc import ItemsView, KeysView, ValuesView
from pathlib import Path
from _griffe.models import Module
class LinesCollection:
"""A simple dictionary containing the modules source code lines."""
def __init__(self) -> None:
"""Initialize the collection."""
self._data: dict[Path, list[str]] = {}
def __getitem__(self, key: Path) -> list[str]:
"""Get the lines of a file path."""
return self._data[key]
def __setitem__(self, key: Path, value: list[str]) -> None:
"""Set the lines of a file path."""
self._data[key] = value
def __contains__(self, item: Path) -> bool:
"""Check if a file path is in the collection."""
return item in self._data
def __bool__(self) -> bool:
"""A lines collection is always true-ish."""
return True
def keys(self) -> KeysView:
"""Return the collection keys.
Returns:
The collection keys.
"""
return self._data.keys()
def values(self) -> ValuesView:
"""Return the collection values.
Returns:
The collection values.
"""
return self._data.values()
def items(self) -> ItemsView:
"""Return the collection items.
Returns:
The collection items.
"""
return self._data.items()
class ModulesCollection(GetMembersMixin, SetMembersMixin, DelMembersMixin):
"""A collection of modules, allowing easy access to members."""
is_collection = True
"""Marked as collection to distinguish from objects."""
def __init__(self) -> None:
"""Initialize the collection."""
self.members: dict[str, Module] = {}
"""Members (modules) of the collection."""
def __bool__(self) -> bool:
"""A modules collection is always true-ish."""
return True
def __contains__(self, item: Any) -> bool:
"""Check if a module is in the collection."""
return item in self.members
@property
def all_members(self) -> dict[str, Module]:
"""Members of the collection.
This property is overwritten to simply return `self.members`,
as `all_members` does not make sense for a modules collection.
"""
return self.members
|