-
Notifications
You must be signed in to change notification settings - Fork 29
Expand file tree
/
Copy pathdssclient.py
More file actions
855 lines (684 loc) · 34.6 KB
/
dssclient.py
File metadata and controls
855 lines (684 loc) · 34.6 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
import json
from requests import Session
from requests import exceptions
from requests.auth import HTTPBasicAuth
from .dss.future import DSSFuture
from .dss.project import DSSProject
from .dss.plugin import DSSPlugin
from .dss.admin import DSSUser, DSSGroup, DSSConnection, DSSGeneralSettings, DSSCodeEnv, DSSGlobalApiKey, DSSCluster
from .dss.meaning import DSSMeaning
from .dss.sqlquery import DSSSQLQuery
from .dss.notebook import DSSNotebook
from .dss.discussion import DSSObjectDiscussions
from .dss.apideployer import DSSAPIDeployer
import os.path as osp
from .utils import DataikuException
class DSSClient(object):
"""Entry point for the DSS API client"""
def __init__(self, host, api_key=None, internal_ticket = None):
"""
Instantiate a new DSS API client on the given host with the given API key.
API keys can be managed in DSS on the project page or in the global settings.
The API key will define which operations are allowed for the client.
"""
self.api_key = api_key
self.internal_ticket = internal_ticket
self.host = host
self._session = Session()
if self.api_key is not None:
self._session.auth = HTTPBasicAuth(self.api_key, "")
elif self.internal_ticket is not None:
self._session.headers.update({"X-DKU-APITicket" : self.internal_ticket})
else:
raise ValueError("API Key is required")
########################################################
# Futures
########################################################
def list_futures(self, as_objects=False, all_users=False):
"""
List the currently-running long tasks (a.k.a futures)
:param boolean as_objects: if True, each returned item will be a :class:`dataikuapi.dss.future.DSSFuture`
:param boolean all_users: if True, returns futures for all users (requires admin privileges). Else, only returns futures for the user associated with the current authentication context (if any)
:return: list of futures. if as_objects is True, each future in the list is a :class:`dataikuapi.dss.future.DSSFuture`. Else, each future in the list is a dict. Each dict contains at least a 'jobId' field
:rtype: list of :class:`dataikuapi.dss.future.DSSFuture` or list of dict
"""
list = self._perform_json("GET", "/futures/", params={"withScenarios":False, "withNotScenarios":True, 'allUsers' : all_users})
if as_objects:
return [DSSFuture(self, state['jobId'], state) for state in list]
else:
return list
def list_running_scenarios(self, all_users=False):
"""
List the running scenarios
:param boolean all_users: if True, returns scenarios for all users (requires admin privileges). Else, only returns scenarios for the user associated with the current authentication context (if any)
:return: list of running scenarios, each one as a dict containing at least a "jobId" field for the
future hosting the scenario run, and a "payload" field with scenario identifiers
:rtype: list of dicts
"""
return self._perform_json("GET", "/futures/", params={"withScenarios":True, "withNotScenarios":False, 'allUsers' : all_users})
def get_future(self, job_id):
"""
Get a handle to interact with a specific long task (a.k.a future). This notably allows aborting this future.
:param str job_id: the identifier of the desired future (which can be returned by :py:meth:`list_futures` or :py:meth:`list_running_scenarios`)
:returns: A handle to interact the future
:rtype: :class:`dataikuapi.dss.future.DSSFuture`
"""
return DSSFuture(self, job_id)
########################################################
# Notebooks
########################################################
def list_running_notebooks(self, as_objects=True):
"""
List the currently-running Jupyter notebooks
:param boolean as_objects: if True, each returned item will be a :class:`dataikuapi.dss.notebook.DSSNotebook`
:return: list of notebooks. if as_objects is True, each entry in the list is a :class:`dataikuapi.dss.notebook.DSSNotebook`. Else, each item in the list is a dict which contains at least a "name" field.
:rtype: list of :class:`dataikuapi.dss.notebook.DSSNotebook` or list of dict
"""
list = self._perform_json("GET", "/admin/notebooks/")
if as_objects:
return [DSSNotebook(self, notebook['projectKey'], notebook['name'], notebook) for notebook in list]
else:
return list
########################################################
# Projects
########################################################
def list_project_keys(self):
"""
List the project keys (=project identifiers).
:returns: list of project keys identifiers, as strings
:rtype: list of strings
"""
return [x["projectKey"] for x in self._perform_json("GET", "/projects/")]
def list_projects(self):
"""
List the projects
:returns: a list of projects, each as a dict. Each dictcontains at least a 'projectKey' field
:rtype: list of dicts
"""
return self._perform_json("GET", "/projects/")
def get_project(self, project_key):
"""
Get a handle to interact with a specific project.
:param str project_key: the project key of the desired project
:returns: A :class:`dataikuapi.dss.project.DSSProject` to interact with this project
"""
return DSSProject(self, project_key)
def create_project(self, project_key, name, owner, description=None, settings=None):
"""
Creates a new project, and return a project handle to interact with it.
Note: this call requires an API key with admin rights or the rights to create a project
:param str project_key: the identifier to use for the project. Must be globally unique
:param str name: the display name for the project.
:param str owner: the login of the owner of the project.
:param str description: a description for the project.
:param dict settings: Initial settings for the project (can be modified later). The exact possible settings are not documented.
:returns: A class:`dataikuapi.dss.project.DSSProject` project handle to interact with this project
"""
resp = self._perform_text(
"POST", "/projects/", body={
"projectKey" : project_key,
"name" : name,
"owner" : owner,
"settings" : settings,
"description" : description
})
return DSSProject(self, project_key)
########################################################
# Plugins
########################################################
def list_plugins(self):
"""
List the installed plugins
:returns: list of dict. Each dict contains at least a 'id' field
"""
return self._perform_json("GET", "/plugins/")
def get_plugin(self, plugin_id):
"""
Get a handle to interact with a specific plugin (plugin in "development" mode only).
:param str plugin_id: the identifier of the desired plugin
:returns: A :class:`dataikuapi.dss.project.DSSPlugin`
"""
return DSSPlugin(self, plugin_id)
def create_dev_plugin(self, creation_mode="EMPTY", plugin_id=None, git_repository=None, git_checkout=None, git_subpath=None):
"""
Create a new dev plugin inside DSS, and returns a handle to interact with it.
:param str creation_mode: the way the plugin will be created;
- EMPTY: from scratch
- GIT_CLONE: from a full Git repository (history is retrieved)
- GIT_EXPORT: from a partial Git repository (no history, no push back)
:param str plugin_id: the identifier of the desired plugin (for EMPTY, guessed otherwise)
:param str git_repository: the Git repository URL (necessary for GIT_CLONE and GIT_EXPORT)
:param str git_checkout: the Git repository branch, tag or hash (necessary for GIT_EXPORT)
:param str git_subpath: path to the plugin in the repository (necessary for GIT_EXPORT)
:returns: A :class:`dataikuapi.dss.project.DSSPlugin`
"""
create_dev_plugin_body = {
'creationMode': creation_mode,
'pluginId': plugin_id,
'gitRepository': git_repository,
'gitCheckout': git_checkout,
'gitSubpath': git_subpath,
}
res = self._perform_json("POST", "/plugins/actions/createDev", body=create_dev_plugin_body)
return DSSPlugin(self, res['details'])
########################################################
# SQL queries
########################################################
def sql_query(self, query, connection=None, database=None, dataset_full_name=None, pre_queries=None, post_queries=None, type='sql', extra_conf={}, script_steps=None, script_input_schema=None, script_output_schema=None, script_report_location=None):
"""
Initiate a SQL, Hive or Impala query and get a handle to retrieve the results of the query.
Internally, the query is run by DSS. The database to run the query on is specified either by
passing a connection name, or by passing a database name, or by passing a dataset full name
(whose connection is then used to retrieve the database)
:param str query: the query to run
:param str connection: the connection on which the query should be run (exclusive of database and dataset_full_name)
:param str database: the database on which the query should be run (exclusive of connection and dataset_full_name)
:param str dataset_full_name: the dataset on the connection of which the query should be run (exclusive of connection and database)
:param list pre_queries: (optional) array of queries to run before the query
:param list post_queries: (optional) array of queries to run after the query
:param str type: the type of query : either 'sql', 'hive' or 'impala'
:returns: A :class:`dataikuapi.dss.sqlquery.DSSSQLQuery` query handle
"""
return DSSSQLQuery(self, query, connection, database, dataset_full_name, pre_queries, post_queries, type, extra_conf, script_steps, script_input_schema, script_output_schema, script_report_location)
########################################################
# Users
########################################################
def list_users(self):
"""
List all users setup on the DSS instance
Note: this call requires an API key with admin rights
:return: A list of users, as a list of dicts
:rtype: list of dicts
"""
return self._perform_json(
"GET", "/admin/users/")
def get_user(self, login):
"""
Get a handle to interact with a specific user
:param str login: the login of the desired user
:return: A :class:`dataikuapi.dss.admin.DSSUser` user handle
"""
return DSSUser(self, login)
def create_user(self, login, password, display_name='', source_type='LOCAL', groups=[], profile='DATA_SCIENTIST'):
"""
Create a user, and return a handle to interact with it
Note: this call requires an API key with admin rights
:param str login: the login of the new user
:param str password: the password of the new user
:param str display_name: the displayed name for the new user
:param str source_type: the type of new user. Admissible values are 'LOCAL' or 'LDAP'
:param list groups: the names of the groups the new user belongs to
:param str profile: The profile for the new user, can be one of READER, DATA_ANALYST or DATA_SCIENTIST
:return: A :class:`dataikuapi.dss.admin.DSSUser` user handle
"""
resp = self._perform_text(
"POST", "/admin/users/", body={
"login" : login,
"password" : password,
"displayName" : display_name,
"sourceType" : source_type,
"groups" : groups,
"userProfile" : profile
})
return DSSUser(self, login)
########################################################
# Groups
########################################################
def list_groups(self):
"""
List all groups setup on the DSS instance
Note: this call requires an API key with admin rights
:returns: A list of groups, as an list of dicts
:rtype: list of dicts
"""
return self._perform_json(
"GET", "/admin/groups/")
def get_group(self, name):
"""
Get a handle to interact with a specific group
:param str name: the name of the desired group
:returns: A :class:`dataikuapi.dss.admin.DSSGroup` group handle
"""
return DSSGroup(self, name)
def create_group(self, name, description=None, source_type='LOCAL'):
"""
Create a group, and return a handle to interact with it
Note: this call requires an API key with admin rights
:param str name: the name of the new group
:param str description: (optional) a description of the new group
:param source_type: the type of the new group. Admissible values are 'LOCAL' and 'LDAP'
:returns: A :class:`dataikuapi.dss.admin.DSSGroup` group handle
"""
resp = self._perform_text(
"POST", "/admin/groups/", body={
"name" : name,
"description" : description,
"sourceType" : source_type
})
return DSSGroup(self, name)
########################################################
# Connections
########################################################
def list_connections(self):
"""
List all connections setup on the DSS instance
Note: this call requires an API key with admin rights
:returns: All connections, as a dict of connection name to connection definition
:rtype: :dict
"""
return self._perform_json(
"GET", "/admin/connections/")
def get_connection(self, name):
"""
Get a handle to interact with a specific connection
:param str name: the name of the desired connection
:returns: A :class:`dataikuapi.dss.admin.DSSConnection` connection handle
"""
return DSSConnection(self, name)
def create_connection(self, name, type, params={}, usable_by='ALL', allowed_groups=[]):
"""
Create a connection, and return a handle to interact with it
Note: this call requires an API key with admin rights
:param name: the name of the new connection
:param type: the type of the new connection
:param params: the parameters of the new connection, as a JSON object
:param usable_by: the type of access control for the connection. Either 'ALL' (=no access control)
or 'ALLOWED' (=access restricted to users of a list of groups)
:param allowed_groups: when using access control (that is, setting usable_by='ALLOWED'), the list
of names of the groups whose users are allowed to use the new connection
:returns: A :class:`dataikuapi.dss.admin.DSSConnection` connection handle
"""
resp = self._perform_text(
"POST", "/admin/connections/", body={
"name" : name,
"type" : type,
"params" : params,
"usableBy" : usable_by,
"allowedGroups" : allowed_groups
})
return DSSConnection(self, name)
########################################################
# Code envs
########################################################
def list_code_envs(self):
"""
List all code envs setup on the DSS instance
Note: this call requires an API key with admin rights
:returns: a list of code envs. Each code env is a dict containing at least "name", "type" and "language"
"""
return self._perform_json(
"GET", "/admin/code-envs/")
def get_code_env(self, env_lang, env_name):
"""
Get a handle to interact with a specific code env
:param str name: the name of the desired code env
:returns: A :class:`dataikuapi.dss.admin.DSSCodeEnv` code env handle
"""
return DSSCodeEnv(self, env_lang, env_name)
def create_code_env(self, env_lang, env_name, deployment_mode, params=None):
"""
Create a code env, and return a handle to interact with it
Note: this call requires an API key with admin rights
:param env_lang: the language (PYTHON or R) of the new code env
:param env_name: the name of the new code env
:param deployment_mode: the type of the new code env
:param params: the parameters of the new code env, as a JSON object
:returns: A :class:`dataikuapi.dss.admin.DSSCodeEnv` code env handle
"""
params = params if params is not None else {}
params['deploymentMode'] = deployment_mode
resp = self._perform_json(
"POST", "/admin/code-envs/%s/%s" % (env_lang, env_name), body=params)
if resp is None:
raise Exception('Env creation returned no data')
if resp.get('messages', {}).get('error', False):
raise Exception('Env creation failed : %s' % (json.dumps(resp.get('messages', {}).get('messages', {}))))
return DSSCodeEnv(self, env_lang, env_name)
########################################################
# Clusters
########################################################
def list_clusters(self):
"""
List all clusters setup on the DSS instance
Returns:
List clusters (name, type, state)
"""
return self._perform_json(
"GET", "/admin/clusters/")
def get_cluster(self, cluster_id):
"""
Get a handle to interact with a specific cluster
Args:
name: the name of the desired cluster
Returns:
A :class:`dataikuapi.dss.admin.DSSCluster` cluster handle
"""
return DSSCluster(self, cluster_id)
def create_cluster(self, cluster_name, cluster_type='manual', params=None):
"""
Create a cluster, and return a handle to interact with it
:param cluster_name: the name of the new cluster
:param cluster_type: the type of the new cluster
:param params: the parameters of the new cluster, as a JSON object
:returns: A :class:`dataikuapi.dss.admin.DSSCluster` cluster handle
"""
definition = {}
definition['name'] = cluster_name
definition['type'] = cluster_type
definition['params'] = params if params is not None else {}
resp = self._perform_json(
"POST", "/admin/clusters/", body=definition)
if resp is None:
raise Exception('Cluster creation returned no data')
if resp.get('messages', {}).get('error', False):
raise Exception('Cluster creation failed : %s' % (json.dumps(resp.get('messages', {}).get('messages', {}))))
return DSSCluster(self, resp['id'])
########################################################
# Global API Keys
########################################################
def list_global_api_keys(self):
"""
List all global API keys set up on the DSS instance
Note: this call requires an API key with admin rights
:returns: All global API keys, as a list of dicts
"""
return self._perform_json(
"GET", "/admin/globalAPIKeys/")
def get_global_api_key(self, key):
"""
Get a handle to interact with a specific Global API key
:param str key: the secret key of the desired API key
:returns: A :class:`dataikuapi.dss.admin.DSSGlobalApiKey` API key handle
"""
return DSSGlobalApiKey(self, key)
def create_global_api_key(self, label=None, description=None, admin=False):
"""
Create a Global API key, and return a handle to interact with it
Note: this call requires an API key with admin rights
:param str label: the label of the new API key
:param str description: the description of the new API key
:param str admin: has the new API key admin rights (True or False)
:returns: A :class:`dataikuapi.dss.admin.DSSGlobalApiKey` API key handle
"""
resp = self._perform_json(
"POST", "/admin/globalAPIKeys/", body={
"label" : label,
"description" : description,
"globalPermissions": {
"admin": admin
}
})
if resp is None:
raise Exception('API key creation returned no data')
if resp.get('messages', {}).get('error', False):
raise Exception('API key creation failed : %s' % (json.dumps(resp.get('messages', {}).get('messages', {}))))
if not resp.get('id', False):
raise Exception('API key creation returned no key')
key = resp.get('key', '')
return DSSGlobalApiKey(self, key)
########################################################
# Meanings
########################################################
def list_meanings(self):
"""
List all user-defined meanings on the DSS instance
Note: this call requires an API key with admin rights
:returns: A list of meanings. Each meaning is a dict
:rtype: list of dicts
"""
return self._perform_json(
"GET", "/meanings/")
def get_meaning(self, id):
"""
Get a handle to interact with a specific user-defined meaning
Note: this call requires an API key with admin rights
:param str id: the ID of the desired meaning
:returns: A :class:`dataikuapi.dss.meaning.DSSMeaning` meaning handle
"""
return DSSMeaning(self, id)
def create_meaning(self, id, label, type, description=None,
values=None, mappings=None, pattern=None,
normalizationMode=None, detectable=False):
"""
Create a meaning, and return a handle to interact with it
Note: this call requires an API key with admin rights
:param id: the ID of the new meaning
:param type: the type of the new meaning. Admissible values are 'DECLARATIVE', 'VALUES_LIST', 'VALUES_MAPPING' and 'PATTERN'
:param description (optional): the description of the new meaning
:param values (optional): when type is 'VALUES_LIST', the list of values, or a list of {'value':'the value', 'color':'an optional color'}
:param mappings (optional): when type is 'VALUES_MAPPING', the mapping, as a list of objects with this
structure: {'from': 'value_1', 'to': 'value_a'}
:param pattern (optional): when type is 'PATTERN', the pattern
:param normalizationMode (optional): when type is 'VALUES_LIST', 'VALUES_MAPPING' or 'PATTERN', the normalization
mode to use for value matching. One of 'EXACT', 'LOWERCASE', or 'NORMALIZED' (not available
for 'PATTERN' type). Defaults to 'EXACT'.
:param detectable (optional): whether DSS should consider assigning the meaning to columns set to 'Auto-detect'. Defaults to False.
:returns: A :class:`dataikuapi.dss.meaning.DSSMeaning` meaning handle
"""
def make_entry(v):
if isinstance(v, str) or isinstance(v, unicode):
return {'value':v}
else:
return v
def make_mapping(v):
return {'from':v.get('from', None), 'to':make_entry(v.get('to', None))}
entries = None
if values is not None:
entries = [make_entry(v) for v in values]
if mappings is not None:
mappings = [make_mapping(v) for v in mappings]
resp = self._perform_text(
"POST", "/meanings/", body={
"id" : id,
"label": label,
"type": type,
"description": description,
"entries": entries,
"mappings": mappings,
"pattern": pattern,
"normalizationMode": normalizationMode,
"detectable": detectable
})
return DSSMeaning(self, id)
########################################################
# Logs
########################################################
def list_logs(self):
"""
List all available log files on the DSS instance
This call requires an API key with admin rights
:returns: A list of log file names
"""
return self._perform_json(
"GET", "/admin/logs/")
def get_log(self, name):
"""
Get the contents of a specific log file
This call requires an API key with admin rights
:param str name: the name of the desired log file (obtained with :meth:`list_logs`)
:returns: The full content of the log file, as a string
"""
return self._perform_json(
"GET", "/admin/logs/%s" % name)
########################################################
# Variables
########################################################
def get_variables(self):
"""
Get the DSS instance's variables, as a Python dictionary
This call requires an API key with admin rights
:returns: a Python dictionary of the instance-level variables
"""
return self._perform_json(
"GET", "/admin/variables/")
def set_variables(self, variables):
"""
Updates the DSS instance's variables
This call requires an API key with admin rights
It is not possible to update a single variable, you must set all of them at once. Thus, you
should only use a ``variables`` parameter that has been obtained using :meth:`get_variables`.
:param dict variables: the new dictionary of all variables of the instance
"""
return self._perform_empty(
"PUT", "/admin/variables/", body=variables)
########################################################
# General settings
########################################################
def get_general_settings(self):
"""
Gets a handle to interact with the general settings.
This call requires an API key with admin rights
:returns: a :class:`dataikuapi.dss.admin.DSSGeneralSettings` handle
"""
return DSSGeneralSettings(self)
########################################################
# Bundles / Import (Automation node)
########################################################
def create_project_from_bundle_local_archive(self, archive_path):
"""
Create a project from a bundle archive.
Warning: this method can only be used on an automation node.
:param string archive_path: Path on the local machine where the archive is
"""
return self._perform_json("POST",
"/projectsFromBundle/fromArchive",
params = { "archivePath" : osp.abspath(archive_path) })
def create_project_from_bundle_archive(self, fp):
"""
Create a project from a bundle archive (as a file object)
Warning: this method can only be used on an automation node.
:param string fp: A file-like object pointing to a bundle archive zip
"""
files = {'file': fp }
return self._perform_json("POST",
"/projectsFromBundle/", files=files)
def prepare_project_import(self, f):
"""
Prepares import of a project archive.
Warning: this method can only be used on a design node.
:param file-like fp: the input stream, as a file-like object
:returns: a :class:`TemporaryImportHandle` to interact with the prepared import
"""
val = self._perform_json_upload(
"POST", "/projects/import/upload",
"tmp-import.zip", f)
return TemporaryImportHandle(self, val.json()["id"])
########################################################
# API Deployer
########################################################
def get_apideployer(self):
"""Gets a handle to work with the API Deployer
:rtype: :class:`~dataikuapi.dss.apideployer.DSSAPIDeployer`
"""
return DSSAPIDeployer(self)
########################################################
# Data Catalog
########################################################
def catalog_index_connections(self, connection_names=[], all_connections=False, indexing_mode="FULL"):
"""
Triggers an indexing of multiple connections in the data catalog
"""
return self._perform_json("POST", "/catalog/index", body={
"connectionNames": connection_names,
"indexAllConnections": all_connections,
"indexingMode": indexing_mode
})
########################################################
# Auth
########################################################
def get_auth_info(self, with_secrets=False):
"""
Returns various information about the user currently authenticated using
this instance of the API client.
This method returns a dict that may contain the following keys (may also contain others):
* authIdentifier: login for a user, id for an API key
* groups: list of group names (if context is an user)
* secrets: list of dicts containing user secrets (if context is an user)
:param: with_secrets boolean: Return user secrets
:returns: a dict
:rtype: dict
"""
return self._perform_json("GET", "/auth/info", params={"withSecrets": with_secrets})
def get_auth_info_from_browser_headers(self, headers_dict, with_secrets=False):
"""
Returns various information about the DSS user authenticated by the dictionary of
HTTP headers provided in headers_dict.
This is generally only used in webapp backends
This method returns a dict that may contain the following keys (may also contain others):
* authIdentifier: login for a user, id for an API key
* groups: list of group names (if context is an user)
* secrets: list of dicts containing user secrets (if context is an user)
:param: headers_dict dict: Dictionary of HTTP headers
:param: with_secrets boolean: Return user secrets
:returns: a dict
:rtype: dict
"""
return self._perform_json("POST", "/auth/info-from-browser-headers",
params={"withSecrets": with_secrets}, body=headers_dict)
########################################################
# Internal Request handling
########################################################
def _perform_http(self, method, path, params=None, body=None, stream=False, files=None, raw_body=None):
if body is not None:
body = json.dumps(body)
if raw_body is not None:
body = raw_body
try:
http_res = self._session.request(
method, "%s/dip/publicapi%s" % (self.host, path),
params=params, data=body,
files = files,
stream = stream)
http_res.raise_for_status()
return http_res
except exceptions.HTTPError:
try:
ex = http_res.json()
except ValueError:
ex = {"message": http_res.text}
raise DataikuException("%s: %s" % (ex.get("errorType", "Unknown error"), ex.get("message", "No message")))
def _perform_empty(self, method, path, params=None, body=None, files = None, raw_body=None):
self._perform_http(method, path, params=params, body=body, files=files, stream=False, raw_body=raw_body)
def _perform_text(self, method, path, params=None, body=None,files=None, raw_body=None):
return self._perform_http(method, path, params=params, body=body, files=files, stream=False, raw_body=raw_body).text
def _perform_json(self, method, path, params=None, body=None,files=None, raw_body=None):
return self._perform_http(method, path, params=params, body=body, files=files, stream=False, raw_body=raw_body).json()
def _perform_raw(self, method, path, params=None, body=None,files=None, raw_body=None):
return self._perform_http(method, path, params=params, body=body, files=files, stream=True, raw_body=raw_body)
def _perform_json_upload(self, method, path, name, f):
try:
http_res = self._session.request(
method, "%s/dip/publicapi%s" % (self.host, path),
files = {'file': (name, f, {'Expires': '0'})} )
http_res.raise_for_status()
return http_res
except exceptions.HTTPError:
ex = http_res.json()
raise DataikuException("%s: %s" % (ex.get("errorType", "Unknown error"), ex.get("message", "No message")))
########################################################
# Discussions
########################################################
def get_object_discussions(self, project_key, object_type, object_id):
"""
Get a handle to manage discussions on any object
:param str project_key: identifier of the project to access
:param str object_type: DSS object type
:param str object_id: DSS object ID
:returns: the handle to manage discussions
:rtype: :class:`dataikuapi.discussion.DSSObjectDiscussions`
"""
return DSSObjectDiscussions(self, project_key, object_type, object_id)
class TemporaryImportHandle(object):
def __init__(self, client, import_id):
self.client = client
self.import_id = import_id
def execute(self, settings = {}):
"""
Executes the import with provided settings.
@warning: You must check the 'success' flag
"""
# Empty JSON dicts can't be parsed properly
if settings == {}:
settings["_"] = "_"
return self.client._perform_json("POST", "/projects/import/%s/process" % (self.import_id),
body = settings)