Skip to content

declearn.test_utils.setup_server_argparse

Set up an ArgumentParser to be used in a server-side script.

Arguments

usage: str or None, default=None Optional usage string to add to the ArgumentParser. default_host: str, default="localhost" Default value for the 'host' argument. default_port: int, default=8765 Default value for the 'port' argument. default_ptcl: str, default="websockets" Default value for the 'protocol' argument. default_cert: str, default="./server-cert.pem" Default value for the 'certificate' argument. default_pkey: str, default="./server-pkey.pem" Default value for the 'private_key' argument.

Returns:

Name Type Description
parser argparse.ArgumentParser

ArgumentParser with pre-set optional arguments required to configure network communications on the server side.
Source code in declearn/test_utils/_argparse.py 
 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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
def setup_server_argparse(
    usage: Optional[str] = None,
    default_host: str = "localhost",
    default_port: int = 8765,
    default_ptcl: str = "websockets",
    default_cert: str = "./server-cert.pem",
    default_pkey: str = "./server-pkey.pem",
) -> argparse.ArgumentParser:
    """Set up an ArgumentParser to be used in a server-side script.

    Arguments
    ---------
    usage: str or None, default=None
        Optional usage string to add to the ArgumentParser.
    default_host: str, default="localhost"
        Default value for the 'host' argument.
    default_port: int, default=8765
        Default value for the 'port' argument.
    default_ptcl: str, default="websockets"
        Default value for the 'protocol' argument.
    default_cert: str, default="./server-cert.pem"
        Default value for the 'certificate' argument.
    default_pkey: str, default="./server-pkey.pem"
        Default value for the 'private_key' argument.

    Returns
    -------
    parser: argparse.ArgumentParser
        ArgumentParser with pre-set optional arguments required
        to configure network communications on the server side.
    """
    # arguments serve modularity; pylint: disable=too-many-arguments
    parser = argparse.ArgumentParser(
        usage=usage,
        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
    )
    parser.add_argument(
        "--host",
        dest="host",
        type=str,
        help="hostname or IP address on which to serve",
        default=default_host,
    )
    parser.add_argument(
        "--port",
        dest="port",
        type=int,
        help="communication port on which to serve",
        default=default_port,
    )
    parser.add_argument(
        "--protocol",
        dest="protocol",
        type=str,
        help="name of the communication protocol to use",
        default=default_ptcl,
    )
    parser.add_argument(
        "--cert",
        dest="certificate",
        type=str,
        help="path to the server-side ssl certificate",
        default=default_cert,
    )
    parser.add_argument(
        "--pkey",
        dest="private_key",
        type=str,
        help="path to the server-side ssl private key",
        default=default_pkey,
    )
    return parser