Skip to content

Commit 2b2ed68

Browse files
Bump stone to 3.5.2 and regenerate client (#540)
Picks up the doc-generation fix (dropbox/stone#375): removes the invalid :field: role and splits :ivar Type name: into :ivar/:vartype, fixing the sphinx warnings in #359. Also fixes a malformed :param in dropbox_client.py.
1 parent ffdc791 commit 2b2ed68

27 files changed

Lines changed: 12311 additions & 10265 deletions

dropbox/account.py

Lines changed: 38 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@
99

1010
class AccountPhotoGetArg(bb.Struct):
1111
"""
12-
:ivar account.AccountPhotoGetArg.dbx_account_id: Encoded ID of the user.
13-
Must start either with 'dbid:' or 'dbaphid:'.
14-
:ivar account.AccountPhotoGetArg.size: A string representing the size of the
15-
photo.
16-
:ivar account.AccountPhotoGetArg.circle_crop: True if the photo should be
17-
cropped and false otherwise.
18-
:ivar account.AccountPhotoGetArg.expect_account_photo: True if we expect
19-
account photo to exist.
12+
:ivar AccountPhotoGetArg.dbx_account_id:
13+
Encoded ID of the user. Must start either with 'dbid:' or 'dbaphid:'.
14+
:ivar AccountPhotoGetArg.size:
15+
A string representing the size of the photo.
16+
:ivar AccountPhotoGetArg.circle_crop:
17+
True if the photo should be cropped and false otherwise.
18+
:ivar AccountPhotoGetArg.expect_account_photo:
19+
True if we expect account photo to exist.
2020
"""
2121

2222
__slots__ = [
@@ -69,12 +69,13 @@ class AccountPhotoGetError(bb.Union):
6969
return true. To get the associated value of a tag (if one exists), use the
7070
corresponding ``get_*`` method.
7171
72-
:ivar ThumbnailError AccountPhotoGetError.thumbnail_error: Indicates
73-
infrastructural failure.
74-
:ivar account.AccountPhotoGetError.account_photo_missing: Account photo is
75-
missing (but we did not expect it to exist).
76-
:ivar account.AccountPhotoGetError.expected_account_photo_missing: Account
77-
photo was expected to exist, but it's missing.
72+
:ivar AccountPhotoGetError.thumbnail_error:
73+
Indicates infrastructural failure.
74+
:vartype AccountPhotoGetError.thumbnail_error: ThumbnailError
75+
:ivar AccountPhotoGetError.account_photo_missing:
76+
Account photo is missing (but we did not expect it to exist).
77+
:ivar AccountPhotoGetError.expected_account_photo_missing:
78+
Account photo was expected to exist, but it's missing.
7879
"""
7980

8081
_catch_all = 'other'
@@ -147,8 +148,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
147148

148149
class AccountPhotoGetResult(bb.Struct):
149150
"""
150-
:ivar account.AccountPhotoGetResult.content_type: The data returned by
151-
get_photo.
151+
:ivar AccountPhotoGetResult.content_type:
152+
The data returned by get_photo.
152153
"""
153154

154155
__slots__ = [
@@ -242,8 +243,9 @@ class PhotoSourceArg(bb.Union):
242243
return true. To get the associated value of a tag (if one exists), use the
243244
corresponding ``get_*`` method.
244245
245-
:ivar str account.PhotoSourceArg.base64_data: Image data in base64-encoded
246-
bytes.
246+
:ivar PhotoSourceArg.base64_data:
247+
Image data in base64-encoded bytes.
248+
:vartype PhotoSourceArg.base64_data: str
247249
"""
248250

249251
_catch_all = 'other'
@@ -296,8 +298,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
296298

297299
class SetProfilePhotoArg(bb.Struct):
298300
"""
299-
:ivar account.SetProfilePhotoArg.photo: Image to set as the user's new
300-
profile photo.
301+
:ivar SetProfilePhotoArg.photo:
302+
Image to set as the user's new profile photo.
301303
"""
302304

303305
__slots__ = [
@@ -326,16 +328,16 @@ class SetProfilePhotoError(bb.Union):
326328
return true. To get the associated value of a tag (if one exists), use the
327329
corresponding ``get_*`` method.
328330
329-
:ivar account.SetProfilePhotoError.file_type_error: File cannot be set as
330-
profile photo.
331-
:ivar account.SetProfilePhotoError.file_size_error: File cannot exceed 10
332-
MB.
333-
:ivar account.SetProfilePhotoError.dimension_error: Image must be larger
334-
than 128 x 128.
335-
:ivar account.SetProfilePhotoError.thumbnail_error: Image could not be
336-
thumbnailed.
337-
:ivar account.SetProfilePhotoError.transient_error: Temporary infrastructure
338-
failure, please retry.
331+
:ivar SetProfilePhotoError.file_type_error:
332+
File cannot be set as profile photo.
333+
:ivar SetProfilePhotoError.file_size_error:
334+
File cannot exceed 10 MB.
335+
:ivar SetProfilePhotoError.dimension_error:
336+
Image must be larger than 128 x 128.
337+
:ivar SetProfilePhotoError.thumbnail_error:
338+
Image could not be thumbnailed.
339+
:ivar SetProfilePhotoError.transient_error:
340+
Temporary infrastructure failure, please retry.
339341
"""
340342

341343
_catch_all = 'other'
@@ -407,8 +409,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
407409

408410
class SetProfilePhotoResult(bb.Struct):
409411
"""
410-
:ivar account.SetProfilePhotoResult.profile_photo_url: URL for the photo
411-
representing the user, if one is set.
412+
:ivar SetProfilePhotoResult.profile_photo_url:
413+
URL for the photo representing the user, if one is set.
412414
"""
413415

414416
__slots__ = [
@@ -437,10 +439,10 @@ class ThumbnailError(bb.Union):
437439
return true. To get the associated value of a tag (if one exists), use the
438440
corresponding ``get_*`` method.
439441
440-
:ivar account.ThumbnailError.permanent_failure: Indicates permanent
441-
infrastructural failure.
442-
:ivar account.ThumbnailError.temporary_failure: Indicates temporary
443-
infrastructural failure.
442+
:ivar ThumbnailError.permanent_failure:
443+
Indicates permanent infrastructural failure.
444+
:ivar ThumbnailError.temporary_failure:
445+
Indicates temporary infrastructural failure.
444446
"""
445447

446448
_catch_all = 'other'

dropbox/async_.py

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,10 @@ class LaunchResultBase(bb.Union):
1919
return true. To get the associated value of a tag (if one exists), use the
2020
corresponding ``get_*`` method.
2121
22-
:ivar str async.LaunchResultBase.async_job_id: This response indicates that
23-
the processing is asynchronous. The string is an id that can be used to
24-
obtain the status of the asynchronous job.
22+
:ivar LaunchResultBase.async_job_id:
23+
This response indicates that the processing is asynchronous. The string
24+
is an id that can be used to obtain the status of the asynchronous job.
25+
:vartype LaunchResultBase.async_job_id: str
2526
"""
2627

2728
_catch_all = None
@@ -73,8 +74,8 @@ class LaunchEmptyResult(LaunchResultBase):
7374
return true. To get the associated value of a tag (if one exists), use the
7475
corresponding ``get_*`` method.
7576
76-
:ivar async.LaunchEmptyResult.complete: The job finished synchronously and
77-
successfully.
77+
:ivar LaunchEmptyResult.complete:
78+
The job finished synchronously and successfully.
7879
"""
7980

8081
# Attribute is overwritten below the class definition
@@ -97,8 +98,9 @@ class PollArg(bb.Struct):
9798
"""
9899
Arguments for methods that poll the status of an asynchronous job.
99100
100-
:ivar async.PollArg.async_job_id: Id of the asynchronous job. This is the
101-
value of a response returned from the method that launched the job.
101+
:ivar PollArg.async_job_id:
102+
Id of the asynchronous job. This is the value of a response returned
103+
from the method that launched the job.
102104
"""
103105

104106
__slots__ = [
@@ -132,8 +134,8 @@ class PollResultBase(bb.Union):
132134
return true. To get the associated value of a tag (if one exists), use the
133135
corresponding ``get_*`` method.
134136
135-
:ivar async.PollResultBase.in_progress: The asynchronous job is still in
136-
progress.
137+
:ivar PollResultBase.in_progress:
138+
The asynchronous job is still in progress.
137139
"""
138140

139141
_catch_all = None
@@ -162,8 +164,8 @@ class PollEmptyResult(PollResultBase):
162164
return true. To get the associated value of a tag (if one exists), use the
163165
corresponding ``get_*`` method.
164166
165-
:ivar async.PollEmptyResult.complete: The asynchronous job has completed
166-
successfully.
167+
:ivar PollEmptyResult.complete:
168+
The asynchronous job has completed successfully.
167169
"""
168170

169171
# Attribute is overwritten below the class definition
@@ -190,10 +192,12 @@ class PollError(bb.Union):
190192
return true. To get the associated value of a tag (if one exists), use the
191193
corresponding ``get_*`` method.
192194
193-
:ivar async.PollError.invalid_async_job_id: The job ID is invalid.
194-
:ivar async.PollError.internal_error: Something went wrong with the job on
195-
Dropbox's end. You'll need to verify that the action you were taking
196-
succeeded, and if not, try again. This should happen very rarely.
195+
:ivar PollError.invalid_async_job_id:
196+
The job ID is invalid.
197+
:ivar PollError.internal_error:
198+
Something went wrong with the job on Dropbox's end. You'll need to
199+
verify that the action you were taking succeeded, and if not, try again.
200+
This should happen very rarely.
197201
"""
198202

199203
_catch_all = 'other'

0 commit comments

Comments
 (0)