add lambda logo, fold sections, add python/error/log snippets
- Pull the rethink lambda logo (assets/img/logo.svg) into docs/assets and wire it as theme.logo + favicon — matches the Gitea brand mark. - standards.md: fold six thin sections into three fuller ones (Files and style / Documentation / Quality and error handling), each illustrated with python snippets, a flake8 output block, Do/Don't tabbed examples, a traceback, and a log line. Admonitions for the run-it-locally tip and the lib-logging note. - libraries.md: add a collapsible 'using a library' example (pyproject pin + import/usage python snippet). Verified in-browser: logo renders in the header, snippets/tabs/traceback/ log blocks render against the dark theme, libraries example expands. mkdocs build --strict clean. Signed-off-by: disqualifier <dev@disqualifier.me>
This commit is contained in:
parent
da47923088
commit
142a0dbff6
10
docs/assets/logo.svg
Normal file
10
docs/assets/logo.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 9.0 KiB |
@ -11,10 +11,44 @@ the repo, where the README and tags live.
|
|||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
|
Pin a tag in your dependencies — never an unpinned branch:
|
||||||
|
|
||||||
```
|
```
|
||||||
<lib> @ git+https://git.rethinkstudios.io/rethink-public/<lib>.git@<tag>
|
<lib> @ git+https://git.rethinkstudios.io/rethink-public/<lib>.git@<tag>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
??? example "Using a library — install, import, go"
|
||||||
|
|
||||||
|
Add it to your project's deps (e.g. `pyproject.toml`):
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[project]
|
||||||
|
dependencies = [
|
||||||
|
"aioweb @ git+https://git.rethinkstudios.io/rethink-public/aioweb.git@v0.3.1",
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
Then use it — the README in each repo has the real surface; this is the shape:
|
||||||
|
|
||||||
|
```python
|
||||||
|
import asyncio
|
||||||
|
|
||||||
|
from aioweb import Session
|
||||||
|
|
||||||
|
|
||||||
|
async def main() -> None:
|
||||||
|
"""fetch a page through the shared async http session"""
|
||||||
|
async with Session() as web:
|
||||||
|
resp = await web.get("https://example.test")
|
||||||
|
print(resp.status, len(resp.content))
|
||||||
|
|
||||||
|
|
||||||
|
asyncio.run(main())
|
||||||
|
```
|
||||||
|
|
||||||
|
Need to bump a lib? Change the `@<tag>` and reinstall — versions live with the
|
||||||
|
lib, not in these docs.
|
||||||
|
|
||||||
<div id="lib-list" markdown="0">
|
<div id="lib-list" markdown="0">
|
||||||
<p class="lib-status">Loading libraries from Gitea…</p>
|
<p class="lib-status">Loading libraries from Gitea…</p>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@ -3,40 +3,123 @@
|
|||||||
The house standards every Rethink Studios project follows. They keep our code
|
The house standards every Rethink Studios project follows. They keep our code
|
||||||
consistent, readable, and predictable across the whole suite.
|
consistent, readable, and predictable across the whole suite.
|
||||||
|
|
||||||
## File hygiene
|
## Files and style
|
||||||
|
|
||||||
- Files end with a **single trailing newline** (LF / Unix line endings).
|
- Files end with a **single trailing newline** (LF / Unix line endings), and
|
||||||
- **No trailing whitespace** on any line.
|
carry **no trailing whitespace** on any line.
|
||||||
|
- **4 spaces** for indentation by default. Respect language norms — TS/JS use
|
||||||
|
**2 spaces**, Go uses **tabs** — and when editing an existing file, follow that
|
||||||
|
file's existing indentation.
|
||||||
|
- **flake8 clean**, max line length **120**. **Type hints** on public functions.
|
||||||
|
|
||||||
## Indentation
|
A well-formed module — module docstring, type hints, lowercase-start docstring:
|
||||||
|
|
||||||
- **4 spaces** by default.
|
```python
|
||||||
- Respect language norms: TS/JS use **2 spaces**, Go uses **tabs**.
|
"""async key/value store backed by a single json file"""
|
||||||
- When editing an existing file, follow that file's existing indentation.
|
|
||||||
|
|
||||||
## Docstrings and comments
|
from pathlib import Path
|
||||||
|
|
||||||
- Public functions get a **docstring**. Style: **lowercase-start, no trailing
|
|
||||||
period**.
|
def load_state(path: Path) -> dict[str, str]:
|
||||||
- Keep inline comments minimal — prefer docstrings. Use an inline comment only
|
"""read the json state file, returning an empty dict if it's missing"""
|
||||||
|
if not path.exists():
|
||||||
|
return {}
|
||||||
|
return _read_json(path)
|
||||||
|
```
|
||||||
|
|
||||||
|
flake8 tells you the moment you drift — keep the tree clean:
|
||||||
|
|
||||||
|
```text
|
||||||
|
$ flake8
|
||||||
|
./aiokv/store.py:14:80: E501 line too long (96 > 79 characters)
|
||||||
|
./aiokv/store.py:22:1: F401 'json' imported but unused
|
||||||
|
./aiokv/store.py:31:5: E303 too many blank lines (3)
|
||||||
|
```
|
||||||
|
|
||||||
|
!!! tip "Run it locally"
|
||||||
|
Wire the shared config into an alias so every project lints the same way:
|
||||||
|
`alias flake8='flake8 --config ~/.config/flake8'` (max line 120). See the
|
||||||
|
[Workflow](workflow.md#handy-shell-setup) page.
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
- Public functions get a **docstring** — **lowercase-start, no trailing period**.
|
||||||
|
- Keep inline comments minimal; prefer docstrings. Use an inline comment only
|
||||||
where the code is genuinely complex.
|
where the code is genuinely complex.
|
||||||
- Each module/file states its scope and purpose via a **module docstring**
|
- Each module/file states its scope and purpose via a **module docstring**
|
||||||
(header string) — **not** a license or copyright header.
|
(header string) — **not** a license or copyright header.
|
||||||
|
- Every library and project has a **README** with the install line, what it does,
|
||||||
|
and a usage example.
|
||||||
|
|
||||||
## READMEs
|
=== "Do"
|
||||||
|
|
||||||
Every library and project has a defined **README** covering:
|
```python
|
||||||
|
def mask_secret(value: str, keep: int = 4) -> str:
|
||||||
|
"""mask all but the last ``keep`` characters of a secret"""
|
||||||
|
if len(value) <= keep:
|
||||||
|
return "*" * len(value)
|
||||||
|
return "*" * (len(value) - keep) + value[-keep:]
|
||||||
|
```
|
||||||
|
|
||||||
- the install line,
|
=== "Don't"
|
||||||
- what it does,
|
|
||||||
- a usage example.
|
|
||||||
|
|
||||||
## Linting and types
|
```python
|
||||||
|
# Masks a secret. <- license-header-style noise, capitalized, trailing period
|
||||||
|
def mask_secret(value, keep=4): # no type hints
|
||||||
|
# loop over the chars and hide them
|
||||||
|
return "*" * (len(value) - keep) + value[-keep:] # crashes if short
|
||||||
|
```
|
||||||
|
|
||||||
- **flake8 clean**, max line length **120**.
|
## Quality and error handling
|
||||||
- **Type hints** on public functions.
|
|
||||||
|
|
||||||
## Error handling
|
**Fail loud** — never swallow exceptions. Catch the **specific** exception and
|
||||||
|
**log** it; don't paper over failures with a bare `except`.
|
||||||
|
|
||||||
- **Fail loud** — never swallow exceptions.
|
=== "Do"
|
||||||
- Catch the **specific** exception, and **log** it.
|
|
||||||
|
```python
|
||||||
|
import logging
|
||||||
|
|
||||||
|
log = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def fetch(url: str) -> bytes:
|
||||||
|
"""fetch ``url``, logging and re-raising on failure"""
|
||||||
|
try:
|
||||||
|
return _client.get(url).content
|
||||||
|
except TimeoutError:
|
||||||
|
log.warning("fetch timed out: %s", url)
|
||||||
|
raise
|
||||||
|
```
|
||||||
|
|
||||||
|
=== "Don't"
|
||||||
|
|
||||||
|
```python
|
||||||
|
def fetch(url):
|
||||||
|
try:
|
||||||
|
return _client.get(url).content
|
||||||
|
except Exception:
|
||||||
|
pass # swallowed — the caller has no idea anything broke
|
||||||
|
```
|
||||||
|
|
||||||
|
When something does break, a loud failure gives you a real traceback to act on:
|
||||||
|
|
||||||
|
```python-traceback
|
||||||
|
Traceback (most recent call last):
|
||||||
|
File "run.py", line 42, in <module>
|
||||||
|
data = fetch("https://example.test/feed")
|
||||||
|
File "aioweb/session.py", line 88, in fetch
|
||||||
|
return self._client.get(url).content
|
||||||
|
TimeoutError: request timed out after 30s
|
||||||
|
```
|
||||||
|
|
||||||
|
…and the log line that precedes it tells you where to look:
|
||||||
|
|
||||||
|
```text
|
||||||
|
2026-06-29 14:03:11,204 WARNING aioweb.session fetch timed out: https://example.test/feed
|
||||||
|
```
|
||||||
|
|
||||||
|
!!! note "Logging belongs to the app, not the library"
|
||||||
|
Libraries **emit only** — `log = logging.getLogger(__name__)` and nothing
|
||||||
|
else. Handlers, levels, and formatting are configured once at the
|
||||||
|
application entry point, so a lib never dictates how its host logs.
|
||||||
|
|||||||
@ -9,6 +9,8 @@ extra_css:
|
|||||||
theme:
|
theme:
|
||||||
name: material
|
name: material
|
||||||
language: en
|
language: en
|
||||||
|
logo: assets/logo.svg
|
||||||
|
favicon: assets/logo.svg
|
||||||
palette:
|
palette:
|
||||||
scheme: slate
|
scheme: slate
|
||||||
primary: custom
|
primary: custom
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user