Na}{

File Content: `opcode.py`

# Copyright (C) Dnspython Contributors, see LICENSE for text of ISC license

# Copyright (C) 2001-2017 Nominum, Inc.
#
# Permission to use, copy, modify, and distribute this software and its
# documentation for any purpose with or without fee is hereby granted,
# provided that the above copyright notice and this permission notice
# appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND NOMINUM DISCLAIMS ALL WARRANTIES
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL NOMINUM BE LIABLE FOR
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
# OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

"""DNS Opcodes."""

import dns.enum
import dns.exception


class Opcode(dns.enum.IntEnum):
    #: Query
    QUERY = 0
    #: Inverse Query (historical)
    IQUERY = 1
    #: Server Status (unspecified and unimplemented anywhere)
    STATUS = 2
    #: Notify
    NOTIFY = 4
    #: Dynamic Update
    UPDATE = 5

    @classmethod
    def _maximum(cls):
        return 15

    @classmethod
    def _unknown_exception_class(cls):
        return UnknownOpcode


class UnknownOpcode(dns.exception.DNSException):
    """An DNS opcode is unknown."""


def from_text(text: str) -> Opcode:
    """Convert text into an opcode.

    *text*, a ``str``, the textual opcode

    Raises ``dns.opcode.UnknownOpcode`` if the opcode is unknown.

    Returns an ``int``.
    """

    return Opcode.from_text(text)


def from_flags(flags: int) -> Opcode:
    """Extract an opcode from DNS message flags.

    *flags*, an ``int``, the DNS flags.

    Returns an ``int``.
    """

    return Opcode((flags & 0x7800) >> 11)


def to_flags(value: Opcode) -> int:
    """Convert an opcode to a value suitable for ORing into DNS message
    flags.

    *value*, an ``int``, the DNS opcode value.

    Returns an ``int``.
    """

    return (value << 11) & 0x7800


def to_text(value: Opcode) -> str:
    """Convert an opcode to text.

    *value*, an ``int`` the opcode value,

    Raises ``dns.opcode.UnknownOpcode`` if the opcode is unknown.

    Returns a ``str``.
    """

    return Opcode.to_text(value)


def is_update(flags: int) -> bool:
    """Is the opcode in flags UPDATE?

    *flags*, an ``int``, the DNS message flags.

    Returns a ``bool``.
    """

    return from_flags(flags) == Opcode.UPDATE


### BEGIN generated Opcode constants

QUERY = Opcode.QUERY
IQUERY = Opcode.IQUERY
STATUS = Opcode.STATUS
NOTIFY = Opcode.NOTIFY
UPDATE = Opcode.UPDATE

### END generated Opcode constants

Name	Size	Permission
__pycache__	---	0755
dnssecalgs	---	0755
quic	---	0755
rdtypes	---	0755
__init__.py	1663 bytes	0644
_asyncbackend.py	2360 bytes	0644
_asyncio_backend.py	8971 bytes	0644
_ddr.py	5247 bytes	0644
_features.py	2384 bytes	0644
_immutable_ctx.py	2459 bytes	0644
asyncbackend.py	2796 bytes	0644
asyncquery.py	26850 bytes	0644
asyncresolver.py	17852 bytes	0644
dnssec.py	40693 bytes	0644
dnssectypes.py	1799 bytes	0644
e164.py	3978 bytes	0644
edns.py	15263 bytes	0644
entropy.py	4242 bytes	0644
enum.py	3691 bytes	0644
exception.py	5957 bytes	0644
flags.py	2750 bytes	0644
grange.py	2148 bytes	0644
immutable.py	2017 bytes	0644
inet.py	5772 bytes	0644
ipv4.py	2552 bytes	0644
ipv6.py	6600 bytes	0644
message.py	65993 bytes	0644
name.py	42672 bytes	0644
namedict.py	4000 bytes	0644
nameserver.py	9909 bytes	0644
node.py	12663 bytes	0644
opcode.py	2730 bytes	0644
query.py	54832 bytes	0644
rcode.py	4156 bytes	0644
rdata.py	29456 bytes	0644
rdataclass.py	2984 bytes	0644
rdataset.py	16756 bytes	0644
rdatatype.py	7339 bytes	0644
renderer.py	11254 bytes	0644
resolver.py	73552 bytes	0644
reversename.py	3828 bytes	0644
rrset.py	9170 bytes	0644
serial.py	3606 bytes	0644
set.py	9088 bytes	0644
tokenizer.py	23583 bytes	0644
transaction.py	22636 bytes	0644
tsig.py	11413 bytes	0644
tsigkeyring.py	2633 bytes	0644
ttl.py	2979 bytes	0644
update.py	12243 bytes	0644
version.py	1926 bytes	0644
versioned.py	11765 bytes	0644
win32util.py	9107 bytes	0644
wire.py	2830 bytes	0644
xfr.py	13273 bytes	0644
zone.py	52086 bytes	0644
zonefile.py	27929 bytes	0644
zonetypes.py	690 bytes	0644

File Content: opcode.py

File Content: `opcode.py`