Skip to content

Commit

Permalink
Refactor handling of user input in new/convert commands.
Browse files Browse the repository at this point in the history
  • Loading branch information
@freakboy3742
freakboy3742 committed Jan 17, 2025
1 parent 8acc982 commit 7945d43
Show file tree
Hide file tree
Showing 28 changed files with 830 additions and 957 deletions.
79 changes: 40 additions & 39 deletions src/briefcase/commands/convert.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
from packaging.utils import canonicalize_name

from ..config import is_valid_app_name
from .new import NewCommand, parse_project_overrides, titlecase
from .new import NewCommand, parse_project_overrides

if sys.version_info >= (3, 11): # pragma: no-cover-if-lt-py311
import tomllib
Expand Down Expand Up @@ -118,7 +118,7 @@ def input_app_name(self, override_value: str | None) -> str:
and override_value is None
):
app_name = canonicalize_name(self.pep621_data["name"])
self.prompt_divider(title="App name")
self.input.divider(title="App name")
self.input.prompt()
self.input.prompt(
f"Using value from PEP621 formatted pyproject.toml {app_name!r}"
Expand All @@ -133,9 +133,9 @@ def input_app_name(self, override_value: str | None) -> str:
f"app name of '{default}', but you can use another name if you want."
)

return self.input_text(
return self.input.text_question(
intro=intro,
variable="app name",
description="App name",
default=default,
validator=self.validate_app_name,
override_value=override_value,
Expand All @@ -146,8 +146,8 @@ def input_formal_name(self, app_name: str, override_value: str | None) -> str:
:returns: The source directory
"""
default = titlecase(" ".join(re.split("[-_]", app_name)))
return self.input_text(
default = (" ".join(re.split("[-_]", app_name))).title()
return self.input.text_question(
intro=(
"We need a formal name for your application. This is the name that "
"will be displayed to humans whenever the name of the application is "
Expand All @@ -157,7 +157,7 @@ def input_formal_name(self, app_name: str, override_value: str | None) -> str:
f"Based on the app name, we suggest a formal name of '{default}', but "
"you can use another name if you want."
),
variable="formal name",
description="Formal name",
default=default,
override_value=override_value,
)
Expand Down Expand Up @@ -214,9 +214,9 @@ def input_source_dir(
:returns: The source directory
"""
default, intro = self.get_source_dir_hint(app_name, module_name)
return self.input_text(
return self.input.text_question(
intro=intro,
variable="source directory",
description="Source directory",
default=default,
validator=partial(self.validate_source_dir, module_name),
override_value=override_value,
Expand Down Expand Up @@ -249,9 +249,9 @@ def input_test_source_dir(self, module_name, override_value) -> str:
else:
default = "tests"

return self.input_text(
return self.input.text_question(
intro=intro,
variable="test source directory",
description="Test source directory",
default=default,
validator=partial(self.validate_test_source_dir, module_name),
override_value=override_value,
Expand All @@ -269,16 +269,16 @@ def input_description(self, override_value: str | None) -> str:
if "description" in self.pep621_data and override_value is None:
description = self.pep621_data["description"]

self.prompt_divider(title="Description")
self.input.divider(title="Description")
self.input.prompt()
self.input.prompt(
f"Using value from PEP621 formatted pyproject.toml {description!r}"
)
return description

return self.input_text(
return self.input.text_question(
intro="Now, we need a one line description for your application.",
variable="description",
description="Description",
default="My first application",
override_value=override_value,
)
Expand All @@ -292,34 +292,34 @@ def input_url(self, app_name, override_value: str | None) -> str:

if not options or override_value:
default = self.make_project_url("com.example", app_name)
return self.input_text(
return self.input.text_question(
intro=(
"What website URL do you want to use for this application? Based "
f"on your existing 'pyproject.toml', this might be {default}"
),
variable="application URL",
description="Application URL",
default=default,
validator=validate_url,
override_value=override_value,
)

options.append("Other")
url = self.select_option(
url = self.input.selection_question(
intro=(
"What website URL do you want to use for this application? The "
"following URLs are defined in your existing 'pyproject.toml'; "
"select 'Other' to provide a different URL."
),
variable="application URL",
description="Application URL",
default=None,
options=options,
override_value=override_value,
)

if url == "Other":
url = self.input_text(
url = self.input.text_question(
intro="What website URL do you want to use for the application?",
variable="application URL",
description="Application URL",
default=self.make_project_url("com.example", app_name),
validator=validate_url,
)
Expand All @@ -333,10 +333,10 @@ def input_console_app(self, override_value: str | None) -> bool:
"""
options = ["GUI", "Console"]
return (
self.select_option(
self.input.selection_question(
intro="Is this a GUI application or a console application?",
variable="interface style",
default=None,
description="Interface style",
default="GUI",
options=options,
override_value=override_value,
)
Expand All @@ -345,7 +345,7 @@ def input_console_app(self, override_value: str | None) -> bool:

def input_bundle(self, url, app_name, override_value: str | None) -> str:
default = ".".join(reversed(urlparse(url).netloc.split(".")))
return self.input_text(
return self.input.text_question(
intro=(
"Now we need a bundle identifier for your application.\n"
"\n"
Expand All @@ -360,7 +360,7 @@ def input_bundle(self, url, app_name, override_value: str | None) -> str:
"application's machine readable name to form a complete application "
f"identifier ('{default}.{app_name}')."
),
variable="bundle identifier",
description="Bundle identifier",
default=default,
validator=self.validate_bundle,
override_value=override_value,
Expand All @@ -384,9 +384,9 @@ def input_author(self, override_value: str | None) -> str:
]

if not options or override_value is not None:
return self.input_text(
return self.input.text_question(
intro=intro,
variable="author",
description="Author",
default="Jane Developer",
override_value=override_value,
)
Expand All @@ -397,26 +397,27 @@ def input_author(self, override_value: str | None) -> str:

options.append("Other")

# We want to use the input_text-function if override_value is provided or if the selected author is "Other"
# However, since we don't want the select_option prompt if an override value is provided, we need to
# initialise the author variable here.
author = self.select_option(
# We want to use text_question if override_value is provided or if the selected
# author is "Other". However, since we don't want the selection_question prompt
# if an override value is provided, we need to initialise the author variable
# here.
author = self.input.selection_question(
intro=(
intro
+ "\n\n"
+ "We found these author names in the PEP621 formatted "
+ "'pyproject.toml'. Who do you want to be credited as the author of "
+ "this application?"
),
variable="Author",
description="Author",
options=options,
default=None,
override_value=None,
)
if author == "Other":
author = self.input_text(
author = self.input.text_question(
intro="Who do you want to be credited as the author of this application?",
variable="author",
description="Author",
default="Jane Developer",
override_value=None,
)
Expand All @@ -443,9 +444,9 @@ def input_email(self, author: str, bundle: str, override_value: str | None) -> s
f"we believe it could be '{default}'."
)

author_email = self.input_text(
author_email = self.input.text_question(
intro=intro,
variable="author's email",
description="Author's email",
default=default,
validator=self.validate_email,
override_value=override_value,
Expand Down Expand Up @@ -547,9 +548,9 @@ def input_license(self, override_value: str | None) -> str:
"Other",
]

return self.select_option(
return self.input.selection_question(
intro=intro,
variable="Project License",
description="Project license",
options=options,
default=default,
override_value=override_value,
Expand Down Expand Up @@ -718,7 +719,7 @@ def convert_app(
self.input.prompt()
self.input.prompt("Let's setup an existing project as a Briefcase app!")
context = self.build_context(project_overrides)
self.prompt_divider() # close the prompting section of output
self.input.divider() # close the prompting section of output

self.warn_unused_overrides(project_overrides)

Expand Down
2 changes: 1 addition & 1 deletion src/briefcase/commands/create.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -910,7 +910,7 @@ def create_app(self, app: AppConfig, test_mode: bool = False, **options):
bundle_path = self.bundle_path(app)
if bundle_path.exists():
self.logger.info()
confirm = self.input.boolean_input(
confirm = self.input.boolean(
f"Application {app.app_name!r} already exists; overwrite", default=False
)
if not confirm:
Expand Down
Loading

0 comments on commit 7945d43

Please sign in to comment.