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
|
# ==================================================================================================================== #
# _____ _ _ _ _ _ #
# _ __ _ |_ _|__ ___ | (_)_ __ __ _ | | (_) ___ ___ _ __ ___(_)_ __ __ _ #
# | '_ \| | | || |/ _ \ / _ \| | | '_ \ / _` | | | | |/ __/ _ \ '_ \/ __| | '_ \ / _` | #
# | |_) | |_| || | (_) | (_) | | | | | | (_| |_| |___| | (_| __/ | | \__ \ | | | | (_| | #
# | .__/ \__, ||_|\___/ \___/|_|_|_| |_|\__, (_)_____|_|\___\___|_| |_|___/_|_| |_|\__, | #
# |_| |___/ |___/ |___/ #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2017-2026 Patrick Lehmann - Bötzingen, 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 #
# ==================================================================================================================== #
#
"""
The Licensing module implements mapping tables for various license names and identifiers.
.. seealso::
List of SPDX identifiers:
* https://spdx.org/licenses/
* https://github.com/spdx/license-list-XML
List of `Python classifiers <https://pypi.org/classifiers/>`__
.. hint::
See :ref:`high-level help <LICENSING>` for explanations and usage examples.
"""
from dataclasses import dataclass
from typing import Any, Dict, Optional as Nullable
try:
from pyTooling.Decorators import export, readonly
from pyTooling.MetaClasses import ExtendedType
except (ImportError, ModuleNotFoundError): # pragma: no cover
print("[pyTooling.Licensing] Could not import from 'pyTooling.*'!")
try:
from Decorators import export, readonly
from MetaClasses import ExtendedType
except (ImportError, ModuleNotFoundError) as ex: # pragma: no cover
print("[pyTooling.Licensing] Could not import directly!")
raise ex
__all__ = [
"PYTHON_LICENSE_NAMES",
"Apache_2_0_License",
"BSD_3_Clause_License",
"GPL_2_0_or_later",
"MIT_License",
"SPDX_INDEX"
]
@export
@dataclass
class PythonLicenseName:
"""A *data class* to represent the license's short name and the package classifier for a license."""
ShortName: str #: License's short name
Classifier: str #: Package classifier for a license.
def __str__(self) -> str:
"""
The string representation of this name tuple returns the short name of the license.
:returns: Short name of the license.
"""
return self.ShortName
#: Mapping of SPDX identifiers to Python license names
PYTHON_LICENSE_NAMES: Dict[str, PythonLicenseName] = {
"Apache-2.0": PythonLicenseName("Apache 2.0", "Apache Software License"),
"BSD-3-Clause": PythonLicenseName("BSD", "BSD License"),
"MIT": PythonLicenseName("MIT", "MIT License"),
"GPL-2.0-or-later": PythonLicenseName("GPL-2.0-or-later", "GNU General Public License v2 or later (GPLv2+)"),
}
@export
class License(metaclass=ExtendedType, slots=True):
"""Representation of a license."""
_spdxIdentifier: str #: Unique SPDX identifier.
_name: str #: Name of the license.
_osiApproved: bool #: OSI approval status
_fsfApproved: bool #: FSF approval status
def __init__(self, spdxIdentifier: str, name: str, osiApproved: bool = False, fsfApproved: bool = False) -> None:
self._spdxIdentifier = spdxIdentifier
self._name = name
self._osiApproved = osiApproved
self._fsfApproved = fsfApproved
@readonly
def Name(self) -> str:
"""
Returns the license' name.
:returns: License name.
"""
return self._name
@readonly
def SPDXIdentifier(self) -> str:
"""
Returns the license' unique `SPDX identifier <https://spdx.org/licenses/>`__.
:returns: The the unique SPDX identifier.
"""
return self._spdxIdentifier
@readonly
def OSIApproved(self) -> bool:
"""
Returns true, if the license is approved by OSI (`Open Source Initiative <https://opensource.org/>`__).
:returns: ``True``, if the license is approved by the Open Source Initiative.
"""
return self._osiApproved
@readonly
def FSFApproved(self) -> bool:
"""
Returns true, if the license is approved by FSF (`Free Software Foundation <https://www.fsf.org/>`__).
:returns: ``True``, if the license is approved by the Free Software Foundation.
"""
return self._fsfApproved
@readonly
def PythonLicenseName(self) -> str:
"""
Returns the Python license name for this license if it's defined.
:returns: The Python license name.
:raises ValueError: If there is no license name defined for the license. |br| (See and check :data:`~pyTooling.Licensing.PYTHON_LICENSE_NAMES`)
"""
try:
item: PythonLicenseName = PYTHON_LICENSE_NAMES[self._spdxIdentifier]
except KeyError as ex:
raise ValueError("License has no Python specify information.") from ex
return item.ShortName
@readonly
def PythonClassifier(self) -> str:
"""
Returns the Python package classifier for this license if it's defined.
:returns: The Python package classifier.
:raises ValueError: If there is no classifier defined for the license. |br| (See and check :data:`~pyTooling.Licensing.PYTHON_LICENSE_NAMES`)
.. seealso::
List of `Python classifiers <https://pypi.org/classifiers/>`__
"""
try:
item: PythonLicenseName = PYTHON_LICENSE_NAMES[self._spdxIdentifier]
except KeyError as ex:
raise ValueError(f"License has no Python specify information.") from ex
osi = "OSI Approved :: " if self._osiApproved else ""
return f"License :: {osi}{item.Classifier}"
def __eq__(self, other: Any) -> bool:
"""
Returns true, if both licenses are identical (comparison based on SPDX identifiers).
:returns: ``True``, if both licenses are identical.
:raises TypeError: If second operand is not of type :class:`License` or :class:`str`.
"""
if isinstance(other, License):
return self._spdxIdentifier == other._spdxIdentifier
else:
ex = TypeError(f"Second operand of type '{other.__class__.__name__}' is not supported by equal operator.")
ex.add_note(f"Supported types for second operand: License, str")
raise ex
def __ne__(self, other: Any) -> bool:
"""
Returns true, if both licenses are not identical (comparison based on SPDX identifiers).
:returns: ``True``, if both licenses are not identical.
:raises TypeError: If second operand is not of type :class:`License` or :class:`str`.
"""
if isinstance(other, License):
return self._spdxIdentifier != other._spdxIdentifier
else:
ex = TypeError(f"Second operand of type '{other.__class__.__name__}' is not supported by unequal operator.")
ex.add_note(f"Supported types for second operand: License, str")
raise ex
def __le__(self, other: Any) -> bool:
"""Returns true, if both licenses are compatible."""
raise NotImplementedError("License compatibility check is not yet implemented.")
def __ge__(self, other: Any) -> bool:
"""Returns true, if both licenses are compatible."""
raise NotImplementedError("License compatibility check is not yet implemented.")
def __repr__(self) -> str:
"""
Returns the internal unique representation (a.k.a SPDX identifier).
:returns: SPDX identifier of the license.
"""
return self._spdxIdentifier
def __str__(self) -> str:
"""
Returns the license' name.
:returns: Name of the license.
"""
return self._name
Apache_2_0_License = License("Apache-2.0", "Apache License 2.0", True, True)
BSD_3_Clause_License = License("BSD-3-Clause", "BSD 3-Clause Revised License", True, True)
GPL_2_0_or_later = License("GPL-2.0-or-later", "GNU General Public License v2.0 or later", True, True)
MIT_License = License("MIT", "MIT License", True, True)
#: Mapping of predefined licenses
SPDX_INDEX: Dict[str, License] = {
"Apache-2.0": Apache_2_0_License,
"BSD-3-Clause": BSD_3_Clause_License,
"GPL-2.0-or-later": GPL_2_0_or_later,
"MIT": MIT_License
}
|
