Source code for pcapkit.protocols.data.application.ftp

# -*- coding: utf-8 -*-
"""data models for FTP protocol"""


from typing import TYPE_CHECKING

from pcapkit.corekit.infoclass import info_final
from pcapkit.protocols.data.protocol import Protocol

if TYPE_CHECKING:
    from typing import Optional

    from typing_extensions import Literal

    from pcapkit.const.ftp.command import Command
    from pcapkit.const.ftp.return_code import ReturnCode
    from pcapkit.protocols.application.ftp import Type as FTP_Type

__all__ = [
    'FTP',
    'Request', 'Response',
]




class FTP(Protocol):
    """Data model for FTP protocol."""

    #: Type.
    type: 'FTP_Type'





@info_final
class Request(FTP):
    """Data model for FTP request."""

    #: Type.
    type: 'Literal[FTP_Type.REQUEST]'
    #: Command.
    cmmd: 'Command'
    #: Arguments, :obj:`None` if the command carries none.
    args: 'Optional[str]'
    #: Charset to encode :attr:`args` with, :obj:`None` for UTF-8.
    charset: 'Optional[str]'
    #: Command as received, in its original case; :attr:`cmmd` is the
    #: case-insensitive lookup of it.
    raw_cmmd: 'bytes'

    if TYPE_CHECKING:
        def __init__(self, type: 'Literal[FTP_Type.REQUEST]', cmmd: 'Command', args: 'Optional[str]', charset: 'Optional[str]', raw_cmmd: 'bytes') -> 'None': ...  # pylint: disable=unused-argument,super-init-not-called,multiple-statements,line-too-long,redefined-builtin





@info_final
class Response(FTP):
    """Data model for FTP response."""

    #: Type.
    type: 'Literal[FTP_Type.RESPONSE]'
    #: Return code.
    code: 'ReturnCode'
    #: Arguments, :obj:`None` if the reply carries no text.
    args: 'Optional[str]'
    #: More data flag.
    more: 'bool'
    #: Charset to encode :attr:`args` with, :obj:`None` for UTF-8.
    charset: 'Optional[str]'
    #: Lines of a multi-line reply after the first, as received and without
    #: their CRLF, ending with the closing ``<code> SP`` line; empty unless the
    #: whole reply arrived at once.
    lines: 'tuple[bytes, ...]'

    if TYPE_CHECKING:
        def __init__(self, type: 'Literal[FTP_Type.RESPONSE]', code: 'ReturnCode', args: 'Optional[str]', more: 'bool', charset: 'Optional[str]', lines: 'tuple[bytes, ...]') -> 'None': ...  # pylint: disable=unused-argument,super-init-not-called,multiple-statements,line-too-long,redefined-builtin