object-storage-client 0.4.3__tar.gz → 0.4.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (206) hide show
  1. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/Cargo.lock +1 -1
  2. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/Cargo.toml +1 -1
  3. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/PKG-INFO +11 -7
  4. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/README.md +10 -6
  5. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/docs/BEHAVIOR.md +34 -17
  6. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/docs/CONFIGURATION.md +69 -25
  7. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/docs/DEVELOPMENT.md +35 -24
  8. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/docs/ENCRYPTION.md +56 -34
  9. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/docs/GUI.md +56 -32
  10. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/docs/TESTING.md +22 -11
  11. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/docs/UPGRADING.md +60 -9
  12. object_storage_client-0.4.4/docs/images/osc-gui.png +0 -0
  13. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/python/object_storage_client/__init__.pyi +3 -2
  14. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/backend/azure.rs +271 -1
  15. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/backend/mod.rs +150 -7
  16. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/backend/s3.rs +394 -22
  17. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/client.rs +203 -33
  18. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/connection/aws.rs +23 -0
  19. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/connection/mod.rs +32 -1
  20. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/action/tests.rs +3 -0
  21. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/keys.rs +5 -0
  22. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/model.rs +68 -0
  23. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/ops/tests.rs +74 -0
  24. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/ops.rs +14 -1
  25. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/view/panel.rs +36 -9
  26. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/view/tests.rs +70 -1
  27. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/worker/tests.rs +3 -0
  28. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/python/mod.rs +1 -1
  29. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/integration/gui_ops.rs +53 -0
  30. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/python/test_plain_client.py +37 -0
  31. object_storage_client-0.4.3/docs/images/osc-gui.png +0 -0
  32. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/.cargo/config.toml +0 -0
  33. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/.docker/garage.toml +0 -0
  34. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/.gitattributes +0 -0
  35. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/.github/dependabot.yml +0 -0
  36. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/.github/workflows/ci.yaml +0 -0
  37. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/.github/workflows/perf.yaml +0 -0
  38. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/.github/workflows/tests.yaml +0 -0
  39. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/.gitignore +0 -0
  40. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/.python-version +0 -0
  41. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/LICENSE +0 -0
  42. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/benches/alloc-counter/Cargo.toml +0 -0
  43. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/benches/alloc-counter/src/lib.rs +0 -0
  44. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/benches/common/mod.rs +0 -0
  45. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/benches/throughput.rs +0 -0
  46. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/compose.yml +0 -0
  47. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/deny.toml +0 -0
  48. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/proptest-regressions/encryption/context.txt +0 -0
  49. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/pyproject.toml +0 -0
  50. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/python/object_storage_client/__init__.py +0 -0
  51. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/python/object_storage_client/_stream.py +0 -0
  52. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/python/object_storage_client/_types.py +0 -0
  53. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/python/object_storage_client/py.typed +0 -0
  54. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/scripts/esdk_oracle.py +0 -0
  55. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/scripts/hostile-env.sh +0 -0
  56. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/scripts/perf_smoke.py +0 -0
  57. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/backend/aws_profile.rs +0 -0
  58. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/backend/body.rs +0 -0
  59. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/backend/connector.rs +0 -0
  60. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/backend/gcs.rs +0 -0
  61. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/backend/http.rs +0 -0
  62. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/backend/local.rs +0 -0
  63. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/backend/stub.rs +0 -0
  64. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/bin/osc-gui.rs +0 -0
  65. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/cli/args.rs +0 -0
  66. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/cli/enc/tests.rs +0 -0
  67. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/cli/enc.rs +0 -0
  68. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/cli/harden.rs +0 -0
  69. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/cli/keyring.rs +0 -0
  70. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/cli/output.rs +0 -0
  71. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/cli/tests.rs +0 -0
  72. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/cli/transfer/tests.rs +0 -0
  73. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/cli/transfer.rs +0 -0
  74. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/cli/tree/tests.rs +0 -0
  75. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/cli/tree.rs +0 -0
  76. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/cli.rs +0 -0
  77. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/client/local_delete.rs +0 -0
  78. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/codec.rs +0 -0
  79. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/connection/azure.rs +0 -0
  80. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/connection/gcp.rs +0 -0
  81. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/connection/sso.rs +0 -0
  82. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/encryption/context.rs +0 -0
  83. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/encryption/envelope/tests.rs +0 -0
  84. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/encryption/envelope.rs +0 -0
  85. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/encryption/fixtures.rs +0 -0
  86. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/encryption/frame.rs +0 -0
  87. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/encryption/fuzzing.rs +0 -0
  88. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/encryption/header.rs +0 -0
  89. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/encryption/keys/keyring/tests.rs +0 -0
  90. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/encryption/keys/keyring.rs +0 -0
  91. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/encryption/keys/mod.rs +0 -0
  92. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/encryption/keys/raw_aes.rs +0 -0
  93. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/encryption/mod.rs +0 -0
  94. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/encryption/suite.rs +0 -0
  95. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/encryption/tamper_tests.rs +0 -0
  96. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/forward.rs +0 -0
  97. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/fsmode.rs +0 -0
  98. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/action/close.rs +0 -0
  99. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/action/conn.rs +0 -0
  100. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/action/job.rs +0 -0
  101. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/action/nav.rs +0 -0
  102. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/action/tests/close.rs +0 -0
  103. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/action/tests/conn.rs +0 -0
  104. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/action/tests/jobs.rs +0 -0
  105. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/action/tests/nav.rs +0 -0
  106. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/action.rs +0 -0
  107. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/app.rs +0 -0
  108. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/args.rs +0 -0
  109. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/display.rs +0 -0
  110. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/location.rs +0 -0
  111. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/startup.rs +0 -0
  112. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/view/address_bar.rs +0 -0
  113. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/view/dialogs.rs +0 -0
  114. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/view/startup_error.rs +0 -0
  115. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/view/status.rs +0 -0
  116. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/view/toolbar.rs +0 -0
  117. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/view.rs +0 -0
  118. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui/worker.rs +0 -0
  119. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/gui.rs +0 -0
  120. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/hex.rs +0 -0
  121. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/lib.rs +0 -0
  122. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/main.rs +0 -0
  123. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/python/client.rs +0 -0
  124. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/python/encryption.rs +0 -0
  125. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/python/stream.rs +0 -0
  126. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/registry.rs +0 -0
  127. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/sign.rs +0 -0
  128. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/text.rs +0 -0
  129. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/src/upload.rs +0 -0
  130. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/functional/aws_profile.rs +0 -0
  131. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/functional/cli.rs +0 -0
  132. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/functional/client.rs +0 -0
  133. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/functional/encryption.rs +0 -0
  134. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/functional/golden.rs +0 -0
  135. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/functional/sign.rs +0 -0
  136. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/functional/suite.rs +0 -0
  137. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/functional.rs +0 -0
  138. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/integration/azure_storage_ops.rs +0 -0
  139. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/integration/common/azurite.rs +0 -0
  140. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/integration/common/gcs.rs +0 -0
  141. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/integration/common/mod.rs +0 -0
  142. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/integration/common/provider.rs +0 -0
  143. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/integration/encryption.rs +0 -0
  144. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/integration/file_roundtrip.rs +0 -0
  145. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/integration/gcs_storage_ops.rs +0 -0
  146. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/integration/reencrypt.rs +0 -0
  147. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/integration/s3_storage_ops.rs +0 -0
  148. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/integration/storage_ops.rs +0 -0
  149. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/integration.rs +0 -0
  150. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/perf_guards.rs +0 -0
  151. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/python/conftest.py +0 -0
  152. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/python/test_abort_at_exit.py +0 -0
  153. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/python/test_encrypted_client.py +0 -0
  154. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/python/test_encryption_runtime.py +0 -0
  155. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/python/test_free_threading.py +0 -0
  156. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/python/test_gil_contention.py +0 -0
  157. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/python/test_list_stream.py +0 -0
  158. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/python/test_pipe_native.py +0 -0
  159. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/python/test_profile.py +0 -0
  160. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/python/test_roundtrip.py +0 -0
  161. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/python/test_shared_client.py +0 -0
  162. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/python/test_stream_leak.py +0 -0
  163. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/python/test_stream_sticky.py +0 -0
  164. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/python/test_stub_conformance.py +0 -0
  165. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/python/test_subinterpreter.py +0 -0
  166. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/python/test_worker_threads.py +0 -0
  167. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/support/mini_http.rs +0 -0
  168. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/support/mock.rs +0 -0
  169. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/support/mod.rs +0 -0
  170. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/README.md +0 -0
  171. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/ctx_long.bin +0 -0
  172. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/ctx_min.bin +0 -0
  173. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/ctx_utf8.bin +0 -0
  174. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/manifest.json +0 -0
  175. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/p0_f4096.bin +0 -0
  176. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/p0_f65536.bin +0 -0
  177. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/p1_f4096.bin +0 -0
  178. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/p1_f65536.bin +0 -0
  179. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/p200000_f4096.bin +0 -0
  180. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/p200000_f65536.bin +0 -0
  181. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/p4095_f4096.bin +0 -0
  182. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/p4095_f65536.bin +0 -0
  183. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/p4096_f4096.bin +0 -0
  184. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/p4096_f65536.bin +0 -0
  185. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/p4097_f4096.bin +0 -0
  186. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/p4097_f65536.bin +0 -0
  187. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/p65535_f4096.bin +0 -0
  188. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/p65535_f65536.bin +0 -0
  189. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/p65536_f4096.bin +0 -0
  190. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/p65536_f65536.bin +0 -0
  191. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/p65537_f4096.bin +0 -0
  192. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/esdk/p65537_f65536.bin +0 -0
  193. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/golden/README.md +0 -0
  194. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/golden/v1/context.bin +0 -0
  195. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/golden/v1/keyring +0 -0
  196. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/golden/v1/manifest.json +0 -0
  197. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/golden/v1/old_key.bin +0 -0
  198. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/golden/v1/size_0.bin +0 -0
  199. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/golden/v1/size_1.bin +0 -0
  200. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/golden/v1/size_200000.bin +0 -0
  201. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/golden/v1/size_65536.bin +0 -0
  202. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/keyrings/README.md +0 -0
  203. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/keyrings/one.keyring +0 -0
  204. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/keyrings/other.keyring +0 -0
  205. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/tests/vectors/keyrings/two.keyring +0 -0
  206. {object_storage_client-0.4.3 → object_storage_client-0.4.4}/uv.lock +0 -0
@@ -3346,7 +3346,7 @@ dependencies = [
3346
3346
 
3347
3347
  [[package]]
3348
3348
  name = "object-storage-client"
3349
- version = "0.4.3"
3349
+ version = "0.4.4"
3350
3350
  dependencies = [
3351
3351
  "alloc-counter",
3352
3352
  "async-trait",
@@ -9,7 +9,7 @@ license = "GPL-3.0-only"
9
9
  name = "object-storage-client"
10
10
  readme = "README.md"
11
11
  repository = "https://github.com/bixority/object-storage-client"
12
- version = "0.4.3"
12
+ version = "0.4.4"
13
13
 
14
14
  [lib]
15
15
  # maturin adds the cdylib crate type itself; do not list it here.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: object-storage-client
3
- Version: 0.4.3
3
+ Version: 0.4.4
4
4
  Classifier: Programming Language :: Rust
5
5
  Classifier: Programming Language :: Python :: Implementation :: CPython
6
6
  Classifier: Programming Language :: Python :: 3
@@ -64,7 +64,7 @@ delete objects and whole folders within a panel or between the two, also across
64
64
  accounts and providers. It finds the connections already set up on the machine
65
65
  and takes the same encryption options as `osc`.
66
66
 
67
- ![osc-gui with Local in the left panel and an S3 connection's bucket list in the right panel](docs/images/osc-gui.png)
67
+ ![osc-gui with Local in the left panel and an S3 bucket in the right panel, where archived (❄) and restoring (⌛) objects are greyed out](docs/images/osc-gui.png)
68
68
 
69
69
  ### Install
70
70
 
@@ -94,10 +94,13 @@ osc-gui --keyring keyring # copies encrypt and decrypt
94
94
  Each panel has a connection selector for Local and what is found on the
95
95
  machine: AWS profiles, provider environment variables, gcloud configurations and
96
96
  Azure CLI storage accounts; a cloud connection lists its buckets. Type any
97
- matching URL or path into a panel's address bar and press Enter. If a
98
- connection cannot authenticate, an AWS SSO profile can log in from the panel's
99
- error banner; for gcloud and Azure the banner shows the command to run. The
100
- keys and shortcuts are listed in [Desktop browser](docs/GUI.md), which also
97
+ matching URL or path into a panel's address bar and press Enter. Archived
98
+ objects (S3 Glacier Flexible Retrieval and Deep Archive, Azure Archive tier)
99
+ show ❄ and objects being restored show ⌛; copy, move and rename skip them and
100
+ say why.
101
+ If a connection cannot authenticate, an AWS SSO profile can log in from the
102
+ panel's error banner; for gcloud and Azure the banner shows the command to run.
103
+ The keys and shortcuts are listed in [Desktop browser](docs/GUI.md), which also
101
104
  covers limits and closing behaviour.
102
105
 
103
106
  ## CLI (`osc`)
@@ -407,7 +410,8 @@ health = keyring.status() # active key, key ages, last reload error
407
410
  - [Encryption](docs/ENCRYPTION.md): what it protects, keyrings, Kubernetes, key
408
411
  rotation, responding to a key leak, the format and interop.
409
412
  - [Behaviour and limits](docs/BEHAVIOR.md): URL rules, copy and move, deletes,
410
- file permissions, large objects, pre-signing, CLI and Python details.
413
+ archived objects, file permissions, large objects, pre-signing, CLI and
414
+ Python details.
411
415
  - [Desktop browser](docs/GUI.md): `osc-gui`, its keys, limits and closing.
412
416
  - [Upgrading](docs/UPGRADING.md): breaking changes between releases.
413
417
  - [Development](docs/DEVELOPMENT.md) and [Testing](docs/TESTING.md).
@@ -44,7 +44,7 @@ delete objects and whole folders within a panel or between the two, also across
44
44
  accounts and providers. It finds the connections already set up on the machine
45
45
  and takes the same encryption options as `osc`.
46
46
 
47
- ![osc-gui with Local in the left panel and an S3 connection's bucket list in the right panel](docs/images/osc-gui.png)
47
+ ![osc-gui with Local in the left panel and an S3 bucket in the right panel, where archived (❄) and restoring (⌛) objects are greyed out](docs/images/osc-gui.png)
48
48
 
49
49
  ### Install
50
50
 
@@ -74,10 +74,13 @@ osc-gui --keyring keyring # copies encrypt and decrypt
74
74
  Each panel has a connection selector for Local and what is found on the
75
75
  machine: AWS profiles, provider environment variables, gcloud configurations and
76
76
  Azure CLI storage accounts; a cloud connection lists its buckets. Type any
77
- matching URL or path into a panel's address bar and press Enter. If a
78
- connection cannot authenticate, an AWS SSO profile can log in from the panel's
79
- error banner; for gcloud and Azure the banner shows the command to run. The
80
- keys and shortcuts are listed in [Desktop browser](docs/GUI.md), which also
77
+ matching URL or path into a panel's address bar and press Enter. Archived
78
+ objects (S3 Glacier Flexible Retrieval and Deep Archive, Azure Archive tier)
79
+ show ❄ and objects being restored show ⌛; copy, move and rename skip them and
80
+ say why.
81
+ If a connection cannot authenticate, an AWS SSO profile can log in from the
82
+ panel's error banner; for gcloud and Azure the banner shows the command to run.
83
+ The keys and shortcuts are listed in [Desktop browser](docs/GUI.md), which also
81
84
  covers limits and closing behaviour.
82
85
 
83
86
  ## CLI (`osc`)
@@ -387,7 +390,8 @@ health = keyring.status() # active key, key ages, last reload error
387
390
  - [Encryption](docs/ENCRYPTION.md): what it protects, keyrings, Kubernetes, key
388
391
  rotation, responding to a key leak, the format and interop.
389
392
  - [Behaviour and limits](docs/BEHAVIOR.md): URL rules, copy and move, deletes,
390
- file permissions, large objects, pre-signing, CLI and Python details.
393
+ archived objects, file permissions, large objects, pre-signing, CLI and
394
+ Python details.
391
395
  - [Desktop browser](docs/GUI.md): `osc-gui`, its keys, limits and closing.
392
396
  - [Upgrading](docs/UPGRADING.md): breaking changes between releases.
393
397
  - [Development](docs/DEVELOPMENT.md) and [Testing](docs/TESTING.md).
@@ -73,7 +73,8 @@ decrypts the source and re-encrypts it to the destination, see
73
73
  destination committed.
74
74
 
75
75
  A plain copy or move first reads the start of the source with one extra ranged
76
- request of 1 KiB (up to 16 KiB more only for a larger header). An encrypted object whose header binds a name other than the
76
+ request of 1 KiB (and a second one of at most 16 KiB only for a larger
77
+ header). An encrypted object whose header binds a name other than the
77
78
  destination's is refused with `Error::InvalidInput` and nothing is written or
78
79
  deleted, because the copy would be unreadable; a header that starts like ours
79
80
  but does not parse is refused too. Other objects, and encrypted objects without
@@ -88,18 +89,21 @@ itself (the same path, scheme aliases such as `gs`/`gcs` or `az`/`abfs`, or a
88
89
  encrypted objects alike, whatever the key; an object on an old key stays on it
89
90
  (use `reencrypt`). Only a `file://` path through a symlinked directory with
90
91
  object key binding on is re-encrypted under its new name, and that rewrite is
91
- abandoned with `Error::Changed` if the file changed meanwhile. An encrypted copy or
92
- move whose source is replaced while it is being read is abandoned the same way:
93
- nothing is written and the source is kept. Every move, server-side or
94
- streamed, deletes the source only if it still matches the object that was
95
- copied (size, last-modified, e-tag, version). If it changed, for example
96
- because the destination is another name for the same server (an IP and a
92
+ abandoned with `Error::Changed` if the file changed meanwhile. Every move,
93
+ server-side or streamed, deletes the source only if it still matches the object
94
+ that was copied (size, last-modified, e-tag, version). If it changed, for
95
+ example because the destination is another name for the same server (an IP and a
97
96
  hostname, a CNAME) or a concurrent writer replaced it, the source is kept and
98
97
  `Error::SourceChanged` is returned; the destination stays written. A
99
98
  same-second rewrite with identical bytes on a store that reports no e-tag or
100
99
  version cannot be detected. Only a move inside one `file://` file system is an
101
100
  atomic rename.
102
101
 
102
+ `osc-gui` gives each connection a client of its own. A copy or move between two
103
+ connections always streams, and a move between them onto the same URL is
104
+ refused with `Error::InvalidInput` and keeps the source, because both may reach
105
+ one object.
106
+
103
107
  A copy or move inside one `http(s)://` origin is a WebDAV `COPY` (a move then
104
108
  deletes the source as above), so the server must support `COPY`; one that does
105
109
  not (405 or 501) fails the call, and the copy can be made with `get` and `put`
@@ -133,7 +137,8 @@ sends no `HEAD`; a move still needs one.
133
137
  A plain copy or move between two buckets (containers) of one provider is
134
138
  server-side too, when all of these hold:
135
139
 
136
- - both ends are S3, both GCS or both Azure (not across providers or schemes);
140
+ - both ends are S3, both GCS or both Azure (not across providers; the scheme
141
+ aliases `gs`/`gcs` and `az`/`wasb(s)`/`abfs(s)` count as one provider);
137
142
  - both reach the same endpoint (GCS: the same JSON API origin; Azure: the same
138
143
  storage account) and, for S3, the same region and addressing style;
139
144
  - both use the very same credential provider, which one client shares between
@@ -165,14 +170,15 @@ code `SourceConditionNotMet`). Any other failed answer is an
165
170
  error, never a silent stream, so a refused request is not retried under other
166
171
  credentials. A copy request that fails before any answer, or is answered 429,
167
172
  500, 502, 503 or 504, is sent again after 200 ms and 400 ms, three attempts in
168
- all; a request answered 2xx is never sent again. An S3 `200` counts as a copy
169
- only when its body is a `CopyObjectResult`: S3 may send white space first and
170
- the result or an `<Error>` last, so an empty, cut-off or other body is an
171
- error. A move deletes the source, on its own bucket, only after the copy is
172
- complete, the destination is as large as the source was read to be, and the
173
- source is unchanged. The provider copies the content type
174
- and user metadata; no storage class or access tier is sent. Encrypted copies
175
- never take this path.
173
+ all; a request answered 2xx is never sent again. Each attempt has the limits of
174
+ a bucket operation: 5 s to connect and 30 s in all, answer included. An S3
175
+ `200` counts as a copy only when its body is a `CopyObjectResult`: S3 may send
176
+ white space first and the result or an `<Error>` last, so an empty, cut-off or
177
+ other body is an error. A move deletes the source, on its own bucket, only
178
+ after the copy is complete, the destination is as large as the source was read
179
+ to be, and the source is unchanged. The provider copies the content type and
180
+ user metadata; no storage class or access tier is sent. Encrypted copies never
181
+ take this path.
176
182
 
177
183
  A streamed plain copy keeps the source's `Content-Type`, `Content-Encoding`,
178
184
  `Content-Disposition`, `Content-Language` and `Cache-Control`, and its user
@@ -245,6 +251,16 @@ in full:
245
251
  `Depth: 1` without an error, so the listing silently stops one level deep and
246
252
  misses nested objects.
247
253
 
254
+ ## Archived objects
255
+
256
+ Reading, copying or moving an archived object fails with `Error::Archived`
257
+ (Python: `PermissionError`): for S3 `InvalidObjectState` (a `GLACIER` or
258
+ `DEEP_ARCHIVE` object that is not restored, or an Intelligent-Tiering object in
259
+ an archive tier), for Azure `BlobArchived` (the Archive tier). Restore (S3) or
260
+ rehydrate (Azure) the object first. A delete is not affected, and neither are
261
+ `exists` and plain metadata (a `HEAD`); encrypted metadata and
262
+ `inspect_encryption` read the header and fail the same way.
263
+
248
264
  ## Writes to `file://`
249
265
 
250
266
  This section describes Unix (Linux and macOS). On Windows the crate's own
@@ -348,7 +364,8 @@ source, and gives the same permission bits.
348
364
  the 5 minutes: about 0.9 Mbit/s for the default 4 parts of 8 MiB in flight,
349
365
  about 28.6 Mbit/s for a 1 GiB `http(s)://` put.
350
366
  See [Configuration](CONFIGURATION.md#request-timeouts).
351
- - Bucket operations (`create_bucket`, `bucket_exists`) time out after 5 s to
367
+ - Bucket operations (`create_bucket`, `bucket_exists`) and the requests of a
368
+ server-side copy (see [Copy and move](#copy-and-move)) time out after 5 s to
352
369
  connect and 30 s per request. They never follow a redirect. They use the
353
370
  transport settings of the store: `*_ALLOW_HTTP`, `*_ALLOW_INVALID_CERTIFICATES`,
354
371
  `*_PROXY_URL`, `*_PROXY_CA_CERTIFICATE`, `*_PROXY_EXCLUDES`, `*_USER_AGENT`,
@@ -6,7 +6,9 @@ constructor arguments. The bucket or container always comes from the URL host,
6
6
  so a single process can talk to several buckets across several providers at
7
7
  once. That is what makes cross-provider copy and move work: export the
8
8
  variables for every provider you touch, and a single client can shuttle objects
9
- between them. The local filesystem needs no variables.
9
+ between them. The local filesystem needs no variables. `osc-gui` finds its
10
+ connections on the machine instead, see
11
+ [`osc-gui` connections](#osc-gui-connections).
10
12
 
11
13
  ## AWS S3 (`s3://`)
12
14
 
@@ -48,7 +50,8 @@ and `AWS_PROFILE` is never read (see [AWS profiles and SSO](#aws-profiles-and-ss
48
50
  - The endpoint is the first of `S3_ENDPOINT`, `AWS_ENDPOINT_URL_S3`,
49
51
  `AWS_ENDPOINT` and `AWS_ENDPOINT_URL` that is set and not empty, then, with a
50
52
  profile, the profile's S3 `endpoint_url`. Without any, requests go to AWS,
51
- and bucket calls to `https://s3.<region>.amazonaws.com`, always over https.
53
+ and bucket calls to `https://s3.<region>.amazonaws.com` (virtual-hosted:
54
+ `https://<bucket>.s3.<region>.amazonaws.com`), always over https.
52
55
  - Addressing: `S3_ADDRESSING_STYLE=path` (the default) puts the bucket in the
53
56
  path, `S3_ADDRESSING_STYLE=virtual` puts it in the host. The value is
54
57
  case-insensitive, and any other value is an error. When it is unset,
@@ -75,7 +78,8 @@ and `AWS_PROFILE` is never read (see [AWS profiles and SSO](#aws-profiles-and-ss
75
78
 
76
79
  ### AWS profiles and SSO
77
80
 
78
- A named profile from `~/.aws/config` / `~/.aws/credentials` can supply the
81
+ A named profile from `~/.aws/config` / `~/.aws/credentials` (or the files
82
+ `AWS_CONFIG_FILE` and `AWS_SHARED_CREDENTIALS_FILE` name) can supply the
79
83
  credentials. Select it with `osc --profile NAME`,
80
84
  `ObjectStorageClient(profile="NAME")` in Python or `Client::with_s3_profile` in
81
85
  Rust. The kinds supported are:
@@ -98,8 +102,9 @@ An explicit profile is the only S3 credential source:
98
102
  - `S3_ACCESS_KEY_ID`, `AWS_ACCESS_KEY_ID` and the other static-key variables
99
103
  are not used with it.
100
104
  - `AWS_PROFILE` is never read. A profile is used only when it is named with
101
- `--profile`, `profile=` or `with_s3_profile`. Other profiles (`[default]`
102
- included) are read only through the named profile's `source_profile`.
105
+ `--profile`, `profile=` or `with_s3_profile`, or picked as a connection in
106
+ `osc-gui`. Other profiles (`[default]` included) are read only through the
107
+ named profile's `source_profile`.
103
108
  - There is no fallback to IMDS or any other source when the profile cannot be
104
109
  resolved (unknown name, SSO login missing or expired): that is an error. A
105
110
  `credential_source` named in the profile itself is honoured.
@@ -121,20 +126,23 @@ lookup gives up after 30 seconds. Resolved credentials are cached and renewed
121
126
  when less than 5 minutes remain. While the cached credential has at least 1
122
127
  minute left, a refresh that is running, slow or failed does not hold requests
123
128
  back: they use the cached credential, and a failed refresh is retried after 30
124
- seconds. Its error is not shown until the credential has run out. Credentials without an expiry (static keys in
129
+ seconds. Its error is not shown until less than 1 minute of the credential is
130
+ left. Credentials without an expiry (static keys in
125
131
  the profile, a `credential_process` that prints no `Expiration`,
126
132
  `credential_source = Environment`) are kept until the client is recreated, as
127
133
  in the AWS SDKs. After rotating such a key, create a new client or restart the
128
134
  process.
129
135
 
130
136
  A lookup that times out is not cancelled in the helper: a `credential_process`
131
- program keeps running and is not killed, and it may outlive the process. The
132
- next call joins that lookup instead of starting another helper, for at most 5
133
- minutes; after that it starts a new one.
134
-
135
- Endpoints. A global `AWS_ENDPOINT_URL` is refused with a profile, because the
136
- AWS SDK would send the profile's SSO and STS tokens to it; set the S3 endpoint
137
- with `S3_ENDPOINT` or `AWS_ENDPOINT_URL_S3`. The SDK's own `AWS_ENDPOINT_URL_SSO`,
137
+ program keeps running and is not killed, and it may outlive the process.
138
+ Without a usable cached credential, the next call joins that lookup instead of
139
+ starting another helper, for at most 5 minutes; after that it starts a new one.
140
+ With one, the lookup is given up and a new one starts after the 30-second
141
+ back-off, even if the first helper is still running.
142
+
143
+ Endpoints. A global `AWS_ENDPOINT_URL` is refused with a profile, in `osc` and
144
+ in `osc-gui` alike, because the AWS SDK would send the profile's SSO and STS
145
+ tokens to it; set the S3 endpoint with `S3_ENDPOINT` or `AWS_ENDPOINT_URL_S3`. The SDK's own `AWS_ENDPOINT_URL_SSO`,
138
146
  `AWS_ENDPOINT_URL_SSO_OIDC` and `AWS_ENDPOINT_URL_STS`, and `endpoint_url` or
139
147
  `services` entries in the profile, redirect the SSO token and the STS calls, so
140
148
  treat them as part of the credential configuration.
@@ -146,13 +154,15 @@ own `endpoint_url`.
146
154
 
147
155
  SSO. `sso-session` and legacy SSO profiles read the AWS CLI token cache under
148
156
  `~/.aws/sso/cache` (`HOME`) and rewrite it when they refresh the token, so run
149
- `aws sso login --profile NAME` first. The SSO, SSO-OIDC and STS requests use
157
+ `aws sso login --profile NAME` first (in `osc-gui`, "Log in" on the error
158
+ banner writes the same cache). The SSO, SSO-OIDC and STS requests use
150
159
  the AWS SDK's own HTTP client (see [Development](DEVELOPMENT.md#cargo-features)).
151
160
  The SDK also reads the process environment for its own settings (the SSO and
152
161
  STS endpoint variables above, FIPS and dual-stack settings).
153
162
 
154
163
  `credential_process`. The helper command from `~/.aws/config` is run by osc,
155
- by the library and by the Python service, with that process's privileges. Anyone who can edit the profile files can therefore make those
164
+ by osc-gui, by the library and by the Python service, with that process's
165
+ privileges. Anyone who can edit the profile files can therefore make those
156
166
  processes execute commands, so keep them as private as the keyring. The helper's
157
167
  standard error is never shown. The AWS SDK logs a failing helper's error chain
158
168
  at WARN through `tracing`; this crate suppresses those events for credential
@@ -203,7 +213,8 @@ export GOOGLE_SERVICE_ACCOUNT="/path/to/service-account.json"
203
213
  # gcs_base_url) to reach an emulator.
204
214
  # export GCS_BASE_URL="http://localhost:4443"
205
215
 
206
- # Bucket creation needs the project:
216
+ # Bucket creation, and the bucket list in osc-gui, need the project
217
+ # (GCS_PROJECT_ID is also recognised):
207
218
  # export GOOGLE_CLOUD_PROJECT="my-project"
208
219
  ```
209
220
 
@@ -226,6 +237,8 @@ export AZURE_STORAGE_ACCOUNT_KEY="..."
226
237
  # export AZURE_STORAGE_CLIENT_ID="..."
227
238
  # export AZURE_STORAGE_CLIENT_SECRET="..."
228
239
  # export AZURE_STORAGE_TENANT_ID="..."
240
+ # 4. The Azure CLI login (`az login`)
241
+ # export AZURE_USE_AZURE_CLI=true
229
242
 
230
243
  # A custom http:// AZURE_STORAGE_ENDPOINT (e.g. Azurite) also needs:
231
244
  # export AZURE_ALLOW_HTTP=true
@@ -242,13 +255,42 @@ request for a private container with 404.
242
255
 
243
256
  No environment variables; no credentials are required.
244
257
 
258
+ ## `osc-gui` connections
259
+
260
+ The library and `osc` read the variables above, and a profile only through
261
+ `--profile`, `profile=` or `with_s3_profile`. `osc-gui` instead lists the
262
+ connections it finds on the machine and gives each one a client of its own
263
+ (see [GUI](GUI.md#using-it)):
264
+
265
+ - Local and the "environment" connections of AWS, GCS and Azure read the
266
+ process environment, as `osc` does.
267
+ - An AWS profile connection reads that profile from the files the AWS CLI reads
268
+ (`AWS_CONFIG_FILE` and `AWS_SHARED_CREDENTIALS_FILE` honoured), as
269
+ `--profile` does. A profile without credential settings (keys, SSO, a role,
270
+ `credential_process`, ...) is not listed; a note names it.
271
+ - A gcloud connection uses the configuration's `credential_file_override`,
272
+ else the application default credentials (an `authorized_user` or
273
+ `service_account` file), and the configuration's `project`.
274
+ - An Azure CLI connection is one storage account that Azure Resource Manager
275
+ lists for a subscription, signed in through `az` (`AZURE_USE_AZURE_CLI`).
276
+
277
+ A profile, gcloud or Azure CLI connection takes nothing else from the
278
+ environment: `S3_ENDPOINT`, `AWS_REGION` and the timeout and transport
279
+ variables do not apply to it, and an AWS profile's region and S3
280
+ endpoint come from the profile. The system proxy settings still apply, and the
281
+ AWS SDK's own SSO and STS requests still read the process environment (see
282
+ [AWS profiles and SSO](#aws-profiles-and-sso)). A global `AWS_ENDPOINT_URL` is
283
+ refused for a profile connection, as described under Endpoints: a panel on that
284
+ profile shows the error. Unset the variable to use the profile.
285
+
245
286
  ## Client settings
246
287
 
247
- | Variable | Used by | Effect |
248
- |-----------------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
249
- | `OSC_KEYRING_FILE` | `osc` | Keyring file, the same as `--keyring`. Enables encryption. |
250
- | `OSC_KEYRING_COMMAND` | `osc` | A shell command that prints a keyring, as an alternative to the file; setting both is an error. See [Encryption](ENCRYPTION.md#cli). |
251
- | `OSC_WORKER_THREADS` | Python | Worker threads of the async runtime, default `min(CPU count, 4)`. Set it before the first call. |
288
+ | Variable | Used by | Effect |
289
+ |--------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------|
290
+ | `OSC_KEYRING_FILE` | `osc`, `osc-gui` | Keyring file, the same as `--keyring`. Enables encryption. |
291
+ | `OSC_KEYRING_COMMAND` | `osc`, `osc-gui` | A shell command that prints a keyring, as an alternative to the file; setting both is an error. See [Encryption](ENCRYPTION.md#cli). |
292
+ | `OSC_REQUIRE_ENCRYPTION` | `osc`, `osc-gui` | The same as `--require-encryption` (`1`, `true`, `yes`, `on`): fail instead of reading or writing plaintext when no key source is set. |
293
+ | `OSC_WORKER_THREADS` | Python | Worker threads of the async runtime, default `min(CPU count, 4)`. Set it before the first call. |
252
294
 
253
295
  Set environment variables before the first client call. Do not modify
254
296
  `os.environ` while client calls are in flight: backends read the environment
@@ -284,7 +326,9 @@ aborted. Raise the read timeout for the upload.
284
326
  Set `AWS_TIMEOUT` / `AWS_READ_TIMEOUT`, `GOOGLE_TIMEOUT` / `GOOGLE_READ_TIMEOUT`
285
327
  or `AZURE_TIMEOUT` / `AZURE_READ_TIMEOUT` (for example `90s`, `10m`) to change
286
328
  them for S3, GCS and Azure; a value you set is kept. `http(s)://` stores take
287
- no settings, so their read timeout cannot be raised. Bucket operations keep their own limits (5 s to connect, 30 s per
288
- request), as does the profile credential lookup (30 s). Apart from the limits,
289
- bucket operations follow the client settings of the store (proxy, certificates,
290
- user agent, HTTP version), see [Behaviour](BEHAVIOR.md).
329
+ no settings, so their read timeout cannot be raised. Bucket operations and the
330
+ requests of a server-side copy keep their own limits (5 s to connect, 30 s per
331
+ request, answer included), as does the profile credential lookup (30 s). Apart
332
+ from the limits, bucket operations and copy requests follow the client settings
333
+ of the store (proxy, certificates, user agent, HTTP version), see
334
+ [Behaviour](BEHAVIOR.md).
@@ -3,8 +3,9 @@
3
3
  ## Prerequisites
4
4
 
5
5
  - Rust 1.99+ (edition 2024)
6
- - Python 3.13+ and [uv](https://docs.astral.sh/uv/) for the bindings;
7
- `uv sync --group dev` installs maturin 1.15+, pytest and testcontainers
6
+ - Python 3.13.9 to 3.15 and [uv](https://docs.astral.sh/uv/) for the bindings;
7
+ `uv sync --group dev` installs maturin 1.15+, pytest, testcontainers, ruff,
8
+ ty and pyright
8
9
  - Docker or Podman for the integration tests (see [Testing](TESTING.md))
9
10
  - Nightly Rust and [`cargo-fuzz`](https://github.com/rust-fuzz/cargo-fuzz) for
10
11
  fuzzing
@@ -19,7 +20,10 @@
19
20
  `uv sync --group dev --no-install-project`, then
20
21
  `uv run --no-sync maturin develop`
21
22
 
22
- The committed `.cargo/config.toml` also drives the PyPI wheels, the sdist and the crate, so CPU tuning (for example `-C target-cpu=native`) belongs in `RUSTFLAGS` or your own `~/.cargo/config.toml`, never in the repository.
23
+ The committed `.cargo/config.toml` also drives the PyPI wheels, the sdist and
24
+ the crate, so CPU tuning (for example `-C target-cpu=native`) belongs in
25
+ `RUSTFLAGS` or your own `~/.cargo/config.toml`, never in the repository; the
26
+ `lint` job fails on any table in it other than `[registries]`.
23
27
 
24
28
  ## Cargo features
25
29
 
@@ -70,7 +74,7 @@ cargo check --locked --features fuzzing
70
74
  cargo check --locked --no-default-features --lib
71
75
  cargo check --locked --no-default-features --features encryption --lib
72
76
  cargo check --locked --no-default-features --features gui --bins
73
- cargo check --locked --manifest-path fuzz/Cargo.toml --target-dir target
77
+ cargo check --manifest-path fuzz/Cargo.toml --target-dir target
74
78
  RUSTDOCFLAGS="-D warnings" cargo doc --locked --no-deps --all-features
75
79
  ```
76
80
 
@@ -91,11 +95,15 @@ are working directories and stay ignored. To keep a crash, minimise it with
91
95
  add the output to `fuzz/seeds/<target>/` in the commit that fixes it. There is
92
96
  no scheduled fuzzing job.
93
97
 
94
- `fuzz/Cargo.lock` is committed, so CI builds the fuzz crate with `--locked`
95
- and `cargo deny` checks it (`manifest-path: fuzz/Cargo.toml`); Dependabot
96
- watches `/fuzz` too. It started as a copy of the root `Cargo.lock`, so shared
97
- crates have the same versions. After a root dependency change, refresh it with
98
- `cargo update --manifest-path fuzz/Cargo.toml` and commit it.
98
+ `fuzz/Cargo.lock` is committed and `cargo deny` checks it
99
+ (`manifest-path: fuzz/Cargo.toml`); Dependabot watches `/fuzz` too. CI checks
100
+ the fuzz crate against it without `--locked`, so a stale lock does not fail
101
+ CI. It started as a copy of the root `Cargo.lock`, so shared crates have the
102
+ same versions. After a root dependency change, refresh it with
103
+ `cargo update --manifest-path fuzz/Cargo.toml` and commit it. It also records
104
+ this crate's own version, so refresh it on every version bump with
105
+ `cargo update --manifest-path fuzz/Cargo.toml -p object-storage-client`;
106
+ otherwise a `--locked` check of the fuzz crate fails.
99
107
 
100
108
  ## Layout
101
109
 
@@ -103,7 +111,8 @@ crates have the same versions. After a root dependency change, refresh it with
103
111
  - `src/backend/`: one module per storage provider
104
112
  - `src/encryption/`: message format, framing, keyrings and the encrypting codec
105
113
  - `src/cli.rs`, `src/cli/`, `src/main.rs`: the `osc` binary
106
- - `src/gui.rs`, `src/gui/`, `src/bin/osc-gui.rs`: the `osc-gui` binary
114
+ - `src/gui.rs`, `src/gui/`, `src/bin/osc-gui.rs`: the `osc-gui` binary;
115
+ `src/connection/`: its connection discovery and SSO login
107
116
  - `src/python/`, `python/object_storage_client/`: the bindings and their type stubs
108
117
  - `tests/`, `benches/`, `fuzz/`, `scripts/`: see [Testing](TESTING.md)
109
118
  - `compose.yml`: Garage and Azurite for manual exploration (`docker compose up`)
@@ -113,12 +122,15 @@ crates have the same versions. After a root dependency change, refresh it with
113
122
  - `tests.yaml`: tests, lints, a `cargo deny` check (advisories, bans, sources;
114
123
  see `deny.toml`), feature builds, Python tests and the AWS Encryption SDK
115
124
  interop check, on pushes to `main` and on pull requests. Every cargo call
116
- on the root crate and the fuzz crate passes `--locked`, so a `Cargo.toml` change without its
117
- lockfile fails the PR. Further jobs:
125
+ on the root crate passes `--locked`, so a `Cargo.toml` change without its
126
+ lockfile fails the PR; the fuzz crate check does not (see [Fuzzing](#fuzzing)).
127
+ Further jobs:
118
128
  - `msrv` runs `cargo check --locked --all-features --all-targets` with Rust
119
129
  1.99, the `rust-version` in `Cargo.toml`.
120
130
  - `tests` runs the Rust suite on Linux and macOS, and on Windows the library
121
131
  tests plus a check of every target.
132
+ - `integration` runs the Rust container tests (Garage, Azurite,
133
+ fake-gcs-server) without the 4 GiB tier.
122
134
  - `esdk-interop` fails unless exactly one oracle test passed.
123
135
 
124
136
  Runs on `main` are never cancelled. Its last job,
@@ -128,22 +140,21 @@ crates have the same versions. After a root dependency change, refresh it with
128
140
  (`workflow_dispatch`), because a merge made with `GITHUB_TOKEN` starts no
129
141
  push run, so the merged commit would otherwise go untested.
130
142
  - `perf.yaml`: benchmarks and the memory smoke test, nightly or on demand.
131
- - `ci.yaml`: when a release is published, tests and a `cargo deny` check
132
- (stable Rust only, so a beta or nightly problem cannot block a release;
133
- both publish jobs wait for the deny check), then builds wheels for
134
- Python 3.13, 3.14 and 3.15 and the sdist. `test-wheels` installs every
135
- wheel into a fresh environment on its own platform (Linux x86_64, macOS,
136
- Windows, and the aarch64 Linux wheel under QEMU in its manylinux image;
137
- the legs match `build-wheels`) and runs the Python tests that need no
138
- containers;
139
- both publish jobs wait for it. `package-crate` checks that the tag
140
- equals `v` plus the Cargo.toml version and runs `cargo package --locked`
143
+ - `ci.yaml`: when a release is published, tests, rustfmt and clippy, and a
144
+ `cargo deny` check (stable Rust only, so a beta or nightly problem cannot
145
+ block a release; both publish jobs wait for the deny check), then builds
146
+ wheels for Python 3.13, 3.14 and 3.15 and the sdist. `test-wheels` installs
147
+ every wheel into a fresh environment on its own platform (Linux x86_64,
148
+ macOS, Windows, and the aarch64 Linux wheel under QEMU in its manylinux
149
+ image; the legs match `build-wheels`) and runs the Python tests that need no
150
+ containers; both publish jobs wait for it. `package-crate` checks that the
151
+ tag equals `v` plus the Cargo.toml version and runs `cargo package --locked`
141
152
  without secrets. The publish jobs run only for a published release on a `v*`
142
153
  tag, in the `release` environment, after all of those succeed.
143
154
  `publish-crate` runs `cargo publish --no-verify` (no dependency code runs
144
155
  next to the Codeberg token) and `publish-to-pypi` uses PyPI Trusted
145
- Publishing (OIDC), with no stored token. Run it by hand
146
- (`workflow_dispatch`) from a branch to dry-run everything except publishing.
156
+ Publishing (OIDC), with no stored token. Run it by hand (`workflow_dispatch`)
157
+ from a branch to dry-run everything except publishing.
147
158
  - Every `uses:` in every workflow is pinned to a full commit SHA with the tag
148
159
  in a trailing comment, and the `lint` job fails on an unpinned one.
149
160
  Dependabot proposes updates to the pins weekly; review them by hand.