fix/examples use get davclient #604
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Identified 10 API inconsistencies in davclient.py - Researched URL parameter usage patterns - Found HTTP method wrappers are essential (dynamic dispatch in _query) - Split URL requirements: optional for query methods, required for resource methods - Standardize on 'body' parameter name for dynamic dispatch compatibility - principals() should be renamed search_principals() in async API
- get_davclient() already recommended in all documentation - Supports env vars, config files (12-factor app) - TODO comment already suggests deprecating direct DAVClient() - Propose making get_davclient() primary for both sync and async - Async: aio.get_client() or aio.get_davclient() or aio.connect()
…pers User insight: _query() could call request() directly instead of using dynamic dispatch Three options analyzed: 1. Eliminate wrappers entirely (breaking change) 2. Method registry pattern (breaking change) 3. Keep wrappers, remove dependency (recommended) Recommendation: Option 3 - refactor _query() to use request() directly, but keep method wrappers as thin public convenience API for discoverability and backward compatibility
- Reject 'connect()' naming - no actual connection in __init__ - Propose optional probe parameter for get_davclient() - OPTIONS request to verify server reachable - probe=False for sync (backward compat), probe=True for async (fail fast) - Opt-out available for testing
Changed 5 example files to use the recommended get_davclient() factory function: - examples/scheduling_examples.py - examples/google-flask.py - examples/google-django.py - examples/google-service-account.py - examples/example_rfc6764_usage.py This aligns examples with the official documentation which already recommends get_davclient() throughout.
Member
Author
|
Wrong branch possibly |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update examples to use get_davclient() instead of DAVClient()