pyrefdev 2025.6__tar.gz → 2025.7__tar.gz

{pyrefdev-2025.6 → pyrefdev-2025.7}/CHANGELOG.md

@@ -4,6 +4,11 @@
 
 Nothing noticeable unreleased.
 
+## v2025.7
+
+- Added search to [pyref.dev](https://pyref.dev).
+- When the symbol is not found, redirect to the search page.
+
 ## v2025.6
 
 - Added a `-p/--print` flag to the `pyrefdev` CLI to print the URL instead of opening it in the browser.

{pyrefdev-2025.6 → pyrefdev-2025.7}/CLAUDE.md

@@ -6,7 +6,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
 
 The project has several components:
 
-1. **Web Server** (`src/pyrefdev/server.py`): FastAPI application that serves redirects based on symbol lookup. `index.html` is the landing page of the server
+1. **Web Server** (`src/pyrefdev/server.py`): FastAPI application that serves redirects based on symbol lookup. `templates/index.html` is the landing page of the server, `static/styles.css` contains CSS styles
 2. **CLI Tool** (`src/pyrefdev/__main__.py`): Command-line interface that opens documentation in browser
 3. **Indexer** (`src/pyrefdev/indexer/`): Tools for crawling, parsing, and managing documentation mappings
 4. **Mapping System** (`src/pyrefdev/mapping/`): Individual Python files per package containing symbol-to-URL mappings
@@ -48,4 +48,7 @@ pyrefdev-indexer update-landing-page
 
 ## Important Notes
 
+- Do not add tests unless explictly asked to.
+- When creating a new file with content, ensure the file has an extra new line at the end.
+- Do NOT add redundant comments describe what the cod does. When needed, DO add comments that explains "why".
 - Server deployment uses systemd and is configured in `pyrefdev.service`

{pyrefdev-2025.6 → pyrefdev-2025.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyrefdev
-Version: 2025.6
+Version: 2025.7
 Summary: The entry point to Python reference docs
 Project-URL: Homepage, https://pyref.dev
 Project-URL: Source, https://github.com/mangoumbrella/pyref.dev
@@ -51,7 +51,19 @@ It allows you to quickly jump to the official documentation for Python standard
 https://pyref.dev/<fully.qualified.symbol.name>
 ```
 
-Alternatively, you could also `pip install pyrefdev` and run the `pyrefdev` CLI tool.
+You can also search for symbols using:
+
+```
+https://pyref.dev/is?symbol=<SYMBOL>
+```
+
+And if you are feeling lucky, ask it to redirect to the first result:
+
+```
+https://pyref.dev/is?lucky=true&symbol=<SYMBOL>
+```
+
+Lastly, you can `pip install pyrefdev` and run the `pyrefdev` CLI tool.
 
 ## Examples
 

{pyrefdev-2025.6 → pyrefdev-2025.7}/README.md

@@ -14,7 +14,19 @@ It allows you to quickly jump to the official documentation for Python standard
 https://pyref.dev/<fully.qualified.symbol.name>
 ```
 
-Alternatively, you could also `pip install pyrefdev` and run the `pyrefdev` CLI tool.
+You can also search for symbols using:
+
+```
+https://pyref.dev/is?symbol=<SYMBOL>
+```
+
+And if you are feeling lucky, ask it to redirect to the first result:
+
+```
+https://pyref.dev/is?lucky=true&symbol=<SYMBOL>
+```
+
+Lastly, you can `pip install pyrefdev` and run the `pyrefdev` CLI tool.
 
 ## Examples
 

pyrefdev-2025.7/src/pyrefdev/_version.py

@@ -0,0 +1 @@
+version = "2025.7"

pyrefdev-2025.7/src/pyrefdev/server.py

@@ -0,0 +1,116 @@
+from fastapi import FastAPI, Request
+from fastapi.responses import RedirectResponse, PlainTextResponse
+from fastapi.staticfiles import StaticFiles
+from fastapi.templating import Jinja2Templates
+import importlib.metadata
+from urllib import parse
+
+from pyrefdev.mapping import MAPPING
+
+
+app = FastAPI()
+app.mount("/static", StaticFiles(directory="static"), name="static")
+
+templates = Jinja2Templates(directory="templates")
+
+
+@app.get("/")
+async def root(request: Request):
+    try:
+        version = importlib.metadata.version("pyrefdev")
+        version = version.split("+")[0]  # Strip the git hash
+    except importlib.metadata.PackageNotFoundError:
+        version = "unknown"
+
+    return templates.TemplateResponse(
+        "index.html", {"request": request, "version": version}
+    )
+
+
+@app.get("/is")
+async def search_symbols(request: Request, symbol: str = "", lucky: bool = False):
+    if not symbol:
+        return templates.TemplateResponse(
+            "search.html", {"request": request, "symbol": "", "results": []}
+        )
+
+    # Search by substring for now.
+    results = []
+    symbol_lower = symbol.lower()
+    for key in MAPPING.keys():
+        if symbol_lower in key.lower():
+            fragment = parse.urlparse(MAPPING[key]).fragment
+            if fragment.lower() == key.lower():
+                candidate = fragment
+            else:
+                candidate = key
+            results.append({"symbol": candidate, "url": MAPPING[key]})
+
+    def ranking_key(result):
+        symbol_path = result["symbol"]
+        components = symbol_path.split(".")
+        num_components = len(components)
+
+        if symbol_path.lower() == symbol_lower:
+            # Prioritize exact case matches over case-insensitive matches (only if search term has uppercase)
+            case_match_priority = 0 if (symbol != symbol_lower and symbol_path == symbol) else 1
+            return (0, 0, case_match_priority, num_components, len(symbol_path), symbol_path)
+
+        # Check for exact component matches (case-insensitive)
+        exact_component_matches = []
+        exact_case_component_matches = []
+        for i, component in enumerate(components):
+            if component.lower() == symbol_lower:
+                # Position from right (0 = rightmost, higher = more left)
+                position_from_right = len(components) - 1 - i
+                exact_component_matches.append(position_from_right)
+                
+                # Check if it's also an exact case match (only if search term has uppercase)
+                if symbol != symbol_lower and component == symbol:
+                    exact_case_component_matches.append(position_from_right)
+
+        if exact_case_component_matches:
+            # Prioritize rightmost position, then exact case matches
+            best_position = min(exact_case_component_matches)
+            return (1, best_position, 0, num_components, len(symbol_path), symbol_path)
+        elif exact_component_matches:
+            # Case-insensitive exact matches
+            best_position = min(exact_component_matches)
+            return (1, best_position, 1, num_components, len(symbol_path), symbol_path)
+
+        # Check for component substring matches
+        component_substring_matches = []
+        for i, component in enumerate(components):
+            if symbol_lower in component.lower():
+                position_from_right = len(components) - 1 - i
+                component_substring_matches.append(position_from_right)
+
+        if component_substring_matches:
+            best_position = min(component_substring_matches)
+            return (2, best_position, 0, num_components, len(symbol_path), symbol_path)
+
+        # Fallback to general substring match
+        return (3, 0, 0, num_components, len(symbol_path), symbol_path)
+
+    results.sort(key=ranking_key)
+
+    # If lucky=true and we have results, redirect to the first (best) result
+    if lucky and results:
+        return RedirectResponse(results[0]["url"])
+
+    return templates.TemplateResponse(
+        "search.html", {"request": request, "symbol": symbol, "results": results}
+    )
+
+
+@app.get("/{symbol}")
+async def redirects(symbol: str, lucky: bool = False):
+    if url := MAPPING.get(symbol):
+        return RedirectResponse(url)
+    if url := MAPPING.get(symbol.lower()):
+        return RedirectResponse(url)
+
+    if lucky:
+        return RedirectResponse(f"/is?symbol={symbol}&lucky=true")
+    else:
+        return RedirectResponse(f"/is?symbol={symbol}")