-
-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathsdk.py
More file actions
1915 lines (1555 loc) · 58.2 KB
/
sdk.py
File metadata and controls
1915 lines (1555 loc) · 58.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import datetime
import fnmatch
import logging
import os
import sys
import requests
import urllib3
import cgi
from enum import Enum
from pathlib import Path
from typing import Any, Callable, Dict, List, Optional, TypedDict, Union, cast
from urllib import parse as urlparse
from requests.adapters import HTTPAdapter, Retry
from requests_toolbelt.multipart.encoder import MultipartEncoderMonitor
from .interfaces import QfcException, QfcRequest, QfcRequestException
from .utils import calc_etag, log, add_trailing_slash_to_url
from pathvalidate import is_valid_filepath
logger = logging.getLogger(__file__)
if sys.version_info >= (3, 8):
from importlib import metadata
else:
import importlib_metadata as metadata
try:
__version__ = metadata.version("qfieldcloud_sdk")
except metadata.PackageNotFoundError:
__version__ = "dev"
DEFAULT_PAGINATION_LIMIT = 20
"""int: Defines the default limit for pagination, set to `20`."""
class FileTransferStatus(str, Enum):
"""Represents the status of a file transfer.
Attributes:
PENDING: The transfer is pending.
SUCCESS: The transfer was successful.
FAILED: The transfer failed.
"""
PENDING = "PENDING"
SUCCESS = "SUCCESS"
FAILED = "FAILED"
class FileTransferType(str, Enum):
"""Represents the type of file transfer.
The PACKAGE transfer type is used only internally in QFieldCloud workers, so it should never be used by other API clients.
Attributes:
PROJECT: Refers to a project file.
PACKAGE: Refers to a package Type.
"""
PROJECT = "project"
PACKAGE = "package"
class JobTypes(str, Enum):
"""Represents the types of jobs that can be processed on QFieldCloud.
Attributes:
PACKAGE: Refers to a packaging job.
APPLY_DELTAS: Refers to applying deltas (differences).
PROCESS_PROJECTFILE: Refers to processing a project file.
"""
PACKAGE = "package"
APPLY_DELTAS = "delta_apply"
PROCESS_PROJECTFILE = "process_projectfile"
CREATE_PROJECT = "create_project"
class ProjectCollaboratorRole(str, Enum):
"""Defines roles for project collaborators.
See project collaborator roles documentation: https://docs.qfield.org/reference/qfieldcloud/permissions/#roles_1
Attributes:
ADMIN: Administrator role.
MANAGER: Manager role.
EDITOR: Editor role.
REPORTER: Reporter role.
READER: Reader role.
"""
ADMIN = "admin"
MANAGER = "manager"
EDITOR = "editor"
REPORTER = "reporter"
READER = "reader"
class OrganizationMemberRole(str, Enum):
"""Defines roles for organization members.
See organization member roles documentation: https://docs.qfield.org/reference/qfieldcloud/permissions/#roles_2
Attributes:
ADMIN: Administrator role.
MEMBER: Member role.
"""
ADMIN = "admin"
MEMBER = "member"
class CollaboratorModel(TypedDict):
"""Represents the structure of a project collaborator in the QFieldCloud system.
Attributes:
collaborator: The collaborator's identifier.
role: The role of the collaborator.
project_id: The associated project identifier.
created_by: The user who created the collaborator entry.
updated_by: The user who last updated the collaborator entry.
created_at: The timestamp when the collaborator entry was created.
updated_at: The timestamp when the collaborator entry was last updated.
"""
collaborator: str
role: ProjectCollaboratorRole
project_id: str
created_by: str
updated_by: str
created_at: datetime.datetime
updated_at: datetime.datetime
class OrganizationMemberModel(TypedDict):
"""Represents the structure of an organization member in the QFieldCloud system.
Attributes:
member: The member's identifier.
role: The role of the member.
organization: The associated organization identifier.
is_public: A boolean indicating if the membership is public.
"""
member: str
role: OrganizationMemberRole
organization: str
is_public: bool
# TODO future work that can be surely expected, check QF-4535
# created_by: str
# updated_by: str
# created_at: datetime.datetime
# updated_at: datetime.datetime
class TeamModel(TypedDict):
"""Represents the structure of a team within an organization in the QFieldCloud system.
Attributes:
team: The team's identifier.
organization: The associated organization identifier.
members: A list of member identifiers belonging to the team.
"""
team: str
organization: str
members: List[str]
class TeamMemberModel(TypedDict):
"""Represents the structure of a team member in the QFieldCloud system.
Attributes:
member: The member's identifier.
"""
member: str
class Pagination:
"""The Pagination class allows for controlling and managing pagination of results within the QFieldCloud SDK.
Args:
limit: The maximum number of items to return. Defaults to None.
offset: The starting point from which to return items. Defaults to None.
Attributes:
limit: The maximum number of items to return.
offset: The starting point from which to return items.
"""
limit: Optional[int] = None
offset: Optional[int] = None
def __init__(
self, limit: Optional[int] = None, offset: Optional[int] = None
) -> None:
self.limit = limit
self.offset = offset
@property
def is_empty(self) -> bool:
"""Whether both limit and offset are None, indicating no pagination settings.
Returns:
True if both limit and offset are None, False otherwise.
"""
return self.limit is None and self.offset is None
class DeltaPushResponse(TypedDict):
"""Represents the structure of the response for pushing a delta file.
Attributes:
status: The status of the response.
message: A message providing additional information about the response.
details: Additional details about the delta push operation.
"""
status: str
message: Optional[str]
details: Optional[Dict[str, Any]]
class Client:
"""The core component of the QFieldCloud SDK, providing methods for interacting with the QFieldCloud platform.
The client provides methods for authentication, project management, file management, and more.
It is configured with retries for GET requests on specific 5xx HTTP status codes.
Args:
url: The base URL for the QFieldCloud API. Defaults to `QFIELDCLOUD_URL` environment variable if empty.
verify_ssl: Whether to verify SSL certificates. Defaults to True.
token: The authentication token for API access. Defaults to `QFIELDCLOUD_TOKEN` environment variable if empty.
Raises:
QfcException: If the `url` is not provided either directly or through the environment variable.
Attributes:
session: The session object to maintain connections.
url: The base URL for the QFieldCloud API.
token: The authentication token for API access.
verify_ssl: Whether to verify SSL certificates.
"""
session: requests.Session
url: str
token: str
verify_ssl: bool
def __init__(
self,
url: str = "",
verify_ssl: bool = True,
token: str = "",
) -> None:
self.session = requests.Session()
# retries should be only on GET and only if error 5xx
retries = Retry(
total=5,
backoff_factor=0.1,
allowed_methods=["GET"],
# skip 501, as it is "Not Implemented", no point to retry
status_forcelist=[500, 502, 503, 504],
)
self.session.mount("https://", HTTPAdapter(max_retries=retries))
self.url = url or os.environ.get("QFIELDCLOUD_URL", "")
self.token = token or os.environ.get("QFIELDCLOUD_TOKEN", "")
self.verify_ssl = verify_ssl
if not self.verify_ssl:
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
if not self.url:
raise QfcException(
"Cannot create a new QFieldCloud client without a url passed in the constructor or as environment variable QFIELDCLOUD_URL"
)
def login(self, username: str, password: str) -> Dict[str, Any]:
"""Logs in with the provided username and password.
Args:
username: The username or email used to register.
password: The password associated with the username.
Returns:
Authentication token and additional metadata.
Example:
```python
client = sdk.Client(url="https://app.qfield.cloud/api/v1/")
client.login("ninjamaster", "secret_password123")
```
"""
resp = self._request(
"POST",
"auth/login",
data={
"username": username,
"password": password,
},
skip_token=True,
)
payload = resp.json()
self.token = payload["token"]
return payload
def logout(self) -> None:
"""Logs out from the current session, invalidating the authentication token.
Example:
```python
client.logout()
```
"""
resp = self._request("POST", "auth/logout")
return resp.json()
def check_server_status(self) -> Dict[str, Any]:
"""Checks the status of the QFieldCloud server.
This endpoint usually provides information of the server health.
Returns:
A dictionary containing the server status information (e.g., {"storage": "ok", ...}).
Example:
```python
client = sdk.Client(url="[https://app.qfield.cloud/api/v1/](https://app.qfield.cloud/api/v1/)")
status = client.check_server_status()
print(f"Server status: {status}")
```
"""
resp = self._request(
"GET",
"status/",
skip_token=True,
)
return resp.json()
def list_projects(
self,
include_public: bool = False,
pagination: Pagination = Pagination(),
**kwargs,
) -> List[Dict[str, Any]]:
"""List projects accessible by the current user. Optionally include all public projects.
Args:
include_public: Whether to include public projects in the list. Defaults to False.
pagination: Pagination settings for the request. Defaults to an empty Pagination instance.
Returns:
A list of dictionaries containing project details.
Example:
```python
client.list_projects()
```
"""
params = {
"include-public": str(int(include_public)), # type: ignore
}
payload = self._request_json(
"GET", "projects", params=params, pagination=pagination
)
return cast(List, payload)
def get_project(
self,
project_id: str,
) -> Dict[str, Any]:
"""Get project data.
Args:
project_id: the project data to get data for.
Returns:
A dictionary containing project details.
Example:
```python
client.get_project(project_id)
```
"""
payload = self._request_json("GET", f"projects/{project_id}")
return cast(Dict, payload)
def get_project_seed(
self,
project_id: str,
) -> Dict[str, Any]:
"""Get project seed data.
Args:
project_id: the project data to get seed data for.
Returns:
A dictionary containing project seed.
Example:
```python
client.get_project_seed(project_id)
```
"""
payload = self._request_json("GET", f"projects/{project_id}/seed")
return cast(Dict, payload)
def get_project_seed_xlsform(
self,
project_id: str,
destination_dir: str,
) -> Optional[str]:
"""Get project seed XLSForm file content.
Args:
project_id: the project data to get seed XLSForm for.
Returns:
The name of the downloaded XLSForm file.
Example:
```python
client.get_project_seed_xlsform(project_id)
```
"""
resp = self._request("GET", f"projects/{project_id}/seed/xlsform")
if resp.status_code != 200:
return None
content_disposition = resp.headers.get("Content-Disposition", "")
if not content_disposition:
logger.warning(
"Response has no `Content-Disposition` header. Skip download of XLSForm file!"
)
return None
_value, params = cgi.parse_header(content_disposition)
filename = params.get("filename")
if not filename:
logger.warning(
"Response has no filename in `Content-Disposition` header. Skip download of XLSForm file!"
)
return None
path = Path(destination_dir).joinpath(filename)
path.write_bytes(resp.content)
return str(path)
def list_remote_files(
self, project_id: str, skip_metadata: bool = True
) -> List[Dict[str, Any]]:
"""List project files.
Args:
project_id: Project ID.
skip_metadata: Whether to skip fetching metadata for the files. Defaults to True.
Returns:
A list of file details.
Example:
```python
client.list_remote_files("123e4567-e89b-12d3-a456-426614174000", False)
```
"""
params = {}
if skip_metadata:
params["skip_metadata"] = "1"
resp = self._request("GET", f"files/{project_id}", params=params)
remote_files = resp.json()
# TODO remove this temporary decoration with `etag` key
remote_files = list(map(lambda f: {"etag": f["md5sum"], **f}, remote_files))
return remote_files
def create_project(
self,
name: str,
owner: Optional[str] = None,
description: str = "",
is_public: bool = False,
) -> Dict[str, Any]:
"""Create a new project.
Args:
name: The name of the new project.
owner: The owner of the project. When None, the project will be owned by the currently logged-in user. Defaults to None.
description: A description of the project. Defaults to an empty string.
is_public: Whether the project should be public. Defaults to False.
Returns:
A dictionary containing the details of the created project.
Example:
```python
client.create_project(
"Tree_Survey", "My_Organization_Clan", "Description"
)
```
"""
resp = self._request(
"POST",
"projects",
data={
"name": name,
"owner": owner,
"description": description,
"is_public": int(is_public),
},
)
return resp.json()
def delete_project(self, project_id: str) -> requests.Response:
"""Delete a project.
Args:
project_id: Project ID.
Returns:
The response object from the file delete request.
Example:
```python
client.delete_project("123e4567-e89b-12d3-a456-426614174000")
```
"""
resp = self._request("DELETE", f"projects/{project_id}")
return resp
def patch_project(
self,
project_id: str,
name: Optional[str] = None,
owner: Optional[str] = None,
description: Optional[str] = None,
is_public: Optional[bool] = None,
) -> Dict[str, Any]:
"""Update a project.
Args:
project_id (str): Project ID.
name (str | None): if passed, the new name. Defaults to None.
owner (str | None, optional): if passed, the new owner. Defaults to None.
description (str, optional): if passed, the new description. Defaults to None.
is_public (bool, optional): if passed, the new public setting. Defaults to None.
Returns:
Dict[str, Any]: the updated project
Example:
```python
client.patch_project(description="New Description")
```
"""
project_data: dict[str, Any] = {}
if name:
project_data["name"] = name
if description:
project_data["description"] = description
if owner:
project_data["owner"] = owner
if is_public:
project_data["is_public"] = is_public
resp = self._request(
"PATCH",
f"projects/{project_id}",
project_data,
)
return resp.json()
def upload_files(
self,
project_id: str,
upload_type: FileTransferType,
project_path: str,
filter_glob: str,
throw_on_error: bool = False,
show_progress: bool = False,
force: bool = False,
job_id: str = "",
) -> List[Dict]:
"""Upload files to a QFieldCloud project.
Args:
project_id: Project ID.
upload_type: The type of file transfer (PROJECT or PACKAGE).
project_path: The local directory containing the files to upload.
filter_glob: A glob pattern to filter which files to upload.
throw_on_error: Whether to raise an error if a file fails to upload. Defaults to False.
show_progress: Whether to display a progress bar during upload. Defaults to False.
force: Whether to force upload all files, even if they exist remotely. Defaults to False.
job_id: The job ID, required if `upload_type` is PACKAGE. Defaults to an empty string.
Returns:
A list of dictionaries with information about the uploaded files.
Example:
```python
client.upload_files(
project_id="123e4567-e89b-12d3-a456-426614174000",
upload_type=sdk.FileTransferType.PROJECT,
project_path="/home/ninjamaster/QField/cloud/Tree_Survey",
filter_glob="*",
throw_on_error=True,
show_progress=True,
force=True
)
```
"""
if not filter_glob:
filter_glob = "*"
local_files = self.list_local_files(project_path, filter_glob)
# we should always upload all package files
if upload_type == FileTransferType.PACKAGE:
force = True
files_to_upload = []
if force:
files_to_upload = local_files
else:
remote_files = self.list_remote_files(project_id)
if len(remote_files) == 0:
files_to_upload = local_files
else:
for local_file in local_files:
remote_file = None
for f in remote_files:
if f["name"] == local_file["name"]:
remote_file = f
break
etag = calc_etag(local_file["absolute_filename"])
if remote_file and remote_file.get("etag", None) == etag:
continue
files_to_upload.append(local_file)
if not files_to_upload:
return files_to_upload
for file in files_to_upload:
try:
local_filename = Path(file["absolute_filename"])
self.upload_file(
project_id,
upload_type,
local_filename,
file["name"],
show_progress,
job_id,
)
file["status"] = FileTransferStatus.SUCCESS
except Exception as err:
file["status"] = FileTransferStatus.FAILED
file["error"] = err
if throw_on_error:
raise err
else:
continue
return local_files
def upload_file(
self,
project_id: str,
upload_type: FileTransferType,
local_filename: Path,
remote_filename: Path,
show_progress: bool,
job_id: str = "",
) -> requests.Response:
"""Upload a single file to a project.
Args:
project_id: Project ID.
upload_type: The type of file transfer.
local_filename: The path to the local file to upload.
remote_filename: The path where the file should be stored remotely.
show_progress: Whether to display a progress bar during upload.
job_id: The job ID, required if `upload_type` is PACKAGE. Defaults to an empty string.
Raises:
pathvalidate.ValidationError: Raised when the uploaded file does not have a valid filename.
Returns:
The response object from the upload request.
Example:
```python
client.upload_file(
project_id="123e4567-e89b-12d3-a456-426614174000",
upload_type=FileTransferType.PROJECT,
local_filename="/home/ninjamaster/QField/cloud/Tree_Survey/trees.gpkg",
remote_filename="trees.gpkg",
show_progress=True
)
```
"""
# if the filepath is invalid, it will throw a new error `pathvalidate.ValidationError`
is_valid_filepath(str(local_filename))
local_file_size = local_filename.stat().st_size
with open(local_filename, "rb") as local_file:
encoder_params = {}
if show_progress:
from tqdm import tqdm
progress_bar = tqdm(
total=local_file_size,
unit_scale=True,
unit="B",
desc=f'Uploading "{remote_filename}"...',
)
def cb(monitor: MultipartEncoderMonitor) -> None:
progress_bar.n = monitor.bytes_read
progress_bar.refresh()
encoder_params["callback"] = cb
else:
logger.info(f'Uploading file "{remote_filename}"…')
multipart_data = MultipartEncoderMonitor.from_fields(
fields={
"file": (
str(remote_filename),
local_file,
None,
),
},
**encoder_params,
)
if upload_type == FileTransferType.PROJECT:
url = f"files/{project_id}/{remote_filename}"
elif upload_type == FileTransferType.PACKAGE:
if not job_id:
raise QfcException(
'When the upload type is "package", you must pass the "job_id" parameter.'
)
url = f"packages/{project_id}/{job_id}/files/{remote_filename}"
else:
raise NotImplementedError()
return self._request(
"POST",
url,
data=multipart_data,
headers={
"Content-Type": multipart_data.content_type,
"Accept": "application/json",
},
)
def download_project(
self,
project_id: str,
local_dir: str,
filter_glob: str = "*",
throw_on_error: bool = False,
show_progress: bool = False,
force_download: bool = False,
) -> List[Dict]:
"""Download the specified project files into the destination dir.
Args:
project_id: Project ID.
local_dir: destination directory where the files will be downloaded
filter_glob: if specified, download only project files which match the glob, otherwise download all
throw_on_error: Throw if download error occurres. Defaults to False.
show_progress: Show progress bar in the console. Defaults to False.
force_download: Download file even if it already exists locally. Defaults to False.
Returns:
A list of dictionaries with information about the downloaded files.
Example:
```python
client.download_project(
project_id="123e4567-e89b-12d3-a456-426614174000",
local_dir="/home/ninjamaster/QField/cloud/Tree_Survey",
filter_glob="*",
show_progress=True,
force_download=True
)
```
"""
files = self.list_remote_files(project_id)
return self.download_files(
files,
project_id,
FileTransferType.PROJECT,
local_dir,
filter_glob,
throw_on_error,
show_progress,
force_download,
)
def list_jobs(
self,
project_id: str,
job_type: Optional[JobTypes] = None,
pagination: Pagination = Pagination(),
) -> List[Dict[str, Any]]:
"""List project jobs.
Args:
project_id: Project ID.
job_type: The type of job to filter by. If set to None, list all jobs. Defaults to None.
pagination: Pagination settings. Defaults to a new Pagination object.
Returns:
A list of dictionaries representing the jobs.
Example:
```python
client.list_jobs(
project_id="123e4567-e89b-12d3-a456-426614174000",
job_type=JobTypes.PACKAGE
)
```
"""
payload = self._request_json(
"GET",
"jobs/",
{
"project_id": project_id,
"type": job_type.value if job_type else None,
},
pagination=pagination,
)
return cast(List, payload)
def job_trigger(
self, project_id: str, job_type: JobTypes, force: bool = False
) -> Dict[str, Any]:
"""Trigger a new job for given project.
Args:
project_id: Project ID.
job_type (JobTypes): The type of job to trigger.
force: Whether to force the job execution. Defaults to False.
Returns:
A dictionary containing the job information.
Example:
```python
client.job_trigger(
project_id="123e4567-e89b-12d3-a456-426614174000",
job_type=JobTypes.PACKAGE,
force=True
)
```
"""
resp = self._request(
"POST",
"jobs/",
{
"project_id": project_id,
"type": job_type.value,
"force": int(force),
},
)
return resp.json()
def job_status(self, job_id: str) -> Dict[str, Any]:
"""Get the status of a job.
Args:
job_id: The ID of the job.
Returns:
A dictionary containing the job status.
Example:
```python
client.job_status("123e4567-e89b-12d3-a456-426614174000")
```
"""
resp = self._request("GET", f"jobs/{job_id}")
return resp.json()
def push_delta(self, project_id: str, delta_filename: str) -> DeltaPushResponse:
"""Push a delta file to a project.
Args:
project_id: Project ID.
delta_filename: Path to the delta JSON file.
Returns:
A DeltaPushResponse containing the response from the server.
Example:
```python
client.push_delta(
project_id="123e4567-e89b-12d3-a456-426614174000",
delta_filename="/home/ninjamaster/QField/cloud/Tree_Survey/deltas.json"
)
```
"""
with open(delta_filename, "r") as delta_file:
files = {"file": delta_file}
response = self._request(
"POST",
f"deltas/{project_id}/",
files=files,
)
return cast(DeltaPushResponse, response)
def delete_files(
self,
project_id: str,
glob_patterns: List[str],
throw_on_error: bool = False,
finished_cb: Optional[Callable] = None,
) -> Dict[str, List[Dict[str, Any]]]:
"""Delete project files.
Args:
project_id: Project ID.
glob_patterns (list[str]): Delete only files matching one the glob patterns.
throw_on_error: Throw if delete error occurres. Defaults to False.
finished_cb (Callable, optional): Deprecated. Defaults to None.
Raises:
QFieldCloudException: if throw_on_error is True, throw an error if a download request fails.
Returns:
Deleted files by glob pattern.
Example:
```python
client.delete_files(
project_id="123e4567-e89b-12d3-a456-426614174000",
glob_patterns=["*.csv", "*.jpg"],
throw_on_error=True
)
```
"""
project_files = self.list_remote_files(project_id)
glob_results: Dict[str, List[Dict[str, Any]]] = {}
log(f"Project '{project_id}' has {len(project_files)} file(s).")
for glob_pattern in glob_patterns:
glob_results[glob_pattern] = []
for file in project_files:
if not fnmatch.fnmatch(file["name"], glob_pattern):
continue
if "status" in file:
# file has already been matched by a previous glob pattern