Merge branch 'laike9m:main' into main

Author: GreyElaina

.github/workflows/test.yaml

@@ -0,0 +1,38 @@
+name: Unit Test
+
+on:
+  push:
+    branches: [ main, test ]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up PDM
+        uses: pdm-project/setup-pdm@v3
+        with:
+          python-version: 3.12
+          cache: true
+      - name: Install dependencies
+        run: pdm install
+      - name: Preheat Pyright
+        # If we don't do this, each pytest-xdist process will try to install the
+        # dependencies of Pyright (Node.js packages, pyi). Each installation assumes
+        # it's a clean install, and will error if files already exist.
+        run: pdm run pyright --pythonversion 3.12 challenges/basic-any/solution.py
+        continue-on-error: true
+      - name: Run tests
+        run: pdm run test
+      - name: Send failure email
+        if: failure()
+        uses: dawidd6/action-send-mail@v3
+        with:
+          subject: Test Failure in ${{ github.repository }}
+          body: The test for ${{ github.repository }} failed.
+          to: ${{ secrets.MAIL_USERNAME }}
+          from: GitHub
+          server_address: smtp.gmail.com
+          username: ${{ secrets.MAIL_USERNAME }}
+          password: ${{ secrets.MAIL_PASSWORD }}

.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+  - repo: https://github.com/rtts/djhtml
+    rev: '3.0.6'
+    hooks:
+      - id: djhtml
+        entry: djhtml --tabwidth 2 templates

README.md

@@ -1,25 +1,53 @@
 # Python Type Challenges
 
-Learn Python 🐍 typing (type hints) by completing online challenges.
+Master Python typing (type hints) with interactive online exercises!
 
-🌟🌟 Click **[HERE](https://python-type-challenges.zeabur.app)** to start 🌟🌟
+Click 👉👉 **[HERE](https://python-type-challenges.zeabur.app)** to start
 
 ![](docs/images/usage.gif)
 
 Happy typing!
 
+## How to Run Locally
+
+You can also run the challenge locally. To do that, clone the project and install necessary dependencies, using either PDM or `requirements.txt`.
+
+[PDM](https://pdm-project.org/) is recommended. After [installing PDM](https://pdm.fming.dev/latest/#installation), you can install needed dependencies with the following steps:
+
+```bash
+pdm install
+pdm dev  # This will run a local Flask server
+```
+
+Alternatively, you can install dependencies with `requirements.txt`:
+
+```bash
+pip install -r requirements.txt
+flask run
+```
+
 ## How to Contribute
 
-You're more than welcome to contribute new challenges!
+- **Add new challenges**
 
-All challenges live under the [`challenges/`](https://github.com/laike9m/Python-Type-Challenges/tree/main/challenges) directory, and it's pretty easy to add a new one: **you only need to create a new folder, add a `question.py`, and that's it**. See [here](docs/Contribute.md) for a detailed guidance.
+  Adding a new challenge is pretty simple: **you only need to create a new folder, add a `question.py` and a `solution.py`, and that's it**. See [here](docs/Contribute.md) for a detailed guidance.
+
+- **New features & bug fixes**
+
+  If you want to fix a bug or add a new feature, follow the [guidance](docs/Development.md).
 
 ## Got Questions?
 
 For general questions, you can post them in [Discussions](https://github.com/laike9m/Python-Type-Challenges/discussions).
 
 If you met issues or want to suggest a new feature/improvement, feel free to [open a new issue](https://github.com/laike9m/Python-Type-Challenges/issues/new).
 
+## Sponsor
+
+[![Deployed on Zeabur](https://zeabur.com/deployed-on-zeabur-dark.svg)](https://zeabur.com?referralCode=laike9m&utm_source=laike9m&utm_campaign=oss)
+
 ## Credits
 
 This project is inspired [Type Exercise in Rust](https://github.com/skyzh/type-exercise-in-rust/) by [@skyzh](https://github.com/skyzh), and [type-challenges](https://github.com/type-challenges/type-challenges/) by [@antfu](https://github.com/antfu).
+
+Social graph [images](https://unsplash.com/photos/person-sitting-front-of-laptop-mfB1B1s4sMc) come from [Christin Hume](https://unsplash.com/@christinhumephoto).

app.py

@@ -1,10 +1,41 @@
-from flask import Flask, redirect
-from views import views
+import threading
+from flask import Flask, redirect, request, send_from_directory
+from typing import cast
 
-app = Flask(__name__)
+from views import views, challenge
+from views.sitemap import sitemapper
+
+app = Flask(
+    __name__,
+    template_folder="templates",
+    static_folder="static",
+    static_url_path="/static",
+)
 app.register_blueprint(views.app_views)
+sitemapper.init_app(app)
 
 
 @app.errorhandler(404)
 def page_not_found(e):
     return redirect("/")
+
+
+@app.route("/robots.txt")
+def robots_txt():
+    return send_from_directory(cast(str, app.static_folder), request.path[1:])
+
+
+@app.route("/sitemap.xml")
+def r_sitemap():
+    return sitemapper.generate()
+
+
+# Temporary solution for
+# https://github.com/laike9m/Python-Type-Challenges/issues/49
+threading.Thread(
+    target=challenge.challenge_manager.run_challenge,
+    kwargs={
+        "key": challenge.ChallengeKey(challenge.Level("basic"), "any"),
+        "user_code": "",
+    },
+).start()

challenges/advanced-callable-protocol/question.py

@@ -0,0 +1,33 @@
+"""
+TODO:
+
+Define a callable type that accepts a string parameter called `name` and returns None.
+
+HINT: Use Protocol
+"""
+
+
+class SingleStringInput:
+    ...
+
+
+## End of your code ##
+def accept_single_string_input(func: SingleStringInput) -> None:
+    func(name="name")
+
+
+def string_name(name: str) -> None:
+    ...
+
+
+def string_value(value: str) -> None:
+    ...
+
+
+def return_string(name: str) -> str:
+    return name
+
+
+accept_single_string_input(string_name)
+accept_single_string_input(string_value)  # expect-type-error
+accept_single_string_input(return_string)  # expect-type-error

challenges/advanced-callable-protocol/solution.py

@@ -0,0 +1,35 @@
+"""
+TODO:
+
+Define a callable type that accepts a string parameter called `name` and returns None.
+
+HINT: Use Protocol
+"""
+from typing import Protocol
+
+
+class SingleStringInput(Protocol):
+    def __call__(self, name: str) -> None:
+        ...
+
+
+## End of your code ##
+def accept_single_string_input(func: SingleStringInput) -> None:
+    func(name="name")
+
+
+def string_name(name: str) -> None:
+    ...
+
+
+def string_value(value: str) -> None:
+    ...
+
+
+def return_string(name: str) -> str:
+    return name
+
+
+accept_single_string_input(string_name)
+accept_single_string_input(string_value)  # expect-type-error
+accept_single_string_input(return_string)  # expect-type-error

challenges/advanced-callable/question.py

@@ -0,0 +1,27 @@
+"""
+TODO:
+
+Define a decorator that wraps a function and returns a function with the same signature.
+The decorator takes an argument `message` of type string
+"""
+
+
+def decorator(message):
+    ...
+
+
+## End of your code ##
+@decorator(message="x")
+def foo(a: int, *, b: str) -> None:
+    ...
+
+
+@decorator  # expect-type-error
+def bar(a: int, *, b: str) -> None:
+    ...
+
+
+foo(1, b="2")
+foo(1, "2")  # expect-type-error
+foo(a=1, e="2")  # expect-type-error
+decorator(1)  # expect-type-error

challenges/advanced-decorator/question.py

@@ -0,0 +1,37 @@
+"""
+TODO:
+
+Define a decorator that wraps a function and returns a function with the same signature.
+The decorator takes an argument `message` of type string
+"""
+from typing import TypeVar
+from collections.abc import Callable
+
+# Python < 3.12
+#
+# T = TypeVar("T", bound=Callable)
+#
+# def decorator(func: T) -> T:
+#     return func
+
+
+# Python >= 3.12
+def decorator[T: Callable](message: str) -> Callable[[T], T]:
+    ...
+
+
+## End of your code ##
+@decorator(message="x")
+def foo(a: int, *, b: str) -> None:
+    ...
+
+
+@decorator  # expect-type-error
+def bar(a: int, *, b: str) -> None:
+    ...
+
+
+foo(1, b="2")
+foo(1, "2")  # expect-type-error
+foo(a=1, e="2")  # expect-type-error
+decorator(1)  # expect-type-error

challenges/advanced-decorator/solution.py

@@ -0,0 +1,16 @@
+class MyClass:
+    def __init__(self, x: int) -> None:
+        self.x = x
+
+    # TODO: Fix the type hints of `copy` to make it type check
+    def copy(self) -> MyClass:
+        copied_object = MyClass(x=self.x)
+        return copied_object
+
+
+## End of your code ##
+
+from typing import assert_type
+
+inst = MyClass(x=1)
+assert_type(inst.copy(), MyClass)