Merge pull request #487 from Backblaze/v2.x

semver v2 release

b2sdk/__init__.py

@@ -9,19 +9,6 @@
 ######################################################################
 from __future__ import annotations
 
-# Set default logging handler to avoid "No handler found" warnings.
-import logging
-
-logging.getLogger(__name__).addHandler(logging.NullHandler())
-
-
-class UrllibWarningFilter:
-    def filter(self, record):
-        return record.msg != "Connection pool is full, discarding connection: %s"
-
-
-logging.getLogger('urllib3.connectionpool').addFilter(UrllibWarningFilter())
-
 import b2sdk.version  # noqa: E402
 __version__ = b2sdk.version.VERSION
 assert __version__  # PEP-0396

b2sdk/account_info/__init__.py → b2sdk/_internal/account_info/__init__.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/account_info/__init__.py
+# File: b2sdk/_internal/account_info/__init__.py
 #
 # Copyright 2019 Backblaze Inc. All Rights Reserved.
 #

b2sdk/account_info/abstract.py → b2sdk/_internal/account_info/abstract.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/account_info/abstract.py
+# File: b2sdk/_internal/account_info/abstract.py
 #
 # Copyright 2019 Backblaze Inc. All Rights Reserved.
 #
@@ -11,9 +11,9 @@
 
 from abc import abstractmethod
 
-from b2sdk.account_info import exception
-from b2sdk.raw_api import ALL_CAPABILITIES
-from b2sdk.utils import B2TraceMetaAbstract, limit_trace_arguments
+from b2sdk._internal.account_info import exception
+from b2sdk._internal.raw_api import ALL_CAPABILITIES
+from b2sdk._internal.utils import B2TraceMetaAbstract, limit_trace_arguments
 
 
 class AbstractAccountInfo(metaclass=B2TraceMetaAbstract):

b2sdk/account_info/exception.py → b2sdk/_internal/account_info/exception.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/account_info/exception.py
+# File: b2sdk/_internal/account_info/exception.py
 #
 # Copyright 2019 Backblaze Inc. All Rights Reserved.
 #

b2sdk/account_info/in_memory.py → b2sdk/_internal/account_info/in_memory.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/account_info/in_memory.py
+# File: b2sdk/_internal/account_info/in_memory.py
 #
 # Copyright 2019 Backblaze Inc. All Rights Reserved.
 #

b2sdk/account_info/sqlite_account_info.py → b2sdk/_internal/account_info/sqlite_account_info.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/account_info/sqlite_account_info.py
+# File: b2sdk/_internal/account_info/sqlite_account_info.py
 #
 # Copyright 2019 Backblaze Inc. All Rights Reserved.
 #

b2sdk/account_info/stub.py → b2sdk/_internal/account_info/stub.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/account_info/stub.py
+# File: b2sdk/_internal/account_info/stub.py
 #
 # Copyright 2019 Backblaze Inc. All Rights Reserved.
 #

b2sdk/account_info/upload_url_pool.py → b2sdk/_internal/account_info/upload_url_pool.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/account_info/upload_url_pool.py
+# File: b2sdk/_internal/account_info/upload_url_pool.py
 #
 # Copyright 2019 Backblaze Inc. All Rights Reserved.
 #

b2sdk/api.py → b2sdk/_internal/api.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/api.py
+# File: b2sdk/_internal/api.py
 #
 # Copyright 2019 Backblaze Inc. All Rights Reserved.
 #
@@ -160,7 +160,7 @@ def __init__(
                       :class:`~b2sdk.v2.SqliteAccountInfo`
 
         :param cache: It is used by B2Api to cache the mapping between bucket name and bucket ids.
-                      default is :class:`~b2sdk.cache.DummyCache`
+                      default is :class:`~b2sdk._internal.cache.DummyCache`
 
         :param max_upload_workers: a number of upload threads
         :param max_copy_workers: a number of copy threads
@@ -198,8 +198,10 @@ def cache(self):
     def raw_api(self):
         """
         .. warning::
-            :class:`~b2sdk.raw_api.B2RawHTTPApi` attribute is deprecated.
-            :class:`~b2sdk.session.B2Session` expose all :class:`~b2sdk.raw_api.B2RawHTTPApi` methods now."""
+            :class:`~b2sdk._internal.raw_api.B2RawHTTPApi` attribute is deprecated.
+            :class:`~b2sdk._internal.session.B2Session` expose all
+            :class:`~b2sdk._internal.raw_api.B2RawHTTPApi` methods now.
+        """
         return self.session.raw_api
 
     def authorize_automatically(self):

b2sdk/api_config.py → b2sdk/_internal/api_config.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/api_config.py
+# File: b2sdk/_internal/api_config.py
 #
 # Copyright 2021 Backblaze Inc. All Rights Reserved.
 #

b2sdk/application_key.py → b2sdk/_internal/application_key.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/application_key.py
+# File: b2sdk/_internal/application_key.py
 #
 # Copyright 2021 Backblaze Inc. All Rights Reserved.
 #

b2sdk/b2http.py → b2sdk/_internal/b2http.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/b2http.py
+# File: b2sdk/_internal/b2http.py
 #
 # Copyright 2019 Backblaze Inc. All Rights Reserved.
 #
@@ -29,6 +29,8 @@
 import requests
 from requests.adapters import HTTPAdapter
 
+from b2sdk.version import USER_AGENT
+
 from .api_config import DEFAULT_HTTP_API_CONFIG, B2HttpApiConfig
 from .exception import (
     B2ConnectionError,
@@ -46,7 +48,6 @@
 )
 from .requests import NotDecompressingResponse
 from .utils.typing import JSON
-from .version import USER_AGENT
 
 LOCALE_LOCK = threading.Lock()
 logger = logging.getLogger(__name__)
@@ -616,7 +617,7 @@ def _translate_and_retry(
 
 class NotDecompressingHTTPAdapter(HTTPAdapter):
     """
-    HTTP adapter that uses :class:`b2sdk.requests.NotDecompressingResponse` instead of the default
+    HTTP adapter that uses :class:`b2sdk._internal.requests.NotDecompressingResponse` instead of the default
     :code:`requests.Response` class.
     """
 

b2sdk/bounded_queue_executor.py → b2sdk/_internal/bounded_queue_executor.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/bounded_queue_executor.py
+# File: b2sdk/_internal/bounded_queue_executor.py
 #
 # Copyright 2019 Backblaze Inc. All Rights Reserved.
 #

b2sdk/bucket.py → b2sdk/_internal/bucket.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/bucket.py
+# File: b2sdk/_internal/bucket.py
 #
 # Copyright 2019 Backblaze Inc. All Rights Reserved.
 #

b2sdk/cache.py → b2sdk/_internal/cache.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/cache.py
+# File: b2sdk/_internal/cache.py
 #
 # Copyright 2019 Backblaze Inc. All Rights Reserved.
 #
@@ -13,7 +13,7 @@
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from b2sdk.account_info.abstract import AbstractAccountInfo
+    from b2sdk._internal.account_info.abstract import AbstractAccountInfo
 
 
 class AbstractCache(metaclass=ABCMeta):

b2sdk/encryption/__init__.py → b2sdk/_internal/encryption/__init__.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/encryption/__init__.py
+# File: b2sdk/_internal/encryption/__init__.py
 #
 # Copyright 2021 Backblaze Inc. All Rights Reserved.
 #

b2sdk/encryption/setting.py → b2sdk/_internal/encryption/setting.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/encryption/setting.py
+# File: b2sdk/_internal/encryption/setting.py
 #
 # Copyright 2021 Backblaze Inc. All Rights Reserved.
 #

b2sdk/encryption/types.py → b2sdk/_internal/encryption/types.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/encryption/types.py
+# File: b2sdk/_internal/encryption/types.py
 #
 # Copyright 2021 Backblaze Inc. All Rights Reserved.
 #

b2sdk/exception.py → b2sdk/_internal/exception.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/exception.py
+# File: b2sdk/_internal/exception.py
 #
 # Copyright 2019 Backblaze Inc. All Rights Reserved.
 #

b2sdk/file_lock.py → b2sdk/_internal/file_lock.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/file_lock.py
+# File: b2sdk/_internal/file_lock.py
 #
 # Copyright 2021 Backblaze Inc. All Rights Reserved.
 #

b2sdk/file_version.py → b2sdk/_internal/file_version.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/file_version.py
+# File: b2sdk/_internal/file_version.py
 #
 # Copyright 2019 Backblaze Inc. All Rights Reserved.
 #

b2sdk/filter.py → b2sdk/_internal/filter.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/filter.py
+# File: b2sdk/_internal/filter.py
 #
 # Copyright 2024 Backblaze Inc. All Rights Reserved.
 #

b2sdk/http_constants.py → b2sdk/_internal/http_constants.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/http_constants.py
+# File: b2sdk/_internal/http_constants.py
 #
 # Copyright 2021 Backblaze Inc. All Rights Reserved.
 #

b2sdk/included_sources.py → b2sdk/_internal/included_sources.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/included_sources.py
+# File: b2sdk/_internal/included_sources.py
 #
 # Copyright 2021 Backblaze Inc. All Rights Reserved.
 #

b2sdk/transfer/emerge/__init__.py → b2sdk/_internal/large_file/__init__.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/transfer/emerge/__init__.py
+# File: b2sdk/_internal/large_file/__init__.py
 #
 # Copyright 2020 Backblaze Inc. All Rights Reserved.
 #

b2sdk/large_file/part.py → b2sdk/_internal/large_file/part.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/large_file/part.py
+# File: b2sdk/_internal/large_file/part.py
 #
 # Copyright 2020 Backblaze Inc. All Rights Reserved.
 #

b2sdk/large_file/services.py → b2sdk/_internal/large_file/services.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/large_file/services.py
+# File: b2sdk/_internal/large_file/services.py
 #
 # Copyright 2021 Backblaze Inc. All Rights Reserved.
 #
@@ -9,11 +9,11 @@
 ######################################################################
 from __future__ import annotations
 
-from b2sdk.encryption.setting import EncryptionSetting
-from b2sdk.file_lock import FileRetentionSetting, LegalHold
-from b2sdk.file_version import FileIdAndName
-from b2sdk.large_file.part import PartFactory
-from b2sdk.large_file.unfinished_large_file import UnfinishedLargeFile
+from b2sdk._internal.encryption.setting import EncryptionSetting
+from b2sdk._internal.file_lock import FileRetentionSetting, LegalHold
+from b2sdk._internal.file_version import FileIdAndName
+from b2sdk._internal.large_file.part import PartFactory
+from b2sdk._internal.large_file.unfinished_large_file import UnfinishedLargeFile
 
 
 class LargeFileServices:

b2sdk/large_file/unfinished_large_file.py → b2sdk/_internal/large_file/unfinished_large_file.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/large_file/unfinished_large_file.py
+# File: b2sdk/_internal/large_file/unfinished_large_file.py
 #
 # Copyright 2021 Backblaze Inc. All Rights Reserved.
 #
@@ -11,9 +11,9 @@
 
 import datetime as dt
 
-from b2sdk.encryption.setting import EncryptionSettingFactory
-from b2sdk.file_lock import FileRetentionSetting, LegalHold
-from b2sdk.utils.http_date import parse_http_date
+from b2sdk._internal.encryption.setting import EncryptionSettingFactory
+from b2sdk._internal.file_lock import FileRetentionSetting, LegalHold
+from b2sdk._internal.utils.http_date import parse_http_date
 
 
 class UnfinishedLargeFile:

b2sdk/progress.py → b2sdk/_internal/progress.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/progress.py
+# File: b2sdk/_internal/progress.py
 #
 # Copyright 2019 Backblaze Inc. All Rights Reserved.
 #
@@ -104,9 +104,13 @@ def __exit__(self, exc_type, exc_val, exc_tb):
 class TqdmProgressListener(AbstractProgressListener):
     """
     Progress listener based on tqdm library.
+
+    This listener displays a nice progress bar, but requires `tqdm` package to be installed.
     """
 
     def __init__(self, *args, **kwargs):
+        if tqdm is None:
+            raise ModuleNotFoundError("No module named 'tqdm' found")
         self.tqdm = None  # set in set_total_bytes()
         self.prev_value = 0
         super().__init__(*args, **kwargs)
@@ -212,7 +216,7 @@ def get_calls(self) -> list[str]:
 
 def make_progress_listener(description: str, quiet: bool) -> AbstractProgressListener:
     """
-    Return a progress listener object depending on some conditions.
+    Produce the best progress listener available for the given parameters.
 
     :param description: listener description
     :param quiet: if ``True``, do not output anything

b2sdk/raw_api.py → b2sdk/_internal/raw_api.py

@@ -1,6 +1,6 @@
 ######################################################################
 #
-# File: b2sdk/raw_api.py
+# File: b2sdk/_internal/raw_api.py
 #
 # Copyright 2021 Backblaze Inc. All Rights Reserved.
 #
@@ -23,9 +23,6 @@
 except ImportError:
     from typing import NotRequired, TypedDict
 
-from b2sdk.http_constants import FILE_INFO_HEADER_PREFIX
-from b2sdk.utils.docs import ensure_b2sdk_doc_urls
-
 from .encryption.setting import EncryptionMode, EncryptionSetting
 from .exception import (
     AccessDenied,
@@ -38,8 +35,10 @@
     WrongEncryptionModeForBucketDefault,
 )
 from .file_lock import BucketRetentionSetting, FileRetentionSetting, LegalHold
+from .http_constants import FILE_INFO_HEADER_PREFIX
 from .replication.setting import ReplicationConfiguration
 from .utils import b2_url_encode
+from .utils.docs import ensure_b2sdk_doc_urls
 
 # All supported realms
 REALM_URLS = {