开发API参考

参数

返回类型

Args

level: 로그 레벨 DEBUG, INFO, WARNING, ERROR, CRITICAL msg: 로그 메시지 args: 필요시 기타 인자들 exc_info: 예외 traceback 출력 여부. None이면 현재 except 문맥의 예외가 있을 때만 자동 출력

Returns

없음

参数

返回类型

Args

ret_code: 오류 코드 ret_msg: 오류 메시지 (Default: '') is_traceback: True이면 현재 예외 traceback을 로그에 포함하고, False이면 오류 메시지만 기록

Returns

없음

参数

返回类型

Args

_return: 정상 리턴할 값 ret_code: 오류 코드 ret_msg: 오류 메시지 (Default: '')

Returns

없음

返回类型

Returns

국가 코드 리턴

返回类型

Returns

회사 코드 리턴

返回类型

Returns

storage 이름 반환 : 회사코드_namespace(dev, stg)

参数

返回类型

Args

name: Agent 이름

Returns

해당 Agent 객체

返回类型

Returns

해당 S3 객체

参数

返回类型

Args

field: 필드명 (None이면 전체 client 요청 DataSet 리턴) convert_type: 변환할 타입 (int, str, bool, float 등)

Returns

필드 값 or None or 전체 client 요청 DataSet

返回类型

Returns

서비스 구분명

返回类型

返回类型

Returns

취소이면 True, 아니면 False

返回类型

설명

Return sync Redis client passed as `RedisSync`. Note: Use this for direct Redis access inside run() (thread) where async __redis is unsafe.

参数

返回类型

Args

use_dash: True이면 '-' 포함 (default: False)

Returns

uuid

返回类型

Returns

bool: req_case 가 ws_work 이면 True

返回类型

설명

Gateway가 Redis Stream에 적재한 WebSocket 수신 데이터를 내부 Queue(self.__in_q)로 전달하는 백그라운드 처리를 시작한다.

Returns

bool: 시작했으면 True, 이미 시작되어 있으면 False

参数

返回类型

Args

timeout: 대기 시간(초). None이면 무한 대기

Returns

bytes | None: - bytes: 수신 데이터 - None : EOS, cancel, timeout, 종료 신호

参数

返回类型

Args

timeout: 대기 시간(초). None이면 무한 대기 encoding: bytes decode 인코딩

Returns

str | None: 수신 문자열. EOS, cancel, timeout이면 None

参数

返回类型

Args

timeout: 대기 시간(초). None이면 무한 대기 encoding: bytes decode 인코딩

Returns

dict | list | str | int | float | bool | None: - JSON parse 성공 시 JSON 객체 - EOS, cancel, timeout이면 None

raise

WorkErrorException: JSON parse 실패

参数

返回类型

Args

data: dict, list, str, bytes 등 응답 데이터 ret_code: 결과 코드 ret_msg: 결과 메시지

Returns

bool: 전송 성공 여부

参数

返回类型

우선순위

1. com_code 범위 svc_common 2. req_group 범위 svc_common 3. req_service 범위 svc_common 파일이 변경되면 DynamicModuleLoader가 다음 호출에서 자동 reload한다.

参数

返回类型

参数

返回类型

参数

返回类型

Args

case: 케이스명 stt 등 (사전에 정의된 값) name: 라이브러리명 google, naver 등 (사전에 정의된 값)

Returns

없음 (오류 종료 : ecode=101)

参数

返回类型

Args

case: 케이스명 mt, 등 (사전에 정의된 값) name: 라이브러리명 google, naver 등 (사전에 정의된 값) req_data: 요청 Data

Returns

없음 (오류 종료 : ecode=101, 102-Library 로딩 실패)

返回类型

Returns

결과 Json

参数

返回类型

Args

result: 전송할 결과 Json ret_code: 결과 코드 (Default: 0) ret_msg: 결과 메시지 (Default: '') final: 최종 응답 여부. Redis 내부에서만 사용하며 frontend에는 전달하지 않는다.

Returns

없음

参数

返回类型

Args

file_name: info 파일명 (확장자 포함)

Returns

텍스트 문자열/JSON 또는 오류

参数

返回类型

설명

- field_name="mongo_db"이면 info["mongo_db"] 값을 반환한다. - field_name="mongo_db.name"이면 info["mongo_db"]["name"] 값을 반환한다. - 함수 내부에서는 current 지역 변수만 이동하므로, 전달받은 원본 info dict는 수정하지 않는다. - 필드가 없거나 중간 경로가 dict가 아닌 경우, default가 지정되어 있으면 그 값을 반환한다. - default를 지정하지 않았으면 internal_error_return(..., ...)로 작업 오류를 발생시킨다.

Args

info: 값을 읽을 dict 객체 field_name: 읽을 필드명 또는 점(.)으로 연결된 경로 default: 필드가 없거나 경로가 잘못된 경우 반환할 기본값

Returns

지정한 필드 값 또는 default 값

参数

返回类型

설명

- info_name이 문자열이면 svc_info 범위에서 해당 파일을 읽는다. - info_name이 dict이면 해당 dict에서 바로 값을 읽는다. - field_names가 문자열이면 해당 필드 값을 반환한다. - field_names가 list이면 list에 지정된 순서대로 모든 필드 값을 조회하여 list로 반환한다. - 필드가 없거나 경로가 잘못된 경우 internal_error_return(202, ...)로 작업 오류를 발생시킨다.

Args

info_name: svc_info 파일명 또는 dict 객체 field_names: 필드명 또는 필드명 목록

Returns

- field_names가 str이면 지정한 필드 값 - field_names가 list이면 지정한 순서대로 조회한 값 list

参数

返回类型

Args

file_name: 템플릿 파일명 (확장자 포함)

Returns

텍스트 문자열/JSON 또는 오류

参数

返回类型

Args

password: 원문 비밀번호 iterations: PBKDF2 반복 횟수

Returns

pbkdf2_sha256$반복횟수$salt_base64$hash_base64 형식의 문자열

参数

返回类型

Args

raw_password: 사용자가 입력한 원문 비밀번호 saved_password: 저장된 비밀번호 해시 문자열

Returns

일치하면 True, 아니면 False

参数

返回类型

Args

subject: 생성하는 토큰의 제목 data: 토큰에 저장하는 dict ttl_seconds:

Returns

token 문자열

参数

返回类型

Args

token: 토큰 문자열 ttl_seconds: (옵션) 만료시간 (디폴트:1800) overwrite_data : (옵션) 토큰 저장데이터 변경 (None:변경없음)

Returns

새 토큰 문자열 내부 오류 발생 시: - "ecode":301, "emsg": "token is empty" - "ecode":302, "emsg": "invalid token" - "ecode":303, "emsg": "token payload decode failed" - "ecode":304, "emsg": "token payload must be dict" - "ecode":305, "emsg": "invalid expire_at field" - "ecode":306, "emsg": "token expired" - "ecode":307, "emsg": "invalid subject field"

参数

返回类型

Args

field: 토큰에 저장되어 있는 필드의 값을 추출하려면 token: 토큰 문자열, None이면 Auth_Token

Returns

- field가 있으면 토큰에서 필드에 해당하는 값을 리턴 - token만 있으면 토큰 전체의 payload 리턴 - token의 payload(dict) - {'subject': '', 'data': {}, 'insert_at': , 'expire_at': , 'jwt_id': ''} 오류 : - "ecode":301, "emsg": "token is empty" - "ecode":302, "emsg": "invalid token" - "ecode":303, "emsg": "token payload decode failed" - "ecode":304, "emsg": "token payload must be dict" - "ecode":305, "emsg": "invalid expire_at field" - "ecode":306, "emsg": "token expired" - "ecode":308, "emsg": "token is None"

参数

返回类型

Args

subject: 생성하는 토큰의 제목 data: 토큰에 저장하는 dict ttl_seconds:

Returns

없음

参数

返回类型

Args

token: 토큰 문자열, None이면 기존 Token을 Update ttl_seconds: (옵션) 만료시간 (디폴트:1800) overwrite_data : (옵션) 토큰 저장데이터 변경 (None:변경없음)

Returns

- 없음 - 갱신된 토큰은 반환하지 않고 self.__flx_auth_token 내부 변수에만 반영한다. 내부 오류 발생 시: - "ecode":301, "emsg": "token is empty" - "ecode":302, "emsg": "invalid token" - "ecode":303, "emsg": "token payload decode failed" - "ecode":304, "emsg": "token payload must be dict" - "ecode":305, "emsg": "invalid expire_at field" - "ecode":306, "emsg": "token expired" - "ecode":307, "emsg": "invalid subject field"

参数

返回类型

설명

- 검사 대상은 현재 요청 데이터(self.__mw_request_data)이다. - self.__mw_request_data가 dict가 아니면 201 오류로 종료한다. - field_name은 "user_id" 같은 일반 필드명과 "aaas.user_pwd" 같은 점(.) 경로를 모두 지원한다. - is_exist=True이면 field_name이 반드시 존재해야 하며, 없으면 202 오류로 종료한다. - is_exist=False이면 field_name이 없어도 정상 통과한다. - convert_type이 지정되어 있어도 field_name이 없고 is_exist=False이면 타입 변환을 수행하지 않는다. - 일반 필드는 기존 FLX_Type_Convert를 사용하여 변환한다. - 점(.) 경로 필드는 FLX_Field_Check 내부에서 마지막 필드 값을 직접 변환하여 원본 요청 데이터에 재저장한다. - 기존 키워드 호환을 위해 FieldName, Convert_Type, isExist 키워드도 허용한다.

Args

field_name: 검사할 필드명 또는 점(.)으로 연결된 경로 convert_type: 변환할 타입. 예: int, str, bool, float 등. None이면 타입 변환하지 않음 is_exist: True이면 필수 필드로 검사하고, False이면 선택 필드로 검사

Returns

없음

Raises

WorkErrorException: internal_error_return 호출을 통해 작업 오류로 종료 - 321: 요청 데이터 형식 오류 - 322: 필수 항목 없음 또는 필드 경로 오류 - 323: 타입 변환 오류

参数

返回类型

설명

-data_set이 None이면 현재 요청 데이터(self.__mw_request_data)를 사용한다. - 검사 대상 데이터가 dict가 아니면 201 오류로 종료한다. - field_name이 데이터셋에 없으면 202 오류로 종료한다. - convert_type이 bool이면 문자열 "true"/"false"를 명확하게 변환한다. - bool 이외의 타입은 convert_type(value) 방식으로 변환한다. - 변환된 값은 check_data_set[field_name]에 다시 저장된다.

Args

field_name: 변환할 필드명 convert_type: 변환할 타입. 예: int, str, bool, float 등 data_set: 검사 및 변환할 데이터셋. None이면 요청 데이터 사용

Returns

없음

Raises

WorkErrorException: internal_error_return 호출을 통해 작업 오류로 종료 - 322~327

参数

返回类型

Args

query_num: Query 번호 replace_items: 치환할 문자열 set

Returns

Query 문자열 (오류 종료 : ecode=51)

参数

返回类型

Args

req_name: 요청 이름 query_num: Query 번호 com_code: 요청 ID (None이면 현재 작업의 com_code 사용) req_group: 요청 그룹명 (None이면 현재 작업의 req_group 사용) req_service: 요청 서비스명 (None이면 현재 작업의 req_service 사용) replace_items: 치환할 문자열 set

Returns

Query 문자열 (오류 종료 : ecode=52)

参数

返回类型

Args

db_name (str): 풀 이름

Returns

sess: Session 객체

参数

返回类型

Args

sess: Session 객체

Returns

None

参数

返回类型

Args

value: ObjectId로 변환할 값. ObjectId 또는 ObjectId 문자열

Returns

ObjectId: MongoDB 조회 조건 등에 사용할 ObjectId 객체

Raises

WorkErrorException: internal_error_return 호출을 통해 작업 오류로 종료 - 31: ObjectId 변환 오류

参数

返回类型

Args

sess: Mongo 세션 객체 database (str): 조회 대상 DB 이름 collection (str): collection name query_filter (dict|None): 조회 조건. None이면 전체 조회 projection (dict|None): 반환 필드 선택 (예: {"name": 1, "age": 1}) sort: [("created_at", -1)] limit (int): 최대 반환 개수 (0이면 제한 없음) skip (int): 스킵 개수

Returns

list[dict]: 조회된 문서 리스트 o 문서의 `_id`(ObjectId) 및 날짜/바이너리 타입은 JSON 직렬화 가능한 형태로 변환되어 반환됨 - ObjectId -> 문자열 - datetime/date -> ISO 문자열 - Bytes -> hex 문자열

参数

返回类型

Args

sess: Mongo 세션 객체 database (str): 조회 대상 DB 이름 collection (str): 컬렉션 이름 query_filter (dict|None): 조회 조건. None이면 첫 문서 반환(정렬 없음) projection (dict|None): 반환 필드 선택 sort (list[tuple[str, int]]|None): 정렬 조건. 예: [("_id", -1)]

Returns

dict | None: 조회된 문서 1건 또는 없음

参数

返回类型

Args

sess: Mongo 세션 객체 database (str): 대상 DB 이름 collection (str): 컬렉션 이름 doc (dict | Sequence[dict]): 삽입할 문서 또는 문서 목록 o dict이면 insert_one 처리 o list/tuple 등 Sequence[dict]이면 insert_many 처리 ordered (bool): 여러 건 insert 시 True이면 순서대로 처리하고 중간 오류 발생 시 중단 o False이면 가능한 문서는 계속 삽입 시도 o 단건 insert인 경우에는 사용하지 않음

Returns

dict: o 단건 insert: {"inserted_count": 1, "inserted_id": "...", "inserted_ids": ["..."]} o 여러 건 insert: {"inserted_count": n, "inserted_id": None, "inserted_ids": ["...", "..."]}

参数

返回类型

Args

sess: Mongo 세션 객체 database (str): 대상 DB 이름 collection (str): 컬렉션 이름 query_filter (dict): 대상 문서를 찾기 위한 조건 update (dict): 업데이트 문서(예: {"$set": {...}}) many (bool): False이면 update_one, True이면 update_many 처리 upsert (bool): True이면 조건에 맞는 문서가 없을 때 신규 생성 o many=False이면 조건에 맞는 문서가 여러 건이어도 1건만 수정함 o many=True이면 조건에 맞는 문서를 여러 건 수정함 o many=True, upsert=True이고 조건에 맞는 문서가 없으면 신규 문서는 1건만 생성됨

Returns

dict: matched_count (int): 조건과 매칭된 문서 수 modified_count (int): 실제 수정된 문서 수 upserted_id (str|None): upsert로 신규 생성된 경우 생성된 _id updated (bool): 기존 문서가 실제 변경된 경우 True inserted (bool): upsert로 신규 문서가 생성된 경우 True many (bool): 여러 건 수정 모드 여부

参数

返回类型

Args

sess: Mongo 세션 객체 database (str): 대상 DB 이름 collection (str): 컬렉션 이름 query_filter (dict): 삭제 대상 조건 many (bool): False이면 delete_one, True이면 delete_many 처리 o many=False이면 조건에 맞는 문서가 여러 건이어도 1건만 삭제함 o many=True이면 조건에 맞는 문서를 여러 건 삭제함

Returns

dict: deleted_count (int): 삭제된 문서 수 many (bool): 여러 건 삭제 모드 여부

参数

返回类型

Args

:sess: Mongo 세션 객체 :database (str): 대상 DB 이름 :collection (str): 컬렉션 이름 :pipeline (list[dict]): aggregate :allow_disk_use (bool): 디스크 사용 허용 여부

Returns

list[dict]: 집계 결과 리스트 o 결과 내 ObjectId/datetime 등 BSON 타입은 JSON 직렬화 가능한 형태로 변환되어 반환됨

参数

返回类型

return

세션 (오류 종료 : ecode=11 or 12 / 13-Exception)

参数

返回类型

param

:sess: DB 세션 :query: 실행할 query :data_set: query에 바인딩할 데이터 (None이면 바인딩 없음) :is_get_one: 하나만 리턴할지 여부 (True이면 {} / False이면 list []) :is_scalar: 스칼라 값으로 리턴할지 여부 (True이면 scalar or None / False이면 is_get_one에 따라)

return

조회결과: scalar or 하나만 {} or list [] (오류 종료 : ecode=14)

参数

返回类型

param

:sess: DB 세션 :query: 실행할 query :data_set: query에 바인딩할 데이터 (None이면 바인딩 없음) :is_get_last_id: 마지막 Insert ID를 리턴할지 여부

return

실행결과 : {} or {'last_id':value} (오류 종료 : ecode=15)

参数

返回类型

param

:sess: DB 세션

return

없음 (오류 종료 : ecode=16)

参数

返回类型

param

:sess: DB 세션

return

없음 (오류 종료 : ecode=17)

参数

返回类型

param

:sess: DB 세션

return

없음

参数

返回类型

返回类型

返回类型

返回类型

返回类型

字段

ret_code: int
ret_msg: str
result: Any

字段

cid: str
req_case: str
req_mode: str
req_ccode: str
com_code: str
req_group: str
req_service: str
req_name: str
error_code: int
error_msg: str
response_data: ResponseData

字段

daemon_ver: Incomplete