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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
|
# ==================================================================================================================== #
# _____ _ _ _ _ _ _ _ _ #
# _ __ _ |_ _|__ ___ | (_)_ __ __ _ / \ | |_| |_ _ __(_) |__ _ _| |_ ___ ___ #
# | '_ \| | | || |/ _ \ / _ \| | | '_ \ / _` | / _ \| __| __| '__| | '_ \| | | | __/ _ \/ __| #
# | |_) | |_| || | (_) | (_) | | | | | | (_| |_ / ___ \ |_| |_| | | | |_) | |_| | || __/\__ \ #
# | .__/ \__, ||_|\___/ \___/|_|_|_| |_|\__, (_)_/ \_\__|\__|_| |_|_.__/ \__,_|\__\___||___/ #
# |_| |___/ |___/ #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2017-2026 Patrick Lehmann - Bötzingen, Germany #
# Copyright 2007-2016 Patrick Lehmann - Dresden, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
# You may obtain a copy of the License at #
# #
# http://www.apache.org/licenses/LICENSE-2.0 #
# #
# Unless required by applicable law or agreed to in writing, software #
# distributed under the License is distributed on an "AS IS" BASIS, #
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
# See the License for the specific language governing permissions and #
# limitations under the License. #
# #
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #
#
"""
This Python module offers the base implementation of .NET-like attributes realized with class-based Python decorators.
This module comes also with a mixin-class to ease using classes having annotated methods.
The annotated data is stored as instances of :class:`~pyTooling.Attributes.Attribute` classes in an additional field per
class, method or function. By default, this field is called ``__pyattr__``.
.. hint::
See :ref:`high-level help <ATTR>` for explanations and usage examples.
"""
from enum import IntFlag
from types import MethodType, FunctionType, ModuleType
from typing import Callable, List, TypeVar, Dict, Any, Iterable, Union, Type, Tuple, Generator, ClassVar
from typing import Optional as Nullable
try:
from pyTooling.Decorators import export, readonly
from pyTooling.Common import getFullyQualifiedName
except (ImportError, ModuleNotFoundError): # pragma: no cover
print("[pyTooling.Attributes] Could not import from 'pyTooling.*'!")
try:
from Decorators import export, readonly
from Common import getFullyQualifiedName
except (ImportError, ModuleNotFoundError) as ex: # pragma: no cover
print("[pyTooling.Attributes] Could not import directly!")
raise ex
__all__ = ["Entity", "TAttr", "TAttributeFilter", "ATTRIBUTES_MEMBER_NAME"]
Entity = TypeVar("Entity", bound=Union[Type, Callable])
"""A type variable for functions, methods or classes."""
TAttr = TypeVar("TAttr", bound='Attribute')
"""A type variable for :class:`~pyTooling.Attributes.Attribute`."""
TAttributeFilter = Union[Type[TAttr], Iterable[Type[TAttr]], None]
"""A type hint for a predicate parameter that accepts either a single :class:`~pyTooling.Attributes.Attribute` or an
iterable of those."""
ATTRIBUTES_MEMBER_NAME: str = "__pyattr__"
"""Field name on entities (function, class, method) to store pyTooling.Attributes."""
@export
class AttributeScope(IntFlag):
"""
An enumeration of possible entities an attribute can be applied to.
Values of this enumeration can be merged (or-ed) if an attribute can be applied to multiple language entities.
Supported language entities are: classes, methods or functions. Class fields or module variables are not supported.
"""
Class = 1 #: Attribute can be applied to classes.
Method = 2 #: Attribute can be applied to methods.
Function = 4 #: Attribute can be applied to functions.
Any = Class + Method + Function #: Attribute can be applied to any language entity.
@export
class Attribute: # (metaclass=ExtendedType, slots=True):
"""Base-class for all pyTooling attributes."""
# __AttributesMemberName__: ClassVar[str] = "__pyattr__" #: Field name on entities (function, class, method) to store pyTooling.Attributes.
_functions: ClassVar[List[Any]] = [] #: List of functions, this Attribute was attached to.
_classes: ClassVar[List[Any]] = [] #: List of classes, this Attribute was attached to.
_methods: ClassVar[List[Any]] = [] #: List of methods, this Attribute was attached to.
_scope: ClassVar[AttributeScope] = AttributeScope.Any #: Allowed language construct this attribute can be used with.
# Ensure each derived class has its own instances of class variables.
def __init_subclass__(cls, **kwargs: Any) -> None:
"""
Ensure each derived class has its own instance of ``_functions``, ``_classes`` and ``_methods`` to register the
usage of that Attribute.
"""
super().__init_subclass__(**kwargs)
cls._functions = []
cls._classes = []
cls._methods = []
# Make all classes derived from Attribute callable, so they can be used as a decorator.
def __call__(self, entity: Entity) -> Entity:
"""
Attributes get attached to an entity (function, class, method) and an index is updated at the attribute for reverse
lookups.
:param entity: Entity (function, class, method), to attach an attribute to.
:returns: Same entity, with attached attribute.
:raises TypeError: If parameter 'entity' is not a function, class nor method.
"""
self._AppendAttribute(entity, self)
return entity
@staticmethod
def _AppendAttribute(entity: Entity, attribute: "Attribute") -> None:
"""
Append an attribute to a language entity (class, method, function).
.. hint::
This method can be used in attribute groups to apply multiple attributes within ``__call__`` method.
.. code-block:: Python
class GroupAttribute(Attribute):
def __call__(self, entity: Entity) -> Entity:
self._AppendAttribute(entity, SimpleAttribute(...))
self._AppendAttribute(entity, SimpleAttribute(...))
return entity
:param entity: Entity, the attribute is attached to.
:param attribute: Attribute to attach.
:raises TypeError: If parameter 'entity' is not a class, method or function.
"""
if isinstance(entity, MethodType):
attribute._methods.append(entity)
elif isinstance(entity, FunctionType):
attribute._functions.append(entity)
elif isinstance(entity, type):
attribute._classes.append(entity)
else:
ex = TypeError(f"Parameter 'entity' is not a function, class nor method.")
ex.add_note(f"Got type '{getFullyQualifiedName(entity)}'.")
raise ex
if hasattr(entity, ATTRIBUTES_MEMBER_NAME):
getattr(entity, ATTRIBUTES_MEMBER_NAME).insert(0, attribute)
else:
setattr(entity, ATTRIBUTES_MEMBER_NAME, [attribute, ])
@property
def Scope(cls) -> AttributeScope:
return cls._scope
@classmethod
def GetFunctions(cls, scope: Nullable[Type] = None) -> Generator[TAttr, None, None]:
"""
Return a generator for all functions, where this attribute is attached to.
The resulting item stream can be filtered by:
* ``scope`` - when the item is a nested class in scope ``scope``.
:param scope: Undocumented.
:returns: A sequence of functions where this attribute is attached to.
"""
if scope is None:
for c in cls._functions:
yield c
elif isinstance(scope, ModuleType):
elementsInScope = set(c for c in scope.__dict__.values() if isinstance(c, FunctionType))
for c in cls._functions:
if c in elementsInScope:
yield c
else:
raise NotImplementedError(f"Parameter 'scope' is a class isn't supported yet.")
@classmethod
def GetClasses(cls, scope: Union[Type, ModuleType, None] = None, subclassOf: Nullable[Type] = None) -> Generator[TAttr, None, None]:
# def GetClasses(cls, scope: Nullable[Type] = None, predicate: Nullable[TAttributeFilter] = None) -> Generator[TAttr, None, None]:
"""
Return a generator for all classes, where this attribute is attached to.
The resulting item stream can be filtered by:
* ``scope`` - when the item is a nested class in scope ``scope``.
* ``subclassOf`` - when the item is a subclass of ``subclassOf``.
:param scope: Undocumented.
:param subclassOf: An attribute class or tuple thereof, to filter for that attribute type or subtype.
:returns: A sequence of classes where this attribute is attached to.
"""
from pyTooling.Common import isnestedclass
if scope is None:
if subclassOf is None:
for c in cls._classes:
yield c
else:
for c in cls._classes:
if issubclass(c, subclassOf):
yield c
elif subclassOf is None:
if isinstance(scope, ModuleType):
elementsInScope = set(c for c in scope.__dict__.values() if isinstance(c, type))
for c in cls._classes:
if c in elementsInScope:
yield c
else:
for c in cls._classes:
if isnestedclass(c, scope):
yield c
else:
for c in cls._classes:
if isnestedclass(c, scope) and issubclass(c, subclassOf):
yield c
@classmethod
def GetMethods(cls, scope: Nullable[Type] = None) -> Generator[TAttr, None, None]:
"""
Return a generator for all methods, where this attribute is attached to.
The resulting item stream can be filtered by:
* ``scope`` - when the item is a nested class in scope ``scope``.
:param scope: Undocumented.
:returns: A sequence of methods where this attribute is attached to.
"""
if scope is None:
for c in cls._methods:
yield c
else:
for m in cls._methods:
if m.__classobj__ is scope:
yield m
@classmethod
def GetAttributes(cls, method: MethodType, includeSubClasses: bool = True) -> Tuple['Attribute', ...]:
"""
Returns attached attributes of this kind for a given method.
:param method:
:param includeSubClasses:
:return:
:raises TypeError:
"""
if hasattr(method, ATTRIBUTES_MEMBER_NAME):
attributes = getattr(method, ATTRIBUTES_MEMBER_NAME)
if isinstance(attributes, list):
return tuple(attribute for attribute in attributes if isinstance(attribute, cls))
else:
raise TypeError(f"Method '{method.__class__.__name__}{method.__name__}' has a '{ATTRIBUTES_MEMBER_NAME}' field, but it's not a list of Attributes.")
return tuple()
@export
class SimpleAttribute(Attribute):
_args: Tuple[Any, ...]
_kwargs: Dict[str, Any]
def __init__(self, *args, **kwargs) -> None:
self._args = args
self._kwargs = kwargs
@readonly
def Args(self) -> Tuple[Any, ...]:
return self._args
@readonly
def KwArgs(self) -> Dict[str, Any]:
return self._kwargs
|
