Fix usethis tool failing in directories with leading dots (#1903)

Copilot · nathanjmcdougall · web-flow · commit fe3b8a6df85e · 2026-04-10T08:18:13.000+12:00
* Initial plan * Fix uv/poetry init failing in directories with leading dots in their name Pass --name with a sanitized project name to uv init, and fix get_project_name_from_dir() to strip leading/trailing non-alphanumeric characters (dots, dashes, underscores) per PEP packaging spec. Also update poetry init to use get_project_name_from_dir() instead of the raw directory name for consistency. Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/e415c235-da21-4847-b92c-704513c59e6e Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com> * Fix Windows test failure: use PurePosixPath instead of real directories The test_only_dots test created a directory named "..." which on Windows is interpreted as parent directory traversal (../..), causing FileExistsError. Since get_project_name_from_dir() only reads Path.name and never accesses the filesystem, all tests now use PurePosixPath synthetic paths instead of creating real directories. Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/b47fb40c-7e7c-44f9-89e3-258b10a5fe34 Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com> * Fix basedpyright: replace PurePosixPath with Path/str in tests PurePosixPath is not assignable to Path | str | None. Use tmp_path / "name" (Path without mkdir) for most tests, and string paths for Windows-problematic names ("..." and "project.") since usethis_config .set() accepts str and converts to Path internally. Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/06111449-4dd0-43b5-87cf-f13293af9a57 Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
diff --git a/src/usethis/_backend/poetry/init.py b/src/usethis/_backend/poetry/init.py
@@ -6,7 +6,7 @@
 
 from usethis._backend.poetry.call import call_poetry_subprocess
 from usethis._backend.poetry.errors import PoetryInitError, PoetrySubprocessFailedError
-from usethis._config import usethis_config
+from usethis._file.dir import get_project_name_from_dir
 from usethis._file.pyproject_toml.errors import PyprojectTOMLInitError
 
 
@@ -32,7 +32,7 @@ def ensure_pyproject_toml_via_poetry(*, author: bool = True) -> None:
     args = [
         "init",
         "--name",
-        usethis_config.cpd().name,
+        get_project_name_from_dir(),
         "--python",
         _get_poetry_python_constraint(),
     ]
@@ -54,7 +54,7 @@ def opinionated_poetry_init() -> None:
             [
                 "init",
                 "--name",
-                usethis_config.cpd().name,
+                get_project_name_from_dir(),
                 "--python",
                 _get_poetry_python_constraint(),
             ],
diff --git a/src/usethis/_backend/uv/init.py b/src/usethis/_backend/uv/init.py
@@ -7,6 +7,7 @@
 )
 from usethis._backend.uv.errors import UVInitError, UVSubprocessFailedError
 from usethis._config import usethis_config
+from usethis._file.dir import get_project_name_from_dir
 from usethis._file.pyproject_toml.errors import PyprojectTOMLInitError
 
 
@@ -20,6 +21,8 @@ def opinionated_uv_init() -> None:
             [
                 "init",
                 "--lib",
+                "--name",
+                get_project_name_from_dir(),
                 "--build-backend",
                 usethis_config.build_backend.value,
                 usethis_config.cpd().as_posix(),
@@ -45,6 +48,8 @@ def ensure_pyproject_toml_via_uv(*, author: bool = True) -> None:
                 "--bare",
                 "--vcs=none",
                 f"--author-from={author_from}",
+                "--name",
+                get_project_name_from_dir(),
                 "--build-backend",
                 usethis_config.build_backend.value,
                 usethis_config.cpd().as_posix(),
diff --git a/src/usethis/_file/dir.py b/src/usethis/_file/dir.py
@@ -7,12 +7,14 @@ def get_project_name_from_dir() -> str:
     """Derive a valid project name from the current directory name."""
     # Use the name of the parent directory
     # Names must start and end with a letter or digit and may only contain -, _, ., and
-    # alphanumeric characters. Any other characters will be dropped. If there are no
-    # valid characters, the name will be "hello_world".
+    # alphanumeric characters. Any other characters will be dropped. Leading and trailing
+    # non-alphanumeric characters are stripped. If there are no valid characters, the
+    # name will be "hello_world".
     # https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#name
     # https://packaging.python.org/en/latest/specifications/name-normalization/#name-format
     dir_name = usethis_config.cpd().name
     name = "".join(c for c in dir_name if c.isalnum() or c in {"-", "_", "."})
+    name = name.strip("-_.")
     if not name:
         name = "hello_world"
 
diff --git a/tests/usethis/_backend/uv/test_init.py b/tests/usethis/_backend/uv/test_init.py
@@ -1,7 +1,7 @@
 from pathlib import Path
 
 from _test import change_cwd
-from usethis._backend.uv.init import opinionated_uv_init
+from usethis._backend.uv.init import ensure_pyproject_toml_via_uv, opinionated_uv_init
 from usethis._config import usethis_config
 from usethis._config_file import files_manager
 from usethis._file.pyproject_toml.io_ import PyprojectTOMLManager
@@ -30,3 +30,27 @@ def test_build_backend_is_uv(self, tmp_path: Path):
 
             # Assert
             assert manager[["build-system", "build-backend"]] == "uv_build"
+
+    def test_leading_dot_dir_name(self, tmp_path: Path):
+        path = tmp_path / ".github-private"
+        path.mkdir()
+        with change_cwd(path), files_manager():
+            manager = PyprojectTOMLManager()
+            # Act
+            opinionated_uv_init()
+
+            # Assert
+            assert manager[["project", "name"]] == "github-private"
+
+
+class TestEnsurePyprojectTomlViaUV:
+    def test_leading_dot_dir_name(self, tmp_path: Path):
+        path = tmp_path / ".github-private"
+        path.mkdir()
+        with change_cwd(path), files_manager():
+            manager = PyprojectTOMLManager()
+            # Act
+            ensure_pyproject_toml_via_uv()
+
+            # Assert
+            assert manager[["project", "name"]] == "github-private"
diff --git a/tests/usethis/_file/pyproject_toml/test_valid.py b/tests/usethis/_file/pyproject_toml/test_valid.py
@@ -226,6 +226,26 @@ def test_drop_nonalphanum_chars_from_dir_name(self, tmp_path: Path):
 [project]
 name = "h-el.l_o"
 version = "0.2.0"
+"""
+        )
+
+    def test_leading_dot_dir_name(self, tmp_path: Path):
+        # Arrange
+        path = tmp_path / ".github-private"
+        path.mkdir()
+        (path / "pyproject.toml").write_text("")
+
+        # Act
+        with change_cwd(path), files_manager():
+            ensure_pyproject_validity()
+
+        # Assert
+        assert (
+            (path / "pyproject.toml").read_text()
+            == """\
+[project]
+name = "github-private"
+version = "0.1.0"
 """
         )
 
diff --git a/tests/usethis/_file/test_dir.py b/tests/usethis/_file/test_dir.py
@@ -0,0 +1,38 @@
+from pathlib import Path
+
+from usethis._config import usethis_config
+from usethis._file.dir import get_project_name_from_dir
+
+
+class TestGetProjectNameFromDir:
+    def test_simple_name(self, tmp_path: Path):
+        with usethis_config.set(project_dir=tmp_path / "my_project"):
+            assert get_project_name_from_dir() == "my_project"
+
+    def test_leading_dot(self, tmp_path: Path):
+        with usethis_config.set(project_dir=tmp_path / ".github-private"):
+            assert get_project_name_from_dir() == "github-private"
+
+    def test_leading_dots(self, tmp_path: Path):
+        with usethis_config.set(project_dir=tmp_path / "..hidden"):
+            assert get_project_name_from_dir() == "hidden"
+
+    def test_trailing_dot(self):
+        with usethis_config.set(project_dir="/fake/project."):
+            assert get_project_name_from_dir() == "project"
+
+    def test_leading_and_trailing_non_alphanumeric(self, tmp_path: Path):
+        with usethis_config.set(project_dir=tmp_path / "-_project_-"):
+            assert get_project_name_from_dir() == "project"
+
+    def test_only_dots(self):
+        with usethis_config.set(project_dir="/fake/..."):
+            assert get_project_name_from_dir() == "hello_world"
+
+    def test_no_valid_chars(self, tmp_path: Path):
+        with usethis_config.set(project_dir=tmp_path / "+"):
+            assert get_project_name_from_dir() == "hello_world"
+
+    def test_drops_invalid_chars(self, tmp_path: Path):
+        with usethis_config.set(project_dir=tmp_path / "h-e+l.l_o"):
+            assert get_project_name_from_dir() == "h-el.l_o"
