Support 3.13 and migrate uv from PDM

tasuren · tasuren · commit 81be6ac75a46 · 2024-10-13T13:28:31.000+09:00
diff --git a/.gitignore b/.gitignore
@@ -168,3 +168,6 @@ cython_debug/
 
 # macOS
 .DS_Store
+
+# Development
+.python-version
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,6 +1,6 @@
 {
     "recommendations": [
-        "ms-python.black-formatter",
-        "ms-python.vscode-pylanc"
+        "charliermarsh.ruff",
+        "ms-python.python"
     ]
-}
+}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/README.md b/README.md
@@ -1,11 +1,17 @@
-[![PyPI](https://img.shields.io/pypi/v/i21y)](https://pypi.org/project/i21y/) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/i21y) ![PyPI - Downloads](https://img.shields.io/pypi/dm/i21y) ![PyPI - License](https://img.shields.io/pypi/l/i21y) [![Documentation Status](https://readthedocs.org/projects/i21y/badge/?version=latest)](https://i21y.readthedocs.io/en/latest/?badge=latest) [![Buy Me a Coffee](https://img.shields.io/badge/-tasuren-E9EEF3?label=Buy%20Me%20a%20Coffee&logo=buymeacoffee)](https://www.buymeacoffee.com/tasuren)
+[![PyPI](https://img.shields.io/pypi/v/i21y)](https://pypi.org/project/i21y/)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/i21y)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/i21y)
+![PyPI - License](https://img.shields.io/pypi/l/i21y)
+[![Documentation Status](https://readthedocs.org/projects/i21y/badge/?version=latest)](https://i21y.readthedocs.io/en/latest/?badge=latest)
+[![Buy Me a Coffee](https://img.shields.io/badge/-tasuren-E9EEF3?label=Buy%20Me%20a%20Coffee&logo=buymeacoffee)](https://www.buymeacoffee.com/tasuren)
+
 # i21y
 i21y (a.k.a internationalization.py) is library for support i18n in Python. It is easy to use.
 
 **Features:**
 - Zero dependencies by default
 - Simple design
-- Tools to Simplify Keys
+- Utilities to simplify keys
 
 ## Installation
 Normal: `pip install i21y`  
@@ -36,5 +42,7 @@ assert t(LONG_KEY + "but_easy_to_use", locale="ja") == "とても長いキーで
 ## Documentation
 See the [documentation](https://i21y.readthedocs.io/) for usage and details.
 
-## License
-i21y is licensed under the [MIT license](./LICENSE).
+## Contributing Guide
+This project is managed by the package manager PDM.  
+In coding, please use Black as a code formatter and pyright for type checking. The configuration is described in `pyproject.toml`.  
+Please write what you have done in a complete sentence and use the original form of the verb. e.g. `Fix that locale_str can't join`.
diff --git a/pdm.lock b/pdm.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -2,52 +2,53 @@
 name = "i21y"
 description = "The simple library for i18n support."
 authors = [
-    {name = "Takagi Tasuku", email = "tasuren@outlook.jp"},
+    { name = "Takagi Tasuku", email = "tasuren@outlook.jp" },
 ]
-dependencies = []
-requires-python = ">=3.11"
 readme = "README.md"
-license = {file = "LICENSE"}
+license = { file = "LICENSE" }
 keywords = ["i18n"]
 classifiers = [
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.11",
     "Topic :: Software Development :: Internationalization",
     "Typing :: Typed"
 ]
-include = ["i21y/py.typed"]
+requires-python = ">=3.11"
+dependencies = []
 dynamic = ["version"]
 
-[tool.pdm]
-version = {source = "file", path = "src/i21y/__init__.py"}
+[project.optional-dependencies]
+yaml = ["pyyaml~=6.0"]
+fast_json = ["orjson~=3.10"]
+
+[tool.uv]
+dev-dependencies = [
+    "myst-parser>=4.0.0",
+    "pytest>=8.3.3",
+    "sphinx>=8.1.2",
+    "sphinx-intl>=2.2.0",
+    "ruff>=0.6.9",
+]
 
 [project.urls]
 Source = "https://github.com/tasuren/i21y"
 Documentation = "https://i21y.readthedocs.io/"
 Donate = "https://www.buymeacoffee.com/tasuren"
-Chat = "https://discord.gg/kfMwZUyGFG"
-
-[optional-dependencies]
-yaml = ["pyyaml~=6.0"]
-fast_json = ["orjson~=3.8.6"]
 
-[tool.pdm.dev-dependencies]
-test = [
-    "pytest~=7.1.2",
-    "pyyaml~=6.0",
-    "orjson~=3.8.6"
-]
-doc = [
-    "sphinx",
-    "sphinx-intl",
-    "myst-parser"
-]
+[tool.pytest.ini_options]
+addopts = ["--import-mode=importlib"]
+testpaths = ["tests"]
 
 [build-system]
-requires = ["pdm-backend"]
-build-backend = "pdm.backend"
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "src/i21y/__init__.py"
 
-[tool.pyright]
-typingCheckMode = "basic"
+[tool.hatch.metadata]
+allow-direct-references = true
 
-[tool.black]
-target-version = ['py311']
+[tool.hatch.build.targets.wheel]
+packages = ["src/i21y"]
diff --git a/src/i21y/__init__.py b/src/i21y/__init__.py
@@ -1,7 +1,7 @@
 __author__ = "Takagi Tasuku"
-__version__ = "0.2.0"
+__version__ = "0.3.0"
 __all__ = ("Translator", "I21YError", "TranslationNotFound", "locale_str")
 
-from .translator import Translator
 from .error import I21YError, TranslationNotFound
+from .translator import Translator
 from .utils import locale_str
diff --git a/src/i21y/abc.py b/src/i21y/abc.py
@@ -22,12 +22,12 @@ def search_impl(
     @overload
     def search(
         self, locale: str, key: str, default: type[Undefined] = Undefined
-    ) -> str:
-        ...
+    ) -> str: ...
 
     @overload
-    def search(self, locale: str, key: str, default: SearchT = Undefined) -> SearchT:
-        ...
+    def search(
+        self, locale: str, key: str, default: SearchT = Undefined
+    ) -> SearchT: ...
 
     def search(
         self, locale: str, key: str, default: SearchT | type[Undefined] = Undefined
diff --git a/src/i21y/loaders/file_.py b/src/i21y/loaders/file_.py
@@ -30,8 +30,9 @@ class LocaleFile:
 
     def __init__(self, parent: Loader, locale: str, path: PurePath) -> None:
         self.parent, self.path, self.data = parent, path, DataDict()
-        self.locale, self.key = locale, ".".join(
-            self.path.parts[parent.path_size + 1 : -1] + (self.path.stem,)
+        self.locale, self.key = (
+            locale,
+            ".".join(self.path.parts[parent.path_size + 1 : -1] + (self.path.stem,)),
         )
 
     def get(self, key: str | Iterable[str]) -> str | None:
diff --git a/src/i21y/loaders/json.py b/src/i21y/loaders/json.py
@@ -2,7 +2,8 @@
 
 from pathlib import PurePath
 
-from .file_ import Loader as FileLoader, LocaleFile
+from .file_ import Loader as FileLoader
+from .file_ import LocaleFile
 
 try:
     from orjson import loads
diff --git a/src/i21y/loaders/yaml.py b/src/i21y/loaders/yaml.py
@@ -15,7 +15,8 @@
         % e
     )
 
-from .file_ import Loader as FileLoader, LocaleFile
+from .file_ import Loader as FileLoader
+from .file_ import LocaleFile
 
 
 class Loader(FileLoader):
diff --git a/src/i21y/utils.py b/src/i21y/utils.py
@@ -65,14 +65,12 @@ def join_raw(self, *other: str | locale_str) -> str:
     @overload
     def join(
         self: ..., *other: str | locale_str, cls: type[AdtnlClsT], **extras: Any
-    ) -> AdtnlClsT:
-        ...
+    ) -> AdtnlClsT: ...
 
     @overload
     def join(
         self: SelfT, *other: str | locale_str, cls: None = None, **extras: Any
-    ) -> SelfT:
-        ...
+    ) -> SelfT: ...
 
     def join(
         self: SelfT,
diff --git a/tests/test_general.py b/tests/test_general.py
@@ -1,12 +1,12 @@
-from src.i21y import Translator
-from src.i21y.loaders.json import Loader
+from i21y import Translator
+from i21y.loaders.json import Loader
 
 
 def do_test_translator(t: Translator[Loader]) -> None:
     assert t("general.main") == "main"
     assert t("general.main", locale="ja") == "メイン"
 
-    from src.i21y.utils import locale_str
+    from i21y.utils import locale_str
 
     BASE = locale_str("wow.a")
     assert t(BASE.b) == "Layor B"
diff --git a/tests/test_locale_str.py b/tests/test_locale_str.py
@@ -1,5 +1,4 @@
-from src.i21y import locale_str
-
+from i21y import locale_str
 
 BASE = locale_str("aiueo")
 assert str(BASE) == "aiueo" and BASE.key == "aiueo"
diff --git a/tests/test_yaml.py b/tests/test_yaml.py
@@ -1,5 +1,5 @@
-from src.i21y import Translator
-from src.i21y.loaders.yaml import Loader
+from i21y import Translator
+from i21y.loaders.yaml import Loader
 
 
 def do_test_translator(t: Translator[Loader]) -> None:
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"recommendations": [`
`3`		`- "ms-python.black-formatter",`
`4`		`- "ms-python.vscode-pylanc"`
	`3`	`+ "charliermarsh.ruff",`
	`4`	`+ "ms-python.python"`
`5`	`5`	`]`
`6`		`-}`
	`6`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,8 @@`
`15`	`15`	`% e`
`16`	`16`	`)`
`17`	`17`
`18`		`-from .file_ import Loader as FileLoader, LocaleFile`
	`18`	`+from .file_ import Loader as FileLoader`
	`19`	`+from .file_ import LocaleFile`
`19`	`20`
`20`	`21`
`21`	`22`	`class Loader(FileLoader):`