Skip to content

foapy.chain_mode

chain_mode

Chain mode enumeration controlling how intervals_chain handles sequence boundaries. # noqa: E501

boundary = 1

Sequence treated as finite; boundary intervals are distances to sequence edges.

cycle = 2

Sequence treated as circular; leading and trailing gaps are combined.

Examples:

1
2
3
4
import foapy

print(foapy.chain_mode.boundary)  # 1
print(foapy.chain_mode.cycle)     # 2
Source code in .tox/docs-deploy/lib/python3.11/site-packages/foapy/core/_chain_mode.py 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
class chain_mode:
    """
    Chain mode enumeration controlling how ``intervals_chain`` handles sequence boundaries.  # noqa: E501

    Examples
    --------

    ``` py linenums="1"
    import foapy

    print(foapy.chain_mode.boundary)  # 1
    print(foapy.chain_mode.cycle)     # 2
    ```
    """

    boundary: int = 1
    """Sequence treated as finite; boundary intervals are distances to sequence edges."""  # noqa: E501

    cycle: int = 2
    """Sequence treated as circular; leading and trailing gaps are combined."""

    def __new__(cls, *args, **kwargs):
        raise TypeError(cls.__name__ + " cannot be instantiated.")