cloudflare / cloudflare/cloudflare-python

Deadlock in mutually exclusive account_id and zone_id resolution raises erroneous ValueError

Aperta
#2,705 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
506
Fork
148
Merge medio
3h 15m
PR unite (30g)
1

Descrizione

### Confirm this is a Python library issue and not an underlying Cloudflare API issue.

- [x] This is an issue with the Python library

### Describe the bug

In multiple classes, there is logic that attempts to extract an `account_id` or `zone_id` from the base client object if they are not provided as arguments. The code then verifies that *exactly one* of these parameters is present.

The current implementation looks like this:
```python
if account_id is None:
account_id = self._client._get_account_id_path_param()
if zone_id is None:
zone_id = self._client._get_zone_id_path_param()
if account_id and zone_id:
raise ValueError("You cannot provide both account_id and zone_id")
```

### The Bug

Both `_get_account_id_path_param()` and `_get_zone_id_path_param()` actively raise a `ValueError` if the client does not possess the requested parameter. This inadvertently creates a deadlock:

* If you only provide one parameter (as required), the attempt to fetch the missing second parameter from the client throws a ValueError.
* To bypass the first two if statements without throwing an error, you would have to provide both parameters (either via arguments or the client). However, doing so triggers the third if statement, throwing a `ValueError` for providing both.

### Expected Behavior

The method should execute successfully, recognizing that exactly one mutually exclusive parameter (`account_id` or `zone_id`) was provided.

### Actual Behavior

A `ValueError` is incorrectly raised no matter what combination of `account_id` or `zone_id` is provided.

### Proposed Solution

There are two straightforward ways to resolve this deadlock:

* Wrap the parameter retrievals in a try...except block that catches and suppresses the `ValueError`s.
* Modify the `_get_*_path_param()` methods so they return `None` instead of throwing an exception when a parameter is missing.

### To Reproduce

I personally encountered this issue using `client.zero_trust.access.applications.list(account_id=account_id)`, but a quick search indicates this pattern appears in roughly 180 occurrences across the codebase.

1. Initalize the Cloudflare client with an API key
2. Retrieve the target account ID via searching or just first available, e.g. `account_id = next(tier(client.accounts.list())).id`
3. Attempt to fetch the applications list using only the `account_id`: `applications = client.zero_trust.access.applications.list(account_id=account_id)`
4. `ValueError` incorrectly raised: `Missing zone_id argument; Please provide it at the client level, e.g. Cloudflare(zone_id='abcd') or per method.`

### Code snippets

```Python

```

### OS

macOS 15.7.4

### Python version

3.13.11

### Library version

5.0.0b2

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Cerca nella codebase _get_account_id_path_param, _get_zone_id_path_param e il pattern account_id/zone_id mutuamente esclusivo; inizia con zero_trust.access.applications.list. Riproduci la chiamata con il solo account_id descritta nell’issue, quindi verifica che le requests con esattamente un parametro non generino più il ValueError relativo al parametro mancante, mentre la fornitura di entrambi continui a generare l’errore di mutua esclusione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
api
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.