openstack/python-swiftclient
Code Issues Proposed changes
6af54cf481
python-swiftclient/doc/source/swiftclient.rst

43 lines
706 B
ReStructuredText
Raw Normal View History

Add doc and version in swiftclient.__init__.py - Add parseable version in swiftclient.__init.py - Generate rst doc like done for swift. Change-Id: I408fbc36693772d2ef6f4823757dd1f4c830193f
2012-05-23 15:14:47 +02:00
.. _swiftclient_package:
swiftclient
==============
.. automodule:: swiftclient
docs: Fix code-generated docs Skip multithreading since some upstream docstrings have invalid ReST. Change-Id: I682238b8307e5a2f9bd7607676749497cd6d4261
2023-03-21 13:07:01 -07:00
:inherited-members:
Add doc and version in swiftclient.__init__.py - Add parseable version in swiftclient.__init.py - Generate rst doc like done for swift. Change-Id: I408fbc36693772d2ef6f4823757dd1f4c830193f
2012-05-23 15:14:47 +02:00
Add v1password keystoneauth plugin This lets us use Keystone sessions against endpoints like swauth and tempauth with code like: import keystoneauth1.loading import keystoneauth1.session import swiftclient loader = keystoneauth1.loading.get_plugin_loader('v1password') auth_plugin = loader.load_from_options( auth_url='http://saio:8080/auth/v1.0', username='test:tester', password='testing') keystone_session = keystoneauth1.session.Session(auth_plugin) conn = swiftclient.Connection(session=keystone_session) The plugin includes an optional project_name option, which may be used to override the swift account from the storage url that was returned. Additionally, it includes enough infrastructure to support some commands in python-openstackclient>=3.0: export OS_AUTH_TYPE=v1password export OS_AUTH_URL=http://saio:8080/auth/v1.0 export OS_PROJECT_NAME=AUTH_test2 export OS_USERNAME=test:tester export OS_PASSWORD=testing openstack token issue openstack catalog list openstack catalog show object-store openstack object store account show openstack container list openstack container create <container> openstack container save <container> openstack container show <container> openstack container delete <container> openstack object list <container> openstack object create <container> <file> openstack object save <container> <object> opsentack object show <container> <object> openstack object delete <container> <object> Change-Id: Ia963dc44415f72a6518227e86d9528a987e07491
2016-04-01 15:12:20 -07:00
swiftclient.authv1
==================
.. automodule:: swiftclient.authv1
:inherited-members:
Add doc and version in swiftclient.__init__.py - Add parseable version in swiftclient.__init.py - Generate rst doc like done for swift. Change-Id: I408fbc36693772d2ef6f4823757dd1f4c830193f
2012-05-23 15:14:47 +02:00
swiftclient.client
==================
.. automodule:: swiftclient.client
docs: Fix code-generated docs Skip multithreading since some upstream docstrings have invalid ReST. Change-Id: I682238b8307e5a2f9bd7607676749497cd6d4261
2023-03-21 13:07:01 -07:00
:inherited-members:
Move multi-threading code to a library. This patch extracts the multi-threading code from bin/swift into swiftclient/multithreading and adds tests. In particular, this new way of doing it (with context managers) will prevent non-daemonic threads from wedging the process when unexpected exceptions happen. I enabled reporting of which lines, specifically, are not covered by unit tests (added -m option to "coverage report" in .unittests). This patch includes a drive-by fix for uploading a segmented file with --use-slo when that object already exists. A key of "name" was used instead of "path", raising KeyError. There's also another drive-by fix for uploading segmented objects with --use-slo. Commit 874e0e4427b80e1b15b74a1557b73ba9d61443ca regressed this by removing the capturing of thread-worker results in QueueFunctionThread.run(). This patch restores that functionality and the feature (uploading SLO objects). Change-Id: I0b4f677e4a734e83d1a25088d9a74f7d46384e53
2013-06-26 22:47:49 -07:00
Add importable SwiftService incorporating shell.py logic This patch adds a SwiftService class that incorporates the high level logic from swiftclient/shell.py. It also ports shell.py to use the new class, and updates the code in swiftclient/multithreading.py to allow the SwiftService to be used for multiple operations whilst using only one thread pool. Currently, code that imports swiftclient has to have its own logic for things like creating large objects, parallel uploads, and parallel downloads. This patch adds a SwiftService class that makes that functionality available in Python code as well as through the shell. Change-Id: I08c5796b4c01001d79fd571651c3017c16462ffd Implements: blueprint bin-swift-logic-as-importable-library
2014-04-04 21:13:01 +02:00
swiftclient.service
===================
.. automodule:: swiftclient.service
docs: Fix code-generated docs Skip multithreading since some upstream docstrings have invalid ReST. Change-Id: I682238b8307e5a2f9bd7607676749497cd6d4261
2023-03-21 13:07:01 -07:00
:inherited-members:
Add importable SwiftService incorporating shell.py logic This patch adds a SwiftService class that incorporates the high level logic from swiftclient/shell.py. It also ports shell.py to use the new class, and updates the code in swiftclient/multithreading.py to allow the SwiftService to be used for multiple operations whilst using only one thread pool. Currently, code that imports swiftclient has to have its own logic for things like creating large objects, parallel uploads, and parallel downloads. This patch adds a SwiftService class that makes that functionality available in Python code as well as through the shell. Change-Id: I08c5796b4c01001d79fd571651c3017c16462ffd Implements: blueprint bin-swift-logic-as-importable-library
2014-04-04 21:13:01 +02:00
Move multi-threading code to a library. This patch extracts the multi-threading code from bin/swift into swiftclient/multithreading and adds tests. In particular, this new way of doing it (with context managers) will prevent non-daemonic threads from wedging the process when unexpected exceptions happen. I enabled reporting of which lines, specifically, are not covered by unit tests (added -m option to "coverage report" in .unittests). This patch includes a drive-by fix for uploading a segmented file with --use-slo when that object already exists. A key of "name" was used instead of "path", raising KeyError. There's also another drive-by fix for uploading segmented objects with --use-slo. Commit 874e0e4427b80e1b15b74a1557b73ba9d61443ca regressed this by removing the capturing of thread-worker results in QueueFunctionThread.run(). This patch restores that functionality and the feature (uploading SLO objects). Change-Id: I0b4f677e4a734e83d1a25088d9a74f7d46384e53
2013-06-26 22:47:49 -07:00
swiftclient.exceptions
======================
.. automodule:: swiftclient.exceptions
docs: Fix code-generated docs Skip multithreading since some upstream docstrings have invalid ReST. Change-Id: I682238b8307e5a2f9bd7607676749497cd6d4261
2023-03-21 13:07:01 -07:00
:inherited-members:
Move multi-threading code to a library. This patch extracts the multi-threading code from bin/swift into swiftclient/multithreading and adds tests. In particular, this new way of doing it (with context managers) will prevent non-daemonic threads from wedging the process when unexpected exceptions happen. I enabled reporting of which lines, specifically, are not covered by unit tests (added -m option to "coverage report" in .unittests). This patch includes a drive-by fix for uploading a segmented file with --use-slo when that object already exists. A key of "name" was used instead of "path", raising KeyError. There's also another drive-by fix for uploading segmented objects with --use-slo. Commit 874e0e4427b80e1b15b74a1557b73ba9d61443ca regressed this by removing the capturing of thread-worker results in QueueFunctionThread.run(). This patch restores that functionality and the feature (uploading SLO objects). Change-Id: I0b4f677e4a734e83d1a25088d9a74f7d46384e53
2013-06-26 22:47:49 -07:00
swiftclient.multithreading
==========================
.. automodule:: swiftclient.multithreading
enable autodocumentation for utils module; docstring fixes This commit adds the utils module to those for which Sphinx automatically generates documentation from docstrings. (Many of the functions here may be of little interest to users, but `generate_temp_url`, at least, definitely deserves to be in the documentation; in this way, this commit can be seen as a spiritual companion to ca70dd9e.) Also, a few markup errors and perceived infelicities in existing docstrings are amended. Change-Id: I8c66a23cb359d7dd9302a16459fad9825fedb690
2015-09-10 14:37:32 -07:00
swiftclient.utils
=================
.. automodule:: swiftclient.utils
docs: Fix code-generated docs Skip multithreading since some upstream docstrings have invalid ReST. Change-Id: I682238b8307e5a2f9bd7607676749497cd6d4261
2023-03-21 13:07:01 -07:00
:inherited-members:
Copy Permalink