Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
P
perxis-python
Manage
Activity
Members
Labels
Plan
Issues
3
Issue boards
Milestones
Wiki
Custom issue tracker
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
perxis
perxis-python
Merge requests
!92
feat:
AUTO-4048
Add docstrings
Code
Review changes
Check out branch
Download
Patches
Plain diff
Merged
feat:
AUTO-4048
Add docstrings
feature/AUTO-4048
into
master
Overview
2
Commits
1
Pipelines
0
Changes
1
Merged
Anton Teplyakov
requested to merge
feature/AUTO-4048
into
master
2 months ago
Overview
2
Commits
1
Pipelines
0
Changes
1
Expand
Closes
AUTO-4048
0
0
Merge request reports
Viewing commit
dc6f3548
Show latest version
1 file
+
44
−
0
Inline
Compare changes
Side-by-side
Inline
Show whitespace changes
Show one file at a time
dc6f3548
feat:
AUTO-4048
Add docstrings
· dc6f3548
teplyakov
authored
2 months ago
perxis/channel.py
+
44
−
0
Options
"""
Этот модуль предоставляет класс для создания защищенного gRPC-соединения.
### Основные компоненты:
- [`GrpcChannel`](#GrpcChannel) — создание и управление защищенным gRPC-соединением.
- [`get_grpc_channel`](#get_grpc_channel) — фабричная функция для создания экземпляра [`GrpcChannel`](#GrpcChannel).
"""
import
grpc
from
perxis.auth
import
APIKeyPlugin
class
GrpcChannel
:
"""
Класс для создания защищенного gRPC-соединения.
Attributes:
call_credentials (grpc.CallCredentials): gRPC-учетные данные для вызова.
channel_credentials (grpc.ChannelCredentials): gRPC-учетные данные канала.
composite_credentials (grpc.ChannelCredentials): Комбинированные учетные данные.
channel (grpc.Channel | None): Активный gRPC-канал или None, если соединение не установлено.
"""
call_credentials
:
grpc
.
CallCredentials
channel_credentials
:
grpc
.
ChannelCredentials
composite_credentials
:
grpc
.
ChannelCredentials
@@ -17,6 +34,15 @@ class GrpcChannel:
project_version
:
str
,
call_credentials_name
:
str
=
"
api-key
"
,
)
->
None
:
"""
Создает новый экземпляр и устанавливает соединение.
Arguments:
target (str): Адрес gRPC-сервера.
metadata_plugin (grpc.AuthMetadataPlugin): Плагин аутентификации.
project_name (str): Название проекта.
project_version (str): Версия проекта.
call_credentials_name (str): Название плагина (по умолчанию
"
api-key
"
).
"""
self
.
target
=
target
self
.
metadata_plugin
=
metadata_plugin
self
.
call_credentials_name
=
call_credentials_name
@@ -24,6 +50,7 @@ class GrpcChannel:
self
.
connect
(
project_name
,
project_version
)
def
_init_credentials
(
self
)
->
None
:
"""
Инициализирует учетные данные для gRPC-соединения.
"""
self
.
call_credentials
=
grpc
.
metadata_call_credentials
(
self
.
metadata_plugin
,
name
=
self
.
call_credentials_name
)
@@ -33,6 +60,12 @@ class GrpcChannel:
)
def
connect
(
self
,
project_name
:
str
,
project_version
:
str
)
->
None
:
"""
Устанавливает защищенное соединение с gRPC-сервером.
Arguments:
project_name (str): Название проекта.
project_version (str): Версия проекта.
"""
if
not
self
.
channel
:
self
.
channel
=
grpc
.
aio
.
secure_channel
(
self
.
target
,
@@ -43,12 +76,23 @@ class GrpcChannel:
)
async
def
close
(
self
)
->
None
:
"""
Закрывает активное gRPC-соединение.
"""
await
self
.
channel
.
close
()
def
get_grpc_channel
(
target
:
str
,
api_key
:
str
,
project_name
:
str
,
project_version
:
str
)
->
GrpcChannel
:
"""
Создает и возвращает новый экземпляр [`GrpcChannel`](#GrpcChannel).
Arguments:
target (str): Адрес gRPC-сервера.
api_key (str): API-ключ для аутентификации.
project_name (str): Название проекта.
project_version (str): Версия проекта.
Returns:
GrpcChannel: Новый экземпляр [`GrpcChannel`](#GrpcChannel).
"""
return
GrpcChannel
(
target
=
target
,
metadata_plugin
=
APIKeyPlugin
(
token
=
api_key
),
Loading