githubkit 0.11.0__tar.gz → 0.11.0a1__tar.gz

{githubkit-0.11.0 → githubkit-0.11.0a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: GitHubKit
-Version: 0.11.0
+Version: 0.11.0a1
 Summary: GitHub SDK for Python
 Home-page: https://github.com/yanyongyu/githubkit
 License: MIT
@@ -21,10 +21,10 @@ Provides-Extra: auth-app
 Provides-Extra: auth-oauth-device
 Provides-Extra: jwt
 Requires-Dist: PyJWT[crypto] (>=2.4.0,<3.0.0) ; extra == "jwt" or extra == "auth-app" or extra == "auth" or extra == "all"
-Requires-Dist: anyio (>=3.6.1,<5.0.0) ; extra == "auth-oauth-device" or extra == "auth" or extra == "all"
+Requires-Dist: anyio (>=3.6.1,<4.0.0) ; extra == "auth-oauth-device" or extra == "auth" or extra == "all"
 Requires-Dist: hishel (>=0.0.21,<0.0.22)
 Requires-Dist: httpx (>=0.23.0,<1.0.0)
-Requires-Dist: pydantic (>=1.9.1,<3.0.0,!=2.5.0,!=2.5.1)
+Requires-Dist: pydantic (>=2.0.0,<3.0.0,!=2.5.0,!=2.5.1)
 Requires-Dist: typing-extensions (>=4.3.0,<5.0.0)
 Project-URL: Documentation, https://github.com/yanyongyu/githubkit
 Project-URL: Repository, https://github.com/yanyongyu/githubkit
@@ -104,8 +104,6 @@ poetry add githubkit[auth-oauth-device]
 pdm add githubkit[auth-oauth-device]
 ```
 
-githubkit supports **both pydantic v1 and v2**, but pydantic v2 is recommended. If you have encountered any problems with pydantic v1/v2, please file an issue.
-
 ## Usage
 
 ### Authentication
@@ -182,18 +180,6 @@ from githubkit import GitHub, ActionAuthStrategy
 github = GitHub(ActionAuthStrategy())
 ```
 
-and add env or input to the step:
-
-```yaml
-- name: Some step use githubkit
-  with:
-    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-- name: Some step use githubkit
-  env:
-    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-```
-
 ### Config
 
 githubkit is highly configurable, you can change the default config by passing config options to `GitHub`:
@@ -208,8 +194,7 @@ github = GitHub(
     user_agent="GitHubKit/Python",
     follow_redirects=True,
     timeout=None,
-    http_cache=True,
-    auto_retry=True,
+    http_cache=True
 )
 ```
 
@@ -217,8 +202,6 @@ The `accept_format` and `previews` are used to set the default `Accept` header,
 
 The `http_cache` option enables the http caching feature powered by [Hishel](https://hishel.com/) for HTTPX. GitHub API limits the number of requests that you can make within a specific amount of time. This feature is useful to reduce the number of requests to GitHub API and avoid hitting the rate limit.
 
-The `auto_retry` option enables request retrying when rate limit exceeded and server error encountered. See [Auto Retry](#auto-retry) for more infomation.
-
 ### Calling Rest API
 
 > APIs are fully typed. Typing in the following examples is just for reference only.
@@ -362,85 +345,6 @@ Simple async call:
 data: Dict[str, Any] = await github.async_graphql(query, variables={"foo": "bar"})
 ```
 
-### Auto Retry
-
-By default, githubkit will retry the request when specific exception encountered. When rate limit exceeded, githubkit will retry once after GitHub suggested waiting time. When server error encountered (http status >= 500), githubkit will retry max three times.
-
-You can disable this feature by set the `auto_retry` config to `False`:
-
-```python
-github = GitHub(
-    ...
-    auto_retry=False
-)
-```
-
-You can also customize the retry decision function by passing a callable:
-
-```python
-from datetime import timedelta
-
-from githubkit.retry import RetryOption
-from githubkit.exception import GitHubException
-
-def retry_decision_func(exc: GitHubException, retry_count: int) -> RetryOption:
-    if retry_count < 1:
-        return RetryOption(True, timedelta(seconds=60))
-    return RetryOption(False)
-
-github = GitHub(
-    ...
-    auto_retry=retry_decision_func
-)
-```
-
-githubkit also provides some builtin retry decision function:
-
-1. Retry when rate limit exceeded:
-
-   ```python
-   from githubkit.retry import RETRY_RATE_LIMIT, RetryRateLimit
-
-   # default
-   github = GitHub(
-      ...
-      auto_retry=RETRY_RATE_LIMIT
-   )
-   # or, custom max retry count
-   github = GitHub(
-      ...
-      auto_retry=RetryRateLimit(max_retry=1)
-   )
-   ```
-
-2. Retry when server error encountered:
-
-   ```python
-   from githubkit.retry import RETRY_SERVER_ERROR, RetryServerError
-
-   # default
-   github = GitHub(
-      ...
-      auto_retry=RETRY_SERVER_ERROR
-   )
-   # or, custom max retry count
-   github = GitHub(
-      ...
-      auto_retry=RetryServerError(max_retry=1)
-   )
-   ```
-
-3. Chain retry decision functions:
-
-   ```python
-   from githubkit.retry import RETRY_RATE_LIMIT, RETRY_SERVER_ERROR, RetryChainDecision
-
-   github = GitHub(
-      ...
-      auto_retry=RetryChainDecision(RETRY_RATE_LIMIT, RETRY_SERVER_ERROR)
-   )
-   ```
-
 ### Webhook Verification
 
 > `githubkit.webhooks` module contains some shortcut functions to help you verify and parse webhook payload.
@@ -473,7 +377,7 @@ from githubkit.webhooks import parse
 event = parse(request.headers["X-GitHub-Event"], request.body)
 ```
 
-(**NOT RECOMMENDED**) Parse the payload without event name (may cost longer time and more memory):
+(NOT RECOMMENDED) Parse the payload without event name (may cost longer time and more memory):
 
 ```python
 from githubkit.webhooks import parse_without_name
@@ -481,13 +385,6 @@ from githubkit.webhooks import parse_without_name
 event = parse_without_name(request.body)
 ```
 
-> [!WARNING]
-> The `parse_without_name` function will try to parse the payload with all supported event names.  
-> The behavior of this function is not the same between pydantic v1 and v2.  
-> When using pydantic v1, the function will return the first valid event model (known as `left-to-right` mode).  
-> When using pydantic v2, the function will return the highest scored valid event model (known as `smart` mode).  
-> See: [Union Modes](https://docs.pydantic.dev/latest/concepts/unions/#union-modes).
-
 Parse dict like payload:
 
 ```python
@@ -540,23 +437,16 @@ Open in Codespaces (Dev Container):
 Generate latest models and apis:
 
 > [!WARNING]
-> This may use about **400M** memory and take a long time.
-
-```bash
-./scripts/run-codegen.sh
-```
-
-Run tests in dev env:
+> This may use a lot of memory (**16G+** RAM) and take a long time.
 
 ```bash
-./scripts/run-tests.sh
+python -m codegen && isort . && black .
 ```
 
-Run tests in test envs, for example:
+Run tests:
 
 ```bash
-cd ./envs/pydantic-v2/
-poetry run bash ../../scripts/run-tests.sh
+pytest -n auto tests
 ```
 
 ## Contributors

{githubkit-0.11.0 → githubkit-0.11.0a1}/README.md

@@ -72,8 +72,6 @@ poetry add githubkit[auth-oauth-device]
 pdm add githubkit[auth-oauth-device]
 ```
 
-githubkit supports **both pydantic v1 and v2**, but pydantic v2 is recommended. If you have encountered any problems with pydantic v1/v2, please file an issue.
-
 ## Usage
 
 ### Authentication
@@ -150,18 +148,6 @@ from githubkit import GitHub, ActionAuthStrategy
 github = GitHub(ActionAuthStrategy())
 ```
 
-and add env or input to the step:
-
-```yaml
-- name: Some step use githubkit
-  with:
-    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-- name: Some step use githubkit
-  env:
-    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-```
-
 ### Config
 
 githubkit is highly configurable, you can change the default config by passing config options to `GitHub`:
@@ -176,8 +162,7 @@ github = GitHub(
     user_agent="GitHubKit/Python",
     follow_redirects=True,
     timeout=None,
-    http_cache=True,
-    auto_retry=True,
+    http_cache=True
 )
 ```
 
@@ -185,8 +170,6 @@ The `accept_format` and `previews` are used to set the default `Accept` header,
 
 The `http_cache` option enables the http caching feature powered by [Hishel](https://hishel.com/) for HTTPX. GitHub API limits the number of requests that you can make within a specific amount of time. This feature is useful to reduce the number of requests to GitHub API and avoid hitting the rate limit.
 
-The `auto_retry` option enables request retrying when rate limit exceeded and server error encountered. See [Auto Retry](#auto-retry) for more infomation.
-
 ### Calling Rest API
 
 > APIs are fully typed. Typing in the following examples is just for reference only.
@@ -330,85 +313,6 @@ Simple async call:
 data: Dict[str, Any] = await github.async_graphql(query, variables={"foo": "bar"})
 ```
 
-### Auto Retry
-
-By default, githubkit will retry the request when specific exception encountered. When rate limit exceeded, githubkit will retry once after GitHub suggested waiting time. When server error encountered (http status >= 500), githubkit will retry max three times.
-
-You can disable this feature by set the `auto_retry` config to `False`:
-
-```python
-github = GitHub(
-    ...
-    auto_retry=False
-)
-```
-
-You can also customize the retry decision function by passing a callable:
-
-```python
-from datetime import timedelta
-
-from githubkit.retry import RetryOption
-from githubkit.exception import GitHubException
-
-def retry_decision_func(exc: GitHubException, retry_count: int) -> RetryOption:
-    if retry_count < 1:
-        return RetryOption(True, timedelta(seconds=60))
-    return RetryOption(False)
-
-github = GitHub(
-    ...
-    auto_retry=retry_decision_func
-)
-```
-
-githubkit also provides some builtin retry decision function:
-
-1. Retry when rate limit exceeded:
-
-   ```python
-   from githubkit.retry import RETRY_RATE_LIMIT, RetryRateLimit
-
-   # default
-   github = GitHub(
-      ...
-      auto_retry=RETRY_RATE_LIMIT
-   )
-   # or, custom max retry count
-   github = GitHub(
-      ...
-      auto_retry=RetryRateLimit(max_retry=1)
-   )
-   ```
-
-2. Retry when server error encountered:
-
-   ```python
-   from githubkit.retry import RETRY_SERVER_ERROR, RetryServerError
-
-   # default
-   github = GitHub(
-      ...
-      auto_retry=RETRY_SERVER_ERROR
-   )
-   # or, custom max retry count
-   github = GitHub(
-      ...
-      auto_retry=RetryServerError(max_retry=1)
-   )
-   ```
-
-3. Chain retry decision functions:
-
-   ```python
-   from githubkit.retry import RETRY_RATE_LIMIT, RETRY_SERVER_ERROR, RetryChainDecision
-
-   github = GitHub(
-      ...
-      auto_retry=RetryChainDecision(RETRY_RATE_LIMIT, RETRY_SERVER_ERROR)
-   )
-   ```
-
 ### Webhook Verification
 
 > `githubkit.webhooks` module contains some shortcut functions to help you verify and parse webhook payload.
@@ -441,7 +345,7 @@ from githubkit.webhooks import parse
 event = parse(request.headers["X-GitHub-Event"], request.body)
 ```
 
-(**NOT RECOMMENDED**) Parse the payload without event name (may cost longer time and more memory):
+(NOT RECOMMENDED) Parse the payload without event name (may cost longer time and more memory):
 
 ```python
 from githubkit.webhooks import parse_without_name
@@ -449,13 +353,6 @@ from githubkit.webhooks import parse_without_name
 event = parse_without_name(request.body)
 ```
 
-> [!WARNING]
-> The `parse_without_name` function will try to parse the payload with all supported event names.  
-> The behavior of this function is not the same between pydantic v1 and v2.  
-> When using pydantic v1, the function will return the first valid event model (known as `left-to-right` mode).  
-> When using pydantic v2, the function will return the highest scored valid event model (known as `smart` mode).  
-> See: [Union Modes](https://docs.pydantic.dev/latest/concepts/unions/#union-modes).
-
 Parse dict like payload:
 
 ```python
@@ -508,23 +405,16 @@ Open in Codespaces (Dev Container):
 Generate latest models and apis:
 
 > [!WARNING]
-> This may use about **400M** memory and take a long time.
-
-```bash
-./scripts/run-codegen.sh
-```
-
-Run tests in dev env:
+> This may use a lot of memory (**16G+** RAM) and take a long time.
 
 ```bash
-./scripts/run-tests.sh
+python -m codegen && isort . && black .
 ```
 
-Run tests in test envs, for example:
+Run tests:
 
 ```bash
-cd ./envs/pydantic-v2/
-poetry run bash ../../scripts/run-tests.sh
+pytest -n auto tests
 ```
 
 ## Contributors

{githubkit-0.11.0 → githubkit-0.11.0a1}/githubkit/compat.py

@@ -29,9 +29,8 @@ if TYPE_CHECKING:
     CVC = TypeVar("CVC", bound=CustomValidationClass)
 
 
-if PYDANTIC_V2:  # pragma: pydantic-v2
+if PYDANTIC_V2:
     from pydantic_core import CoreSchema, core_schema
-    from pydantic_core import to_jsonable_python as to_jsonable_python
     from pydantic import (
         BaseModel,
         ConfigDict,
@@ -55,7 +54,7 @@ if PYDANTIC_V2:  # pragma: pydantic-v2
     def model_dump(model: BaseModel, by_alias: bool = True) -> Dict[str, Any]:
         return model.model_dump(by_alias=by_alias)
 
-    def model_rebuild(model: Type[BaseModel]):
+    def model_rebuild(model: BaseModel):
         model.model_rebuild()
 
     def model_before_validator(func: "ModelBeforeValidator"):
@@ -81,8 +80,7 @@ if PYDANTIC_V2:  # pragma: pydantic-v2
         )
         return class_
 
-else:  # pragma: pydantic-v1
-    from pydantic.json import pydantic_encoder
+else:
     from pydantic import Extra, BaseModel, parse_obj_as, parse_raw_as, root_validator
 
     class GitHubModel(BaseModel):
@@ -99,22 +97,10 @@ else:  # pragma: pydantic-v1
     def type_validate_json(type_: Type[T], data: Any) -> T:
         return parse_raw_as(type_, data)
 
-    def to_jsonable_python(obj: Any) -> Any:
-        if isinstance(obj, dict):
-            return {k: to_jsonable_python(v) for k, v in obj.items()}
-
-        if isinstance(obj, (list, tuple)):
-            return [to_jsonable_python(item) for item in obj]
-
-        if obj is None or isinstance(obj, (int, float, str, bool)):
-            return obj
-
-        return pydantic_encoder(obj)
-
     def model_dump(model: BaseModel, by_alias: bool = True) -> Dict[str, Any]:
         return model.dict(by_alias=by_alias)
 
-    def model_rebuild(model: Type[BaseModel]):
+    def model_rebuild(model: BaseModel):
         return model.update_forward_refs()
 
     def model_before_validator(func: "ModelBeforeValidator"):

{githubkit-0.11.0 → githubkit-0.11.0a1}/githubkit/config.py

@@ -4,9 +4,6 @@ from typing import Any, Dict, List, Union, Optional
 
 import httpx
 
-from .retry import RETRY_DEFAULT
-from .typing import RetryDecisionFunc
-
 
 @dataclass(frozen=True)
 class Config:
@@ -16,7 +13,6 @@ class Config:
     follow_redirects: bool
     timeout: httpx.Timeout
     http_cache: bool
-    auto_retry: Optional[RetryDecisionFunc]
 
     def dict(self) -> Dict[str, Any]:
         return asdict(self)
@@ -63,17 +59,6 @@ def build_timeout(
     return timeout if isinstance(timeout, httpx.Timeout) else httpx.Timeout(timeout)
 
 
-def build_auto_retry(
-    auto_retry: Union[bool, RetryDecisionFunc] = True
-) -> Optional[RetryDecisionFunc]:
-    if auto_retry is True:
-        return RETRY_DEFAULT
-    elif auto_retry:
-        return auto_retry
-    else:
-        return None
-
-
 def get_config(
     base_url: Optional[Union[str, httpx.URL]] = None,
     accept_format: Optional[str] = None,
@@ -82,7 +67,6 @@ def get_config(
     follow_redirects: bool = True,
     timeout: Optional[Union[float, httpx.Timeout]] = None,
     http_cache: bool = True,
-    auto_retry: Union[bool, RetryDecisionFunc] = True,
 ) -> Config:
     return Config(
         build_base_url(base_url),
@@ -91,5 +75,4 @@ def get_config(
         follow_redirects,
         build_timeout(timeout),
         http_cache,
-        build_auto_retry(auto_retry),
     )