Skip to content

Commit 029f0ad

Browse files
committed
Updated Template Python Source
Made changes to satisfy ruff.
1 parent 7e3cfbf commit 029f0ad

File tree

7 files changed

+19
-17
lines changed

7 files changed

+19
-17
lines changed

{{ cookiecutter.package_name }}/src/{{cookiecutter.package_name}}/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""{{ cookiecutter.package_name }}
1+
"""{{ cookiecutter.package_name }}.
22
33
{{ cookiecutter.project_short_description }}
44
"""

{{ cookiecutter.package_name }}/src/{{cookiecutter.package_name}}/__main__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""{{ cookiecutter.cli_name }}
1+
"""{{ cookiecutter.cli_name }} CLI implementation.
22
33
{{ cookiecutter.project_short_description }}
44
"""

{{ cookiecutter.package_name }}/src/{{cookiecutter.package_name}}/self_subcommand.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""{{ cookiecutter.cli_name }} Self Command-Line Interface
1+
"""{{ cookiecutter.cli_name }} Self Command-Line Interface.
22
33
This module provides a command-line interface to interact with
44
internals of the {{ cookiecutter.cli_name }} CLI.
@@ -21,4 +21,4 @@ def version_subcommand() -> None:
2121
typer.secho(pkg_version, fg=typer.colors.GREEN)
2222
except Exception as error:
2323
logger.error(f"Failed to retrieve package version: {error}")
24-
raise typer.Exit(code=1)
24+
raise typer.Exit(code=1) from None

{{ cookiecutter.package_name }}/src/{{cookiecutter.package_name}}/{% if cookiecutter.use_pydantic_settings %}settings.py{% endif %}

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
""" {{ cookiecutter.package_name }} Settings
2-
"""
1+
"""{{ cookiecutter.package_name }} Settings."""
32

43
from pydantic_settings import BaseSettings, SettingsConfigDict
54

65

76
class Settings(BaseSettings):
7+
"""Settings for {{ cookiecutter.package_name }}."""
88
model_config = SettingsConfigDict(
99
env_prefix="{{ cookiecutter.package_name.upper() }}",
1010
env_file=".env-{{ cookiecutter.package_name.lower() }}",
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"""{{ cookiecutter.package_name }} tests."""

{{ cookiecutter.package_name }}/tests/conftest.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""{{ cookiecutter.project_name }} pytest configuration file"""
1+
"""{{ cookiecutter.project_name }} pytest configuration file."""
22

33
from pathlib import Path
44

@@ -13,7 +13,7 @@ def project_root() -> Path:
1313

1414

1515
@pytest.fixture(scope="session")
16-
def pyproject_path(project_root) -> Path:
16+
def pyproject_path(project_root: Path) -> Path:
1717
"""Return the path to the pyproject.toml file."""
1818
yield project_root / "pyproject.toml"
1919

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,41 @@
1-
"""test CLI"""
1+
"""test {{ cookiecutter.package_name }} CLI: {{ cookiecutter.cli_name }}."""
22

33
from typer.testing import CliRunner
4+
import importlib
45

5-
from thing.__main__ import cli
6-
6+
main_module_name = "{{ cookiecutter.package_name }}.__main__"
7+
main_module = importlib.import_module(main_module_name)
78
runner = CliRunner()
89

910

1011
def test_cli_no_arguments() -> None:
1112
"""Test the main command-line interface with no arguments."""
12-
result = runner.invoke(cli)
13+
result = runner.invoke(main_module.cli)
1314
assert result.exit_code != 0
1415
assert "Usage:" in result.output
1516

1617

1718
def test_cli_help() -> None:
1819
"""Test the main command-line interface help flag."""
19-
result = runner.invoke(cli, ["--help"])
20+
result = runner.invoke(main_module.cli, ["--help"])
2021
assert result.exit_code == 0
2122

2223

2324
def test_cli_self_no_arguments() -> None:
2425
"""Test the self subcommand with no arguments."""
25-
result = runner.invoke(cli, ["self"])
26+
result = runner.invoke(main_module.cli, ["self"])
2627
assert result.exit_code != 0
2728
assert "Usage:" in result.output
2829

2930

3031
def test_cli_self_help() -> None:
31-
"""Test the self subcommand help flag"""
32-
result = runner.invoke(cli, ["self", "--help"])
32+
"""Test the self subcommand help flag."""
33+
result = runner.invoke(main_module.cli, ["self", "--help"])
3334
assert result.exit_code == 0
3435

3536

3637
def test_cli_self_version(project_version: str) -> None:
3738
"""Test the version self subcommand."""
38-
result = runner.invoke(cli, ["self", "version"])
39+
result = runner.invoke(main_module.cli, ["self", "version"])
3940
assert result.exit_code == 0
4041
assert result.output.strip() == project_version

0 commit comments

Comments
 (0)