Create new subpackage for app's internal modules (snowflakedb#362)

sfc-gh-cgorrie · Sep 7, 2023 · 4ea8641 · 4ea8641
1 parent 835bd7a
commit 4ea8641
Show file tree

Hide file tree

Showing 16 changed files with 12 additions and 10 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -9,7 +9,7 @@ repos:
  - id: check-yaml
  exclude: .github/repo_meta.yaml
  - id: debug-statements
- exclude: src/snowcli/pycharm_remote_debug.py
+ exclude: src/snowcli/app/dev/pycharm_remote_debug.py
  - id: check-ast
  - repo: https://github.com/charliermarsh/ruff-pre-commit
  rev: "v0.0.217"

diff --git a/pyproject.toml b/pyproject.toml
@@ -49,7 +49,7 @@ dev = [
 "Bug Tracker" = "https://github.com/Snowflake-Labs/snowcli/issues"
 
 [project.scripts]
-snow = "snowcli.__main__:main"
+snow = "snowcli.app.__main__:main"
 
 [tool.hatch.version]
 path = "src/snowcli/__about__.py"

diff --git a/snowcli.spec b/snowcli.spec
@@ -5,7 +5,7 @@ block_cipher = None
 
 
 a = Analysis(
- ['src/snowcli/cli/__init__.py'],
+ ['src/snowcli/app/__main__.py'],
  pathex=[],
  binaries=[],
  datas=[('src/templates', 'templates'), ('src/snowcli', 'snowcli')],

diff --git a/src/snowcli/__init__.py → src/snowcli/app/__init__.py b/src/snowcli/__init__.py → src/snowcli/app/__init__.py
diff --git a/src/snowcli/__main__.py → src/snowcli/app/__main__.py b/src/snowcli/__main__.py → src/snowcli/app/__main__.py
@@ -2,7 +2,7 @@
 
 import sys
 
-from snowcli.cli.app import app
+from snowcli.app.cli_app import app
 
 
 def main(*args):

diff --git a/src/snowcli/cli/app.py → src/snowcli/app/cli_app.py b/src/snowcli/cli/app.py → src/snowcli/app/cli_app.py
@@ -8,12 +8,14 @@
 import click
 
 from snowcli import __about__
-from snowcli.cli.main.snow_cli_main_typer import SnowCliMainTyper
+from snowcli.app.main_typer import SnowCliMainTyper
 from snowcli.config import config_init, cli_config
-from snowcli.docs.generator import generate_docs
+from snowcli.app.dev.docs.generator import generate_docs
 from snowcli.output.formats import OutputFormat
 from snowcli.output.printing import OutputData
-from snowcli.pycharm_remote_debug import setup_pycharm_remote_debugger_if_provided
+from snowcli.app.dev.pycharm_remote_debug import (
+ setup_pycharm_remote_debugger_if_provided,
+)
 
 app: SnowCliMainTyper = SnowCliMainTyper()
 log = logging.getLogger(__name__)

diff --git a/src/snowcli/cli/main/__init__.py → src/snowcli/app/dev/__init__.py b/src/snowcli/cli/main/__init__.py → src/snowcli/app/dev/__init__.py
diff --git a/src/snowcli/docs/__init__.py → src/snowcli/app/dev/docs/__init__.py b/src/snowcli/docs/__init__.py → src/snowcli/app/dev/docs/__init__.py
diff --git a/src/snowcli/docs/generator.py → src/snowcli/app/dev/docs/generator.py b/src/snowcli/docs/generator.py → src/snowcli/app/dev/docs/generator.py
diff --git a/...nowcli/docs/templates/overview.rst.jinja2 → ...pp/dev/docs/templates/overview.rst.jinja2 b/...nowcli/docs/templates/overview.rst.jinja2 → ...pp/dev/docs/templates/overview.rst.jinja2
diff --git a/src/snowcli/docs/templates/usage.rst.jinja2 → ...i/app/dev/docs/templates/usage.rst.jinja2 b/src/snowcli/docs/templates/usage.rst.jinja2 → ...i/app/dev/docs/templates/usage.rst.jinja2
diff --git a/src/snowcli/pycharm_remote_debug.py → src/snowcli/app/dev/pycharm_remote_debug.py b/src/snowcli/pycharm_remote_debug.py → src/snowcli/app/dev/pycharm_remote_debug.py
diff --git a/src/snowcli/cli/main/snow_cli_main_typer.py → src/snowcli/app/main_typer.py b/src/snowcli/cli/main/snow_cli_main_typer.py → src/snowcli/app/main_typer.py
diff --git a/tests/test_main.py b/tests/test_main.py
@@ -62,7 +62,7 @@ def test_info_callback(runner):
 
 
 def test_all_commands_has_proper_documentation():
- from snowcli.cli.app import app
+ from snowcli.app.cli_app import app
 
  ctx = click.Context(get_command(app))
  errors = []

diff --git a/tests/testing_utils/fixtures.py b/tests/testing_utils/fixtures.py
@@ -150,7 +150,7 @@ def package_file():
 
 @pytest.fixture(scope="function")
 def runner(test_snowcli_config):
- from snowcli.cli.app import app
+ from snowcli.app.cli_app import app
 
  return SnowCLIRunner(app, test_snowcli_config)
 

diff --git a/tests_integration/conftest.py b/tests_integration/conftest.py
@@ -5,7 +5,7 @@
 import pytest
 from dataclasses import dataclass
 from pathlib import Path
-from snowcli.cli.app import app
+from snowcli.app.cli_app import app
 from tempfile import NamedTemporaryFile
 from typer import Typer
 from typer.testing import CliRunner