Merge pull request #50 from a5chin/feature/timer

Add trace Timer

.devcontainer/Dockerfile

@@ -1,4 +1,4 @@
-ARG UV_VERSION=0.5.11
+ARG UV_VERSION=0.5.13
 ARG DEBIAN_VERSION=bookworm
 
 

.devcontainer/devcontainer.json

@@ -4,7 +4,7 @@
         "context": "..",
         "dockerfile": "Dockerfile",
         "args": {
-            "UV_VERSION": "0.5.11",
+            "UV_VERSION": "0.5.13",
             "DEBIAN_VERSION": "bookworm"
         }
     },
@@ -23,7 +23,8 @@
                 "njpwerner.autodocstring",
                 "redhat.vscode-yaml",
                 "shardulm94.trailing-spaces",
-                "tamasfe.even-better-toml"
+                "tamasfe.even-better-toml",
+                "yzhang.markdown-all-in-one"
             ]
         }
     },

.python-version

@@ -1 +1 @@
-3.12.6
+3.13.1

.vscode/extensions.json

@@ -16,6 +16,6 @@
         "shardulm94.trailing-spaces",
         "tamasfe.even-better-toml",
         "usernamehw.errorlens",
-        "yzhang.markdown-all-in-one",
+        "yzhang.markdown-all-in-one"
     ]
 }

Dockerfile

@@ -1,6 +1,6 @@
 ARG DEBIAN_VERSION=bookworm
-ARG UV_VERSION=0.5.11
-ARG VARIANT=3.12
+ARG UV_VERSION=0.5.13
+ARG VARIANT=3.13
 
 
 FROM ghcr.io/astral-sh/uv:$UV_VERSION AS uv

README.md

@@ -37,6 +37,7 @@ Specifically, you can solve this problem by following the steps below.
   - [GitHub Actions](#github-actions)
   - [Ruff](#ruff)
   - [pre-commit](#pre-commit)
+  - [pytest](#pytest)
   - [Appendix](#appendix)
     - [Install libraries](#install-libraries)
     - [The structure of this repository](#the-structure-of-this-repository)
@@ -170,7 +171,9 @@ uv add {libraries}
 │   └── settings.json
 ├── tests/
 │   └── tools/
-│        └── test__logger.py
+│        ├── test__config.py
+│        ├── test__logger.py
+│        └── test__trace.py
 ├── tools/
 │   ├── config/
 │   │    ├── __init__.py
@@ -184,6 +187,9 @@ uv add {libraries}
 │   │    ├── logger.py
 │   │    ├── style.py
 │   │    └── type.py
+│   ├── trace/
+│   │    ├── __init__.py
+│   │    └── time.py
 │   └── __init__.py
 ├── .dockerignore
 ├── .env.local

docs/configurations/pyright.md

@@ -8,7 +8,7 @@
 
 ```{.json title="pyrightconfig.json"}
 {
-    "pythonVersion": "3.12",
+    "pythonVersion": "3.13",
     "pythonPlatform": "All",
     "venv": ".venv",
     "typeCheckingMode": "standard",

docs/configurations/ruff.md

@@ -55,8 +55,8 @@ The Ruff formatter is an extremely fast Python code formatter designed as a drop
     line-length = 88
     indent-width = 4
 
-    # Assume Python 3.12
-    target-version = "py312"
+    # Assume Python 3.13
+    target-version = "py313"
 
     [lint]
     # Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.

docs/guides/index.md

@@ -10,3 +10,4 @@ How to use this repository.
 - [How to use Tools](tools/index.md)
     - [How to use config in this repository](tools/config.md)
     - [How to use logger in this repository](tools/logger.md)
+    - [How to use trace in this repository](tools/trace.md)

docs/guides/tools/config.md

@@ -7,7 +7,19 @@
 Addendum environment variables to `tools/config/settings.py`:
 ```{.py title="tools/config/settings.py" hl_lines="9"}
 class Settings(BaseSettings):
-    """Environment variables settings."""
+    """Environment variables settings.
+
+    Examples:
+        >>> from tools.config import Settings
+        >>> from tools.logger import Logger, LogType
+        >>>
+        >>> settings = Settings()
+        >>> logger = Logger(
+        >>>     name=__name__,
+        >>>     log_type=LogType.LOCAL if settings.IS_LOCAL else LogType.GOOGLE_CLOUD
+        >>> )
+
+    """
 
     model_config = SettingsConfigDict(
         env_file=(".env", ".env.local"),
@@ -22,7 +34,7 @@ class Settings(BaseSettings):
 ```python
 from fastapi import FastAPI
 
-from tools import Settings
+from tools.config import Settings
 
 
 settings = Settings()

docs/guides/tools/logger.md

@@ -1,5 +1,5 @@
 ```python
-from tools import Logger
+from tools.logger import Logger
 
 
 def main() -> None:

docs/guides/tools/trace.md

@@ -0,0 +1,36 @@
+## Timer
+
+### Decorator
+```{.py hl_lines="6"}
+import time
+
+from tools.trace import Timer
+
+
+@Timer("sleep")
+def sleep(t: int = 1) -> None:
+    time.sleep(t)
+
+
+sleep(1)
+```
+
+!!! NOTE
+    ```sh
+    2038-01-19 03:14:07,000 | DEBUG    | sleep:__exit__:50 - executed in 1000.000000 ms
+    ```
+
+### ContextManager
+```{.py hl_lines="5"}
+import time
+
+from tools.trace import Timer
+
+with Timer("examples"):
+    time.sleep(1)
+```
+
+!!! NOTE
+    ```sh
+    2038-01-19 03:14:07,000 | DEBUG    | examples:__exit__:50 - executed in 1000.000000 ms
+    ```

docs/guides/uv.md

@@ -29,7 +29,7 @@ uv remove ruff
 ## Pin Python Version
 If you want to pin the Python version, run the following command:
 ```sh
-uv pin python 3.12
+uv pin python 3.13
 ```
 
 ## Configuration for uv

docs/index.md

@@ -27,7 +27,9 @@ This repository contains configurations to set up a Python development environme
     │   └── settings.json
     ├── tests/
     │   └── tools/
-    │        └── test__logger.py
+    │        ├── test__config.py
+    │        ├── test__logger.py
+    │        └── test__trace.py
     ├── tools/
     │   ├── config/
     │   │    ├── __init__.py
@@ -41,6 +43,9 @@ This repository contains configurations to set up a Python development environme
     │   │    ├── logger.py
     │   │    ├── style.py
     │   │    └── type.py
+    │   ├── trace/
+    │   │    ├── __init__.py
+    │   │    └── time.py
     │   └── __init__.py
     ├── .dockerignore
     ├── .env.local

mkdocs.yml

@@ -1,4 +1,7 @@
+repo_name: a5chin/python-uv
+repo_url: https://github.com/a5chin/python-uv
 site_name: python-uv
+site_url: https://a5chin.github.io/a5chin
 
 theme:
   name: material
@@ -40,9 +43,6 @@ markdown_extensions:
   - pymdownx.tabbed:
       alternate_style: true
 
-repo_url: https://github.com/a5chin/python-uv
-repo_name: a5chin/python-uv
-
 nav:
   - Home: index.md
   - Getting Started:
@@ -57,10 +57,11 @@ nav:
       - Pyright: guides/pyright.md
       - pre-commit: guides/pre-commit.md
       - Test: guides/test.md
-      - Using tools:
+      - tools:
           - guides/tools/index.md
           - config: guides/tools/config.md
           - logger: guides/tools/logger.md
+          - trace: guides/tools/trace.md
   - Configurations:
       - configurations/index.md
       - uv: configurations/uv.md

pyproject.toml

@@ -21,7 +21,7 @@ dev-dependencies = [
     "mkdocs-material>=9.5.49",
     "pre-commit>=4.0.1",
     "pyright>=1.1.391",
-    "pytest>=8.3.4",
     "pytest-cov>=6.0.0",
+    "pytest>=8.3.4",
     "ruff>=0.8.4",
 ]

pyrightconfig.json

@@ -1,5 +1,5 @@
 {
-    "pythonVersion": "3.12",
+    "pythonVersion": "3.13",
     "pythonPlatform": "All",
     "venv": ".venv",
     "typeCheckingMode": "standard",

ruff.toml

@@ -32,8 +32,8 @@ exclude = [
 line-length = 88
 indent-width = 4
 
-# Assume Python 3.12
-target-version = "py312"
+# Assume Python 3.13
+target-version = "py313"
 
 [lint]
 # Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.

tests/conftest.py

@@ -1,6 +1,6 @@
 import pytest
 
-from tools import Settings
+from tools.config import Settings
 
 
 @pytest.fixture

tests/tools/test__config.py

@@ -1,7 +1,6 @@
 import pytest
 
-from tools import Settings
-from tools.config import FastAPIKwArgs
+from tools.config import FastAPIKwArgs, Settings
 
 
 class TestSettings:

tests/tools/test__logger.py

@@ -1,4 +1,4 @@
-from tools import Logger, LogType
+from tools.logger import Logger, LogType
 
 
 class TestLocalLogger:

tests/tools/test__trace.py

@@ -0,0 +1,14 @@
+from tools.trace import Timer
+
+
+class TestTimer:
+    """Test class for Timer."""
+
+    def test_contextmanager(self) -> None:
+        """Test for ContextManager."""
+        with Timer("ContextManager"):
+            pass
+
+    @Timer("Decorator")
+    def test_decorator(self) -> None:
+        """Test for Decorator."""

tools/__init__.py

@@ -1,10 +1 @@
 """Tools."""
-
-from tools.config import Settings
-from tools.logger import Logger, LogType
-
-__all__ = [
-    "LogType",
-    "Logger",
-    "Settings",
-]

tools/config/settings.py

@@ -6,7 +6,19 @@
 
 
 class Settings(BaseSettings):
-    """Environment variables settings."""
+    """Environment variables settings.
+
+    Examples:
+        >>> from tools.config import Settings
+        >>> from tools.logger import Logger, LogType
+        >>>
+        >>> settings = Settings()
+        >>> logger = Logger(
+        >>>     name=__name__,
+        >>>     log_type=LogType.LOCAL if settings.IS_LOCAL else LogType.GOOGLE_CLOUD
+        >>> )
+
+    """
 
     model_config = SettingsConfigDict(
         env_file=(".env", ".env.local"),

tools/logger/logger.py

@@ -7,7 +7,16 @@
 
 
 class Logger(logging.Logger):
-    """Logger."""
+    """Logger.
+
+    Examples:
+        >>> from tools.logger import Logger
+        >>>
+        >>>
+        >>> logger = Logger(__name__)
+        >>> logger.info("Logger")
+
+    """
 
     def __init__(
         self,
@@ -26,11 +35,6 @@ def __init__(
             log_type (LogType, optional): Local or something.
                                           Defaults to LogType.LOCAL.
 
-        Examples:
-            >>> from tools import Logger, LogType
-            >>> local_logger = Logger(name=__name__, log_type=LogType.LOCAL)
-            >>> gc_logger = Logger(name=__name__, log_type=LogType.GOOGLE_CLOUD)
-
         """
         super().__init__(name=name)
 

tools/trace/__init__.py

@@ -0,0 +1,7 @@
+"""Timer."""
+
+from tools.trace.time import Timer
+
+__all__ = [
+    "Timer",
+]