v3.0.0 Beta #116
Replies: 14 comments 44 replies
-
|
This check is wrong and is throwing an error if zone ID is specified but NOT account ID. In fact I think it throws an error on ANY combination of account ID and zone ID being set or not set. :) Did a PR: |
Beta Was this translation helpful? Give feedback.
-
|
@et304383 whether it matters is entirely up to you. i'm looking to narrow down which part of the system is causing the unintended validation here as this isn't as simple as your PR solution of "just delete these lines". there is a reason the validation is ending up there due to one of the generational rules that we have in place. the more time i have to invest in putting together a reproduction case to identify how to invoke the use case here, the longer it remains a bug. if i have a simple copy/paste report that i can run, we skip all the guess work and i can get to triaging why it has broken instead. |
Beta Was this translation helpful? Give feedback.
-
|
@jacobbednarz I am sorry but I don't have a ready example to give you. I reverted to version 2 of the package to move forward. Regardless, your logic says the two values are mutually exclusive in that you must specify one or the other, but it currently blocks ANY combination of account or zone. Try calling ruleset create with account or zone, see what happens? I mean if your code generation logic is so complex that you cannot find what is generating the bad lines that I suggested removing, that's an entirely different problem. You asked for feedback, I gave you feedback. This API (ruleset API) is non-functional in its current state. @DoingItNow agrees. Do you not have a single regression test that is calling any of these ruleset APIs? You'd see the issue pretty quickly if so. |
Beta Was this translation helpful? Give feedback.
-
|
So we can move forward here is an example The validation logic is flawed as pointed out. Again here is the reference. As @et304383 said, calling literally anything from the CRUD operation from @et304383 which version 2 of the SDK are you using? I will need to pip install that particular version as well |
Beta Was this translation helpful? Give feedback.
-
|
thanks @DoingItNow - we identified the issue and will be fixed in the next beta. if you want it today, you can use 6b99b55. |
Beta Was this translation helpful? Give feedback.
-
|
Sweet thanks for the update |
Beta Was this translation helpful? Give feedback.
-
|
Hello, I am just migrating a very simple script from v2 to v3: the script iterates over all email routing rules in one specific zone and changes the destination address by updating the existing rule. I am unable to get pagination working as expected. Currently, only the first and second page are processed, but there are four pages. There are 77 rules, each page returns 20 of those. The script is pretty simple, here it is. from pprint import pprint
import cloudflare
from cloudflare import Cloudflare
from cloudflare.types.email_routing import ActionParam, MatcherParam
def main():
token = "REMOVED"
client = Cloudflare(api_token=token)
zone_id = "REMOVED"
current_email_address = "REMOVED"
new_email_address = "REMOVED"
for email_route in client.email_routing.rules.list(zone_identifier=zone_id):
pprint("old rule")
pprint(email_route)
if (
email_route.id
and email_route.actions
and len(email_route.actions) == 1
and email_route.actions[0].type == "forward"
and len(email_route.actions[0].value) == 1
and email_route.actions[0].value[0] == current_email_address
and email_route.matchers
and len(email_route.matchers) == 1
and email_route.matchers[0].type == "literal"
and email_route.matchers[0].field == "to"
):
try:
new_email_route = client.email_routing.rules.update(
rule_identifier=email_route.id,
zone_identifier=zone_id,
actions=[ActionParam(type="forward", value=[new_email_address])],
matchers=[
MatcherParam(
field="to",
type="literal",
value=email_route.matchers[0].value,
)
],
)
pprint("new rule")
pprint(new_email_route)
except cloudflare.APIError as e:
exit(e.message)
if __name__ == "__main__":
main()Here is the debug output.
As you can see, only the first and second page are fetched ( The README has the following sentence and the example is similar to my code.
Am I using the library wrong or is there a problem with the example in the README? Any help would be appreciated. Kind regards, Markus |
Beta Was this translation helpful? Give feedback.
-
|
@markus289 to clarify that I'm understanding correctly - you're saying that pagination works after the second I do agree that looks incorrect, |
Beta Was this translation helpful? Give feedback.
-
Yes, this is correct. The change for This is only a partial solution as the type of the functions becomes wrong. Also, there are multiple copies of this function in This works as no new iterator is yielded when the API returns a page without any rules (e.g. page_5.txt) |
Beta Was this translation helpful? Give feedback.
-
|
@markus289 this has been fixed, can you try out the |
Beta Was this translation helpful? Give feedback.
-
|
@RobertCraigie I can confirm that pagination now works as expected. Thank you for the quick solution. EDIT: for reference, I used commit d0b53fb in that |
Beta Was this translation helpful? Give feedback.
-
|
Awesome, thank you for the detailed bug report and confirming the fix worked! |
Beta Was this translation helpful? Give feedback.
-
|
Looking for command |
Beta Was this translation helpful? Give feedback.
-
|
cli4 is not included in the generated SDKs. instead, the 2.x version of cli4 is available at https://pypi.org/project/cloudflare-cli4/. there will be a CLI tool in the future however it is unlikely to be python based. |
Beta Was this translation helpful? Give feedback.
-
|
I am struggling with the usability of this library for updating things. For example I want to add an email address to an access group (example below). Is this the right way? Do I have to specify all the parameters to update() individually? Is there a way to just pass the whole group back in? |
Beta Was this translation helpful? Give feedback.
-
|
that's the right approach at a high level. fetch the resources you need, modify the parameters and then send the update to the API. |
Beta Was this translation helpful? Give feedback.
-
|
I was running through the testsuite for version 3.0.1 with python 3.11 and python 3.12 and tests/test_client.py::TestAsyncCloudflare::test_copy_build_request intermittently fails |
Beta Was this translation helpful? Give feedback.
-
|
I notice that the create test for the Images API is marked as broken in the tests: https://github.com/cloudflare/cloudflare-python/blob/main/tests/api_resources/images/test_v1.py#L25 I've been trying to upload images for a bit, and it seems like the API is expecting a multipart/form-data for the file contents (In cases where you're sending a file), but the client is sending it all as JSON, causing an error 5415 ("Must be uploaded as a form, not as raw image data. Please use multipart/form-data format"). Is there an estimated timeline for this to be fixed? |
Beta Was this translation helpful? Give feedback.
-
|
the pending test is unrelated to the issue here. this is pending a fix in the schemas by the service team in order to have this represented correctly in the SDKs. there is no current ETA but the team is aware of it. |
Beta Was this translation helpful? Give feedback.
-
|
Hi, I'm having some trouble pulling a zone inventory using the 3.x SDK, the setting types id doesn't work as expected and I wasn't able to figure out why. I was looking at this part of the documentation related to zones settings. Here's an example of code that will fail with an from cloudflare import Cloudflare, CloudflareError
from cloudflare.types.zones import (
WAF,
SettingGetResponse
)
client = Cloudflare(
api_token=<API_TOKEN>,
)
zones = client.zones.list()
inventory = []
for zone in zones:
inventory.append(
{
"name": zone.name,
"status": zone.status,
"id": zone.id,
"owner": zone.owner.to_dict(),
"meta": zone.meta.to_dict(),
# Fails unless I pass the string "waf" as a positional argument
"waf_setting": client.zones.settings.get(WAF.id, zone_id=zone.id),
# I kind of expected this to fail but still curious if this is something you can handle
"settings": client.zones.settings.get(SettingGetResponse.id, zone_id=zone.id),
}
)FWIW I'm interested in pulling for each zone the WAF settings (on/off) and the rules enabled and the same for the Bot Control settings and DDoS settings among other things, if you could tell me the best approach to get there that'd be great too. Navigating through the SDK API documentation could be easier with a table of content, if that's something you could add too. Thanks |
Beta Was this translation helpful? Give feedback.
-
|
fetching all zone settings isn't something we encourage (hence the change to individual settings). you should fetch the settings you care about and append those directly. wrt the table of contents; did you see https://github.com/cloudflare/cloudflare-python/blob/main/api.md ? |
Beta Was this translation helpful? Give feedback.
-
|
Thanks, I am not trying to fetch all settings (see comment in the code), I was curious if But even fetching a single setting following the instructions in the documentation isn't working.
Yes, I did read and use the examples from this page, I'm only suggesting to add some kind of table of content at the top to help the reader understand the structure and navigate the document quickly to find the information they need. |
Beta Was this translation helpful? Give feedback.
-
|
i think the misunderstanding here is that
i've just tried this on the latest version and it seems to be working as expected for me. (i'm not using types here for simplicity and my editor currently doing funny things with the multiple local versions) from cloudflare import Cloudflare
import os
client = Cloudflare()
setting = client.zones.settings.get(setting_id="always_use_https", zone_id=os.environ.get("CLOUDFLARE_ZONE_ID"))
print(setting)
#=> AlwaysUseHTTPS(id='always_use_https', value='on', editable=True, modified_on=datetime.datetime(2022, 4, 22, 5, 28, 52, 196770, tzinfo=TzInfo(UTC)))does that make the usage clearer? |
Beta Was this translation helpful? Give feedback.
-
|
Reading your response I'm not sure how I missed it! :-) Thanks @jacobbednarz ! |
Beta Was this translation helpful? Give feedback.
-
|
great to hear. if in doubt for further usage, you can also check out the examples used in the tests. example for zones: https://github.com/cloudflare/cloudflare-python/blob/main/tests/api_resources/zones/test_settings.py |
Beta Was this translation helpful? Give feedback.
-
|
I have noticed that the new version 3.0 has significant longer import time. Is it something expected? I am testing it on a raspberry pi 4 by the way. |
Beta Was this translation helpful? Give feedback.
-
|
Hey @randy3k, I'm seeing faster import times on my machine but it is still a lot slower to import than v2... which pydantic version do you have installed? |
Beta Was this translation helpful? Give feedback.
-
|
python 3.11.2 |
Beta Was this translation helpful? Give feedback.
-
|
Hey @randy3k, would you mind trying this version out and letting me know what the import time looks like for you? On my machine, importing, instantiating the client and referencing a resource is much faster. Before: After: |
Beta Was this translation helpful? Give feedback.
-
|
Ya, it is much faster now. Before After Note that it is running on a raspberry pi 4, so it is expected to be slower. |
Beta Was this translation helpful? Give feedback.
-
|
I'm unable to update rulesets current_rule = cf.rulesets.phases.get("http_request_firewall_managed", zone_id=zone_id)
for rule in current_rule.rules:
if isinstance(rule, ExecuteRule) and rule.action_parameters.id == CLOUDFLARE_OWASP_RULESET:
# Mutate
break
cf.rulesets.phases.update("http_request_firewall_managed", rules=current_rule.rules, zone_id=zone_id)Result: Calling Package cloudflare version 3.1.0 |
Beta Was this translation helpful? Give feedback.
-
|
I cannot create a ratelimit rule because the parameter does not have a ratelimit option，Package cloudflare version 3.1.0
|
Beta Was this translation helpful? Give feedback.
-
|
Thanks for the report, will look into fixing the schemas! Note that in the meantime you should still be able to pass |
Beta Was this translation helpful? Give feedback.
-
|
A fresh venv running cloudflare sdk is not working. pydantic throws an error on import. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for the report, can you share the stack trace? This seems to be working for me on Python 3.9 |
Beta Was this translation helpful? Give feedback.
-
|
@mmusket I can reproduce the error you're seeing, it looks like I've reported this to the Pydantic team. |
Beta Was this translation helpful? Give feedback.
-
|
Ah great, was on my todo list today. It is very easy to reproduce as you have observed. Thanks for forwarding. |
Beta Was this translation helpful? Give feedback.
-
Forward annotations issues with Pydantic 2.10A pretty obscure issue is happening right now with Pydantic 2.10. This is due to the internal implementation of the
Edit: Just noticed that @RobertCraigie you are part of the Stainless API team. Let me know if you need more details on how to work this out together. Technical details of the issueIn the automatically generated types of the Python cloudflare SDK, you are making use of type aliases and the old cloudflare-python/src/cloudflare/types/request_tracers/trace.py Lines 3 to 11 in 7d935bd When using Now coming back to the SDK, the # Original source code: https://github.com/cloudflare/cloudflare-python/blob/7d935b/src/cloudflare/types/request_tracers/trace_item.py#L44-L47
from .trace import Trace
# At this point, `Trace` is equal to `List[ForwardRef('TraceItem')]`, but the ForwardRef instance
# inside the List doesn't have the cached evaluated value
if PYDANTIC_V2:
TraceItem.model_rebuild()
# Because 'TraceItem' is available here when calling model_rebuild(), the ForwardRef instance
# now has the cached value saved for future reuse.Then, the And the following happens:
Potential fixesIn general, it is best to avoid using aliases with forward references. Consider the following example: # module1.py
from typing import List
Alias = List['SomeType']
SomeType = int
# module2.py
from module1 import Alias
from pydantic import BaseModel
class Model(BaseModel):
a: AliasAt runtime, from module1 import Alias
from pydantic import BaseModel
class Model(BaseModel):
a: List['SomeType']because # module1.py
from typing import List
from typing_extensions import TypeAliasType
Alias = TypeAliasType('Alias', List['SomeType'])
SomeType = int
# module2.py
from module1 import Alias
from pydantic import BaseModel
class Model(BaseModel):
a: Alias |
Beta Was this translation helpful? Give feedback.
-
|
ah thanks for the incredibly detailed write up @Viicos! I appreciate the deep dive :) sounds like changing the codegen to explicitly use
I do wonder if it'd make sense for Pydantic to cache the evaluations itself? or would that introduce a leak? |
Beta Was this translation helpful? Give feedback.
-
We can't really do much on that side, as this caching mechanism is implemented in the |
Beta Was this translation helpful? Give feedback.
-
|
For this reason, I would also recommend a couple things to improve the codegen implementation:
|
Beta Was this translation helpful? Give feedback.
-
|
Thanks Victorien! For what it's worth we'd already updated our codegen to use I'll update codegen to use |
Beta Was this translation helpful? Give feedback.
-
|
any chance of getting release that fixes this issue ? |
Beta Was this translation helpful? Give feedback.
-
|
With the release of httpx 0.28.0 this library fails with: Which I assume is due to the removal of the proxies argument which has been deprecated prior to this https://github.com/encode/httpx/releases/tag/0.28.0 |
Beta Was this translation helpful? Give feedback.
-
|
EDIT: removed the redundant part on Pydantic failing. So this is basically just +1 |
Beta Was this translation helpful? Give feedback.
-
|
Because both pydantic and httpx have had breaking changes, if you pin httpx as well it works fine but ultimately needs to be resolved by Cloudflare. |
Beta Was this translation helpful? Give feedback.
-
|
Please try with |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Warning
v3.xof this library is a ground-up rewrite of the SDK, using code generation from our OpenAPI spec.This package should be in a usable state for many projects, but expect frequent minor breaking
changes as we rename methods and types until GA. If this isn't suitable for you project, we recommend
pinning to the
2.xreleases for now.We're working on a new major version of our SDK and are excited to have you test it!
Please use this discussion page as a place to report issues and feedback about the new release.
Install
Important
You may need to uninstall the package if you've installed it previously due to how
piphandles linking.Things we would like feedback on
Beta Was this translation helpful? Give feedback.
All reactions