Module sktmls.components.component

Classes

class Component (**kwargs)

MLS 컴포넌트 클래스입니다.

Args

• kwargs
  • id: (int) 컴포넌트 고유 ID
  • name: (str) 컴포넌트 이름
  • info: (str) 컴포넌트 정보
  • is_latest: (bool) 최신여부
  • user: (str) 컴포넌트 생성 계정명
  • created_at: (datetime) 생성일시
  • updated_at: (datetime) 수정일시

Returns

Component

Methods

def get(self)

def reset(self, **kwargs)

class ComponentClient (env: MLSENV = None, runtime_env: MLSRuntimeENV = None, username: str = None, password: str = None)

MLS 컴포넌트 관련 기능들을 제공하는 클라이언트입니다.

Args

• env: (MLSENV) 접근할 MLS 환경 (MLSENV.DEV|MLSENV.STG|MLSENV.PRD) (기본값: MLSENV.STG)
• runtime_env: (MLSRuntimeENV) 클라이언트가 실행되는 환경 (MLSRuntimeENV.YE|MLSRuntimeENV.EDD|MLSRuntimeENV.LOCAL) (기본값: MLSRuntimeENV.LOCAL)
• username: (str) MLS 계정명 (기본값: $MLS_USERNAME)
• password: (str) MLS 계정 비밀번호 (기본값: $MLS_PASSWORD)

아래의 환경 변수가 정의된 경우 해당 파라미터를 생략 가능합니다.

• $MLS_ENV: env
• $MLS_RUNTIME_ENV: runtime_env
• $MLS_USERNAME: username
• $MLS_PASSWORD: password

Returns

ComponentClient

Example

component_client = ComponentClient(env=MLSENV.STG, runtime_env=MLSRuntimeENV.YE, username="mls_account", password="mls_password")

Ancestors

• MLSClient

Methods

def create_component(self, name: str, info: str, is_latest: bool) ‑> Component

컴포넌트를 생성합니다.

Args

• name: (str) 컴포넌트 이름
• info: (str) 컴포넌트 정보
• is_latest: (bool) 최신여부

Returns

Component

• id: (int) 컴포넌트 고유 ID
• name: (str) 컴포넌트 이름
• info: (str) 컴포넌트 정보
• is_latest: (bool) 최신여부
• user: (str) 컴포넌트 생성 계정명
• created_at: (datetime) 생성일시
• updated_at: (datetime) 수정일시

Example

component = component_client.create_component(
    name="my_component",
    info="my_info",
    is_latest=True,
)

def delete_component(self, component: Component) ‑> MLSResponse

컴포넌트 삭제합니다.

Args

• component: (Component) 컴포넌트 객체

Returns

MLSResponse

Example

component_client.delete_component(component)

def get_component(self, id: int = None, name: str = None, info: str = None, is_latest: bool = True) ‑> Component

컴포넌트 정보를 가져옵니다. 여러개가 존재하는 경우 is_latest가 True인 최신의 컴포넌트를 반환합니다.

Args: id 또는 name 중 한 개 이상의 값이 반드시 전달되어야 합니다.

• id: (optional) (int) 컴포넌트 고유 ID
• name: (optional) (str) 컴포넌트 이름
• is_latest: (optional) (bool) 최신여부 (기본값 : True)

Returns

Component

• id: (int) 컴포넌트 고유 ID
• name: (str) 컴포넌트 이름
• info: (str) 컴포넌트 정보
• is_latest: (bool) 최신여부
• user: (str) 컴포넌트 생성 계정명
• created_at: (datetime) 생성일시
• updated_at: (datetime) 수정일시

Example

component_by_id = component_client.get_component(
    id=3
)
component_by_name = component_client.get_component(
    name="my_component",
    is_latest=True
)

def list_components(self, **kwargs) ‑> List[Component]

컴포넌트 리스트를 가져옵니다.

Args

• kwargs: (optional) (dict) 컴포넌트 조건
  • id: (int) 컴포넌트 고유 ID
  • name: (str) 컴포넌트 이름
  • is_latest: (bool) 최신여부
  • query: (str) 검색 문자
  • page: (int) 페이지 번호

Returns

list(Component)

• id: (int) 컴포넌트 고유 ID
• name: (str) 컴포넌트 이름
• info: (str) 컴포넌트 정보
• is_latest: (bool) 최신여부
• user: (str) 컴포넌트 생성 계정명
• created_at: (datetime) 생성일시
• updated_at: (datetime) 수정일시

Example

components = component_client.list_components()

def update_component(self, component: Component, is_latest: bool) ‑> Component

컴포넌트 정보 중 is_latest를 수정합니다.

Args

• component: (Component) 컴포넌트 객체
• is_latest: (bool) 최신여부

Returns

Component

• id: (int) 컴포넌트 고유 ID
• name: (str) 컴포넌트 이름
• info: (str) 컴포넌트 정보
• is_latest: (bool) 최신여부
• user: (str) 컴포넌트 생성 계정명
• created_at: (datetime) 생성일시
• updated_at: (datetime) 수정일시

Example

component = component_client.get_component(name="hello")
component = component_client.update_component(
    component=component,
    is_latest=True,
)