githubkit 0.12.1__py3-none-any.whl → 0.12.3__py3-none-any.whl

githubkit/config.py

@@ -1,4 +1,4 @@
-from dataclasses import asdict, dataclass
+from dataclasses import dataclass, fields
 from typing import Any, Optional, Union
 from typing_extensions import Self
 
@@ -24,9 +24,11 @@ class Config:
     rest_api_validate_body: bool
 
     def dict(self) -> dict[str, Any]:
-        return asdict(self)
+        """Return the config as a dictionary without copy values."""
+        return {field.name: getattr(self, field.name) for field in fields(self)}
 
     def copy(self) -> Self:
+        """Return a shallow copy of the config."""
         return self.__class__(**self.dict())
 
 
@@ -107,6 +109,7 @@ def get_config(
     auto_retry: Union[bool, RetryDecisionFunc] = True,
     rest_api_validate_body: bool = True,
 ) -> Config:
+    """Build the configs from the given options."""
     return Config(
         build_base_url(base_url),
         build_accept(accept_format, previews),

githubkit/core.py

@@ -478,6 +478,11 @@ class GitHubCore(Generic[A]):
         response_model: Union[type[T], UnsetType] = UNSET,
         error_models: Optional[dict[str, type]] = None,
     ) -> Union[Response[T], Response[Any]]:
+        """Send a request.
+
+        Response will be checked and the request will be retried if necessary.
+        """
+
         retry_count: int = 0
         while True:
             try:
@@ -555,6 +560,11 @@ class GitHubCore(Generic[A]):
         response_model: Union[type[T], UnsetType] = UNSET,
         error_models: Optional[dict[str, type]] = None,
     ) -> Union[Response[T], Response[Any]]:
+        """Asynchronously send a request.
+
+        Response will be checked and the request will be retried if necessary.
+        """
+
         retry_count: int = 0
         while True:
             try:

githubkit/paginator.py

@@ -17,6 +17,8 @@ R = Union[
 
 
 class Paginator(Generic[RT]):
+    """Paginate through the responses of the rest api request."""
+
     @overload
     def __init__(
         self: "Paginator[RTS]",

githubkit/response.py

@@ -10,6 +10,8 @@ JT = TypeVar("JT", default=Any)
 
 
 class Response(Generic[MT, JT]):
+    """A wrapper around httpx.Response that provides data model validation."""
+
     def __init__(self, response: httpx.Response, data_model: type[MT]):
         self._response = response
         self._data_model = data_model
@@ -41,6 +43,33 @@ class Response(Generic[MT, JT]):
             else str(self.status_code)
         )
 
+    @property
+    def is_informational(self) -> bool:
+        return self._response.is_informational
+
+    @property
+    def is_success(self) -> bool:
+        return self._response.is_success
+
+    @property
+    def is_redirect(self) -> bool:
+        return self._response.is_redirect
+
+    @property
+    def is_client_error(self) -> bool:
+        return self._response.is_client_error
+
+    @property
+    def is_server_error(self) -> bool:
+        return self._response.is_server_error
+
+    @property
+    def is_error(self) -> bool:
+        return self._response.is_error
+
+    def raise_for_status(self) -> None:
+        self._response.raise_for_status()
+
     @property
     def headers(self) -> httpx.Headers:
         return self._response.headers

githubkit/rest/__init__.py

@@ -75,6 +75,9 @@ if TYPE_CHECKING:
     from githubkit.versions.v2022_11_28.models import (
         ApiOverviewPropDomains as ApiOverviewPropDomains,
     )
+    from githubkit.versions.v2022_11_28.models import (
+        ApiOverviewPropDomainsPropActionsInbound as ApiOverviewPropDomainsPropActionsInbound,
+    )
     from githubkit.versions.v2022_11_28.models import (
         ApiOverviewPropDomainsPropArtifactAttestations as ApiOverviewPropDomainsPropArtifactAttestations,
     )
@@ -276,6 +279,15 @@ if TYPE_CHECKING:
     from githubkit.versions.v2022_11_28.models import (
         CodeScanningAnalysisTool as CodeScanningAnalysisTool,
     )
+    from githubkit.versions.v2022_11_28.models import (
+        CodeScanningAutofix as CodeScanningAutofix,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        CodeScanningAutofixCommits as CodeScanningAutofixCommits,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        CodeScanningAutofixCommitsResponse as CodeScanningAutofixCommitsResponse,
+    )
     from githubkit.versions.v2022_11_28.models import (
         CodeScanningCodeqlDatabase as CodeScanningCodeqlDatabase,
     )
@@ -538,6 +550,9 @@ if TYPE_CHECKING:
         CustomDeploymentRuleApp as CustomDeploymentRuleApp,
     )
     from githubkit.versions.v2022_11_28.models import CustomProperty as CustomProperty
+    from githubkit.versions.v2022_11_28.models import (
+        CustomPropertySetPayload as CustomPropertySetPayload,
+    )
     from githubkit.versions.v2022_11_28.models import (
         CustomPropertyValue as CustomPropertyValue,
     )
@@ -666,7 +681,25 @@ if TYPE_CHECKING:
     from githubkit.versions.v2022_11_28.models import EmptyObject as EmptyObject
     from githubkit.versions.v2022_11_28.models import Enterprise as Enterprise
     from githubkit.versions.v2022_11_28.models import (
-        EnterprisesEnterpriseCopilotBillingSeatsGetResponse200 as EnterprisesEnterpriseCopilotBillingSeatsGetResponse200,
+        EnterprisesEnterpriseCodeSecurityConfigurationsConfigurationIdAttachPostBody as EnterprisesEnterpriseCodeSecurityConfigurationsConfigurationIdAttachPostBody,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        EnterprisesEnterpriseCodeSecurityConfigurationsConfigurationIdDefaultsPutBody as EnterprisesEnterpriseCodeSecurityConfigurationsConfigurationIdDefaultsPutBody,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        EnterprisesEnterpriseCodeSecurityConfigurationsConfigurationIdDefaultsPutResponse200 as EnterprisesEnterpriseCodeSecurityConfigurationsConfigurationIdDefaultsPutResponse200,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        EnterprisesEnterpriseCodeSecurityConfigurationsConfigurationIdPatchBody as EnterprisesEnterpriseCodeSecurityConfigurationsConfigurationIdPatchBody,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        EnterprisesEnterpriseCodeSecurityConfigurationsConfigurationIdPatchBodyPropDependencyGraphAutosubmitActionOptions as EnterprisesEnterpriseCodeSecurityConfigurationsConfigurationIdPatchBodyPropDependencyGraphAutosubmitActionOptions,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        EnterprisesEnterpriseCodeSecurityConfigurationsPostBody as EnterprisesEnterpriseCodeSecurityConfigurationsPostBody,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        EnterprisesEnterpriseCodeSecurityConfigurationsPostBodyPropDependencyGraphAutosubmitActionOptions as EnterprisesEnterpriseCodeSecurityConfigurationsPostBodyPropDependencyGraphAutosubmitActionOptions,
     )
     from githubkit.versions.v2022_11_28.models import (
         EnterprisesEnterpriseSecretScanningAlertsGetResponse503 as EnterprisesEnterpriseSecretScanningAlertsGetResponse503,
@@ -1087,6 +1120,12 @@ if TYPE_CHECKING:
     from githubkit.versions.v2022_11_28.models import (
         OrgMembershipPropPermissions as OrgMembershipPropPermissions,
     )
+    from githubkit.versions.v2022_11_28.models import (
+        OrgPrivateRegistryConfiguration as OrgPrivateRegistryConfiguration,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        OrgPrivateRegistryConfigurationWithSelectedRepositories as OrgPrivateRegistryConfigurationWithSelectedRepositories,
+    )
     from githubkit.versions.v2022_11_28.models import (
         OrgRepoCustomPropertyValues as OrgRepoCustomPropertyValues,
     )
@@ -1355,10 +1394,19 @@ if TYPE_CHECKING:
         OrgsOrgPersonalAccessTokensPostBody as OrgsOrgPersonalAccessTokensPostBody,
     )
     from githubkit.versions.v2022_11_28.models import (
-        OrgsOrgProjectsPostBody as OrgsOrgProjectsPostBody,
+        OrgsOrgPrivateRegistriesGetResponse200 as OrgsOrgPrivateRegistriesGetResponse200,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        OrgsOrgPrivateRegistriesPostBody as OrgsOrgPrivateRegistriesPostBody,
     )
     from githubkit.versions.v2022_11_28.models import (
-        OrgsOrgPropertiesSchemaCustomPropertyNamePutBody as OrgsOrgPropertiesSchemaCustomPropertyNamePutBody,
+        OrgsOrgPrivateRegistriesPublicKeyGetResponse200 as OrgsOrgPrivateRegistriesPublicKeyGetResponse200,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        OrgsOrgPrivateRegistriesSecretNamePatchBody as OrgsOrgPrivateRegistriesSecretNamePatchBody,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        OrgsOrgProjectsPostBody as OrgsOrgProjectsPostBody,
     )
     from githubkit.versions.v2022_11_28.models import (
         OrgsOrgPropertiesSchemaPatchBody as OrgsOrgPropertiesSchemaPatchBody,
@@ -8687,6 +8735,9 @@ if TYPE_CHECKING:
     from githubkit.versions.v2022_11_28.models import (
         WebhookSecretScanningAlertValidated as WebhookSecretScanningAlertValidated,
     )
+    from githubkit.versions.v2022_11_28.models import (
+        WebhookSecretScanningScanCompleted as WebhookSecretScanningScanCompleted,
+    )
     from githubkit.versions.v2022_11_28.models import (
         WebhookSecurityAdvisoryPublished as WebhookSecurityAdvisoryPublished,
     )
@@ -9623,28 +9674,15 @@ else:
             "SimpleClassroomAssignment",
             "SimpleClassroom",
             "ClassroomAssignmentGrade",
-            "OrganizationSimple",
-            "TeamSimple",
-            "Team",
-            "TeamPropPermissions",
-            "CopilotSeatDetails",
-            "EnterpriseTeam",
-            "CopilotUsageMetricsDay",
-            "CopilotDotcomChat",
-            "CopilotDotcomChatPropModelsItems",
-            "CopilotIdeChat",
-            "CopilotIdeChatPropEditorsItems",
-            "CopilotIdeChatPropEditorsItemsPropModelsItems",
-            "CopilotDotcomPullRequests",
-            "CopilotDotcomPullRequestsPropRepositoriesItems",
-            "CopilotDotcomPullRequestsPropRepositoriesItemsPropModelsItems",
-            "CopilotIdeCodeCompletions",
-            "CopilotIdeCodeCompletionsPropLanguagesItems",
-            "CopilotIdeCodeCompletionsPropEditorsItems",
-            "CopilotIdeCodeCompletionsPropEditorsItemsPropModelsItems",
-            "CopilotIdeCodeCompletionsPropEditorsItemsPropModelsItemsPropLanguagesItems",
-            "CopilotUsageMetrics",
-            "CopilotUsageMetricsPropBreakdownItems",
+            "CodeSecurityConfiguration",
+            "CodeSecurityConfigurationPropDependencyGraphAutosubmitActionOptions",
+            "CodeSecurityConfigurationPropCodeScanningDefaultSetupOptions",
+            "CodeSecurityConfigurationPropSecretScanningDelegatedBypassOptions",
+            "CodeSecurityConfigurationPropSecretScanningDelegatedBypassOptionsPropReviewersItems",
+            "CodeScanningDefaultSetupOptions",
+            "CodeSecurityDefaultConfigurationsItems",
+            "SimpleRepository",
+            "CodeSecurityConfigurationRepositories",
             "DependabotAlertPackage",
             "DependabotAlertSecurityVulnerability",
             "DependabotAlertSecurityVulnerabilityPropFirstPatchedVersion",
@@ -9653,7 +9691,6 @@ else:
             "DependabotAlertSecurityAdvisoryPropCwesItems",
             "DependabotAlertSecurityAdvisoryPropIdentifiersItems",
             "DependabotAlertSecurityAdvisoryPropReferencesItems",
-            "SimpleRepository",
             "DependabotAlertWithRepository",
             "DependabotAlertWithRepositoryPropDependency",
             "OrganizationSecretScanningAlert",
@@ -9695,6 +9732,7 @@ else:
             "ApiOverview",
             "ApiOverviewPropSshKeyFingerprints",
             "ApiOverviewPropDomains",
+            "ApiOverviewPropDomainsPropActionsInbound",
             "ApiOverviewPropDomainsPropArtifactAttestations",
             "SecurityAndAnalysis",
             "SecurityAndAnalysisPropAdvancedSecurity",
@@ -9710,6 +9748,7 @@ else:
             "Thread",
             "ThreadPropSubject",
             "ThreadSubscription",
+            "OrganizationSimple",
             "BillingUsageReport",
             "BillingUsageReportPropUsageItemsItems",
             "OrganizationFull",
@@ -9732,14 +9771,6 @@ else:
             "CodeScanningAlertLocation",
             "CodeScanningAlertInstancePropMessage",
             "CodeScanningOrganizationAlertItems",
-            "CodeSecurityConfiguration",
-            "CodeSecurityConfigurationPropDependencyGraphAutosubmitActionOptions",
-            "CodeSecurityConfigurationPropCodeScanningDefaultSetupOptions",
-            "CodeSecurityConfigurationPropSecretScanningDelegatedBypassOptions",
-            "CodeSecurityConfigurationPropSecretScanningDelegatedBypassOptionsPropReviewersItems",
-            "CodeScanningDefaultSetupOptions",
-            "CodeSecurityDefaultConfigurationsItems",
-            "CodeSecurityConfigurationRepositories",
             "CodespaceMachine",
             "Codespace",
             "CodespacePropGitStatus",
@@ -9747,6 +9778,28 @@ else:
             "CodespacesPublicKey",
             "CopilotOrganizationDetails",
             "CopilotSeatBreakdown",
+            "TeamSimple",
+            "Team",
+            "TeamPropPermissions",
+            "CopilotSeatDetails",
+            "EnterpriseTeam",
+            "OrgsOrgCopilotBillingSeatsGetResponse200",
+            "CopilotUsageMetricsDay",
+            "CopilotDotcomChat",
+            "CopilotDotcomChatPropModelsItems",
+            "CopilotIdeChat",
+            "CopilotIdeChatPropEditorsItems",
+            "CopilotIdeChatPropEditorsItemsPropModelsItems",
+            "CopilotDotcomPullRequests",
+            "CopilotDotcomPullRequestsPropRepositoriesItems",
+            "CopilotDotcomPullRequestsPropRepositoriesItemsPropModelsItems",
+            "CopilotIdeCodeCompletions",
+            "CopilotIdeCodeCompletionsPropLanguagesItems",
+            "CopilotIdeCodeCompletionsPropEditorsItems",
+            "CopilotIdeCodeCompletionsPropEditorsItemsPropModelsItems",
+            "CopilotIdeCodeCompletionsPropEditorsItemsPropModelsItemsPropLanguagesItems",
+            "CopilotUsageMetrics",
+            "CopilotUsageMetricsPropBreakdownItems",
             "DependabotPublicKey",
             "Package",
             "OrganizationInvitation",
@@ -9781,8 +9834,10 @@ else:
             "OrganizationProgrammaticAccessGrantPropPermissionsPropOrganization",
             "OrganizationProgrammaticAccessGrantPropPermissionsPropRepository",
             "OrganizationProgrammaticAccessGrantPropPermissionsPropOther",
+            "OrgPrivateRegistryConfigurationWithSelectedRepositories",
             "Project",
             "CustomProperty",
+            "CustomPropertySetPayload",
             "CustomPropertyValue",
             "OrgRepoCustomPropertyValues",
             "CodeOfConductSimple",
@@ -9990,6 +10045,9 @@ else:
             "CodeScanningAlertItems",
             "CodeScanningAlert",
             "CodeScanningAlertRule",
+            "CodeScanningAutofix",
+            "CodeScanningAutofixCommits",
+            "CodeScanningAutofixCommitsResponse",
             "CodeScanningAnalysis",
             "CodeScanningAnalysisDeletion",
             "CodeScanningCodeqlDatabase",
@@ -12284,6 +12342,7 @@ else:
             "WebhookSecretScanningAlertReopened",
             "WebhookSecretScanningAlertResolved",
             "WebhookSecretScanningAlertValidated",
+            "WebhookSecretScanningScanCompleted",
             "WebhookSecurityAdvisoryPublished",
             "WebhookSecurityAdvisoryUpdated",
             "WebhookSecurityAdvisoryWithdrawn",
@@ -12452,7 +12511,13 @@ else:
             "ApplicationsClientIdTokenPatchBody",
             "ApplicationsClientIdTokenScopedPostBody",
             "EmojisGetResponse200",
-            "EnterprisesEnterpriseCopilotBillingSeatsGetResponse200",
+            "EnterprisesEnterpriseCodeSecurityConfigurationsPostBody",
+            "EnterprisesEnterpriseCodeSecurityConfigurationsPostBodyPropDependencyGraphAutosubmitActionOptions",
+            "EnterprisesEnterpriseCodeSecurityConfigurationsConfigurationIdPatchBody",
+            "EnterprisesEnterpriseCodeSecurityConfigurationsConfigurationIdPatchBodyPropDependencyGraphAutosubmitActionOptions",
+            "EnterprisesEnterpriseCodeSecurityConfigurationsConfigurationIdAttachPostBody",
+            "EnterprisesEnterpriseCodeSecurityConfigurationsConfigurationIdDefaultsPutBody",
+            "EnterprisesEnterpriseCodeSecurityConfigurationsConfigurationIdDefaultsPutResponse200",
             "EnterprisesEnterpriseSecretScanningAlertsGetResponse503",
             "GistsPostBody",
             "GistsPostBodyPropFiles",
@@ -12526,7 +12591,6 @@ else:
             "OrgsOrgCodespacesSecretsSecretNamePutBody",
             "OrgsOrgCodespacesSecretsSecretNameRepositoriesGetResponse200",
             "OrgsOrgCodespacesSecretsSecretNameRepositoriesPutBody",
-            "OrgsOrgCopilotBillingSeatsGetResponse200",
             "OrgsOrgCopilotBillingSelectedTeamsPostBody",
             "OrgsOrgCopilotBillingSelectedTeamsPostResponse201",
             "OrgsOrgCopilotBillingSelectedTeamsDeleteBody",
@@ -12558,9 +12622,13 @@ else:
             "OrgsOrgPersonalAccessTokenRequestsPatRequestIdPostBody",
             "OrgsOrgPersonalAccessTokensPostBody",
             "OrgsOrgPersonalAccessTokensPatIdPostBody",
+            "OrgsOrgPrivateRegistriesGetResponse200",
+            "OrgPrivateRegistryConfiguration",
+            "OrgsOrgPrivateRegistriesPostBody",
+            "OrgsOrgPrivateRegistriesPublicKeyGetResponse200",
+            "OrgsOrgPrivateRegistriesSecretNamePatchBody",
             "OrgsOrgProjectsPostBody",
             "OrgsOrgPropertiesSchemaPatchBody",
-            "OrgsOrgPropertiesSchemaCustomPropertyNamePutBody",
             "OrgsOrgPropertiesValuesPatchBody",
             "OrgsOrgReposPostBody",
             "OrgsOrgReposPostBodyPropCustomProperties",

githubkit/retry.py

@@ -7,6 +7,8 @@ from .typing import RetryOption as RetryOption
 
 
 class RetryRateLimit:
+    """Retry decision function for rate limit exceeded."""
+
     __slots__ = ("max_retry",)
 
     def __init__(self, max_retry: int = 1) -> None:
@@ -30,6 +32,8 @@ RETRY_RATE_LIMIT = RetryRateLimit()
 
 
 class RetryServerError:
+    """Retry decision function for server error."""
+
     __slots__ = ("max_retry",)
 
     def __init__(self, max_retry: int = 3) -> None:
@@ -57,6 +61,8 @@ RETRY_SERVER_ERROR = RetryServerError()
 
 
 class RetryChainDecision:
+    """Chain multiple retry decision functions."""
+
     __slots__ = ("decision_funcs",)
 
     def __init__(self, *decision_funcs: RetryDecisionFunc) -> None:

githubkit/throttling.py

@@ -33,11 +33,19 @@ class BaseThrottler(abc.ABC):
 
 
 class LocalThrottler(BaseThrottler):
+    """Simple local throttler."""
+
     def __init__(self, max_concurrency: int) -> None:
         self.max_concurrency = max_concurrency
-        self.semaphore = threading.Semaphore(max_concurrency)
+        self._semaphore: Optional[threading.Semaphore] = None
         self._async_semaphore: Optional[anyio.Semaphore] = None
 
+    @property
+    def semaphore(self) -> threading.Semaphore:
+        if self._semaphore is None:
+            self._semaphore = threading.Semaphore(self.max_concurrency)
+        return self._semaphore
+
     @property
     def async_semaphore(self) -> anyio.Semaphore:
         if self._async_semaphore is None: