File: errors.rst

package info (click to toggle)
gfapy 1.2.3%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 2,036 kB
  • sloc: python: 11,777; sh: 167; makefile: 68
file content (43 lines) | stat: -rw-r--r-- 3,192 bytes parent folder | download | duplicates (2)
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
.. _errors:

Errors
------

The different types of errors defined in Gfapy are summarized in the
following table. All exception raised in the library are subclasses of
`Error`. Thus, ``except gfapy.Error`` can be use to catch
all library errors.

+-----------------------+-------------------------------+---------------------------------+
| Error                 | Description                   | Examples                        |
+=======================+===============================+=================================+
| `VersionError`        | An unknown or wrong version   | "GFA0"; or GFA1 in GFA2 context |
|                       | is specified or implied       |                                 |
+-----------------------+-------------------------------+---------------------------------+
| `ValueError`          | The value of an object is     | a negative position is used     |
|                       | invalid                       |                                 |
+-----------------------+-------------------------------+---------------------------------+
| `TypeError`           | The wrong type has been used  | Z instead of i used for VN tag; |
|                       | or specified                  | Hash for an i tag               |
+-----------------------+-------------------------------+---------------------------------+
| `FormatError`         | The format of an object is    | a line does not contain the     |
|                       | wrong                         | expected number of fields       |
+-----------------------+-------------------------------+---------------------------------+
| `NotUniqueError`      | Something should be unique    | duplicated tag name or line     |
|                       | but is not                    | identifier                      |
+-----------------------+-------------------------------+---------------------------------+
| `InconsistencyError`  | Pieces of information collide | length of sequence and LN tag   |
|                       | with each other               | do not match                    |
+-----------------------+-------------------------------+---------------------------------+
| `RuntimeError`        | The user tried to do          | editing from_segment field in   |
|                       | something which is not        | connected links                 |
|                       | allowed                       |                                 |
+-----------------------+-------------------------------+---------------------------------+
| `ArgumentError`       | Problem with the arguments of | wrong number of arguments in    |
|                       | a method                      | dynamically created method      |
+-----------------------+-------------------------------+---------------------------------+
| `AssertionError`      | Something unexpected happened | there is a bug in the library or|
|                       |                               | the library has been used in    |
|                       |                               | an unintended way               |
+-----------------------+-------------------------------+---------------------------------+