Updating the docs in dev/ for branch: main, commit 1181156 [skip ci]

Author: scaramallion

dev/_sources/changelog/v3.0.0.rst.txt

@@ -8,6 +8,7 @@ The major breaking changes with the version 3.0 release are:
 * Minimum required pydicom version is 3.0
 * Changed :attr:`~pynetdicom.presentation.StoragePresentationContexts` to match DCMTK
   implementation
+* Various small changes required to support IPv6
 
 Changes
 -------
@@ -18,6 +19,36 @@ Changes
 * Updated SOP classes to version 2025b of the DICOM Standard
 * P-DATA PDUs received during association release are now added to the normal DIMSE
   messaging queue
+* The following changes have been made in order to support IPv6 connections:
+
+  * Changed :meth:`AE.associate()<pynetdicom.ae.ApplicationEntity.associate>` to accept
+    either a str or tuple[str, int, int] as the `addr` parameter.
+  * Changed :meth:`AE.associate()<pynetdicom.ae.ApplicationEntity.associate>` to accept
+    either a tuple[str, int] or tuple[str, int, int, int] as the `bind_address` keyword
+    parameter.
+  * Changed :meth:`AE.make_server()<pynetdicom.ae.ApplicationEntity.associate>` and
+    :meth:`AE.start_server()<pynetdicom.ae.ApplicationEntity.associate>` to
+    accept either a tuple[str, int] or tuple[str, int, int, int] as the `address`
+    parameter.
+  * Added :class:`~pynetdicom.transport.AddressInformation`
+  * :attr:`ServiceUser.address<pynetdicom.association.ServiceUser.address>` and
+    :attr:`ServiceUser.port<pynetdicom.association.ServiceUser.port>` are now
+    read-only properties.
+  * Added :attr:`ServiceUser.address_info
+    <pynetdicom.association.ServiceUser.address_info>`.
+  * Changed :meth:`pynetdicom.transport.AssociationSocket` to accept an
+    :class:`~pynetdicom.transport.AddressInformation` instance as the `address`
+    keyword parameter.
+  * :attr:`RequestHandler.local<pynetdicom.transport.RequestHandler.local>` and
+    :attr:`RequestHandler.remote<pynetdicom.transport.RequestHandler.remote>` now
+    return an :class:`~pynetdicom.transport.AddressInformation` instance
+  * Added :attr:`T_CONNECT.address_info<pynetdicom.transport.T_CONNECT.address_info>`
+  * :attr:`A_ASSOCIATE.calling_presentation_address
+    <pynetdicom.pdu_primitives.A_ASSOCIATE.calling_presentation_address>` and
+    :attr:`A_ASSOCIATE.called_presentation_address
+    <pynetdicom.pdu_primitives.A_ASSOCIATE.called_presentation_address>` are both now
+    set using an :class:`~pynetdicom.transport.AddressInformation` instance
+
 
 Enhancements
 ------------
@@ -26,6 +57,8 @@ Enhancements
   absent from the N-CREATE-RQ can now be done by adding it to the returned *Attribute
   List* dataset (it'll be removed from the dataset prior to sending) (:issue:`995`)
 * Added debugging handlers for the remaining DIMSE-N messages
+* Added :attr:`_config.DEFAULT_BIND_ADDRESS<pynetdicom._config.DEFAULT_BIND_ADDRESS>`
+* Added support for IPv6 connections (:issue:`984`)
 
 
 Fixes

dev/_sources/reference/config.rst.txt

@@ -11,6 +11,7 @@ Configuration Options (:mod:`pynetdicom._config`)
    :toctree: generated/
 
    CODECS
+   DEFAULT_BIND_ADDRESS
    ENFORCE_UID_CONFORMANCE
    LOG_HANDLER_LEVEL
    LOG_REQUEST_IDENTIFIERS

dev/_sources/reference/generated/pynetdicom._config.DEFAULT_BIND_ADDRESS.rst.txt

@@ -0,0 +1,6 @@
+pynetdicom.\_config.DEFAULT\_BIND\_ADDRESS
+==========================================
+
+.. currentmodule:: pynetdicom._config
+
+.. autodata:: DEFAULT_BIND_ADDRESS

dev/_sources/reference/generated/pynetdicom.association.ServiceUser.rst.txt

@@ -28,6 +28,7 @@
    .. autosummary::
 
       ~ServiceUser.accepted_common_extended
+      ~ServiceUser.address
       ~ServiceUser.ae_title
       ~ServiceUser.asynchronous_operations
       ~ServiceUser.extended_negotiation
@@ -38,6 +39,7 @@
       ~ServiceUser.is_requestor
       ~ServiceUser.maximum_length
       ~ServiceUser.mode
+      ~ServiceUser.port
       ~ServiceUser.requested_contexts
       ~ServiceUser.role_selection
       ~ServiceUser.sop_class_common_extended

dev/_sources/reference/generated/pynetdicom.transport.AddressInformation.rst.txt

@@ -0,0 +1,34 @@
+pynetdicom.transport.AddressInformation
+=======================================
+
+.. currentmodule:: pynetdicom.transport
+
+.. autoclass:: AddressInformation
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+      ~AddressInformation.__init__
+      ~AddressInformation.from_addr_port
+      ~AddressInformation.from_tuple
+   
+   
+
+   
+   
+   .. rubric:: Attributes
+
+   .. autosummary::
+   
+      ~AddressInformation.address
+      ~AddressInformation.address_family
+      ~AddressInformation.as_tuple
+      ~AddressInformation.is_ipv4
+      ~AddressInformation.is_ipv6
+   
+   

dev/_sources/reference/generated/pynetdicom.transport.T_CONNECT.rst.txt

@@ -24,6 +24,7 @@
    .. autosummary::
 
       ~T_CONNECT.address
+      ~T_CONNECT.address_info
       ~T_CONNECT.result
 
 

dev/_sources/reference/transport.rst.txt

@@ -17,6 +17,7 @@ communication with peer AEs.
 
    AssociationSocket
    AssociationServer
+   AddressInformation
    RequestHandler
    ThreadedAssociationServer
    T_CONNECT

dev/_sources/tutorials/create_scu.rst.txt

@@ -13,13 +13,13 @@ This tutorial is intended for people who are new to *pynetdicom*. In it you'll:
 * Learn how to perform some basic troubleshooting of associations
 * Modify your AE to be an Echo SCU
 
-The tutorial is written for *pynetdicom* 2.0 and higher, which supports Python
-3.7+. You can tell which version of *pynetdicom* you have by running
+The tutorial is written for *pynetdicom* 3.0 and higher, which supports Python
+3.10+. You can tell which version of *pynetdicom* you have by running
 the following command::
 
     $ python -m pynetdicom --version
 
-If you get an error or if your version is earlier than 2.0, then install or
+If you get an error or if your version is earlier than 3.0, then install or
 upgrade *pynetdicom* by following the instructions in the
 :doc:`installation guide</tutorials/installation>`. For
 this tutorial we'll also be using the :doc:`echoscp<../apps/echoscp>`

dev/_sources/user/ae.rst.txt

@@ -221,15 +221,22 @@ Specifying the network port
 In general it shouldn't be necessary to specify the port when acting as an SCU,
 as by default *pynetdicom* will use the first port available. To specify the
 port number manually you can use the *bind_address* keyword parameter when
-requesting an association, which takes a 2-tuple of (:class:`str` *host*,
-:class:`int` *port*):
+requesting an association, which takes:
+
+* For IPv4 or IPv6 a 2-tuple of (:class:`str` *host*, :class:`int` *port*), with the
+  `flowinfo` and `scope_id` defaulting to ``0`` for IPv6, or,
+* For IPv6 a 4-tuple of (:class:`str` *host*, :class:`int` *port*, :class:`int`
+  flowinfo, :class:`int` scope_id)
 
 .. doctest::
 
     >>> from pynetdicom import AE
     >>> ae = AE()
     >>> ae.add_requested_context('1.2.840.10008.1.1')
     >>> assoc = ae.associate("127.0.0.1", 11112, bind_address=("127.0.0.1", 11113))  # doctest: +SKIP
+    >>> assoc.release()
+    >>> assoc = ae.associate("::1", 11112, bind_address=("::1", 11113))  # doctest: +SKIP
+    >>> assoc.release()
 
 .. note::
 
@@ -497,15 +504,22 @@ to see the requirements for implementations of the ``evt.EVT_USER_ID`` handler.
 Specifying the bind address
 ...........................
 The bind address for the server socket is specified by the *address*
-parameter to :meth:`~pynetdicom.ae.ApplicationEntity.start_server` as
-(str *host*, int *port*).
+parameter to :meth:`~pynetdicom.ae.ApplicationEntity.start_server` as:
+
+* For IPv4 or IPv6 a 2-tuple of (:class:`str` *host*, :class:`int` *port*), with the
+  `flowinfo` and `scope_id` defaulting to ``0`` for IPv6, or,
+* For IPv6 a 4-tuple of (:class:`str` *host*, :class:`int` *port*, :class:`int`
+  flowinfo, :class:`int` scope_id)
 
 .. code-block:: python
 
     >>> from pynetdicom import AE
     >>> ae = AE()
     >>> ae.add_supported_context('1.2.840.10008.1.1')
-    >>> ae.start_server(("127.0.0.1", 11112))
+    >>> server = ae.start_server(("127.0.0.1", 11112), block=False)
+    >>> server.shutdown()
+    >>> server = ae.start_server(("::1", 11112), block=False)
+    >>> server.shutdown()
 
 
 Association

dev/_sources/user/association.rst.txt

@@ -23,14 +23,15 @@ method, which returns an :class:`Association` thread:
     ae = AE()
     ae.add_requested_context(Verification)
 
-    # Associate with the peer at IP address 127.0.0.1 and port 11112
+    # Associate with the peer at IPv4 address 127.0.0.1 and port 11112
+    #   IPv6 is also supported
     assoc = ae.associate("127.0.0.1", 11112)
 
     # Release the association
     if assoc.is_established:
         assoc.release()
 
-This sends an association request to the IP address ``127.0.0.1`` on port
+This sends an association request to the IPv4 address ``127.0.0.1`` on port
 ``11112`` with the request containing the presentation contexts from
 :attr:`AE.requested_contexts<pynetdicom.ae.ApplicationEntity.requested_contexts>`
 and the default *Called AE Title* parameter of ``'ANY-SCP'``.
@@ -96,7 +97,7 @@ also acting as a Storage SCP), plus a *User Identity Negotiation* item:
     ae = AE()
     # Contexts supported as a Storage SCP - requires Role Selection
     #   Note that we are limited to a maximum of 128 contexts.
-    #   StoragePresentationContexts includes 120, it is therefore 
+    #   StoragePresentationContexts includes 120, it is therefore
     #   possible to add 8 additional presentation contexts if needed.
     ae.requested_contexts = StoragePresentationContexts
     # Contexts proposed as a QR SCU
@@ -343,7 +344,7 @@ method:
     ae = AE()
     ae.add_supported_context(Verification)
 
-    # Listen for association requests
+    # Listen for association requests on a IPv4 address, IPv6 is also supported
     ae.start_server(("127.0.0.1", 11112))
 
 The above is suitable as an implementation of the Verification Service