style: update docstring to match mutable args changes

Author: jfyuen

dataikuapi/dss/macro.py

@@ -37,9 +37,9 @@ def run(self, params=None, admin_params=None, wait=True):
         """
         Run the macro from the project
 
-        :param params: parameters to the macro run
-        :param admin_params: admin parameters to the macro run (if the authentication of
-                             the api client does not cover admin rights, they are ignored)
+        :param dict params: parameters to the macro run (defaults to `{}`)
+        :param dict admin_params: admin parameters to the macro run (if the authentication of
+                             the api client does not cover admin rights, they are ignored, default to empty)
         :param wait: if True, the call blocks until the run is finished
         :returns: a run identifier to use to abort or retrieve results
         """

dataikuapi/dss/ml.py

@@ -1259,7 +1259,7 @@ def ensemble(self, model_ids=None, method=None):
         """
         Create an ensemble model of a set of models
         
-        :param list model_ids: A list of model identifiers
+        :param list model_ids: A list of model identifiers (defaults to `[]`)
         :param str method: the ensembling method. One of: AVERAGE, PROBA_AVERAGE, MEDIAN, VOTE, LINEAR_MODEL, LOGISTIC_MODEL
 
         This method waits for the ensemble train to complete. If you want to train asynchronously, use :meth:`start_ensembling` and :meth:`wait_train_complete`
@@ -1302,7 +1302,7 @@ def start_ensembling(self, model_ids=None, method=None):
         """
         Creates asynchronously a new ensemble models of a set of models.
 
-        :param list model_ids: A list of model identifiers
+        :param list model_ids: A list of model identifiers (defaults to `[]`)
         :param str method: the ensembling method (AVERAGE, PROBA_AVERAGE, MEDIAN, VOTE, LINEAR_MODEL, LOGISTIC_MODEL)
 
         This returns immediately, before train is complete. To wait for train to complete, use :meth:`wait_train_complete`

dataikuapi/dss/project.py

@@ -54,7 +54,7 @@ def get_export_stream(self, options=None):
         Return a stream of the exported project
         You need to close the stream after download. Failure to do so will result in the DSSClient becoming unusable.
 
-        :param dict options: Dictionary of export options. The following options are available:
+        :param dict options: Dictionary of export options (defaults to `{}`). The following options are available:
 
             * exportUploads (boolean): Exports the data of Uploaded datasets - default False
             * exportManagedFS (boolean): Exports the data of managed Filesystem datasets - default False
@@ -80,6 +80,18 @@ def export_to_file(self, path, options=None):
         Export the project to a file
         
         :param str path: the path of the file in which the exported project should be saved
+        :param dict options: Dictionary of export options (defaults to `{}`). The following options are available:
+
+            * exportUploads (boolean): Exports the data of Uploaded datasets - default False
+            * exportManagedFS (boolean): Exports the data of managed Filesystem datasets - default False
+            * exportAnalysisModels (boolean): Exports the models trained in analysis - default False
+            * exportSavedModels (boolean): Exports the models trained in saved models - default False
+            * exportManagedFolders (boolean): Exports the data of managed folders - default False
+            * exportAllInputDatasets (boolean): Exports the data of all input datasets - default False
+            * exportAllDatasets (boolean): Exports the data of all datasets - default False
+            * exportAllInputManagedFolders (boolean): Exports the data of all input managed folders - default False
+            * exportGitRepositoy (boolean): Exports the Git repository history - default False
+            * exportInsightsData (boolean): Exports the data of static insights - default False
         """
         if options is None:
             options = {}
@@ -114,7 +126,7 @@ def duplicate(self, target_project_key,
         :param bool export_saved_models:
         :param bool export_git_repository:
         :param bool export_insights_data:
-        :param dict remapping: dict of connections to be remapped for the new project
+        :param dict remapping: dict of connections to be remapped for the new project (defaults to `{}`)
         :param target_project_folder: the project folder where to put the duplicated project
         :type target_project_folder: A :class:`dataikuapi.dss.projectfolder.DSSProjectFolder
         :returns: A dict containing the original and duplicated project's keys
@@ -230,9 +242,9 @@ def create_dataset(self, dataset_name, type,
         
         :param string dataset_name: the name for the new dataset
         :param string type: the type of the dataset
-        :param dict params: the parameters for the type, as a JSON object
+        :param dict params: the parameters for the type, as a JSON object (defaults to `{}`)
         :param string formatType: an optional format to create the dataset with (only for file-oriented datasets)
-        :param string formatParams: the parameters to the format, as a JSON object (only for file-oriented datasets)
+        :param dict formatParams: the parameters to the format, as a JSON object (only for file-oriented datasets, default to empty)
         
         Returns:
             A :class:`dataikuapi.dss.dataset.DSSDataset` dataset handle
@@ -692,8 +704,8 @@ def create_scenario(self, scenario_name, type, definition=None):
         :param str scenario_name: The name for the new scenario. This does not need to be unique
                                 (although this is strongly recommended)
         :param str type: The type of the scenario. MUst be one of 'step_based' or 'custom_python'
-        :param object definition: the JSON definition of the scenario. Use ``get_definition(with_status=False)`` on an
-                existing ``DSSScenario`` object in order to get a sample definition object
+        :param dict definition: the JSON definition of the scenario. Use ``get_definition(with_status=False)`` on an
+                existing ``DSSScenario`` object in order to get a sample definition object (defaults to `{}`)
 
         :returns: a :class:`.scenario.DSSScenario` handle to interact with the newly-created scenario
         """
@@ -804,7 +816,7 @@ def get_tags(self):
     def set_tags(self, tags=None):
         """
         Set the tags of this project.
-        @param obj: must be a modified version of the object returned by list_tags
+        :param dict tags: must be a modified version of the object returned by list_tags (defaults to `{}`)
         """
         if tags is None:
             tags = {}

dataikuapi/dss/scenario.py

@@ -24,7 +24,7 @@ def run(self, params=None):
         """
         Requests a run of the scenario, which will start after a few seconds.
 
-        :params dict params: additional parameters that will be passed to the scenario through trigger params
+        :params dict params: additional parameters that will be passed to the scenario through trigger params (defaults to `{}`)
         """
         if params is None:
             params = {}
@@ -53,11 +53,9 @@ def run_and_wait(self, params=None, no_fail=False):
         """
         Requests a run of the scenario, which will start after a few seconds. Wait the end of the run to complete.
 
-        Args:
-            params: additional parameters that will be passed to the scenario through trigger params
+        :param dict params: additional parameters that will be passed to the scenario through trigger params (defaults to `{}`)
 
-        Returns:
-            A :class:`dataikuapi.dss.admin.DSSScenarioRun` run handle
+        :return: A :class:`dataikuapi.dss.admin.DSSScenarioRun` run handle
         """
         if params is None:
             params = {}

dataikuapi/dssclient.py

@@ -302,7 +302,7 @@ def create_user(self, login, password, display_name='', source_type='LOCAL', gro
         :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 list groups: the names of the groups the new user belongs to (defaults 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
@@ -398,11 +398,11 @@ def create_connection(self, name, type, params=None, usable_by='ALL', allowed_gr
 
         :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 dict params: the parameters of the new connection, as a JSON object (defaults to `{}`)
         :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
+        :param list 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 (defaults to `[]`)
         
         :returns: A :class:`dataikuapi.dss.admin.DSSConnection` connection handle
         """
@@ -671,8 +671,8 @@ def log_custom_audit(self, custom_type, custom_params=None):
         """
         Log a custom entry to the audit trail
         
-        :param str custom_type value for customMsgType in audit trail item
-        :param dict custom_params value for customMsgParams in audit trail item
+        :param str custom_type: value for customMsgType in audit trail item
+        :param dict custom_params: value for customMsgParams in audit trail item (defaults to `{}`)
         """
         if custom_params is None:
             custom_params = {}
@@ -793,6 +793,9 @@ def get_apideployer(self):
     def catalog_index_connections(self, connection_names=None, all_connections=False, indexing_mode="FULL"):
         """
         Triggers an indexing of multiple connections in the data catalog
+
+        :param list connection_names: list of connections to index, ignored if `all_connections=True` (defaults to `[]`)
+        :param bool all_connections: index all connections, (defaults to `False`)
         """
         if connection_names is None:
             connection_names = []
@@ -955,7 +958,7 @@ def execute(self, settings=None):
         """
         Executes the import with provided settings.
 
-        :param dict settings: Dict of import settings. The following settings are available:
+        :param dict settings: Dict of import settings (defaults to `{}`). The following settings are available:
 
             * targetProjectKey (string): Key to import under. Defaults to the original project key
             * remapping (dict): Dictionary of connection and code env remapping settings.