Deadlock in mutually exclusive account_id and zone_id resolution raises erroneous ValueError
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 45/100
Research direction
Search the codebase for _get_account_id_path_param, _get_zone_id_path_param, and the mutually exclusive account_id/zone_id pattern; begin with zero_trust.access.applications.list. Reproduce the account_id-only call described in the issue, then verify that requests with exactly one parameter no longer raise the missing-parameter ValueError while supplying both still raises the mutual-exclusion error.
Written by the indexing model from the issue text.
Description
Confirm this is a Python library issue and not an underlying Cloudflare API issue.
- 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:
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
ValueErrorfor 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
ValueErrors. - Modify the
_get_*_path_param()methods so they returnNoneinstead 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.
- Initalize the Cloudflare client with an API key
- Retrieve the target account ID via searching or just first available, e.g.
account_id = next(tier(client.accounts.list())).id - Attempt to fetch the applications list using only the
account_id:applications = client.zero_trust.access.applications.list(account_id=account_id) ValueErrorincorrectly raised:Missing zone_id argument; Please provide it at the client level, e.g. Cloudflare(zone_id='abcd') or per method.
Code snippets
OS
macOS 15.7.4
Python version
3.13.11
Library version
5.0.0b2
- Dominant language
- Python
- Stars
- 509
- Forks
- 150
- Avg merge
- 3h 15m
- Merged PRs (30d)
- 1
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from cloudflare/cloudflare-python
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
cloudflare/cloudflare-python#2747 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
cloudflare/cloudflare-python#2718 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
cloudflare/cloudflare-python#2692 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
cloudflare/cloudflare-python#2679 · 4 comments · 5 reactions ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
cloudflare/cloudflare-python#2745 · 1 comment ·
All issues in cloudflare/cloudflare-python
Similar issues
-
Add: hunch Open
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
AbdelStark/awesome-typesafe#104 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
DiamondLightSource/dodal#2211 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
openml/openml-python#1749 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
sipyourdrink-ltd/bernstein#6191 ·