python-cnb 1.20.13__tar.gz → 1.22.12__tar.gz

{python_cnb-1.20.13/python_cnb.egg-info → python_cnb-1.22.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-cnb
-Version: 1.20.13
+Version: 1.22.12
 Summary: CNB OpenAPI的Python SDK,方便与CNB平台进行交互
 Home-page: https://cnb.cool
 Author: Tencent Cloud

{python_cnb-1.20.13 → python_cnb-1.22.12}/cnb/activities.py

@@ -7,7 +7,7 @@ class ActivitiesService:
 	def __init__(self, client):
 		self._client = client
 
-	# 获取个人动态活跃详情汇总。Get user activities by date.
+	# 获取动态活跃详情。Get user activities.
 	def get_user_activities_by_date(self,
 		username: str,
 	    date: Optional[str] = None,
@@ -24,7 +24,7 @@ class ActivitiesService:
 			)
 		return dto.ActivityDate.safe_parse(data)
 		
-	# 个人仓库动态详情列表。List of personal repository activity details.
+	# 获取仓库动态详情。Get repository activity details.
 	def get_user_repo_activity_details(self,
 		username: str,
 		activityType: str,
@@ -44,7 +44,7 @@ class ActivitiesService:
 			)
 		return data
 		
-	# 获取仓库 top 活跃用户。List the top active users
+	# 获取仓库 top 活跃用户。List the top active users.
 	def top_contributors(self,
 		repo: str,
 	    top: Optional[int] = None,

{python_cnb-1.20.13 → python_cnb-1.22.12}/cnb/assets.py

@@ -7,7 +7,7 @@ class AssetsService:
 	def __init__(self, client):
 		self._client = client
 
-	# 通过 asset 记录 id 删除一个 asset
+	# 删除 asset 记录。Delete an asset record by ID.
 	def delete_asset(self,
 		repo: str,
 		assetID: str,
@@ -20,7 +20,7 @@ class AssetsService:
 			)
 		return 
 		
-	# 获取 issue 文件或合并请求文件的请求，返回文件二进制内容。Request to retrieve file of issues and pull requests, returns binary content.
+	# 获取 Issue/PR 文件。Get issue/PR files.
 	def get_files(self,
 		repo: str,
 		filePath: str,
@@ -33,7 +33,7 @@ class AssetsService:
 			)
 		return 
 		
-	# 获取 issue 图片或合并请求图片的请求，返回图片二进制内容。Request to retrieve image of issues and pull requests, returns binary content.
+	# 获取 Issue/PR 图片。Get issue/PR images.
 	def get_imgs(self,
 		repo: str,
 		imgPath: str,
@@ -46,7 +46,7 @@ class AssetsService:
 			)
 		return 
 		
-	# 仓库的 asset 记录列表
+	# 获取仓库 asset 记录列表。Get repository asset records.
 	def list_assets(self,
 		slug: str,
 	    page: Optional[int] = None,

{python_cnb-1.20.13 → python_cnb-1.22.12}/cnb/badge.py

@@ -23,7 +23,7 @@ class BadgeService:
 			)
 		return dto.GetBadgeResult.safe_parse(data)
 		
-	# 获取徽章列表数据。List badge data
+	# 获取徽章列表。Get badge list.
 	def list_badge(self,
 		repo: str,
 	    body_params: dto.ListBadgeReq,
@@ -37,7 +37,7 @@ class BadgeService:
 			)
 		return dto.ListBadgeResult.safe_parse(data)
 		
-	# 上传徽章数据。Upload badge data
+	# 上传徽章数据。Upload badge data.
 	def upload_badge(self,
 		repo: str,
 	    body_params: dto.UploadBadgeReq,

{python_cnb-1.20.13 → python_cnb-1.22.12}/cnb/build.py

@@ -7,7 +7,7 @@ class BuildService:
 	def __init__(self, client):
 		self._client = client
 
-	# 同步仓库分支下的定时任务。 Synchronize the content under the repository branch.
+	# 同步分支定时任务。Sync branch crontab tasks.
 	def build_crontab_sync(self,
 		repo: str,
 		branch: str,
@@ -33,7 +33,7 @@ class BuildService:
 			)
 		return dto.BuildCommonResult.safe_parse(data)
 		
-	# 流水线runner日志下载。Pipeline runner log download.
+	# 流水线runner 日志下载。Pipeline runner log download.
 	def build_runner_download_log(self,
 		repo: str,
 		pipelineId: str,
@@ -85,7 +85,7 @@ class BuildService:
 			)
 		return dto.BuildLogsResult.safe_parse(data)
 		
-	# 查询流水线Stage详情。Get pipeline build stage detail.
+	# 查询流水线Stage 详情。Get pipeline build stage detail.
 	def get_build_stage(self,
 		repo: str,
 		sn: str,

python_cnb-1.22.12/cnb/charge.py

@@ -0,0 +1,72 @@
+# Code generated by cnb.cool/cnb/sdk/cnb-sdk-generator. DO NOT EDIT.
+# source: https://api.cnb-dev.woa.com/swagger.json
+
+from typing import Optional
+from .models import dto
+class ChargeService:    
+	def __init__(self, client):
+		self._client = client
+
+	# 获取组织月度额度。Get organization monthly quotas.
+	def get_quota(self,
+		slug: str,
+	    ) -> dto.VolumeQuotaResp:
+		u = "/%s/-/charge/quota" % (slug, )
+
+		data = self._client.request(
+			method="GET", 
+			endpoint=u,
+			)
+		return dto.VolumeQuotaResp.safe_parse(data)
+		
+	# 获取组织仓库用量。Get organization repository usage.
+	def get_repos_volume(self,
+		slug: str,
+	    type: Optional[str] = None,
+		page: Optional[int] = None,
+		page_size: Optional[int] = None,
+		) -> list[dto.RepoVolume]:
+		u = "/%s/-/charge/repos-volume" % (slug, )
+
+		query_params = {
+			"type": type,
+			"page": page,
+			"page_size": page_size,
+			}
+		data = self._client.request(
+			method="GET", 
+			endpoint=u,
+			params=query_params,
+			)
+		return [dto.RepoVolume.safe_parse(item) for item in data]
+		
+	# 查看特权额度。View privilege quotas.
+	def get_special_amount(self,
+		slug: str,
+	    ) -> dto.SpecialAmount:
+		u = "/%s/-/charge/special-amount" % (slug, )
+
+		data = self._client.request(
+			method="GET", 
+			endpoint=u,
+			)
+		return dto.SpecialAmount.safe_parse(data)
+		
+	# 获取组织资源用量。Get organization resource usage.
+	def get_volume(self,
+		slug: str,
+	    month: Optional[str] = None,
+		) -> dto.VolumeUsedResp:
+		u = "/%s/-/charge/volume" % (slug, )
+
+		query_params = {
+			"month": month,
+			}
+		data = self._client.request(
+			method="GET", 
+			endpoint=u,
+			params=query_params,
+			)
+		return dto.VolumeUsedResp.safe_parse(data)
+		
+	

{python_cnb-1.20.13 → python_cnb-1.22.12}/cnb/event.py

@@ -6,7 +6,7 @@ class EventService:
 	def __init__(self, client):
 		self._client = client
 
-	# 获取仓库动态预签名地址，并返回内容。Get events pre-signed URL and return content.
+	# 获取仓库动态内容。Get repository events content.
 	def get_events(self,
 		repo: str,
 		date: str,

{python_cnb-1.20.13 → python_cnb-1.22.12}/cnb/followers.py

@@ -7,7 +7,7 @@ class FollowersService:
 	def __init__(self, client):
 		self._client = client
 
-	# 获取指定用户的粉丝列表。Get the followers list of specified user.
+	# 获取粉丝列表。Get followers list.
 	def get_followers_by_user_id(self,
 		username: str,
 	    page: Optional[int] = None,
@@ -26,7 +26,7 @@ class FollowersService:
 			)
 		return [dto.UserFollowResult.safe_parse(item) for item in data]
 		
-	# 获取指定用户的关注人列表。Get the list of users that the specified user is following.
+	# 获取关注人列表。Get following list.
 	def get_following_by_user_id(self,
 		username: str,
 	    page: Optional[int] = None,

{python_cnb-1.20.13 → python_cnb-1.22.12}/cnb/git.py

@@ -10,7 +10,7 @@ class GitService:
 	def __init__(self, client):
 		self._client = client
 
-	# 创建一个 blob。Create a blob.
+	# 创建 Blob 对象。Create blob object.
 	def create_blob(self,
 		repo: str,
 	    body_params: api.PostBlobForm,
@@ -24,7 +24,7 @@ class GitService:
 			)
 		return api.Blob.safe_parse(data)
 		
-	# 创建新分支。Create a new branch based on a start point.
+	# 创建分支。Create branch.
 	def create_branch(self,
 		repo: str,
 	    body_params: openapi.CreateBranchForm,
@@ -38,7 +38,7 @@ class GitService:
 			)
 		return 
 		
-	# 锁定分支
+	# 锁定分支。Lock branch.
 	def create_branch_lock(self,
 		repo: str,
 		branch: str,
@@ -51,7 +51,7 @@ class GitService:
 			)
 		return 
 		
-	# 创建一个 tag。Create a tag.
+	# 创建标签。Create tag.
 	def create_tag(self,
 		repo: str,
 	    body_params: api.PostTagFrom,
@@ -65,7 +65,7 @@ class GitService:
 			)
 		return api.Tag.safe_parse(data)
 		
-	# 删除指定分支。Delete the specified branch.
+	# 删除分支。Delete branch.
 	def delete_branch(self,
 		repo: str,
 		branch: str,
@@ -78,7 +78,7 @@ class GitService:
 			)
 		return 
 		
-	# 解除锁定分支
+	# 解锁分支。Unlock branch.
 	def delete_branch_lock(self,
 		repo: str,
 		branch: str,
@@ -91,7 +91,7 @@ class GitService:
 			)
 		return 
 		
-	# 删除指定 commit 的元数据。Delete commit annotation.
+	# 删除提交元数据。Delete commit annotations.
 	def delete_commit_annotation(self,
 		repo: str,
 		sha: str,
@@ -105,7 +105,7 @@ class GitService:
 			)
 		return 
 		
-	# 删除指定 commit 的附件。Delete commit asset.
+	# 删除提交附件。Delete commit asset.
 	def delete_commit_asset(self,
 		repo: str,
 		sha1: str,
@@ -119,7 +119,7 @@ class GitService:
 			)
 		return 
 		
-	# 删除指定 tag。Delete the specified tag.
+	# 删除标签。Delete tag.
 	def delete_tag(self,
 		repo: str,
 		tag: str,
@@ -132,7 +132,7 @@ class GitService:
 			)
 		return 
 		
-	# 删除指定 tag 的元数据。Delete the metadata of the specified tag.
+	# 删除标签元数据。Delete tag annotations.
 	def delete_tag_annotation(self,
 		repo: str,
 		tag_with_key: str,
@@ -145,7 +145,7 @@ class GitService:
 			)
 		return 
 		
-	# 下载仓库内容
+	# 下载仓库归档。Download repository archive.
 	def get_archive(self,
 		repo: str,
 		ref_with_path: str,
@@ -158,7 +158,7 @@ class GitService:
 			)
 		return 
 		
-	# 打包下载 commit 变更文件。Download archive of changed files for a commit.
+	# 下载提交变更文件。Download commit changed files archive.
 	def get_archive_commit_changed_files(self,
 		repo: str,
 		sha1: str,
@@ -171,7 +171,7 @@ class GitService:
 			)
 		return 
 		
-	# 打包下载两次 ref 之间的变更文件。Download archive of changed files for a compare.
+	# 下载比较变更文件。Download compared changed files.
 	def get_archive_compare_changed_files(self,
 		repo: str,
 		base_head: str,
@@ -184,7 +184,7 @@ class GitService:
 			)
 		return 
 		
-	# 查询指定分支。Get a branch.
+	# 获取分支。Get branch.
 	def get_branch(self,
 		repo: str,
 		branch: str,
@@ -197,7 +197,7 @@ class GitService:
 			)
 		return api.BranchDetail.safe_parse(data)
 		
-	# 查询指定 commit。Get a commit.
+	# 获取提交。Get commit.
 	def get_commit(self,
 		repo: str,
 		ref: str,
@@ -210,7 +210,7 @@ class GitService:
 			)
 		return api.Commit.safe_parse(data)
 		
-	# 查询指定 commit 的元数据。Get commit annotations.
+	# 查询提交元数据。Get commit annotations.
 	def get_commit_annotations(self,
 		repo: str,
 		sha: str,
@@ -223,7 +223,7 @@ class GitService:
 			)
 		return [web.CommitAnnotation.safe_parse(item) for item in data]
 		
-	# 查询指定 commit 的元数据。Get commit annotations in batch.
+	# 批量查询提交元数据。Batch get commit annotations.
 	def get_commit_annotations_in_batch(self,
 		repo: str,
 	    body_params: web.GetCommitAnnotationsInBatchForm,
@@ -237,7 +237,7 @@ class GitService:
 			)
 		return [web.CommitAnnotationInBatch.safe_parse(item) for item in data]
 		
-	# 发起一个获取 commits 附件的请求， 302到有一定效期的下载地址。Get a request to fetch a commit assets and returns 302 redirect to the assets URL with specific valid time.
+	# 下载 Commit 附件。Download commit attachments.
 	def get_commit_assets(self,
 		repo: str,
 		commit_id: str,
@@ -256,7 +256,7 @@ class GitService:
 			)
 		return 
 		
-	# 查询指定 commit 的附件。List commit assets.
+	# 查询提交附件列表。List commit assets.
 	def get_commit_assets_by_sha(self,
 		repo: str,
 		sha1: str,
@@ -269,7 +269,7 @@ class GitService:
 			)
 		return [api.CommitAsset.safe_parse(item) for item in data]
 		
-	# 查询指定 commit 的提交状态。List commit check statuses.
+	# 查询提交状态检查。Get commit statuses.
 	def get_commit_statuses(self,
 		repo: str,
 		commitish: str,
@@ -282,7 +282,7 @@ class GitService:
 			)
 		return [git_woa_com_cnb_monorepo_git_internal_app_git_service_bff_api.CommitStatus.safe_parse(item) for item in data]
 		
-	# 比较两个提交、分支或标签之间差异的接口。Compare two commits, branches, or tags.
+	# 比较提交差异。Compare commits.
 	def get_compare_commits(self,
 		repo: str,
 		base_head: str,
@@ -295,7 +295,7 @@ class GitService:
 			)
 		return api.CompareResponse.safe_parse(data)
 		
-	# 查询仓库文件列表或文件。List repository files or file.
+	# 查询仓库文件内容。Get repository file content.
 	def get_content(self,
 		repo: str,
 		file_path: str,
@@ -313,7 +313,7 @@ class GitService:
 			)
 		return api.Content.safe_parse(data)
 		
-	# 查询仓库文件和目录内容。List repository files and directories.
+	# 查询仓库根目录内容。Get repository root contents.
 	def get_content_without_path(self,
 		repo: str,
 	    ref: Optional[str] = None,
@@ -330,7 +330,7 @@ class GitService:
 			)
 		return api.Content.safe_parse(data)
 		
-	# 获取仓库默认分支。Get the default branch of the repository.
+	# 获取默认分支。Get default branch.
 	def get_head(self,
 		repo: str,
 	    ) -> openapi.HeadRef:
@@ -342,7 +342,7 @@ class GitService:
 			)
 		return openapi.HeadRef.safe_parse(data)
 		
-	# 获取 git lfs 文件下载链接
+	# 获取 LFS 文件下载链接。Get LFS file download URL.
 	def get_presigned_lfsdownload_link(self,
 		slug: str,
 		oid: str,
@@ -360,7 +360,7 @@ class GitService:
 			)
 		return 
 		
-	# 获得仓库指定文件内容
+	# 获取文件原始内容。Get raw file content.
 	def get_raw(self,
 		repo: str,
 		ref_with_path: str,
@@ -378,7 +378,7 @@ class GitService:
 			)
 		return str.safe_parse(data)
 		
-	# 查询指定 tag。Get a tag.
+	# 获取标签。Get tag.
 	def get_tag(self,
 		repo: str,
 		tag: str,
@@ -391,7 +391,7 @@ class GitService:
 			)
 		return api.Tag.safe_parse(data)
 		
-	# 查询指定 tag 的元数据。Query the metadata of the specified tag.
+	# 查询标签元数据。Get tag annotations.
 	def get_tag_annotations(self,
 		repo: str,
 		tag: str,
@@ -423,7 +423,7 @@ class GitService:
 			)
 		return [api.Branch.safe_parse(item) for item in data]
 		
-	# 查询 commit 列表。List commits.
+	# 查询提交列表。List commits.
 	def list_commits(self,
 		repo: str,
 	    sha: Optional[str] = None,
@@ -452,7 +452,7 @@ class GitService:
 			)
 		return [api.Commit.safe_parse(item) for item in data]
 		
-	# 查询 tag 列表。List tags.
+	# 查询标签列表。List tags.
 	def list_tags(self,
 		repo: str,
 	    page: Optional[int] = None,
@@ -471,7 +471,7 @@ class GitService:
 			)
 		return [api.Tag.safe_parse(item) for item in data]
 		
-	# 确认 commit 附件上传完成。Confirm commit asset upload.
+	# 确认提交附件上传。Confirm commit asset upload.
 	def post_commit_asset_upload_confirmation(self,
 		repo: str,
 		sha1: str,
@@ -491,7 +491,7 @@ class GitService:
 			)
 		return 
 		
-	# 新增一个 commit 附件。Create a commit asset.
+	# 获取提交附件上传地址。Get commit asset upload URL.
 	def post_commit_asset_upload_url(self,
 		repo: str,
 		sha1: str,
@@ -506,7 +506,7 @@ class GitService:
 			)
 		return openapi.CommitAssetUploadURL.safe_parse(data)
 		
-	# 设定指定 commit 的元数据。Put commit annotations.
+	# 设置提交元数据。Set commit annotations.
 	def put_commit_annotations(self,
 		repo: str,
 		sha: str,
@@ -521,7 +521,7 @@ class GitService:
 			)
 		return 
 		
-	# 设定指定 tag 的元数据。Set the metadata of the specified tag.
+	# 设置标签元数据。Set tag annotations.
 	def put_tag_annotations(self,
 		repo: str,
 		tag: str,

{python_cnb-1.20.13 → python_cnb-1.22.12}/cnb/gitsettings.py

@@ -7,7 +7,7 @@ class GitsettingsService:
 	def __init__(self, client):
 		self._client = client
 
-	# 删除仓库保护分支规则。 Delete branch protection rule.
+	# 删除保护分支规则。Delete branch protection rule.
 	def delete_branch_protection(self,
 		repo: str,
 		id: str,
@@ -20,7 +20,7 @@ class GitsettingsService:
 			)
 		return 
 		
-	# 查询仓库保护分支规则。Get branch protection rule.
+	# 获取保护分支规则。Get branch protection rule.
 	def get_branch_protection(self,
 		repo: str,
 		id: str,
@@ -33,7 +33,7 @@ class GitsettingsService:
 			)
 		return api.BranchProtection.safe_parse(data)
 		
-	# 查询仓库云原生构建设置。List pipeline settings.
+	# 查询云原生构建设置。Get cloud-native build settings.
 	def get_pipeline_settings(self,
 		repo: str,
 	    ) -> api.PipelineSettings:
@@ -45,7 +45,7 @@ class GitsettingsService:
 			)
 		return api.PipelineSettings.safe_parse(data)
 		
-	# 查询仓库合并请求设置。List pull request settings.
+	# 查询合并请求设置。Get pull request settings.
 	def get_pull_request_settings(self,
 		repo: str,
 	    ) -> api.PullRequestSettings:
@@ -57,7 +57,7 @@ class GitsettingsService:
 			)
 		return api.PullRequestSettings.safe_parse(data)
 		
-	# 查询仓库推送设置。List push limit settings.
+	# 查询推送限制设置。Get push limit settings.
 	def get_push_limit_settings(self,
 		repo: str,
 	    ) -> api.PushLimitSettings:
@@ -69,7 +69,7 @@ class GitsettingsService:
 			)
 		return api.PushLimitSettings.safe_parse(data)
 		
-	# 查询仓库保护分支规则列表。List branch protection rules.
+	# 查询保护分支规则列表。List branch protection rules.
 	def list_branch_protections(self,
 		repo: str,
 	    ) -> list[api.BranchProtection]:
@@ -81,7 +81,7 @@ class GitsettingsService:
 			)
 		return [api.BranchProtection.safe_parse(item) for item in data]
 		
-	# 更新仓库保护分支规则。Update branch protection rule.
+	# 更新保护分支规则。Update branch protection rule.
 	def patch_branch_protection(self,
 		repo: str,
 		id: str,
@@ -96,7 +96,7 @@ class GitsettingsService:
 			)
 		return 
 		
-	# 新增仓库保护分支规则。Create branch protection rule.
+	# 创建保护分支规则。Create branch protection rule.
 	def post_branch_protection(self,
 		repo: str,
 	    body_params: api.BranchProtection,
@@ -110,7 +110,7 @@ class GitsettingsService:
 			)
 		return 
 		
-	# 更新仓库云原生构建设置。Update pipeline settings.
+	# 更新云原生构建设置。Update cloud-native build settings.
 	def put_pipeline_settings(self,
 		repo: str,
 	    body_params: api.PipelineSettings,
@@ -124,7 +124,7 @@ class GitsettingsService:
 			)
 		return 
 		
-	# 更新仓库合并请求设置。Set pull request settings.
+	# 更新合并请求设置。Update pull request settings.
 	def put_pull_request_settings(self,
 		repo: str,
 	    body_params: api.PullRequestSettings,
@@ -138,7 +138,7 @@ class GitsettingsService:
 			)
 		return 
 		
-	# 设置仓库推送设置。Set push limit settings.
+	# 设置推送限制。Set push limit.
 	def put_push_limit_settings(self,
 		repo: str,
 	    body_params: api.PushLimitSettings,