pcvs.helpers.exceptions module

exception pcvs.helpers.exceptions.BankException(reason, help_msg=None, dbg_info=None)[source]

Bases: CommonException

Bank-specific exceptions.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception NotFoundError(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

Bank not Found.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception ProjectNameError(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

name is not a valid project under the given bank.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception pcvs.helpers.exceptions.CommonException(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

Gathers exceptions commonly encountered by more specific namespaces.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception AlreadyExistError(reason='Already Exist')[source]

Bases: PCVSException

The content already exist as it should.

Updated constructor

exception IOError(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

Communication error (FS, process) while processing data.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception NotFoundError(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

Content haven’t been found based on specifications.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception NotImplementedError(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

Missing implementation for this particular feature.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception NotPCVSRelated(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception TimeoutError(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

The parent class timeout error.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception UnclassifiableError(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

Unable to classify this common error.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception WIPError(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

Work in Progress, not a real error.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception pcvs.helpers.exceptions.ConfigException(reason, help_msg=None, dbg_info=None)[source]

Bases: CommonException

Config-specific exceptions.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception pcvs.helpers.exceptions.GitException(reason, help_msg=None, dbg_info=None)[source]

Bases: CommonException

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception BadEntryError(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception pcvs.helpers.exceptions.LockException(reason, help_msg=None, dbg_info=None)[source]

Bases: CommonException

Lock-specific exceptions.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception BadOwnerError(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

Attempt to manipulate the lock while the current process is not the owner.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception TimeoutError(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

Timeout reached before lock.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception pcvs.helpers.exceptions.OrchestratorException(reason, help_msg=None, dbg_info=None)[source]

Bases: CommonException

Execution-specific errors.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception CircularDependencyError(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

Circular dep detected while processing job dep tree.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception UndefDependencyError(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

Declared job dep cannot be fully qualified, not defined.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception pcvs.helpers.exceptions.PCVSException(reason, help_msg=None, dbg_info=None)[source]

Bases: Exception

Generic PCVS error (custom errors will inherit of this).

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

add_dbg(name, info)[source]

Add debug info to the current exception.

Return type:

None

set_dbg(dbg_infos)[source]

Set all debugs infos.

Return type:

None

exception pcvs.helpers.exceptions.PluginException(reason, help_msg=None, dbg_info=None)[source]

Bases: CommonException

Plugin-related exceptions.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception BadStepError(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

targeted pass does not exist.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception LoadError(reason='Issue(s) while loading plugin')[source]

Bases: PCVSException

Unable to load plugin directory.

Updated constructor

exception pcvs.helpers.exceptions.ProfileException(reason, help_msg=None, dbg_info=None)[source]

Bases: CommonException

Profile-specific exceptions.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception IncompleteError(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

A configuration block is missing to build the profile.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception pcvs.helpers.exceptions.PublisherException(reason, help_msg=None, dbg_info=None)[source]

Bases: CommonException

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception AlreadyExistJobError(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

A single ID leads to multiple jobs.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception BadMagicTokenError(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

Issue with token stored to file to check consistency

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception UnknownJobError(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

Unable to identify a job by its ID

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception pcvs.helpers.exceptions.RunException(reason, help_msg=None, dbg_info=None)[source]

Bases: CommonException

Run-specific exceptions.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception InProgressError(path, lockfile, owner_pid, reason='Build directory currently used by another instance')[source]

Bases: PCVSException

A run is currently occurring in the given dir.

Updated constructor

exception NonZeroSetupScript(rc, err, file, reason='A setup script failed to complete')[source]

Bases: PCVSException

a setup script (=pcvs.setup) completed but returned non-zero exit code.

Updated constructor

exception ProgramError(reason='A program cannot be found')[source]

Bases: PCVSException

The given program cannot be found.

Updated constructor

exception pcvs.helpers.exceptions.RunnerException(reason, help_msg=None, dbg_info=None)[source]

Bases: CommonException

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception LaunchError(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

Unable to run a remote container

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception pcvs.helpers.exceptions.TestException(reason, help_msg=None, dbg_info=None)[source]

Bases: CommonException

Test-specific exceptions.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception TestExpressionError(input_files, reason='Issue(s) while parsing a Test Descriptor')[source]

Bases: PCVSException

Test description is wrongly formatted.

Updated constructor

exception pcvs.helpers.exceptions.ValidationException(reason, help_msg=None, dbg_info=None)[source]

Bases: PCVSException

Validation-specific exceptions.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg (str | None) – a help message for the user

  • dbg_info (dict[str, str | None] | None) – a list of additional debug info

exception FormatError(reason='Invalid format')[source]

Bases: PCVSException

The content does not comply the required format (schemes).

Updated constructor

exception InvalidSchemeError(schema, reason='Invalid Scheme provided')[source]

Bases: PCVSException

The schema used to verify the template is not a valid YAML file.

Constructor for generic errors.

Parameters:

  • reason (str) – the main error messages

  • help_msg – a help message for the user

  • dbg_info – a list of additional debug info

exception SchemeError(name, content, error, reason='Fail to verify schema')[source]

Bases: PCVSException

The content is not a valid format (scheme).

Updated constructor

exception SetupError(file)[source]

Bases: PCVSException

An error ocured when run pcvs.setup file.

Constructor for generic errors.

Parameters:

  • reason – the main error messages

  • help_msg – a help message for the user

  • dbg_info – a list of additional debug info

exception WrongTokenError(invalid_tokens, reason='Invalid token(s) used as Placeholders')[source]

Bases: PCVSException

A unknown token is found in valided content

Updated constructor

exception YamlError(file, content)[source]

Bases: PCVSException

An error ocured when parsing an Invalid yaml structure.

Updated Constructor