diff --git a/packages/smithy-python/.changes/next-release/smithy-python-enhancement-767eec42172f43409cb7a04f463d2ec2.json b/packages/smithy-python/.changes/next-release/smithy-python-enhancement-767eec42172f43409cb7a04f463d2ec2.json new file mode 100644 index 000000000..782922ba4 --- /dev/null +++ b/packages/smithy-python/.changes/next-release/smithy-python-enhancement-767eec42172f43409cb7a04f463d2ec2.json @@ -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." +} diff --git a/packages/smithy-python/src/smithy_python/_client_emitter.py b/packages/smithy-python/src/smithy_python/_client_emitter.py index 01e1320ca..f06e196bc 100644 --- a/packages/smithy-python/src/smithy_python/_client_emitter.py +++ b/packages/smithy-python/src/smithy_python/_client_emitter.py @@ -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 @@ -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" @@ -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, @@ -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] @@ -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] diff --git a/packages/smithy-python/src/smithy_python/_package.py b/packages/smithy-python/src/smithy_python/_package.py index 1ef0921a9..374ee5068 100644 --- a/packages/smithy-python/src/smithy_python/_package.py +++ b/packages/smithy-python/src/smithy_python/_package.py @@ -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( @@ -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 @@ -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") diff --git a/packages/smithy-python/src/smithy_python/cli.py b/packages/smithy-python/src/smithy_python/cli.py index 42789340d..f3cb66d07 100644 --- a/packages/smithy-python/src/smithy_python/cli.py +++ b/packages/smithy-python/src/smithy_python/cli.py @@ -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", @@ -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 ), diff --git a/packages/smithy-python/src/smithy_python/clients.py b/packages/smithy-python/src/smithy_python/clients.py index 3429e9099..b1030b3c7 100644 --- a/packages/smithy-python/src/smithy_python/clients.py +++ b/packages/smithy-python/src/smithy_python/clients.py @@ -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 ) @@ -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] ) diff --git a/packages/smithy-python/src/smithy_python/generation.py b/packages/smithy-python/src/smithy_python/generation.py index ce123ee05..4d06d3068 100644 --- a/packages/smithy-python/src/smithy_python/generation.py +++ b/packages/smithy-python/src/smithy_python/generation.py @@ -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): diff --git a/packages/smithy-python/src/smithy_python/models.py b/packages/smithy-python/src/smithy_python/models.py index a8786b8dd..fe3e409ae 100644 --- a/packages/smithy-python/src/smithy_python/models.py +++ b/packages/smithy-python/src/smithy_python/models.py @@ -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, ) @@ -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, @@ -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 = ( diff --git a/packages/smithy-python/src/smithy_python/schemas.py b/packages/smithy-python/src/smithy_python/schemas.py index d4757bfb0..fb97fc516 100644 --- a/packages/smithy-python/src/smithy_python/schemas.py +++ b/packages/smithy-python/src/smithy_python/schemas.py @@ -101,14 +101,14 @@ class SchemaGenerator: def generate(self, context: GenerationContext[ModelArtifactSettings]) -> None: """Register ``._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 @@ -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, @@ -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, diff --git a/packages/smithy-python/tests/unit/test_cli.py b/packages/smithy-python/tests/unit/test_cli.py index 054ef82c4..4c0128199 100644 --- a/packages/smithy-python/tests/unit/test_cli.py +++ b/packages/smithy-python/tests/unit/test_cli.py @@ -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"), [ @@ -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"), diff --git a/packages/smithy-python/tests/unit/test_client_generation.py b/packages/smithy-python/tests/unit/test_client_generation.py index 5c3eb0c1c..b21a9dc80 100644 --- a/packages/smithy-python/tests/unit/test_client_generation.py +++ b/packages/smithy-python/tests/unit/test_client_generation.py @@ -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 @@ -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 diff --git a/packages/smithy-python/tests/unit/test_generation.py b/packages/smithy-python/tests/unit/test_generation.py index 9a5ef2f91..807278738 100644 --- a/packages/smithy-python/tests/unit/test_generation.py +++ b/packages/smithy-python/tests/unit/test_generation.py @@ -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",