msl.loadlib.client64 module

Contains the base class for communicating with a 32-bit library from 64-bit Python.

The Server32 class is used in combination with the Client64 class to communicate with a 32-bit shared library from 64-bit Python.

class msl.loadlib.client64.Client64(module32, host='127.0.0.1', port=None, timeout=10.0, quiet=None, append_sys_path=None, append_environ_path=None, rpc_timeout=None, protocol=None, server32_dir=None, **kwargs)[source]

Bases: object

Base class for communicating with a 32-bit library from 64-bit Python.

Starts a 32-bit server, Server32, to host a Python class that is a wrapper around a 32-bit library. Client64 runs within a 64-bit Python interpreter, and it sends a request to the server which calls the 32-bit library to execute the request. The server then provides a response back to the client.

Changed in version 0.6: Added the rpc_timeout argument.

Changed in version 0.8: Added the protocol argument and the default quiet value became None.

Changed in version 0.10: Added the server32_dir argument.

Parameters:

  • module32 (str) – The name of the Python module that is to be imported by the 32-bit server.

  • host (str, optional) – The address of the 32-bit server. Default is '127.0.0.1'.

  • port (int, optional) – The port to open on the 32-bit server. Default is None, which means to automatically find a port that is available.

  • timeout (float, optional) – The maximum number of seconds to wait to establish a connection to the 32-bit server. Default is 10 seconds.

  • quiet (bool, optional) – This keyword argument is no longer used and will be removed in a future release.

  • append_sys_path (str or list of str, optional) – Append path(s) to the 32-bit server’s sys.path variable. The value of sys.path from the 64-bit process is automatically included, i.e., sys.path(32bit) = sys.path(64bit) + append_sys_path.

  • append_environ_path (str or list of str, optional) – Append path(s) to the 32-bit server’s os.environ['PATH'] variable. This can be useful if the library that is being loaded requires additional libraries that must be available on PATH.

  • rpc_timeout (float, optional) – The maximum number of seconds to wait for a response from the 32-bit server. The RPC timeout value is used for all requests from the server. If you want different requests to have different timeout values then you will need to implement custom timeout handling for each method on the server. Default is None, which means to use the default timeout value used by the socket module (which is to wait forever).

  • protocol (int, optional) – The pickle protocol to use. If not specified then determines the value to use based on the version of Python that the Client64 is running in.

  • server32_dir (str, optional) – The directory where the frozen 32-bit server is located.

  • **kwargs – All additional keyword arguments are passed to the Server32 subclass. The data type of each value is not preserved. It will be a string at the constructor of the Server32 subclass.

Note

If module32 is not located in the current working directory then you must either specify the full path to module32 or you can specify the folder where module32 is located by passing a value to the append_sys_path parameter. Using the append_sys_path option also allows for any other modules that module32 may depend on to also be included in sys.path so that those modules can be imported when module32 is imported.

Raises:

  • ConnectionTimeoutError – If the connection to the 32-bit server cannot be established.

  • OSError – If the frozen executable cannot be found.

  • TypeError – If the data type of append_sys_path or append_environ_path is invalid.

property host

The address of the host for the connection.

Type:

str

property port

The port number of the connection.

Type:

int

property connection

The reference to the connection to the 32-bit server.

Type:

HTTPConnection

property lib32_path

The path to the 32-bit library.

Returns:

str – The path to the 32-bit shared-library file.

request32(name, *args, **kwargs)[source]

Send a request to the 32-bit server.

Parameters:

  • name (str) – The name of an attribute of the Server32 subclass. The name can be a method, property or any attribute.

  • *args – The arguments that the method in the Server32 subclass requires.

  • **kwargs – The keyword arguments that the method in the Server32 subclass requires.

Returns:

Whatever is returned by the method of the Server32 subclass.

Raises:

  • Server32Error – If there was an error processing the request on the 32-bit server.

  • ResponseTimeoutError – If a timeout occurs while waiting for the response from the 32-bit server.

shutdown_server32(kill_timeout=10)[source]

Shutdown the 32-bit server.

This method shuts down the 32-bit server, closes the client connection, and deletes the temporary file that is used to save the serialized pickle’d data.

Changed in version 0.6: Added the kill_timeout argument.

Changed in version 0.8: Returns the (stdout, stderr) streams from the 32-bit server.

Parameters:

kill_timeout (float, optional) – If the 32-bit server is still running after kill_timeout seconds then the server will be killed using brute force. A warning will be issued if the server is killed in this manner.

Returns:

tuple – The (stdout, stderr) streams from the 32-bit server. Limit the total number of characters that are written to either stdout or stderr on the 32-bit server to be < 4096. This will avoid potential blocking when reading the stdout and stderr PIPE buffers.

Note

This method gets called automatically when the reference count to the Client64 object reaches 0 – see __del__().