update documentation after b2sdk._internal change

reef-technologies · Mar 28, 2024 · 7929fe5 · 7929fe5
1 parent 47ed528
commit 7929fe5
Show file tree

Hide file tree

Showing 42 changed files with 93 additions and 98 deletions.
diff --git a/doc/source/advanced.rst b/doc/source/advanced.rst
@@ -75,7 +75,7 @@ Concatenate files of known size
     ... ]
     >>> file_info = {'how': 'good-file'}
     >>> bucket.concatenate(input_sources, remote_name, file_info)
-    <b2sdk.file_version.FileVersion at 0x7fc8cd560551>
+    <b2sdk._internal.file_version.FileVersion at 0x7fc8cd560551>
 
 If one of remote source has length smaller than :term:`absoluteMinimumPartSize` then it cannot be copied into large file part. Such remote source would be downloaded and concatenated locally with local source or with other downloaded remote source.
 
@@ -99,7 +99,7 @@ Concatenate files of known size (streamed version)
     ... ]
     >>> file_info = {'how': 'good-file'}
     >>> bucket.concatenate_stream(input_sources, remote_name, file_info)
-    <b2sdk.file_version.FileVersion at 0x7fc8cd560551>
+    <b2sdk._internal.file_version.FileVersion at 0x7fc8cd560551>
 
 
 
@@ -148,7 +148,7 @@ The assumption here is that the file has been appended to since it was last uplo
     ... ]
     >>> file_info = {'how': 'good-file'}
     >>> bucket.create_file(input_sources, remote_name, file_info)
-    <b2sdk.file_version.FileVersion at 0x7fc8cd560552>
+    <b2sdk._internal.file_version.FileVersion at 0x7fc8cd560552>
 
 `LocalUploadSource` has the size determined automatically in this case. This is more efficient than :meth:`b2sdk.v2.Bucket.concatenate`, as it can use the overlapping ranges when a remote part is smaller than :term:`absoluteMinimumPartSize` to prevent downloading a range (when concatenating, local source would have destination offset at the end of remote source)
 
@@ -177,7 +177,7 @@ Change the middle of the remote file
     ... ]
     >>> file_info = {'how': 'good-file'}
     >>> bucket.create_file(input_sources, remote_name, file_info)
-    <b2sdk.file_version.FileVersion at 0x7fc8cd560552>
+    <b2sdk._internal.file_version.FileVersion at 0x7fc8cd560552>
 
 `LocalUploadSource` has the size determined automatically in this case. This is more efficient than :meth:`b2sdk.v2.Bucket.concatenate`, as it can use the overlapping ranges when a remote part is smaller than :term:`absoluteMinimumPartSize` to prevent downloading a range.
 
@@ -236,7 +236,7 @@ Scenarios such as below are then possible:
     ...
     >>> file_info = {'how': 'good-file'}
     >>> bucket.create_file(generate_input(), remote_name, file_info)
-    <b2sdk.file_version.FileVersion at 0x7fc8cd560552>
+    <b2sdk._internal.file_version.FileVersion at 0x7fc8cd560552>
 
 
 In such case, if the sizes allow for it (there would be no parts smaller than :term:`absoluteMinimumPartSize`), the only uploaded part will be `C-D`. Otherwise, more data will be uploaded, but the data transfer will be reduced in most cases. :meth:`b2sdk.v2.Bucket.create_file` does not guarantee that outbound transfer usage would be optimal, it uses a simple greedy algorithm with as small look-aheads as possible.

diff --git a/doc/source/api/api.rst b/doc/source/api/api.rst
@@ -1,5 +1,5 @@
 B2 Api client
-===============================================
+=============
 
 .. autoclass:: b2sdk.v2.B2Api()
     :inherited-members:

diff --git a/doc/source/api/bucket.rst b/doc/source/api/bucket.rst
@@ -1,5 +1,5 @@
 B2 Bucket
-===============================================
+=========
 
 .. autoclass:: b2sdk.v2.Bucket()
     :inherited-members:

diff --git a/doc/source/api/cache.rst b/doc/source/api/cache.rst
@@ -1,5 +1,5 @@
 Cache
-===============================================
+=====
 
 **b2sdk** caches the mapping between bucket name and bucket
 id, so that the user of the library does not need to maintain

diff --git a/doc/source/api/data_classes.rst b/doc/source/api/data_classes.rst
@@ -1,5 +1,5 @@
 Data classes
-===============================================
+============
 
 .. autoclass:: b2sdk.v2.FileVersion
    :inherited-members:

diff --git a/doc/source/api/downloaded_file.rst b/doc/source/api/downloaded_file.rst
@@ -4,4 +4,3 @@ Downloaded File
 .. autoclass:: b2sdk.v2.DownloadedFile
 
 .. autoclass:: b2sdk.v2.MtimeUpdatedFile
-
diff --git a/doc/source/api/encryption/types.rst b/doc/source/api/encryption/types.rst
@@ -3,4 +3,4 @@
 Encryption Types
 ================
 
-.. automodule:: b2sdk.encryption.types
+.. automodule:: b2sdk._internal.encryption.types
diff --git a/doc/source/api/enums.rst b/doc/source/api/enums.rst
@@ -1,5 +1,5 @@
 Enums
-===============================================
+=====
 
 .. autoclass:: b2sdk.v2.MetadataDirectiveMode
    :inherited-members:
@@ -12,4 +12,3 @@ Enums
 
 .. autoclass:: b2sdk.v2.KeepOrDeleteMode
    :inherited-members:
-
diff --git a/doc/source/api/exception.rst b/doc/source/api/exception.rst
@@ -1,5 +1,5 @@
 Exceptions
-====================================
+==========
 
 .. todo::
    improve documentation of exceptions, automodule -> autoclass?

diff --git a/doc/source/api/file_lock.rst b/doc/source/api/file_lock.rst
@@ -34,4 +34,3 @@ File locks
 .. autoclass:: b2sdk.v2.NO_RETENTION_FILE_SETTING()
 
 .. autoclass:: b2sdk.v2.UNKNOWN_FILE_RETENTION_SETTING()
-
diff --git a/doc/source/api/internal/b2http.rst b/doc/source/api/internal/b2http.rst
@@ -1,4 +1,4 @@
-:mod:`b2sdk.b2http` -- thin http client wrapper
-===============================================
+:mod:`b2sdk._internal.b2http` -- thin http client wrapper
+=========================================================
 
-.. automodule:: b2sdk.b2http
+.. automodule:: b2sdk._internal.b2http
diff --git a/doc/source/api/internal/cache.rst b/doc/source/api/internal/cache.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.cache`
-===========================
+:mod:`b2sdk._internal.cache`
+============================
 
-.. automodule:: b2sdk.cache
+.. automodule:: b2sdk._internal.cache
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/raw_api.rst b/doc/source/api/internal/raw_api.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.raw_api` -- B2 raw api wrapper
-=============================================
+:mod:`b2sdk._internal.raw_api` -- B2 raw api wrapper
+====================================================
 
-.. automodule:: b2sdk.raw_api
+.. automodule:: b2sdk._internal.raw_api
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/raw_simulator.rst b/doc/source/api/internal/raw_simulator.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.raw_simulator` -- B2 raw api simulator
-==================================================
+:mod:`b2sdk._internal.raw_simulator` -- B2 raw api simulator
+============================================================
 
-.. automodule:: b2sdk.raw_simulator
+.. automodule:: b2sdk._internal.raw_simulator
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/requests.rst b/doc/source/api/internal/requests.rst
@@ -1,4 +1,4 @@
-:mod:`b2sdk.requests` -- modified requests.models.Response class
-================================================================
+:mod:`b2sdk._internal.requests` -- modified requests.models.Response class
+==========================================================================
 
-.. automodule:: b2sdk.requests
+.. automodule:: b2sdk._internal.requests
diff --git a/doc/source/api/internal/scan/folder.rst b/doc/source/api/internal/scan/folder.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.scan.folder`
+:mod:`b2sdk._internal.scan.folder`
 ==================================
 
-.. automodule:: b2sdk.scan.folder
+.. automodule:: b2sdk._internal.scan.folder
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/scan/folder_parser.rst b/doc/source/api/internal/scan/folder_parser.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.scan.folder_parser`
-================================================
+:mod:`b2sdk._internal.scan.folder_parser`
+=========================================
 
-.. automodule:: b2sdk.scan.folder_parser
+.. automodule:: b2sdk._internal.scan.folder_parser
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/scan/path.rst b/doc/source/api/internal/scan/path.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.scan.path`
-==============================
+:mod:`b2sdk._internal.scan.path`
+================================
 
-.. automodule:: b2sdk.scan.path
+.. automodule:: b2sdk._internal.scan.path
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/scan/policies.rst b/doc/source/api/internal/scan/policies.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.scan.policies`
-================================================
+:mod:`b2sdk._internal.scan.policies`
+====================================
 
-.. automodule:: b2sdk.scan.policies
+.. automodule:: b2sdk._internal.scan.policies
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/scan/scan.rst b/doc/source/api/internal/scan/scan.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.scan.scan`
-================================================
+:mod:`b2sdk._internal.scan.scan`
+================================
 
-.. automodule:: b2sdk.scan.scan
+.. automodule:: b2sdk._internal.scan.scan
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/session.rst b/doc/source/api/internal/session.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.session` -- B2 Session
-=============================================
+:mod:`b2sdk._internal.session` -- B2 Session
+============================================
 
-.. automodule:: b2sdk.session
+.. automodule:: b2sdk._internal.session
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/stream/chained.rst b/doc/source/api/internal/stream/chained.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.stream.chained` ChainedStream
-============================================
+:mod:`b2sdk._internal.stream.chained` ChainedStream
+===================================================
 
-.. automodule:: b2sdk.stream.chained
+.. automodule:: b2sdk._internal.stream.chained
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/stream/hashing.rst b/doc/source/api/internal/stream/hashing.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.stream.hashing` StreamWithHash
-============================================
+:mod:`b2sdk._internal.stream.hashing` StreamWithHash
+====================================================
 
-.. automodule:: b2sdk.stream.hashing
+.. automodule:: b2sdk._internal.stream.hashing
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/stream/progress.rst b/doc/source/api/internal/stream/progress.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.stream.progress` Streams with progress reporting
-============================================================
+:mod:`b2sdk._internal.stream.progress` Streams with progress reporting
+======================================================================
 
-.. automodule:: b2sdk.stream.progress
+.. automodule:: b2sdk._internal.stream.progress
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/stream/range.rst b/doc/source/api/internal/stream/range.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.stream.range` RangeOfInputStream
-=============================================
+:mod:`b2sdk._internal.stream.range` RangeOfInputStream
+======================================================
 
-.. automodule:: b2sdk.stream.range
+.. automodule:: b2sdk._internal.stream.range
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/stream/wrapper.rst b/doc/source/api/internal/stream/wrapper.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.stream.wrapper` StreamWrapper
-=========================================
+:mod:`b2sdk._internal.stream.wrapper` StreamWrapper
+===================================================
 
-.. automodule:: b2sdk.stream.wrapper
+.. automodule:: b2sdk._internal.stream.wrapper
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/sync/action.rst b/doc/source/api/internal/sync/action.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.sync.action`
-=======================================
+:mod:`b2sdk._internal.sync.action`
+==================================
 
-.. automodule:: b2sdk.sync.action
+.. automodule:: b2sdk._internal.sync.action
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/sync/exception.rst b/doc/source/api/internal/sync/exception.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.sync.exception`
-==============================================
+:mod:`b2sdk._internal.sync.exception`
+=====================================
 
-.. automodule:: b2sdk.sync.exception
+.. automodule:: b2sdk._internal.sync.exception
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/sync/policy.rst b/doc/source/api/internal/sync/policy.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.sync.policy`
+:mod:`b2sdk._internal.sync.policy`
 ==================================
 
-.. automodule:: b2sdk.sync.policy
+.. automodule:: b2sdk._internal.sync.policy
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/sync/policy_manager.rst b/doc/source/api/internal/sync/policy_manager.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.sync.policy_manager`
-==================================================
+:mod:`b2sdk._internal.sync.policy_manager`
+==========================================
 
-.. automodule:: b2sdk.sync.policy_manager
+.. automodule:: b2sdk._internal.sync.policy_manager
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/sync/sync.rst b/doc/source/api/internal/sync/sync.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.sync.sync`
-==============================
+:mod:`b2sdk._internal.sync.sync`
+================================
 
-.. automodule:: b2sdk.sync.sync
+.. automodule:: b2sdk._internal.sync.sync
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/transfer/inbound/download_manager.rst b/doc/source/api/internal/transfer/inbound/download_manager.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.transfer.inbound.download_manager` -- Manager of downloaders
-========================================================================
+:mod:`b2sdk._internal.transfer.inbound.download_manager` -- Manager of downloaders
+==================================================================================
 
-.. automodule:: b2sdk.transfer.inbound.download_manager
+.. automodule:: b2sdk._internal.transfer.inbound.download_manager
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/transfer/inbound/downloader/abstract.rst b/doc/source/api/internal/transfer/inbound/downloader/abstract.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.transfer.inbound.downloader.abstract` -- Downloader base class
-==========================================================================
+:mod:`b2sdk._internal.transfer.inbound.downloader.abstract` -- Downloader base class
+====================================================================================
 
-.. automodule:: b2sdk.transfer.inbound.downloader.abstract
+.. automodule:: b2sdk._internal.transfer.inbound.downloader.abstract
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/transfer/inbound/downloader/parallel.rst b/doc/source/api/internal/transfer/inbound/downloader/parallel.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.transfer.inbound.downloader.parallel` -- ParallelTransferer
-=======================================================================
+:mod:`b2sdk._internal.transfer.inbound.downloader.parallel` -- ParallelTransferer
+=================================================================================
 
-.. automodule:: b2sdk.transfer.inbound.downloader.parallel
+.. automodule:: b2sdk._internal.transfer.inbound.downloader.parallel
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/transfer/inbound/downloader/simple.rst b/doc/source/api/internal/transfer/inbound/downloader/simple.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.transfer.inbound.downloader.simple` -- SimpleDownloader
-===================================================================
+:mod:`b2sdk._internal.transfer.inbound.downloader.simple` -- SimpleDownloader
+=============================================================================
 
-.. automodule:: b2sdk.transfer.inbound.downloader.simple
+.. automodule:: b2sdk._internal.transfer.inbound.downloader.simple
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/transfer/outbound/upload_source.rst b/doc/source/api/internal/transfer/outbound/upload_source.rst
@@ -1,7 +1,7 @@
-:mod:`b2sdk.transfer.outbound.upload_source`
-============================================
+:mod:`b2sdk._internal.transfer.outbound.upload_source`
+======================================================
 
-.. automodule:: b2sdk.transfer.outbound.upload_source
+.. automodule:: b2sdk._internal.transfer.outbound.upload_source
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/source/api/internal/utils.rst b/doc/source/api/internal/utils.rst
@@ -1,5 +1,5 @@
 :mod:`b2sdk._internal.utils`
-========================================
+============================
 
 .. automodule:: b2sdk._internal.utils
     :members:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,4 +4,3 @@ Downloaded File
		.. autoclass:: b2sdk.v2.DownloadedFile

		.. autoclass:: b2sdk.v2.MtimeUpdatedFile
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,4 +34,3 @@ File locks
		.. autoclass:: b2sdk.v2.NO_RETENTION_FILE_SETTING()

		.. autoclass:: b2sdk.v2.UNKNOWN_FILE_RETENTION_SETTING()