Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"type": "enhancement",
"description": "Allow dashes in `--package`. The distribution name in `pyproject.toml` keeps the package name as given. The import name replaces dashes with underscores."
}
23 changes: 12 additions & 11 deletions packages/smithy-python/src/smithy_python/_client_emitter.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,11 @@ def write_client(
endpoints: _endpoints.EndpointPlan,
) -> None:
"""Register client, config, endpoints, and package modules for both modes."""
package = context.settings.package
directory = package.replace(".", "/")
import_name = context.settings.import_name
directory = import_name.replace(".", "/")
service = plan.selection.service
assert service is not None # noqa: S101 - ClientPlan requires a service
endpoints_module = f"{package}._private.endpoints"
endpoints_module = f"{import_name}._private.endpoints"
_endpoints.write_endpoints(
context.files.python_module(
f"src/{directory}/_private/endpoints.py", endpoints_module
Expand All @@ -74,7 +74,7 @@ def write_client(
)
sync, aio = _modes(plan, protocol)
for mode in (sync, aio):
module = f"{package}.{mode.directory.replace('/', '.')}"
module = f"{import_name}.{mode.directory.replace('/', '.')}"
_write_config(
context.files.python_module(
f"src/{directory}/{mode.directory}config.py", f"{module}config"
Expand All @@ -100,17 +100,18 @@ def write_client(
context,
plan,
endpoints,
TypeReference(aio.client, f"{package}.aio.client"),
TypeReference(aio.config, f"{package}.aio.config"),
TypeReference(aio.client, f"{import_name}.aio.client"),
TypeReference(aio.config, f"{import_name}.aio.config"),
)
aio_init = context.files.python_module(
f"src/{directory}/aio/__init__.py", f"{package}.aio"
f"src/{directory}/aio/__init__.py", f"{import_name}.aio"
)
_write_exports(aio_init, {aio.client: ".client", aio.config: ".config"})
init = _package.write_package(
context,
title=f"{package} Client Package",
description=context.settings.package_description or f"{package} client package",
title=f"{context.settings.package} Client Package",
description=context.settings.package_description
or f"{context.settings.package} client package",
)
_write_exports(
init,
Expand Down Expand Up @@ -277,7 +278,7 @@ def _write_config(
) -> None:
client_protocol = _generic(_core("ClientProtocol", "interfaces"), _ANY, _ANY)
interceptor = _generic(_core("Interceptor", "interceptors"), *_ANY4)
schemas = f"{plan.settings.package}._private.schemas"
schemas = f"{plan.settings.import_name}._private.schemas"
writer.line("_PROTOCOL_SETTINGS = ", _PROTOCOL_SETTINGS, "(")
with writer.indent():
writer.line("namespace=", _models._quote(service.id.namespace), ",") # pyright: ignore[reportPrivateUsage]
Expand Down Expand Up @@ -429,7 +430,7 @@ def _write_client(
) -> None:
config = TypeReference(mode.config, config_module)
plugin = TypeReference("Plugin", config_module)
models = TypeReference("models", plan.settings.package)
models = TypeReference("models", plan.settings.import_name)
writer.line("class ", mode.client, "(", _generic(mode.client_base, config), "):")
with writer.indent():
_models._write_docstring( # pyright: ignore[reportPrivateUsage]
Expand Down
10 changes: 5 additions & 5 deletions packages/smithy-python/src/smithy_python/_package.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ def write_package(
writer, which already declares ``__version__``.
"""
settings = context.settings
package = settings.package
directory = package.replace(".", "/")
import_name = settings.import_name
directory = import_name.replace(".", "/")

context.dependencies.add(_dependencies.HATCHLING)
context.files.text_file(
Expand All @@ -56,10 +56,10 @@ def write_package(
f"{_GENERATED_MARKDOWN_COMMENT}\n\n## {title}\n\n{description}\n",
)

init = context.files.python_module(f"src/{directory}/__init__.py", package)
init = context.files.python_module(f"src/{directory}/__init__.py", import_name)
init.line("__version__: str = ", repr(settings.package_version))
context.files.python_module(
f"src/{directory}/_private/__init__.py", f"{package}._private"
f"src/{directory}/_private/__init__.py", f"{import_name}._private"
)
context.files.text_file(f"src/{directory}/py.typed", "")
return init
Expand All @@ -70,7 +70,7 @@ def _render_pyproject(
dependencies: _dependencies.DependencySet,
description: str,
) -> str:
package_root = settings.package.split(".", 1)[0]
package_root = settings.import_name.split(".", 1)[0]
groups = "\n".join(
f"{group} = {_toml_array(map(_requirement, values))}"
for group in ("test", "docs")
Expand Down
7 changes: 5 additions & 2 deletions packages/smithy-python/src/smithy_python/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,10 @@ def _add_package_options(parser: argparse.ArgumentParser, artifact: str) -> None
parser.add_argument(
"--package",
required=True,
help="Import package and distribution name for the generated artifact.",
help=(
"Package name for the generated artifact. The distribution name "
"uses it as given. The import name replaces dashes with underscores."
),
)
parser.add_argument(
"--package-version",
Expand Down Expand Up @@ -246,7 +249,7 @@ def _generate_types(
symbols = _symbols.SymbolProvider(
model,
selection,
package=settings.package,
package=settings.import_name,
reserved_member_names=_models._model_reserved_member_names( # pyright: ignore[reportPrivateUsage]
model
),
Expand Down
4 changes: 2 additions & 2 deletions packages/smithy-python/src/smithy_python/clients.py
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ def from_model(
)
service = selection.service
assert service is not None # noqa: S101 - required service invariant
model = normalize_client_model(model, service, package=settings.package)
model = normalize_client_model(model, service, package=settings.import_name)
selection = _selection.select_shapes(
model, service_id=str(service.id), require_service=True
)
Expand All @@ -127,7 +127,7 @@ def from_model(
symbols = _symbols.ClientSymbolProvider(
model,
selection,
package=settings.package,
package=settings.import_name,
operations=operations,
reserved_member_names=_models._model_reserved_member_names(model), # pyright: ignore[reportPrivateUsage]
)
Expand Down
11 changes: 10 additions & 1 deletion packages/smithy-python/src/smithy_python/generation.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,21 @@

@dataclass(frozen=True, slots=True)
class ArtifactSettings:
"""Settings shared by generated artifacts."""
"""Settings shared by generated artifacts.

``package`` is the distribution name, used as given in ``pyproject.toml``.
``import_name`` derives the name to import from it.
"""

package: str
package_version: str
package_description: str | None

@property
def import_name(self) -> str:
"""The name to import: ``package`` with dashes replaced by underscores."""
return self.package.replace("-", "_")


@dataclass(frozen=True, slots=True)
class ModelArtifactSettings(ArtifactSettings):
Expand Down
12 changes: 6 additions & 6 deletions packages/smithy-python/src/smithy_python/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,17 @@ class ModelGenerator:
def generate(self, context: GenerationContext[ModelArtifactSettings]) -> None:
"""Register ``models.py`` and ``models.pyi`` with the file manifest."""
_validate_member_names(context)
package = context.settings.package
directory = package.replace(".", "/")
import_name = context.settings.import_name
directory = import_name.replace(".", "/")
_write_runtime(
context.files.python_module(
f"src/{directory}/models.py", f"{package}.models"
f"src/{directory}/models.py", f"{import_name}.models"
),
context.plan.models,
)
facade = _StubEmitter(
context.files.python_module(
f"src/{directory}/models.pyi", f"{package}.models"
f"src/{directory}/models.pyi", f"{import_name}.models"
),
context,
)
Expand All @@ -58,7 +58,7 @@ def generate(self, context: GenerationContext[ModelArtifactSettings]) -> None:
_StubEmitter(
context.files.python_module(
f"src/{directory}/_private/{module}.pyi",
f"{package}._private.{module}",
f"{import_name}._private.{module}",
),
context,
external_bases=True,
Expand Down Expand Up @@ -232,7 +232,7 @@ def __init__(
self.model = context.model
self.plan = context.plan.models
self.symbols = context.symbols
self.module = f"{context.settings.package}.models"
self.module = f"{context.settings.import_name}.models"
self.external_bases = external_bases
self.serde_shape = "_SerdeShape"
self.service_error: str | _symbols.TypeReference = (
Expand Down
10 changes: 5 additions & 5 deletions packages/smithy-python/src/smithy_python/schemas.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,14 +101,14 @@ class SchemaGenerator:

def generate(self, context: GenerationContext[ModelArtifactSettings]) -> None:
"""Register ``<package>._private.schemas`` with the file manifest."""
package = context.settings.package
directory = package.replace(".", "/")
import_name = context.settings.import_name
directory = import_name.replace(".", "/")
plan = context.plan.schemas
size = context.settings.schema_partition_size
if size is None or len(plan.shapes) <= size:
writer = context.files.python_module(
f"src/{directory}/_private/schemas.py",
f"{package}._private.schemas",
f"{import_name}._private.schemas",
)
_write_schema_module(writer, plan, plan.shapes)
return
Expand All @@ -118,7 +118,7 @@ def generate(self, context: GenerationContext[ModelArtifactSettings]) -> None:
_write_schema_facade(
context.files.python_module(
f"src/{directory}/_private/schemas.py",
f"{package}._private.schemas",
f"{import_name}._private.schemas",
),
plan,
partitions,
Expand All @@ -128,7 +128,7 @@ def generate(self, context: GenerationContext[ModelArtifactSettings]) -> None:
_write_schema_module(
context.files.python_module(
f"src/{directory}/_private/{module}.py",
f"{package}._private.{module}",
f"{import_name}._private.{module}",
),
plan,
shapes,
Expand Down
27 changes: 22 additions & 5 deletions packages/smithy-python/tests/unit/test_cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,27 @@ def test_types_generation_packages_dotted_modules_from_namespace_root(
assert capsys.readouterr().err == ""


def test_types_generation_keeps_dashes_in_the_distribution_name(
tmp_path: Path,
monkeypatch: pytest.MonkeyPatch,
) -> None:
output = tmp_path / "output"
source = b'{"smithy": "2.0", "shapes": {"example#Data": {"type": "structure"}}}'

assert _run_types(output, source=source, package="dashed-types") == 0
project = tomllib.loads((output / "pyproject.toml").read_text())
assert project["project"]["name"] == "dashed-types"
assert project["project"]["keywords"] == ["smithy", "dashed-types"]
wheel = project["tool"]["hatch"]["build"]["targets"]["wheel"]
assert wheel["packages"] == ["src/dashed_types"]

monkeypatch.syspath_prepend( # pyright: ignore[reportUnknownMemberType]
str(output / "src")
)
models = importlib.import_module("dashed_types.models")
assert models.Data.__module__ == "dashed_types.models"


@pytest.mark.parametrize(
("argv", "expected_usage"),
[
Expand Down Expand Up @@ -382,11 +403,7 @@ def test_types_generation_requires_package_settings(
@pytest.mark.parametrize(
("option", "value", "expected"),
[
(
"--package",
"invalid-package",
"Invalid Python package or distribution name",
),
("--package", "example-", "Invalid Python package or distribution name"),
("--package", "_example", "Invalid Python package or distribution name"),
("--package", "example_", "Invalid Python package or distribution name"),
("--package", "café", "Invalid Python package or distribution name"),
Expand Down
15 changes: 15 additions & 0 deletions packages/smithy-python/tests/unit/test_client_generation.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import struct
import subprocess
import sys
import tomllib
from collections.abc import Callable
from pathlib import Path
from types import ModuleType
Expand Down Expand Up @@ -200,6 +201,20 @@ def test_package_loads_no_clients_or_models_until_used(
assert not models._registry._classes # pyright: ignore[reportPrivateUsage]


def test_dashed_package_names_the_distribution_and_imports_with_underscores(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
_generate(tmp_path, "greeter-dashed")
project = tomllib.loads((tmp_path / "pyproject.toml").read_text())["project"]
assert project["name"] == "greeter-dashed"
monkeypatch.syspath_prepend( # pyright: ignore[reportUnknownMemberType]
str(tmp_path / "src")
)
package = importlib.import_module("greeter_dashed")
assert package.Greeter.__module__ == "greeter_dashed.client"
assert package.AsyncGreeter.__module__ == "greeter_dashed.aio.client"


@pytest.mark.parametrize("aio", [False, True])
def test_operation_sends_cbor_request_and_returns_output(
package: ModuleType, aio: bool
Expand Down
15 changes: 15 additions & 0 deletions packages/smithy-python/tests/unit/test_generation.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,21 @@ def test_artifact_settings_are_immutable_values() -> None:
assert settings.package_version == "1.2.3"


@pytest.mark.parametrize(
("package", "import_name"),
[
("example_types", "example_types"),
("example-types", "example_types"),
("example.nested-types", "example.nested_types"),
],
)
def test_import_name_replaces_dashes_with_underscores(
package: str, import_name: str
) -> None:
settings = ArtifactSettings(package, "1.2.3", None)
assert settings.import_name == import_name


def test_types_settings_default_to_identity_selection() -> None:
settings = TypesSettings(
package="example.types",
Expand Down
Loading