scripts/cli_smoke_tests.py - develop - vshmidt/streamlit

scripts/cli_smoke_tests.py
53 строки2 KB
Ken McGrady
Update copyright header to 2026 (#13491)
02 янв 2026, 16:21
02 янв 2026, 16:21374540a
#!/usr/bin/env python

# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2026)
#
# 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 __future__ import annotations

import subprocess
import sys

import click


def main() -> None:
    standard_cli = ["streamlit", "test", "prog_name"]
    if not _can_run_streamlit(standard_cli):
        sys.exit("Failed to run `streamlit test prog_name`")

    # When calling from module, the called argv[0] is updated by
    # __main__.py to be "streamlit" instead of "__main__.py".
    # If this doesn't occur, an assert stops execution of the program.
    module_cli = ["python", "-m", "streamlit", "test", "prog_name"]
    if not _can_run_streamlit(module_cli):
        sys.exit("Failed to run `python -m streamlit test prog_name`")

    # Invoking streamlit via `python -m streamlit.cli <command>` is a method
    # that we previously accidentally supported, but we decided that we should
    # only keep official support for the similar `python -m streamlit <command>`
    # invocation.
    unsupported_module_cli = ["python", "-m", "streamlit.cli", "test", "prog_name"]
    if _can_run_streamlit(unsupported_module_cli):
        sys.exit("`python -m streamlit.cli test prog_name` should not run")

    click.secho("CLI smoke tests succeeded!", fg="green", bold=True)


def _can_run_streamlit(command_list: list[str]) -> bool:
    result = subprocess.run(command_list, stdout=subprocess.DEVNULL, check=False)
    return result.returncode == 0


if __name__ == "__main__":
    main()