These are the current known issues for the Python SDK.
Performance regression in oci v2.38.4 and above¶
In OCI Python SDK version 2.38.4 and later versions, you may encounter performance regressions when using the SDK with some OCI services. The regression surfaces itself as a 3-second increase in latency in SDK operations made to some OCI services. This issue has been confirmed to impact the OCI Streaming service, and likely impacts the following services:
- Email Delivery
- Health Checks
- NoSQL Database Cloud
- Generic Artifacts
- Web Application Acceleration
- Security service
This list is not comprehensive – it is possible you may encounter the issue against other OCI services as well. The issue has been confirmed to NOT affect the OCI Object Storage and Functions services.
We are actively working on fixing this issue, but in the mean time, if you are experiencing this issue there are some workarounds you can do:
- Recommended: Disable support for the OCI Python SDK’s Expect: 100-Continue feature by adding the following environment variable OCI_PYSDK_USING_EXPECT_HEADER to FALSE. For example, in Bash, export OCI_PYSDK_USING_EXPECT_HEADER=FALSE
- Or, use OCI Python SDK version 2.38.3 or earlier
- Or, use the OCI Python SDK’s raw request signer to make requests to OCI services for any requests where you are experiencing performance degradation. An example on how to use the raw request signer is here.
If you have any questions, please feel free to comment on this GitHub issue and we will be happy to help.
create_job_and_wait_for_state() fails with KeyError for ResourceManagerClientCompositeOperations (versions 2.20.0 and above)¶
ResourceManagerClientCompositeOperations.create_job_and_wait_for_state() fails with KeyError: ‘opc-work-request-id’.
UploadManager.upload_stream() raises MultipartUploadError in oci v2.23.2¶
UploadManager.upload_stream() raises MultipartUploadError when a timeout is set on the underlying object storage client, and the operation takes more than the read timeout to complete. Prior to v2.23.2, we were overwriting the timeout to None in the operations (please see this known issue). The default timeout is a read timeout of 60 seconds, hence this scenario will be triggered by default in v2.23.2 on any use of this operation where the operation takes 60 or more seconds to complete. You can work around the issue by explicitly setting the timeout to None. For example,
client.base_client.timeout = None
This issue has been fixed in oci v2.23.3
UploadManager generates ssl3_write_pending error when a read timeout is set for the Object Storage client¶
Update: This issue has partially been fixed in v2.23.2. This issue still may exist with using Python versions < 2.7.9. If you do encounter this issue, please consult the workaround mentioned below.
Update: With v2.18.0 we handle the object storage client with default timeout values (connect timeout = 10 secs and read timeout = 60 secs), by overwriting the timeout to None in the operations.
PLEASE NOTE that the operations are NOT thread-safe, and you should provide the UploadManager class with its own Object Storage client that isn’t used elsewhere.
Details: UploadManager generates the following error when a read timeout is set for the Object Storage client.
OpenSSL.SSL.Error: [('SSL routines', 'ssl3_write_pending', 'bad write retry')]
Workaround: Do not set the read timeout for the Object Storage client. There are a two ways to do so:
- Create an Object Storage client without setting a timeout.
- Clear the timeout on an already initialized Object Storage client by setting the timeout of the base_client to
client.base_client.timeout = None
If you need to retain the connection timeout while clearing the read timeout, you can do so by setting the timeout to a tuple. The first item in the tuple is the connection timeout and the second is the read timeout. In the following example, the connection timeout is set to 90.0 seconds and the read timeout is set to infinite, or no timeout.
client.base_client.timeout = (90.0, None)
Potential data corruption with Python SDK on binary upload (versions 2.8.0 and below)¶
Details: When using the Python SDK to perform binary upload operations you may encounter an issue with data corruption if retries are enabled or if you are using UploadManager.upload_file.
Impacted Versions: v2.8.0 and below
Direct link to this issue: Potential data corruption with Python SDK on binary upload
Default timeout not getting set in the clients (versions 2.17.2 and below)¶
The default timeout values (connect timeout = 10 secs and read timeout = 60 secs) we not getting set in the clients and remained None (infinite timeout). This has been fixed in v2.18.0.