r47225 - make proper links in epytext
hawkowl-TA+aISz0psMTMxyoc4vAAJOcrHinNvQL0E9HWUfgJXw@public.gmane.org Wed, 13 Apr 2016 23:34:48 -0600 (MDT)
| Newsgroups | gmane.comp.python.twisted.commits |
|---|---|
| Message-ID | <[email protected]> |
Author: hawkowl
Date: Wed Apr 13 23:34:44 2016
New Revision: 47225
Modified:
branches/t-names-authority-py3-8259-3/twisted/names/dns.py
Log:
make proper links in epytext
Modified: branches/t-names-authority-py3-8259-3/twisted/names/dns.py
==============================================================================
--- branches/t-names-authority-py3-8259-3/twisted/names/dns.py (original)
+++ branches/t-names-authority-py3-8259-3/twisted/names/dns.py Wed Apr 13 23:34:44 2016
@@ -69,8 +69,8 @@
Construct a bytes object representing a single byte with the given
ordinal value.
- @type ordinal: C{int}
- @rtype: C{bytes}
+ @type ordinal: L{int}
+ @rtype: L{bytes}
"""
return bytes([ordinal])
@@ -81,7 +81,7 @@
to an end user.
@param bytes: The bytes to represent.
- @rtype: C{str}
+ @rtype: L{str}
"""
return repr(bytes)[1:]
@@ -92,7 +92,7 @@
presentation to an end user.
@param list: The list of bytes to represent.
- @rtype: C{str}
+ @rtype: L{str}
"""
return '[%s]' % (
', '.join([_nicebytes(b) for b in list]),)
@@ -212,7 +212,7 @@
"""
Split a domain name into its constituent labels.
- @type name: C{bytes}
+ @type name: L{bytes}
@param name: A fully qualified domain name (with or without a
trailing dot).
@@ -244,10 +244,10 @@
C{descendantName} is considered a I{subdomain} if its sequence of
labels ends with the labels of C{ancestorName}.
- @type descendantName: C{bytes}
+ @type descendantName: L{bytes}
@param descendantName: The DNS subdomain name.
- @type ancestorName: C{bytes}
+ @type ancestorName: L{bytes}
@param ancestorName: The DNS parent or ancestor domain name.
@return: C{True} if C{descendantName} is equal to or if it is a
@@ -273,7 +273,7 @@
@type s: text string (L{bytes} or L{unicode}) for parsing; anything else
for passthrough.
- @return: an C{int} giving the interval represented by the string C{s}, or
+ @return: an L{int} giving the interval represented by the string C{s}, or
whatever C{s} is if it is not a string.
"""
suffixes = (
@@ -330,7 +330,7 @@
@type strio: File-like object
@param strio: The stream from which bytes may be read
- @type length: C{int} or C{None}
+ @type length: L{int} or L{None}
@param length: The number of bytes in this RDATA field. Most
implementations can ignore this value. Only in the case of
records similar to TXT where the total length is in no way
@@ -409,7 +409,7 @@
I{twistedmatrix.com}.
@ivar name: A byte string giving the name.
- @type name: C{bytes}
+ @type name: L{bytes}
"""
def __init__(self, name=b''):
"""
@@ -545,10 +545,10 @@
@type name: L{bytes} or L{unicode}
@param name: See L{Query.name}
- @type type: C{int}
+ @type type: L{int}
@param type: The query type.
- @type cls: C{int}
+ @type cls: L{int}
@param cls: The query class.
"""
self.name = Name(name)
@@ -836,7 +836,7 @@
"""
A resource record header.
- @cvar fmt: C{str} specifying the byte format of an RR.
+ @cvar fmt: L{str} specifying the byte format of an RR.
@ivar name: The name about which this reply contains information.
@type name: L{Name}
@@ -851,8 +851,8 @@
@ivar payload: An object that implements the L{IEncodable} interface
- @ivar auth: A C{bool} indicating whether this C{RRHeader} was parsed from an
- authoritative message.
+ @ivar auth: A L{bool} indicating whether this C{RRHeader} was parsed from
+ an authoritative message.
"""
compareAttributes = ('name', 'type', 'cls', 'ttl', 'payload', 'auth')
@@ -870,16 +870,16 @@
def __init__(self, name=b'', type=A, cls=IN, ttl=0, payload=None,
auth=False):
"""
- @type name: C{bytes} or L{unicode}
+ @type name: L{bytes} or L{unicode}
@param name: See L{RRHeader.name}
- @type type: C{int}
+ @type type: L{int}
@param type: The query type.
- @type cls: C{int}
+ @type cls: L{int}
@param cls: The query class.
- @type ttl: C{int}
+ @type ttl: L{int}
@param ttl: Time to live for this record.
@type payload: An object implementing C{IEncodable}
@@ -942,7 +942,7 @@
@type name: L{Name}
@ivar name: The name associated with this record.
- @type ttl: C{int}
+ @type ttl: L{int}
@ivar ttl: The maximum number of seconds which this record should be
cached.
"""
@@ -1082,11 +1082,11 @@
"""
An IPv4 host address.
- @type address: C{bytes}
+ @type address: L{bytes}
@ivar address: The packed network-order representation of the IPv4 address
associated with this record.
- @type ttl: C{int}
+ @type ttl: L{int}
@ivar ttl: The maximum number of seconds which this record should be
cached.
"""
@@ -1147,28 +1147,28 @@
@ivar rname: A domain-name which specifies the mailbox of the person
responsible for this zone.
- @type serial: C{int}
+ @type serial: L{int}
@ivar serial: The unsigned 32 bit version number of the original copy of
the zone. Zone transfers preserve this value. This value wraps and
should be compared using sequence space arithmetic.
- @type refresh: C{int}
+ @type refresh: L{int}
@ivar refresh: A 32 bit time interval before the zone should be refreshed.
- @type minimum: C{int}
+ @type minimum: L{int}
@ivar minimum: The unsigned 32 bit minimum TTL field that should be
exported with any RR from this zone.
- @type expire: C{int}
+ @type expire: L{int}
@ivar expire: A 32 bit time value that specifies the upper limit on the
time interval that can elapse before the zone is no longer
authoritative.
- @type retry: C{int}
+ @type retry: L{int}
@ivar retry: A 32 bit time interval that should elapse before a failed
refresh should be retried.
- @type ttl: C{int}
+ @type ttl: L{int}
@ivar ttl: The default TTL to use for records served from this zone.
"""
fancybasename = 'SOA'
@@ -1228,7 +1228,7 @@
This is an experimental record type.
- @type ttl: C{int}
+ @type ttl: L{int}
@ivar ttl: The maximum number of seconds which this record should be
cached.
"""
@@ -1263,11 +1263,11 @@
This record type is obsolete. See L{Record_SRV}.
- @type address: C{bytes}
+ @type address: L{bytes}
@ivar address: The packed network-order representation of the IPv4 address
associated with this record.
- @type protocol: C{int}
+ @type protocol: L{int}
@ivar protocol: The 8 bit IP protocol number for which this service map is
relevant.
@@ -1275,7 +1275,7 @@
@ivar map: A bitvector indicating the services available at the specified
address.
- @type ttl: C{int}
+ @type ttl: L{int}
@ivar ttl: The maximum number of seconds which this record should be
cached.
"""
@@ -1327,7 +1327,7 @@
@ivar address: The packed network-order representation of the IPv6 address
associated with this record.
- @type ttl: C{int}
+ @type ttl: L{int}
@ivar ttl: The maximum number of seconds which this record should be
cached.
@@ -1373,20 +1373,20 @@
This is an experimental record type.
- @type prefixLen: C{int}
+ @type prefixLen: L{int}
@ivar prefixLen: The length of the suffix.
- @type suffix: C{bytes}
+ @type suffix: L{bytes}
@ivar suffix: An IPv6 address suffix in network order.
@type prefix: L{Name}
@ivar prefix: If specified, a name which will be used as a prefix for other
A6 records.
- @type bytes: C{int}
+ @type bytes: L{int}
@ivar bytes: The length of the prefix.
- @type ttl: C{int}
+ @type ttl: L{int}
@ivar ttl: The maximum number of seconds which this record should be
cached.
@@ -1467,18 +1467,18 @@
This is an experimental record type.
- @type priority: C{int}
+ @type priority: L{int}
@ivar priority: The priority of this target host. A client MUST attempt to
contact the target host with the lowest-numbered priority it can reach;
target hosts with the same priority SHOULD be tried in an order defined
by the weight field.
- @type weight: C{int}
+ @type weight: L{int}
@ivar weight: Specifies a relative weight for entries with the same
priority. Larger weights SHOULD be given a proportionately higher
probability of being selected.
- @type port: C{int}
+ @type port: L{int}
@ivar port: The port on this target host of this service.
@type target: L{Name}
@@ -1489,7 +1489,7 @@
section. Unless and until permitted by future standards action, name
compression is not to be used for this field.
- @type ttl: C{int}
+ @type ttl: L{int}
@ivar ttl: The maximum number of seconds which this record should be
cached.
@@ -1536,12 +1536,12 @@
"""
The location of the server(s) for a specific protocol and domain.
- @type order: C{int}
+ @type order: L{int}
@ivar order: An integer specifying the order in which the NAPTR records
MUST be processed to ensure the correct ordering of rules. Low numbers
are processed before high numbers.
- @type preference: C{int}
+ @type preference: L{int}
@ivar preference: An integer that specifies the order in which NAPTR
records with equal "order" values SHOULD be processed, low numbers
being processed before high numbers.
@@ -1570,7 +1570,7 @@
records depending on the value of the flags field. This MUST be a
fully qualified domain-name.
- @type ttl: C{int}
+ @type ttl: L{int}
@ivar ttl: The maximum number of seconds which this record should be
cached.
@@ -1635,7 +1635,7 @@
"""
Map from a domain name to the name of an AFS cell database server.
- @type subtype: C{int}
+ @type subtype: L{int}
@ivar subtype: In the case of subtype 1, the host has an AFS version 3.0
Volume Location Server for the named AFS cell. In the case of subtype
2, the host has an authenticated name server holding the cell-root
@@ -1645,7 +1645,7 @@
@ivar hostname: The domain name of a host that has a server for the cell
named by this record.
- @type ttl: C{int}
+ @type ttl: L{int}
@ivar ttl: The maximum number of seconds which this record should be
cached.
@@ -1696,7 +1696,7 @@
@ivar txt: A domain name for which TXT RR's exist (indirection through
which allows information sharing about the contents of this RP record).
- @type ttl: C{int}
+ @type ttl: L{int}
@ivar ttl: The maximum number of seconds which this record should be
cached.
@@ -1749,7 +1749,7 @@
@type os: L{bytes}
@ivar os: Specifies the OS.
- @type ttl: C{int}
+ @type ttl: L{int}
@ivar ttl: The maximum number of seconds which this record should be
cached.
"""
@@ -1807,7 +1807,7 @@
owner of the MINFO record. If this domain name names the root, errors
should be returned to the sender of the message.
- @type ttl: C{int}
+ @type ttl: L{int}
@ivar ttl: The maximum number of seconds which this record should be
cached.
"""
@@ -1855,7 +1855,7 @@
"""
Mail exchange.
- @type preference: C{int}
+ @type preference: L{int}
@ivar preference: Specifies the preference given to this RR among others at
the same owner. Lower values are preferred.
@@ -1863,7 +1863,7 @@
@ivar name: A domain-name which specifies a host willing to act as a mail
exchange.
- @type ttl: C{int}
+ @type ttl: L{int}
@ivar ttl: The maximum number of seconds which this record should be
cached.
"""
@@ -1902,10 +1902,10 @@
"""
Freeform text.
- @type data: C{list} of C{bytes}
+ @type data: L{list} of L{bytes}
@ivar data: Freeform text which makes up this record.
- @type ttl: C{int}
+ @type ttl: L{int}
@ivar ttl: The maximum number of seconds which this record should be cached.
"""
TYPE = TXT
@@ -1951,10 +1951,10 @@
Encapsulate the wire data for unknown record types so that they can
pass through the system unchanged.
- @type data: C{bytes}
+ @type data: L{bytes}
@ivar data: Wire data which makes up this record.
- @type ttl: C{int}
+ @type ttl: L{int}
@ivar ttl: The maximum number of seconds which this record should be cached.
@since: 11.1
@@ -1996,10 +1996,10 @@
Structurally, freeform text. Semantically, a policy definition, formatted
as defined in U{rfc 4408<http://www.faqs.org/rfcs/rfc4408.html>}.
- @type data: C{list} of C{bytes}
+ @type data: L{list} of L{bytes}
@ivar data: Freeform text which makes up this record.
- @type ttl: C{int}
+ @type ttl: L{int}
@ivar ttl: The maximum number of seconds which this record should be cached.
"""
TYPE = SPF
@@ -2254,13 +2254,13 @@
"""
Add another query to this Message.
- @type name: C{bytes}
+ @type name: L{bytes}
@param name: The name to query.
- @type type: C{int}
+ @type type: L{int}
@param type: Query type
- @type cls: C{int}
+ @type cls: L{int}
@param cls: Query class
"""
self.queries.append(Query(name, type, cls))
@@ -2368,9 +2368,9 @@
Retrieve the L{IRecord} implementation for the given record type.
@param type: A record type, such as L{A} or L{NS}.
- @type type: C{int}
+ @type type: L{int}
- @return: An object which implements L{IRecord} or C{None} if none
+ @return: An object which implements L{IRecord} or L{None} if none
can be found for the given type.
@rtype: L{types.ClassType}
"""
@@ -2382,7 +2382,7 @@
Encode this L{Message} into a byte string in the format described by RFC
1035.
- @rtype: C{bytes}
+ @rtype: L{bytes}
"""
strio = BytesIO()
self.encode(strio)
@@ -2509,7 +2509,7 @@
@param dnssecOK: DNSSEC OK bit as defined by
U{RFC3225 3<https://tools.ietf.org/html/rfc3225#section-3>}.
- @type dnssecOK: C{bool}
+ @type dnssecOK: L{bool}
@param authenticData: A flag indicating in a response that all the data
included in the answer and authority portion of the response has
@@ -2752,13 +2752,13 @@
"""
Send out a message with the given queries.
- @type queries: C{list} of C{Query} instances
+ @type queries: L{list} of C{Query} instances
@param queries: The queries to transmit
- @type timeout: C{int} or C{float}
+ @type timeout: L{int} or C{float}
@param timeout: How long to wait before giving up
- @type id: C{int}
+ @type id: L{int}
@param id: Unique key for this request
@type writeMessage: C{callable}
@@ -2872,10 +2872,10 @@
"""
Send out a message with the given queries.
- @type address: C{tuple} of C{str} and C{int}
+ @type address: L{tuple} of L{str} and L{int}
@param address: The address to which to send the query
- @type queries: C{list} of C{Query} instances
+ @type queries: L{list} of C{Query} instances
@param queries: The queries to transmit
@rtype: C{Deferred}
@@ -2966,7 +2966,7 @@
"""
Send out a message with the given queries.
- @type queries: C{list} of C{Query} instances
+ @type queries: L{list} of C{Query} instances
@param queries: The queries to transmit
@rtype: C{Deferred}