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
93
94
95
96
97
98
99
100
|
from pathlib import Path
from typing import Any, Optional
class ResourceDescription:
"""Description of any resource.
Resource descriptions are required to load a resource.
This class can be extended to add more specific properties.
"""
default_kind = "" # The default kind of loader
"""str: The default kind for this resource type"""
resource_type = "" # What resource type is described
"""str: A unique identifier for the resource type"""
def __init__(self, **kwargs: Any):
"""Initialize a resource description
Args:
**kwargs: Attributes describing the resource to load
"""
self._kwargs = kwargs
@property
def path(self) -> Optional[str]:
"""str: The path to a resource when a single file is specified"""
return self._kwargs.get("path")
@property
def label(self) -> Optional[str]:
"""str: optional name for the resource
Assigning a label is not mandatory but can help
when aliasing resources. Some prefer to preload
all needed resources and fetch them later by the label.
This can he a lot less chaotic in larger applications.
"""
return self._kwargs.get("label")
@property
def kind(self) -> str:
"""str: default resource kind.
The resource ``kind`` is directly matched
with the ``kind`` in loader classes.
This property also supports assignment
and is useful if the ``kind`` is detected
based in the the attribute values.
.. code:: python
description.kind = 'something'
"""
k = self._kwargs.get("kind")
if k is None:
k = self.default_kind
return k
@kind.setter
def kind(self, value: str) -> None:
self._kwargs["kind"] = value
@property
def loader_cls(self) -> Optional[type]:
"""type: The loader class for this resource.
This property is assigned to during the loading
stage were a loader class is assigned based on
the `kind`.
"""
return self._kwargs.get("loader_cls")
@loader_cls.setter
def loader_cls(self, value: type) -> None:
self._kwargs["loader_cls"] = value
@property
def resolved_path(self) -> Optional[Path]:
"""pathlib.Path: The resolved path by a finder.
The absolute path to the resource can optionally
be assigned by a loader class.
"""
return self._kwargs.get("resolved_path")
@resolved_path.setter
def resolved_path(self, value: Path) -> None:
self._kwargs["resolved_path"] = value
@property
def attrs(self) -> dict[str, Any]:
"""dict: All keywords arguments passed to the resource"""
return self._kwargs
def __str__(self) -> str:
return str(self._kwargs)
def __repr__(self) -> str:
return str(self)
|
