docs: add full documentation for all functions in tienda/views.py

Agent-Logs-Url: https://github.com/dsaub/proyecto-final/sessions/49df17c8-213a-4e23-adfe-465a0104f6a3

Co-authored-by: dsaub <54474838+dsaub@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2026-04-09 10:35:28 +00:00
committed by GitHub
parent 47ea00c822
commit ed92991872
66 changed files with 2580 additions and 0 deletions
+33
View File
@@ -0,0 +1,33 @@
# `_get_client_ip`
**Archivo:** `tienda/views.py`
**Tipo:** Función auxiliar privada
## Descripción
Obtiene la dirección IP real del cliente a partir de la petición HTTP.
Cuando la aplicación se encuentra detrás de un proxy inverso (como Nginx), la IP real del cliente viaja en la cabecera `X-Forwarded-For`. Esta función la extrae y devuelve la primera IP de la cadena. Si dicha cabecera no está presente, devuelve el valor de `REMOTE_ADDR`.
## Firma
```python
def _get_client_ip(request: HttpRequest) -> str:
```
## Parámetros
| Nombre | Tipo | Descripción |
|-----------|---------------|--------------------|
| `request` | `HttpRequest` | Petición HTTP de Django. |
## Retorno
Cadena de texto con la dirección IP del cliente. Devuelve una cadena vacía si no hay ninguna disponible.
## Uso interno
Llamada desde [`login`](./login.md), [`register`](./register.md) y [`logout`](./logout.md) para incluir la IP del cliente en los registros de auditoría.
> [!CAUTION]
> La cabecera `X-Forwarded-For` puede ser falsificada por un cliente malicioso. Confiar en ella para control de acceso o límites de tasa sin validación adicional conlleva riesgos de seguridad.