From 8bc9e4854292e3c23d50f4185cc68fbbc1a58265 Mon Sep 17 00:00:00 2001
From: Timm Fitschen <t.fitschen@indiscale.com>
Date: Thu, 3 Nov 2022 11:01:32 +0100
Subject: [PATCH] DOC: more docs for the connection classes
---
src/caosdb/connection/connection.py | 2 +-
src/caosdb/connection/encode.py | 2 ++
src/caosdb/schema-pycaosdb-ini.yml | 2 +-
3 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/src/caosdb/connection/connection.py b/src/caosdb/connection/connection.py
index 7ecf0680..4cd8bc77 100644
--- a/src/caosdb/connection/connection.py
+++ b/src/caosdb/connection/connection.py
@@ -204,7 +204,7 @@ class _DefaultCaosDBServerConnection(CaosDBServerConnection):
https_proxy = config["https_proxy"] if "https_proxy" in config else None
self._session = HTTPSession()
- #self._session.mount(self._base_path, _SSLAdapter(ssl_version))
+ self._session.mount(self._base_path, _SSLAdapter(ssl_version))
if socket_proxy is not None:
self._session.proxies = {
"https": "socks5://" + socket_proxy,
diff --git a/src/caosdb/connection/encode.py b/src/caosdb/connection/encode.py
index 689c9ae4..0b826cc4 100644
--- a/src/caosdb/connection/encode.py
+++ b/src/caosdb/connection/encode.py
@@ -479,6 +479,8 @@ def multipart_encode(params, boundary=None, callback=None):
class ReadableMultiparts(object):
+ """Wraps instances of the MultipartYielder class as a readable and withable
+ object."""
def __init__(self, multipart_yielder):
self.multipart_yielder = multipart_yielder
diff --git a/src/caosdb/schema-pycaosdb-ini.yml b/src/caosdb/schema-pycaosdb-ini.yml
index e3ba5ead..d6aff8a8 100644
--- a/src/caosdb/schema-pycaosdb-ini.yml
+++ b/src/caosdb/schema-pycaosdb-ini.yml
@@ -58,7 +58,7 @@ schema-pycaosdb-ini:
https_proxy:
examples: ["http://localhost:8888", "socks5://localhost:8888", "socks4://localhost:8888"]
type: string
- description: Define a proxy for the https connections. These are either (non-TLS) HTTP proxies, SOCKS4 proxies, or SOCKS5 proxies. HTTPS proxies are not supported. However, the connection will be secured using TLS in the tunneled connection nonetheless. Only the connection to the proxy is insecure which is why it is not recommended to use HTTP proxies when authentication against the proxy is necessary. Note: this option is overridden by the HTTPS_PROXY environment variable, if present.
+ description: "Define a proxy for the https connections. These are either (non-TLS) HTTP proxies, SOCKS4 proxies, or SOCKS5 proxies. HTTPS proxies are not supported. However, the connection will be secured using TLS in the tunneled connection nonetheless. Only the connection to the proxy is insecure which is why it is not recommended to use HTTP proxies when authentication against the proxy is necessary. Note: this option is overridden by the HTTPS_PROXY environment variable, if present."
implementation:
description: This option is used internally and for testing. Do not override.
examples: [_DefaultCaosDBServerConnection]
--
GitLab