Added NEPTUNE_MODE env variables and support in all metadata containers

CHANGELOG.md

@@ -1,6 +1,8 @@
 ## [UNRELEASED] neptune-client 0.16.5
 
-
+## Features
+- Added `NEPTUNE_MODE` environment variable ([#928](https://github.com/neptune-ai/neptune-client/pull/928))
+- Added support of Service account management ([#927](https://github.com/neptune-ai/neptune-client/pull/927))
 
 ## neptune-client 0.16.4
 

neptune/new/envs.py

@@ -15,6 +15,8 @@
 #
 
 
+CONNECTION_MODE = "NEPTUNE_MODE"
+
 PROJECT_ENV_NAME = "NEPTUNE_PROJECT"
 
 API_TOKEN_ENV_NAME = "NEPTUNE_API_TOKEN"

neptune/new/internal/init/model.py

@@ -14,10 +14,12 @@
 # limitations under the License.
 #
 
+import os
 import threading
 from typing import Optional
 
 from neptune.new.attributes import constants as attr_consts
+from neptune.new.envs import CONNECTION_MODE
 from neptune.new.exceptions import (
     NeedExistingModelForReadOnlyMode,
     NeptuneException,
@@ -49,7 +51,7 @@ def init_model(
     key: Optional[str] = None,
     project: Optional[str] = None,
     api_token: Optional[str] = None,
-    mode: str = Mode.ASYNC.value,
+    mode: Optional[str] = None,
     flush_period: float = DEFAULT_FLUSH_PERIOD,
     proxies: Optional[dict] = None,
 ) -> Model:
@@ -58,11 +60,12 @@ def init_model(
     verify_type("key", key, (str, type(None)))
     verify_type("project", project, (str, type(None)))
     verify_type("api_token", api_token, (str, type(None)))
-    verify_type("mode", mode, str)
+    verify_type("mode", mode, (str, type(None)))
     verify_type("flush_period", flush_period, (int, float))
     verify_type("proxies", proxies, (dict, type(None)))
+
     # make mode proper Enum instead of string
-    mode = Mode(mode)
+    mode = Mode(mode or os.getenv(CONNECTION_MODE) or Mode.ASYNC.value)
 
     if mode == Mode.OFFLINE:
         raise NeptuneException("Model can't be initialized in OFFLINE mode")

neptune/new/internal/init/model_version.py

@@ -14,10 +14,12 @@
 # limitations under the License.
 #
 
+import os
 import threading
 from typing import Optional
 
 from neptune.new.attributes import constants as attr_consts
+from neptune.new.envs import CONNECTION_MODE
 from neptune.new.exceptions import (
     NeedExistingModelVersionForReadOnlyMode,
     NeptuneException,
@@ -47,7 +49,7 @@ def init_model_version(
     model: Optional[str] = None,
     project: Optional[str] = None,
     api_token: Optional[str] = None,
-    mode: str = Mode.ASYNC.value,
+    mode: Optional[str] = None,
     flush_period: float = DEFAULT_FLUSH_PERIOD,
     proxies: Optional[dict] = None,
 ) -> ModelVersion:
@@ -56,11 +58,12 @@ def init_model_version(
     verify_type("model", model, (str, type(None)))
     verify_type("project", project, (str, type(None)))
     verify_type("api_token", api_token, (str, type(None)))
-    verify_type("mode", mode, str)
+    verify_type("mode", mode, (str, type(None)))
     verify_type("flush_period", flush_period, (int, float))
     verify_type("proxies", proxies, (dict, type(None)))
+
     # make mode proper Enum instead of string
-    mode = Mode(mode)
+    mode = Mode(mode or os.getenv(CONNECTION_MODE) or Mode.ASYNC.value)
 
     if mode == Mode.OFFLINE:
         raise NeptuneException("Model can't be initialized in OFFLINE mode")

neptune/new/internal/init/project.py

@@ -13,9 +13,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+import os
 import threading
 from typing import Optional
 
+from neptune.new.envs import CONNECTION_MODE
 from neptune.new.exceptions import NeptuneException
 from neptune.new.internal import id_formats
 from neptune.new.internal.backends.factory import get_backend
@@ -33,17 +35,18 @@ def init_project(
     *,
     name: Optional[str] = None,
     api_token: Optional[str] = None,
-    mode: str = Mode.ASYNC.value,
+    mode: Optional[str] = None,
     flush_period: float = DEFAULT_FLUSH_PERIOD,
     proxies: Optional[dict] = None,
 ) -> Project:
     verify_type("name", name, (str, type(None)))
     verify_type("api_token", api_token, (str, type(None)))
-    verify_type("mode", mode, str)
+    verify_type("mode", mode, (str, type(None)))
     verify_type("flush_period", flush_period, (int, float))
     verify_type("proxies", proxies, (dict, type(None)))
+
     # make mode proper Enum instead of string
-    mode = Mode(mode)
+    mode = Mode(mode or os.getenv(CONNECTION_MODE) or Mode.ASYNC.value)
 
     if mode == Mode.OFFLINE:
         raise NeptuneException("Project can't be initialized in OFFLINE mode")

neptune/new/internal/init/run.py

@@ -22,6 +22,7 @@
 
 from neptune.new.attributes import constants as attr_consts
 from neptune.new.envs import (
+    CONNECTION_MODE,
     CUSTOM_RUN_ID_ENV_NAME,
     MONITORING_NAMESPACE,
     NEPTUNE_NOTEBOOK_ID,
@@ -82,7 +83,7 @@ def init_run(
     api_token: Optional[str] = None,
     run: Optional[str] = None,
     custom_run_id: Optional[str] = None,
-    mode: str = Mode.ASYNC.value,
+    mode: Optional[str] = None,
     name: Optional[str] = None,
     description: Optional[str] = None,
     tags: Optional[Union[List[str], str]] = None,
@@ -113,7 +114,9 @@ def init_run(
         custom_run_id (str, optional): A unique identifier to be used when running Neptune in pipelines.
             Defaults to `None`.
             Make sure you are using the same identifier throughout the whole pipeline execution.
-        mode (str, optional): Connection mode in which the tracking will work. Defaults to `'async'`.
+        mode (str, optional): Connection mode in which the tracking will work. Defaults to `None`.
+            If `None`, the value of `NEPTUNE_MODE` environment variable will be taken.
+            If no value was set for environment variable then `'async'` at default.
             Possible values 'async', 'sync', 'offline', 'read-only' and 'debug'.
         name (str, optional): Editable name of the run. Defaults to `'Untitled'`.
             Name is displayed in the run's Details and in Runs table as a column.
@@ -197,7 +200,7 @@ def init_run(
     verify_type("api_token", api_token, (str, type(None)))
     verify_type("run", run, (str, type(None)))
     verify_type("custom_run_id", custom_run_id, (str, type(None)))
-    verify_type("mode", mode, str)
+    verify_type("mode", mode, (str, type(None)))
     verify_type("name", name, (str, type(None)))
     verify_type("description", description, (str, type(None)))
     verify_type("capture_stdout", capture_stdout, bool)
@@ -219,8 +222,7 @@ def init_run(
             verify_collection_type("source_files", source_files, str)
 
     # for backward compatibility imports
-    mode = Mode(mode)
-
+    mode = Mode(mode or os.getenv(CONNECTION_MODE) or Mode.ASYNC.value)
     name = DEFAULT_NAME if run is None and name is None else name
     description = "" if run is None and description is None else description
     hostname = get_hostname() if run is None else None