snowflake-cli-labs 2.8.0rc0__py3-none-any.whl → 3.0.0rc0__py3-none-any.whl

snowflake/cli/__about__.py

@@ -14,4 +14,4 @@
 
 from __future__ import annotations
 
-VERSION = "2.8.0rc0"
+VERSION = "3.0.0rc0"

snowflake/cli/{app → _app}/__main__.py

@@ -16,7 +16,7 @@ from __future__ import annotations
 
 import sys
 
-from snowflake.cli.app.cli_app import app_factory
+from snowflake.cli._app.cli_app import app_factory
 
 
 def main(*args):

snowflake/cli/{app → _app}/cli_app.py

@@ -25,24 +25,24 @@ import click
 import typer
 from click import Context
 from snowflake.cli import __about__
-from snowflake.cli.api import Api, api_provider
-from snowflake.cli.api.config import config_init
-from snowflake.cli.api.output.formats import OutputFormat
-from snowflake.cli.api.output.types import CollectionResult
-from snowflake.cli.api.secure_path import SecurePath
-from snowflake.cli.app.api_impl.plugin.plugin_config_provider_impl import (
+from snowflake.cli._app.api_impl.plugin.plugin_config_provider_impl import (
     PluginConfigProviderImpl,
 )
-from snowflake.cli.app.commands_registration.commands_registration_with_callbacks import (
+from snowflake.cli._app.commands_registration.commands_registration_with_callbacks import (
     CommandsRegistrationWithCallbacks,
 )
-from snowflake.cli.app.dev.commands_structure import generate_commands_structure
-from snowflake.cli.app.dev.docs.generator import generate_docs
-from snowflake.cli.app.dev.pycharm_remote_debug import (
+from snowflake.cli._app.dev.commands_structure import generate_commands_structure
+from snowflake.cli._app.dev.docs.generator import generate_docs
+from snowflake.cli._app.dev.pycharm_remote_debug import (
     setup_pycharm_remote_debugger_if_provided,
 )
-from snowflake.cli.app.main_typer import SnowCliMainTyper
-from snowflake.cli.app.printing import MessageResult, print_result
+from snowflake.cli._app.main_typer import SnowCliMainTyper
+from snowflake.cli._app.printing import MessageResult, print_result
+from snowflake.cli.api import Api, api_provider
+from snowflake.cli.api.config import config_init
+from snowflake.cli.api.output.formats import OutputFormat
+from snowflake.cli.api.output.types import CollectionResult
+from snowflake.cli.api.secure_path import SecurePath
 from snowflake.connector.config_manager import CONFIG_MANAGER
 
 log = logging.getLogger(__name__)

snowflake/cli/{app → _app}/commands_registration/builtin_plugins.py

@@ -12,24 +12,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from snowflake.cli.plugins.connection import plugin_spec as connection_plugin_spec
-from snowflake.cli.plugins.cortex import plugin_spec as cortex_plugin_spec
-from snowflake.cli.plugins.git import plugin_spec as git_plugin_spec
-from snowflake.cli.plugins.init import plugin_spec as init_plugin_spec
-from snowflake.cli.plugins.nativeapp import plugin_spec as nativeapp_plugin_spec
-from snowflake.cli.plugins.notebook import plugin_spec as notebook_plugin_spec
-from snowflake.cli.plugins.object import plugin_spec as object_plugin_spec
-
-# TODO 3.0: remove this import
-from snowflake.cli.plugins.object_stage_deprecated import (
-    plugin_spec as object_stage_deprecated_plugin_spec,
-)
-from snowflake.cli.plugins.snowpark import plugin_spec as snowpark_plugin_spec
-from snowflake.cli.plugins.spcs import plugin_spec as spcs_plugin_spec
-from snowflake.cli.plugins.sql import plugin_spec as sql_plugin_spec
-from snowflake.cli.plugins.stage import plugin_spec as stage_plugin_spec
-from snowflake.cli.plugins.streamlit import plugin_spec as streamlit_plugin_spec
-from snowflake.cli.plugins.workspace import plugin_spec as workspace_plugin_spec
+from snowflake.cli._plugins.connection import plugin_spec as connection_plugin_spec
+from snowflake.cli._plugins.cortex import plugin_spec as cortex_plugin_spec
+from snowflake.cli._plugins.git import plugin_spec as git_plugin_spec
+from snowflake.cli._plugins.init import plugin_spec as init_plugin_spec
+from snowflake.cli._plugins.nativeapp import plugin_spec as nativeapp_plugin_spec
+from snowflake.cli._plugins.notebook import plugin_spec as notebook_plugin_spec
+from snowflake.cli._plugins.object import plugin_spec as object_plugin_spec
+from snowflake.cli._plugins.snowpark import plugin_spec as snowpark_plugin_spec
+from snowflake.cli._plugins.spcs import plugin_spec as spcs_plugin_spec
+from snowflake.cli._plugins.sql import plugin_spec as sql_plugin_spec
+from snowflake.cli._plugins.stage import plugin_spec as stage_plugin_spec
+from snowflake.cli._plugins.streamlit import plugin_spec as streamlit_plugin_spec
+from snowflake.cli._plugins.workspace import plugin_spec as workspace_plugin_spec
 
 
 # plugin name to plugin spec
@@ -45,7 +40,6 @@ def get_builtin_plugin_name_to_plugin_spec():
         "streamlit": streamlit_plugin_spec,
         "git": git_plugin_spec,
         "notebook": notebook_plugin_spec,
-        "object-stage-deprecated": object_stage_deprecated_plugin_spec,
         "cortex": cortex_plugin_spec,
         "init": init_plugin_spec,
         "workspace": workspace_plugin_spec,

snowflake/cli/{app → _app}/commands_registration/command_plugins_loader.py

@@ -18,21 +18,21 @@ import logging
 from typing import Dict, List, Optional
 
 import pluggy
-from snowflake.cli.api.plugins.command import (
-    SNOWCLI_COMMAND_PLUGIN_NAMESPACE,
-    CommandPath,
-    CommandSpec,
-    plugin_hook_specs,
-)
-from snowflake.cli.app.commands_registration import (
+from snowflake.cli._app.commands_registration import (
     LoadedBuiltInCommandPlugin,
     LoadedCommandPlugin,
     LoadedExternalCommandPlugin,
 )
-from snowflake.cli.app.commands_registration.builtin_plugins import (
+from snowflake.cli._app.commands_registration.builtin_plugins import (
     get_builtin_plugin_name_to_plugin_spec,
 )
-from snowflake.cli.app.commands_registration.exception_logging import exception_logging
+from snowflake.cli._app.commands_registration.exception_logging import exception_logging
+from snowflake.cli.api.plugins.command import (
+    SNOWCLI_COMMAND_PLUGIN_NAMESPACE,
+    CommandPath,
+    CommandSpec,
+    plugin_hook_specs,
+)
 
 log = logging.getLogger(__name__)
 log_exception = exception_logging(log)

snowflake/cli/{app → _app}/commands_registration/commands_registration_with_callbacks.py

@@ -17,15 +17,15 @@ from __future__ import annotations
 from dataclasses import dataclass
 from typing import Callable, List
 
-from snowflake.cli.api.plugins.plugin_config import PluginConfigProvider
-from snowflake.cli.app.commands_registration.command_plugins_loader import (
+from snowflake.cli._app.commands_registration.command_plugins_loader import (
     load_builtin_and_external_command_plugins,
     load_only_builtin_command_plugins,
 )
-from snowflake.cli.app.commands_registration.threadsafe import ThreadsafeCounter
-from snowflake.cli.app.commands_registration.typer_registration import (
+from snowflake.cli._app.commands_registration.threadsafe import ThreadsafeCounter
+from snowflake.cli._app.commands_registration.typer_registration import (
     register_commands_from_plugins,
 )
+from snowflake.cli.api.plugins.plugin_config import PluginConfigProvider
 
 
 @dataclass

snowflake/cli/{app → _app}/commands_registration/exception_logging.py

@@ -15,12 +15,12 @@
 from logging import Logger
 from typing import Callable
 
-from snowflake.cli.api.cli_global_context import cli_context
+from snowflake.cli.api.cli_global_context import get_cli_context
 
 
 def exception_logging(logger: Logger) -> Callable[[str, Exception], None]:
     def log_error(msg: str, exception: Exception) -> None:
-        exc_info = exception if cli_context.enable_tracebacks else None
+        exc_info = exception if get_cli_context().enable_tracebacks else None
         logger.error(msg=msg, exc_info=exc_info)
 
     return log_error

snowflake/cli/{app → _app}/commands_registration/typer_registration.py

@@ -18,9 +18,9 @@ import logging
 from typing import List
 
 import click
+from snowflake.cli._app.commands_registration import LoadedCommandPlugin
+from snowflake.cli._app.commands_registration.exception_logging import exception_logging
 from snowflake.cli.api.plugins.command import CommandSpec, CommandType
-from snowflake.cli.app.commands_registration import LoadedCommandPlugin
-from snowflake.cli.app.commands_registration.exception_logging import exception_logging
 from typer.core import TyperGroup
 
 log = logging.getLogger(__name__)

snowflake/cli/{app → _app}/dev/docs/commands_docs_generator.py

@@ -15,11 +15,11 @@
 from __future__ import annotations
 
 import logging
-from typing import List, Optional
+from typing import Any, List, Optional
 
 from click import Command
+from snowflake.cli._app.dev.docs.template_utils import get_template_environment
 from snowflake.cli.api.secure_path import SecurePath
-from snowflake.cli.app.dev.docs.template_utils import get_template_environment
 from typer.core import TyperArgument
 
 log = logging.getLogger(__name__)
@@ -86,15 +86,33 @@ def _render_command_usage(
     # Included files, which these are, need to use the .txt extension.
     file_path = root / f"usage-{command_name}.txt"
     log.info("Creating %s", file_path)
+    command_help_params = _split_docstring(command.help)
+    template_params = {
+        "name": command_name,
+        "options": options,
+        "arguments": arguments,
+        "path": path,
+    }
     with file_path.open("w+") as fh:
-        fh.write(
-            template.render(
-                {
-                    "help": command.help,
-                    "name": command_name,
-                    "options": options,
-                    "arguments": arguments,
-                    "path": path,
-                }
-            )
+        fh.write(template.render(command_help_params | template_params))
+
+
+def _split_docstring(command_help: Optional[str]) -> dict[str, Any]:
+    if command_help is None:
+        return {}
+
+    split_command_help = command_help.split("## ")
+
+    if len(split_command_help) == 1:
+        return {"help": split_command_help[0]}
+
+    additional_sections = []
+    for section in split_command_help[1:]:
+        lines = section.split("\n")
+        additional_sections.append(
+            {"title": lines[0], "content": "\n".join(lines[1:]).strip()}
         )
+    return {
+        "help": split_command_help[0],
+        "additional_sections": additional_sections,
+    }

snowflake/cli/{app → _app}/dev/docs/generator.py

@@ -17,11 +17,11 @@ from __future__ import annotations
 import logging
 
 from click import Command
-from snowflake.cli.api.secure_path import SecurePath
-from snowflake.cli.app.dev.docs.commands_docs_generator import generate_command_docs
-from snowflake.cli.app.dev.docs.project_definition_docs_generator import (
+from snowflake.cli._app.dev.docs.commands_docs_generator import generate_command_docs
+from snowflake.cli._app.dev.docs.project_definition_docs_generator import (
     generate_project_definition_docs,
 )
+from snowflake.cli.api.secure_path import SecurePath
 
 log = logging.getLogger(__name__)
 

snowflake/cli/{app → _app}/dev/docs/project_definition_docs_generator.py

@@ -18,12 +18,12 @@ import logging
 from typing import Any, Dict
 
 from pydantic.json_schema import model_json_schema
-from snowflake.cli.api.project.schemas.project_definition import DefinitionV11
-from snowflake.cli.api.secure_path import SecurePath
-from snowflake.cli.app.dev.docs.project_definition_generate_json_schema import (
+from snowflake.cli._app.dev.docs.project_definition_generate_json_schema import (
     ProjectDefinitionGenerateJsonSchema,
 )
-from snowflake.cli.app.dev.docs.template_utils import get_template_environment
+from snowflake.cli._app.dev.docs.template_utils import get_template_environment
+from snowflake.cli.api.project.schemas.project_definition import DefinitionV11
+from snowflake.cli.api.secure_path import SecurePath
 
 log = logging.getLogger(__name__)
 

snowflake/cli/{app → _app}/dev/docs/templates/usage.rst.jinja2

@@ -1,4 +1,4 @@
-{{ help | replace("`", "``") }}
+{{ help | replace("`", "``") | replace("\n", " ") }}
 
 Syntax
 ===============================================================================
@@ -26,7 +26,7 @@ Arguments
         {{ param.make_metavar().replace("[", "").replace("]", "").lower() }}
     {%- endif -%}
     {{ '}' }}`
-{% if param.help %}{{ "  " + param.help | replace("`", "``") }}{% if param.help[-1] != '.' %}.{% endif %}{% else %}  TBD{% endif %}
+{% if param.help %}{{ "  " + param.help | replace("`", "``") | replace("\n", " ") }}{% if param.help[-1] != '.' %}.{% endif %}{% if param.default %} Default: {{ param.default }}.{% endif %}{% else %}  TBD{% endif %}
 {% endfor %}
 {% else %}
 
@@ -48,10 +48,20 @@ Options
         {%- if param.type.name != "choice" %}{{ ' {' }}{% else %} {% endif %}{{ param.make_metavar() }}{% if param.type.name != "choice" %}{{ '}' }}
         {%- endif %}
     {%- endif %}`
-{% if param.help %}{{ "  " + param.help | replace("`", "``") }}{% if param.help[-1] != '.' %}.{% endif %}{% else %}  TBD{% endif %}
-{% endfor %}
+{% if param.help %}{{ "  " + param.help | replace("`", "``") | replace("\n", " ") }}{% if param.help[-1] != '.' %}.{% endif %}{% if param.default is not none %} Default: {{ param.default }}.{% endif %}{% else %}  TBD{% endif %}
+{% endfor -%}
 {% else %}
 
 None
 
 {% endif -%}
+
+{%- if additional_sections %}
+..
+{%- for section in additional_sections %}
+  {{ section.title }}
+  ===============================================================================
+
+  {{ section.content | indent(2) }}
+{% endfor %}
+{% endif %}

snowflake/cli/{app → _app}/main_typer.py

@@ -17,13 +17,13 @@ from __future__ import annotations
 import sys
 
 import typer
-from snowflake.cli.api.cli_global_context import cli_context
+from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.commands.flags import DEFAULT_CONTEXT_SETTINGS, DebugOption
 from snowflake.cli.api.console import cli_console
 
 
 def _handle_exception(exception: Exception):
-    if cli_context.enable_tracebacks:
+    if get_cli_context().enable_tracebacks:
         raise exception
     else:
         cli_console.warning(

snowflake/cli/{app → _app}/printing.py

@@ -26,7 +26,7 @@ from rich import box, get_console
 from rich import print as rich_print
 from rich.live import Live
 from rich.table import Table
-from snowflake.cli.api.cli_global_context import cli_context
+from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.output.formats import OutputFormat
 from snowflake.cli.api.output.types import (
     CollectionResult,
@@ -65,7 +65,7 @@ class CustomJSONEncoder(JSONEncoder):
 
 
 def _get_format_type() -> OutputFormat:
-    output_format = cli_context.output_format
+    output_format = get_cli_context().output_format
     if output_format:
         return output_format
     return OutputFormat.TABLE

snowflake/cli/{app → _app}/snow_connector.py

@@ -21,7 +21,11 @@ from typing import Dict, Optional
 
 import snowflake.connector
 from click.exceptions import ClickException
-from snowflake.cli.api.cli_global_context import cli_context
+from snowflake.cli._app.constants import (
+    PARAM_APPLICATION_NAME,
+)
+from snowflake.cli._app.telemetry import command_info
+from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.config import (
     get_connection_dict,
     get_default_connection_dict,
@@ -33,10 +37,6 @@ from snowflake.cli.api.exceptions import (
     SnowflakeConnectionError,
 )
 from snowflake.cli.api.secure_path import SecurePath
-from snowflake.cli.app.constants import (
-    PARAM_APPLICATION_NAME,
-)
-from snowflake.cli.app.telemetry import command_info
 from snowflake.connector import SnowflakeConnection
 from snowflake.connector.errors import DatabaseError, ForbiddenError
 
@@ -75,7 +75,7 @@ def connect_to_snowflake(
         connection_parameters = {}  # we will apply overrides in next step
     else:
         connection_parameters = get_default_connection_dict()
-        cli_context.connection_context.set_connection_name(
+        get_cli_context().connection_context.set_connection_name(
             get_default_connection_name()
         )
 

snowflake/cli/{app → _app}/telemetry.py

@@ -21,12 +21,12 @@ from typing import Any, Dict, Union
 
 import click
 from snowflake.cli.__about__ import VERSION
-from snowflake.cli.api.cli_global_context import cli_context
+from snowflake.cli._app.constants import PARAM_APPLICATION_NAME
+from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.commands.execution_metadata import ExecutionMetadata
 from snowflake.cli.api.config import get_feature_flags_section
 from snowflake.cli.api.output.formats import OutputFormat
 from snowflake.cli.api.utils.error_handling import ignore_exceptions
-from snowflake.cli.app.constants import PARAM_APPLICATION_NAME
 from snowflake.connector.telemetry import (
     TelemetryData,
     TelemetryField,
@@ -88,8 +88,7 @@ def _find_command_info() -> TelemetryDict:
 
 
 def _get_definition_version() -> str | None:
-    from snowflake.cli.api.cli_global_context import cli_context
-
+    cli_context = get_cli_context()
     if cli_context.project_definition:
         return cli_context.project_definition.definition_version
     return None
@@ -144,7 +143,7 @@ class CLITelemetryClient:
         self._telemetry.send_batch()
 
 
-_telemetry = CLITelemetryClient(ctx=cli_context)
+_telemetry = CLITelemetryClient(ctx=get_cli_context())
 
 
 @ignore_exceptions()

snowflake/cli/{plugins → _plugins}/connection/commands.py

@@ -21,7 +21,12 @@ import typer
 from click import ClickException, Context, Parameter  # type: ignore
 from click.core import ParameterSource  # type: ignore
 from click.types import StringParamType
-from snowflake.cli.api.cli_global_context import cli_context
+from snowflake.cli._plugins.connection.util import (
+    strip_and_check_if_exists,
+    strip_if_value_present,
+)
+from snowflake.cli._plugins.object.manager import ObjectManager
+from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.commands.flags import (
     PLAIN_PASSWORD_MSG,
 )
@@ -43,7 +48,6 @@ from snowflake.cli.api.output.types import (
     MessageResult,
     ObjectResult,
 )
-from snowflake.cli.plugins.object.manager import ObjectManager
 from snowflake.connector import ProgrammingError
 from snowflake.connector.config_manager import CONFIG_MANAGER
 
@@ -94,8 +98,8 @@ def require_integer(field_name: str):
     def callback(value: str):
         if value is None:
             return None
-        if value.isdigit():
-            return value
+        if value.strip().isdigit():
+            return value.strip()
         raise ClickException(f"Value of {field_name} must be integer")
 
     return callback
@@ -117,6 +121,7 @@ def add(
         prompt="Name for this connection",
         help="Name of the new connection.",
         show_default=False,
+        callback=strip_if_value_present,
     ),
     account: str = typer.Option(
         None,
@@ -126,6 +131,7 @@ def add(
         prompt="Snowflake account name",
         help="Account name to use when authenticating with Snowflake.",
         show_default=False,
+        callback=strip_if_value_present,
     ),
     user: str = typer.Option(
         None,
@@ -135,6 +141,7 @@ def add(
         prompt="Snowflake username",
         show_default=False,
         help="Username to connect to Snowflake.",
+        callback=strip_if_value_present,
     ),
     password: str = typer.Option(
         EmptyInput(),
@@ -153,6 +160,7 @@ def add(
         click_type=OptionalPrompt(),
         prompt="Role for the connection",
         help="Role to use on Snowflake.",
+        callback=strip_if_value_present,
     ),
     warehouse: str = typer.Option(
         EmptyInput(),
@@ -161,6 +169,7 @@ def add(
         click_type=OptionalPrompt(),
         prompt="Warehouse for the connection",
         help="Warehouse to use on Snowflake.",
+        callback=strip_if_value_present,
     ),
     database: str = typer.Option(
         EmptyInput(),
@@ -169,6 +178,7 @@ def add(
         click_type=OptionalPrompt(),
         prompt="Database for the connection",
         help="Database to use on Snowflake.",
+        callback=strip_if_value_present,
     ),
     schema: str = typer.Option(
         EmptyInput(),
@@ -177,6 +187,7 @@ def add(
         click_type=OptionalPrompt(),
         prompt="Schema for the connection",
         help="Schema to use on Snowflake.",
+        callback=strip_if_value_present,
     ),
     host: str = typer.Option(
         EmptyInput(),
@@ -185,6 +196,7 @@ def add(
         click_type=OptionalPrompt(),
         prompt="Connection host",
         help="Host name the connection attempts to connect to Snowflake.",
+        callback=strip_if_value_present,
     ),
     port: int = typer.Option(
         EmptyInput(),
@@ -202,6 +214,7 @@ def add(
         click_type=OptionalPrompt(),
         prompt="Snowflake region",
         help="Region name if not the default Snowflake deployment.",
+        callback=strip_if_value_present,
     ),
     authenticator: str = typer.Option(
         EmptyInput(),
@@ -218,6 +231,7 @@ def add(
         click_type=OptionalPrompt(),
         prompt="Path to private key file",
         help="Path to file containing private key",
+        callback=strip_and_check_if_exists,
     ),
     token_file_path: str = typer.Option(
         EmptyInput(),
@@ -226,6 +240,7 @@ def add(
         click_type=OptionalPrompt(),
         prompt="Path to token file",
         help="Path to file with an OAuth token that should be used when connecting to Snowflake",
+        callback=strip_and_check_if_exists,
     ),
     set_as_default: bool = typer.Option(
         False,
@@ -276,6 +291,7 @@ def test(
     """
 
     # Test connection
+    cli_context = get_cli_context()
     conn = cli_context.connection
 
     # Test session attributes
@@ -320,7 +336,8 @@ def test(
 @app.command(requires_connection=False)
 def set_default(
     name: str = typer.Argument(
-        help="Name of the connection, as defined in your `config.toml`"
+        help="Name of the connection, as defined in your `config.toml`",
+        show_default=False,
     ),
     **options,
 ):

snowflake/cli/_plugins/connection/plugin_spec.py

@@ -0,0 +1,30 @@
+# Copyright (c) 2024 Snowflake Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from snowflake.cli._plugins.connection import commands
+from snowflake.cli.api.plugins.command import (
+    SNOWCLI_ROOT_COMMAND_PATH,
+    CommandSpec,
+    CommandType,
+    plugin_hook_impl,
+)
+
+
+@plugin_hook_impl
+def command_spec():
+    return CommandSpec(
+        parent_command_path=SNOWCLI_ROOT_COMMAND_PATH,
+        command_type=CommandType.COMMAND_GROUP,
+        typer_instance=commands.app.create_instance(),
+    )

snowflake/cli/{plugins → _plugins}/connection/util.py

@@ -16,6 +16,8 @@ from __future__ import annotations
 
 import json
 import logging
+import os
+from typing import Optional
 
 from click.exceptions import ClickException
 from snowflake.connector import SnowflakeConnection
@@ -177,3 +179,17 @@ def make_snowsight_url(conn: SnowflakeConnection, path: str) -> str:
     account = get_account(conn)
     path_with_slash = path if path.startswith("/") else f"/{path}"
     return f"{snowsight_host}/{deployment}/{account}{path_with_slash}"
+
+
+def strip_if_value_present(value: Optional[str]) -> Optional[str]:
+    return value.strip() if value else value
+
+
+def ensure_that_path_exist(path: Optional[str]) -> Optional[str]:
+    if path and not os.path.exists(path):
+        raise ClickException(f"Path {path} does not exist.")
+    return path
+
+
+def strip_and_check_if_exists(value: Optional[str]) -> Optional[str]:
+    return ensure_that_path_exist(strip_if_value_present(value))