reorganize and cleanup

Author: matthiaszimmermann

.devcontainer/devcontainer.json

@@ -15,6 +15,8 @@
                 "python.defaultInterpreterPath": "/workspace/.venv/bin/python",
                 "python.terminal.activateEnvironment": true,
                 "python.formatting.provider": "ruff",
+                "python.analysis.extraPaths": ["./src"],
+                "python.autoComplete.extraPaths": ["./src"],
                 "[python]": {
                     "editor.codeActionsOnSave": {
                         "source.fixAll": "explicit",

examples/flight.py

@@ -8,15 +8,18 @@ readme = "README.md"
 license = { file = "LICENSE" }
 
 dependencies = [
-    "pydantic>=2.10.6,<3.0.0",
-    "pytz>=2024.2,<2025.0"
+    "pydantic[email]>=2.10.6,<3.0.0",
+    "pytz>=2024.2,<2025.0",
 ]
 
 [tool.pytest.ini_options]
-pythonpath = "src"
+pythonpath = ["src"]
 testpaths = ["tests"]
 filterwarnings = ["error"]
 
+[tool.setuptools]
+package-dir = { "" = "src" }
+
 [tool.uv]
 dev-dependencies = [
     "pyright>=1.1.389,<2.0.0",

pyproject.toml

@@ -0,0 +1 @@
+"""Example modules demonstrating various features.""" 

src/examples/__init__.py

@@ -0,0 +1,68 @@
+"""Example of using Pydantic for flight time handling."""
+
+from datetime import datetime, timedelta
+
+from pydantic import BaseModel, Field
+
+
+class Flight(BaseModel):
+    """Represents a flight with departure time and duration."""
+
+    # Departure information
+    departure_airport: str = Field(..., min_length=3, max_length=3)
+    departure_time: datetime
+    departure_utc_offset: int = Field(..., ge=-12, le=14)  # Hours from UTC
+
+    # Arrival information
+    arrival_airport: str = Field(..., min_length=3, max_length=3)
+    arrival_utc_offset: int = Field(..., ge=-12, le=14)  # Hours from UTC
+
+    # Flight duration
+    duration_minutes: int = Field(..., gt=0)
+
+    def calculate_arrival_time(self) -> datetime:
+        """Calculate arrival time based on departure time and duration."""
+        return self.departure_time + timedelta(minutes=self.duration_minutes)
+
+    def to_local_times(self) -> dict[str, datetime]:
+        """Convert times to their respective timezones."""
+        departure_local = self.departure_time + timedelta(
+            hours=self.departure_utc_offset
+        )
+        arrival_local = self.calculate_arrival_time() + timedelta(
+            hours=self.arrival_utc_offset
+        )
+
+        return {
+            "departure_local": departure_local,
+            "arrival_local": arrival_local,
+        }
+
+
+def main() -> None:
+    """Show how to use the Flight class."""
+    # Example flight from New York to London
+    flight = Flight(
+        # Departure information
+        departure_airport="JFK",
+        departure_time=datetime(2024, 3, 25, 20, 0),  # 8 PM
+        departure_utc_offset=-4,  # EDT (UTC-4)
+        # Arrival information
+        arrival_airport="LHR",
+        arrival_utc_offset=0,  # GMT (UTC+0)
+        # Flight duration
+        duration_minutes=420,  # 7 hours
+    )
+
+    # Calculate arrival time
+    arrival_time = flight.calculate_arrival_time()
+    print(f"Arrival time: {arrival_time}")
+
+    # Get local times
+    local_times = flight.to_local_times()
+    print(f"Departure (local): {local_times['departure_local']}")
+    print(f"Arrival (local): {local_times['arrival_local']}")
+
+
+if __name__ == "__main__":
+    main()

src/examples/flight.py

@@ -0,0 +1,35 @@
+"""Example of using Pydantic for user data validation."""
+
+from pydantic import BaseModel, EmailStr, Field
+
+from logging_config import get_logger
+
+logger = get_logger(__name__)
+
+
+class User(BaseModel):
+    """Represents a user with basic profile information."""
+
+    id: int
+    name: str = Field(..., min_length=2)  # Added min_length validation to match test
+    email: EmailStr  # Using EmailStr for email validation
+
+    def to_json(self) -> str:  # noqa: D102
+        return self.model_dump_json()
+
+    @classmethod
+    def from_json(cls, json_str: str) -> "User":  # noqa: D102
+        return cls.model_validate_json(json_str)
+
+
+def main() -> None:
+    """Show how to use the User class."""
+    user = User(id=1, name="Alice Smith", email="alice.smith@example.com")
+
+    print(f"User: {user.name}")  # noqa: T201
+    print(f"Email: {user.email}")  # noqa: T201
+    print(f"ID: {user.id}")  # noqa: T201
+
+
+if __name__ == "__main__":
+    main()

src/examples/user.py

@@ -0,0 +1,13 @@
+import sys
+
+
+def main() -> None:
+    """Print 'hello world' to the console."""
+    if len(sys.argv) >= 2:
+        print(f"hello {sys.argv[1]}!")
+    else:
+        print("hello world!")
+
+
+if __name__ == "__main__":
+    main()