Differential D4931 Diff 17793 swh/clearlydefined/error.py

Changeset View

Standalone View

swh/clearlydefined/error.py

This file was added.

				# Copyright (C) 2021 The Software Heritage developers
				vlorentzUnsubmitted Done Inline Actions only 2021 vlorentz: only 2021
				# See the AUTHORS file at the top-level directory of this distribution
				# License: GNU Affero General Public License version 3, or any later version
				# See top-level LICENSE file for more information


				vlorentzUnsubmitted Done Inline Actions Better name, please. vlorentz: Better name, please.
				class InvalidComponents(Exception):
				"""
				Raise this when ID has invalid components
				For example: maven/mavencentral/cobol-parser/abc/revision/def/0.4.0.json
				"""
				vlorentzUnsubmitted Done Inline Actions this is not needed, the base exception handles it properly already. vlorentz: this is not needed, the base exception handles it properly already.

				pass


				class RevisionNotFound(Exception):
				"""
				Raise this when ID does not has revision component at the expected place
				For example: maven/mavencentral/cobol-parser/abc/0.4.0.json
				"""

				pass


				class WrongMetadata(Exception):
				"""
				Raise this when tried to process invalid metadata
				"""

				pass


				class NoJsonExtension(Exception):
				"""
				Raise this when ID does not have .json extension at end
				vlorentzUnsubmitted Done Inline Actions Could you add docstrings explaining the meaning of each of these? vlorentz: Could you add docstrings explaining the meaning of each of these?
				For example: maven/mavencentral/cobol-parser/revision/0.4.0.txt
				"""

				pass


				class ToolNotFound(Exception):
				"""
				Raise this when ID does not have revision component at the expected place
				For example: npm/npmjs/@ngtools/webpack/revision/10.2.1/abc/scancode/3.2.2.json
				"""

				pass


				class ToolNotSupported(Exception):
				"""
				Raise this when ID contains an unknown tool
				For example: npm/npmjs/@ngtools/webpack/revision/10.2.1/tool/newtool/3.2.2.json
				"""

				pass