Files.com 1.4.116__tar.gz → 1.4.117__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {Files.com-1.4.116 → Files.com-1.4.117}/Files.com.egg-info/PKG-INFO +1 -1
- {Files.com-1.4.116 → Files.com-1.4.117}/PKG-INFO +1 -1
- {Files.com-1.4.116 → Files.com-1.4.117}/README.md +28 -28
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/__init__.py +1 -1
- {Files.com-1.4.116 → Files.com-1.4.117}/Files.com.egg-info/SOURCES.txt +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/Files.com.egg-info/dependency_links.txt +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/Files.com.egg-info/requires.txt +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/Files.com.egg-info/top_level.txt +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/api.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/api_client.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/error.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/list_obj.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/__init__.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/account_line_item.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/action.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/action_notification_export.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/action_notification_export_result.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/api_key.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/api_request_log.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/app.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/as2_incoming_message.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/as2_outgoing_message.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/as2_partner.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/as2_station.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/auto.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/automation.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/automation_log.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/automation_run.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/bandwidth_snapshot.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/behavior.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/bundle.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/bundle_action.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/bundle_download.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/bundle_notification.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/bundle_path.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/bundle_recipient.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/bundle_registration.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/clickwrap.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/dns_record.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/email_incoming_message.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/email_log.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/errors.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/exavault_api_request_log.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/external_event.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/file.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/file_action.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/file_comment.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/file_comment_reaction.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/file_migration.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/file_migration_log.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/file_upload_part.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/folder.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/form_field.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/form_field_set.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/ftp_action_log.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/gpg_key.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/group.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/group_user.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/history.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/history_export.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/history_export_result.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/image.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/inbox_recipient.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/inbox_registration.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/inbox_upload.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/invoice.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/invoice_line_item.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/ip_address.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/lock.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/message.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/message_comment.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/message_comment_reaction.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/message_reaction.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/notification.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/outbound_connection_log.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/payment.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/payment_line_item.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/permission.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/preview.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/priority.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/project.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/public_hosting_request_log.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/public_ip_address.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/public_key.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/remote_bandwidth_snapshot.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/remote_server.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/remote_server_configuration_file.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/request.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/session.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/settings_change.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/sftp_action_log.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/sftp_host_key.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/share_group.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/share_group_member.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/site.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/snapshot.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/sso_strategy.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/status.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/style.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/sync_log.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/usage_daily_snapshot.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/usage_snapshot.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/user.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/user_cipher_use.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/user_request.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/web_dav_action_log.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/webhook_test.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/path_util.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/util.py +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/pyproject.toml +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/setup.cfg +0 -0
- {Files.com-1.4.116 → Files.com-1.4.117}/setup.py +0 -0
|
@@ -251,16 +251,16 @@ handle the general `files_sdk.error.Error` exception as a catch-all.
|
|
|
251
251
|
try:
|
|
252
252
|
session = files_sdk.session.create({ "username": "USERNAME", "password": "BADPASSWORD" })
|
|
253
253
|
except files_sdk.error.NotAuthenticatedError as err:
|
|
254
|
-
print(f"Authentication Error
|
|
254
|
+
print(f"Authentication Error Occurred ({type(err).__name__}):", err)
|
|
255
255
|
except files_sdk.error.Error as err:
|
|
256
|
-
print(f"Unknown Error
|
|
256
|
+
print(f"Unknown Error Occurred ({type(err).__name__}):", err)
|
|
257
257
|
```
|
|
258
258
|
|
|
259
259
|
### Error Types
|
|
260
260
|
|
|
261
261
|
#### SDK Errors
|
|
262
262
|
|
|
263
|
-
SDK errors are general errors that
|
|
263
|
+
SDK errors are general errors that occur within the SDK code. Each exception class inherits from a standard `Error` base class.
|
|
264
264
|
|
|
265
265
|
```python title="Example SDK Exception Class Inheritance Structure"
|
|
266
266
|
files_sdk.error.APIConnectionError -> files_sdk.error.Error -> Exception
|
|
@@ -281,7 +281,7 @@ API errors are errors returned by the Files.com API. Each exception class inher
|
|
|
281
281
|
The error group base class indicates a particular type of error.
|
|
282
282
|
|
|
283
283
|
```python title="Example API Exception Class Inheritance Structure"
|
|
284
|
-
|
|
284
|
+
files_sdk.error.FolderAdminPermissionRequiredError -> files_sdk.error.NotAuthorizedError -> files_sdk.error.APIError -> files_sdk.error.Error -> Exception
|
|
285
285
|
```
|
|
286
286
|
##### API Exception Classes
|
|
287
287
|
|
|
@@ -466,7 +466,7 @@ This SDK allows both file based transfer and data based transfer. Please see the
|
|
|
466
466
|
The second parameter is optional and will simply use the remote filename by default.
|
|
467
467
|
|
|
468
468
|
```python
|
|
469
|
-
|
|
469
|
+
files_sdk.file.download_file("/remote.txt", "local.txt")
|
|
470
470
|
```
|
|
471
471
|
|
|
472
472
|
#### File Upload
|
|
@@ -474,49 +474,49 @@ The second parameter is optional and will simply use the remote filename by defa
|
|
|
474
474
|
The second parameter is optional and will simply use the local filename by default.
|
|
475
475
|
|
|
476
476
|
```python
|
|
477
|
-
|
|
477
|
+
files_sdk.file.upload_file("local.txt", "/remote.txt")
|
|
478
478
|
```
|
|
479
479
|
|
|
480
480
|
If the parent directories do not already exist, they can be automatically created by passing
|
|
481
481
|
`mkdir_parents` in the `params`.
|
|
482
482
|
|
|
483
483
|
```python
|
|
484
|
-
|
|
484
|
+
files_sdk.file.upload_file("local.txt", "/uploads/remote.txt", params={"mkdir_parents": True})
|
|
485
485
|
```
|
|
486
486
|
|
|
487
487
|
#### List root folder
|
|
488
488
|
|
|
489
489
|
```python
|
|
490
|
-
|
|
491
|
-
|
|
490
|
+
for f in files_sdk.folder.list_for("/").auto_paging_iter():
|
|
491
|
+
print(f.type, f.path)
|
|
492
492
|
```
|
|
493
493
|
|
|
494
494
|
#### Writing a file example (string)
|
|
495
495
|
|
|
496
496
|
```python
|
|
497
|
-
|
|
498
|
-
|
|
497
|
+
with files_sdk.file.open("foo.txt", 'w') as f:
|
|
498
|
+
f.write("contents")
|
|
499
499
|
```
|
|
500
500
|
|
|
501
501
|
#### Writing a file example (binary)
|
|
502
502
|
|
|
503
503
|
```python
|
|
504
|
-
|
|
505
|
-
|
|
504
|
+
with files_sdk.file.open("foo.txt", 'wb') as f:
|
|
505
|
+
f.write(b"contents")
|
|
506
506
|
```
|
|
507
507
|
|
|
508
508
|
#### Reading a file example (string)
|
|
509
509
|
|
|
510
510
|
```python
|
|
511
|
-
|
|
512
|
-
|
|
511
|
+
with files_sdk.open("foo.txt", 'r') as f:
|
|
512
|
+
print(f.read())
|
|
513
513
|
```
|
|
514
514
|
|
|
515
515
|
#### Reading a file example (binary)
|
|
516
516
|
|
|
517
517
|
```python
|
|
518
|
-
|
|
519
|
-
|
|
518
|
+
with files_sdk.open("foo.txt", 'rb') as f:
|
|
519
|
+
print(f.read())
|
|
520
520
|
```
|
|
521
521
|
|
|
522
522
|
### List Responses and Cursor Paging
|
|
@@ -529,24 +529,24 @@ as needed.
|
|
|
529
529
|
#### Iterating with with auto_paging_iter
|
|
530
530
|
|
|
531
531
|
```python
|
|
532
|
-
|
|
532
|
+
list_obj = files_sdk.folder.list_for('/')
|
|
533
533
|
|
|
534
|
-
|
|
535
|
-
|
|
534
|
+
for f in list_obj.auto_paging_iter():
|
|
535
|
+
print(f.type, f.path)
|
|
536
536
|
```
|
|
537
537
|
|
|
538
538
|
#### Iterating manually
|
|
539
539
|
|
|
540
540
|
```python
|
|
541
|
-
|
|
541
|
+
list_obj = files_sdk.folder.list_for('/')
|
|
542
542
|
|
|
543
|
+
for f in list_obj:
|
|
544
|
+
print(f.type, f.path)
|
|
545
|
+
|
|
546
|
+
while list_obj.has_next_page:
|
|
547
|
+
list_obj.load_next_page()
|
|
543
548
|
for f in list_obj:
|
|
544
549
|
print(f.type, f.path)
|
|
545
|
-
|
|
546
|
-
while list_obj.has_next_page:
|
|
547
|
-
list_obj.load_next_page()
|
|
548
|
-
for f in list_obj:
|
|
549
|
-
print(f.type, f.path)
|
|
550
550
|
```
|
|
551
551
|
|
|
552
552
|
### Comparing Case insensitive files and paths
|
|
@@ -554,8 +554,8 @@ as needed.
|
|
|
554
554
|
For related documentation see [Case Sensitivity Documentation](https://www.files.com/docs/files-and-folders/file-system-semantics/case-sensitivity).
|
|
555
555
|
|
|
556
556
|
```python
|
|
557
|
-
|
|
558
|
-
|
|
557
|
+
if files_sdk.path_util.is_same("Fïłèńämê.Txt", "filename.txt"):
|
|
558
|
+
print("Paths are the same")
|
|
559
559
|
```
|
|
560
560
|
|
|
561
561
|
## Mock Server
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/action_notification_export_result.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{Files.com-1.4.116 → Files.com-1.4.117}/files_sdk/models/remote_server_configuration_file.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|