nafcodec-py 0.3.1

PyO3 bindings and Python interface to the nafcodec crate.
Documentation 
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

import os
import typing
from types import TracebackType
from typing import Type, Union, Iterator, Optional, BinaryIO, ContextManager

try:
    from typing import Literal
except ImportError:
    from typing_extensions import Literal  # type: ignore

__version__: str
__author__: str

if typing.TYPE_CHECKING:
    SEQUENCE_TYPE = Literal["dna", "rna", "protein", "text"]
    FORMAT_VERSION = Literal["v1", "v2"]

class Record:
    id: Optional[str]
    comment: Optional[str]
    sequence: Optional[str]
    quality: Optional[str]
    length: Optional[int]
    def __init__(
        self,
        *,
        id: Optional[str] = None,
        comment: Optional[str] = None,
        sequence: Optional[str] = None,
        quality: Optional[str] = None,
        length: Optional[int] = None,
    ): ...
    def __repr__(self) -> str: ...

class Decoder(Iterator[Record], ContextManager[Decoder]):
    def __init__(
        self,
        file: Union[str, os.PathLike[str], BinaryIO],
        *,
        id: bool = True,
        comment: bool = True,
        sequence: bool = True,
        quality: bool = True,
        mask: bool = True,
        buffer_size: Optional[int] = None,
    ) -> None: ...
    def __iter__(self) -> Decoder: ...
    def __next__(self) -> Record: ...
    def __len__(self) -> int: ...
    def __enter__(self) -> Decoder: ...
    def __exit__(
        self,
        exc_type: Optional[Type[BaseException]],
        exc_value: Optional[BaseException],
        traceback: Optional[TracebackType],
    ) -> bool: ...
    @property
    def sequence_type(self) -> SEQUENCE_TYPE: ...
    @property
    def format_version(self) -> FORMAT_VERSION: ...
    @property
    def line_length(self) -> int: ...
    @property
    def name_separator(self) -> str: ...
    @property
    def number_of_sequences(self) -> int: ...
    def read(self) -> Optional[Record]: ...

class Encoder(ContextManager[Encoder]):
    def __init__(
        self,
        file: Union[str, os.PathLike[str], BinaryIO],
        sequence_type: SEQUENCE_TYPE = "dna",
        *,
        id: bool = False,
        comment: bool = False,
        sequence: bool = False,
        quality: bool = False,
    ): ...
    def __enter__(self) -> Encoder: ...
    def __exit__(
        self,
        exc_type: Optional[Type[BaseException]],
        exc_value: Optional[BaseException],
        traceback: Optional[TracebackType],
    ) -> bool: ...
    def write(self, record: Record) -> None: ...
    def close(self) -> None: ...

@typing.overload
def open(
    file: Union[str, os.PathLike[str], BinaryIO],
    mode: Literal["r"],
    **options,
) -> Decoder: ...
@typing.overload
def open(
    file: Union[str, os.PathLike[str], BinaryIO],
    mode: Literal["w"],
    sequence_type: SEQUENCE_TYPE = "dna",
    **options,
) -> Encoder: ...
@typing.overload
def open(
    file: Union[str, os.PathLike[str], BinaryIO],
    mode: Literal["r", "w"] = "r",
    **options,
) -> Union[Decoder, Encoder]: ...